diff --git a/.changes/1.35.52.json b/.changes/1.35.52.json new file mode 100644 index 0000000000..6b685c5fcd --- /dev/null +++ b/.changes/1.35.52.json @@ -0,0 +1,87 @@ +[ + { + "category": "``appsync``", + "description": "This release adds support for AppSync Event APIs.", + "type": "api-change" + }, + { + "category": "``connect``", + "description": "Updated the public documentation for the UserIdentityInfo object to accurately reflect the character limits for the FirstName and LastName fields, which were previously listed as 1-100 characters.", + "type": "api-change" + }, + { + "category": "``datasync``", + "description": "AWS DataSync now supports Enhanced mode tasks. This task mode supports transfer of virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. This mode currently supports transfers between Amazon S3 locations.", + "type": "api-change" + }, + { + "category": "``ec2``", + "description": "This release adds two new capabilities to VPC Security Groups: Security Group VPC Associations and Shared Security Groups.", + "type": "api-change" + }, + { + "category": "``ecs``", + "description": "This release supports service deployments and service revisions which provide a comprehensive view of your Amazon ECS service history.", + "type": "api-change" + }, + { + "category": "``geo-maps``", + "description": "Release of Amazon Location Maps API. Maps enables you to build digital maps that showcase your locations, visualize your data, and unlock insights to drive your business", + "type": "api-change" + }, + { + "category": "``geo-places``", + "description": "Release of Amazon Location Places API. Places enables you to quickly search, display, and filter places, businesses, and locations based on proximity, category, and name", + "type": "api-change" + }, + { + "category": "``geo-routes``", + "description": "Release of Amazon Location Routes API. Routes enables you to plan efficient routes and streamline deliveries by leveraging real-time traffic, vehicle restrictions, and turn-by-turn directions.", + "type": "api-change" + }, + { + "category": "``keyspaces``", + "description": "Adds support for interacting with user-defined types (UDTs) through the following new operations: Create-Type, Delete-Type, List-Types, Get-Type.", + "type": "api-change" + }, + { + "category": "``network-firewall``", + "description": "AWS Network Firewall now supports configuring TCP idle timeout", + "type": "api-change" + }, + { + "category": "``opensearch``", + "description": "This release introduces the new OpenSearch user interface (Dashboards), a new web-based application that can be associated with multiple data sources across OpenSearch managed clusters, serverless collections, and Amazon S3, so that users can gain a comprehensive insights in an unified interface.", + "type": "api-change" + }, + { + "category": "``opensearchserverless``", + "description": "Neo Integration via IAM Identity Center (IdC)", + "type": "api-change" + }, + { + "category": "``redshift``", + "description": "This release launches S3 event integrations to create and manage integrations from an Amazon S3 source into an Amazon Redshift database.", + "type": "api-change" + }, + { + "category": "``redshift-serverless``", + "description": "Adds and updates API members for the Redshift Serverless AI-driven scaling and optimization feature using the price-performance target setting.", + "type": "api-change" + }, + { + "category": "``route53``", + "description": "This release adds support for TLSA, SSHFP, SVCB, and HTTPS record types.", + "type": "api-change" + }, + { + "category": "``sagemaker``", + "description": "Added support for Model Registry Staging construct. Users can define series of stages that models can progress through for model workflows and lifecycle. This simplifies tracking and managing models as they transition through development, testing, and production stages.", + "type": "api-change" + }, + { + "category": "``workmail``", + "description": "This release adds support for Multi-Factor Authentication (MFA) and Personal Access Tokens through integration with AWS IAM Identity Center.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 908484da99..e24b2501c5 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,28 @@ CHANGELOG ========= +1.35.52 +======= + +* api-change:``appsync``: This release adds support for AppSync Event APIs. +* api-change:``connect``: Updated the public documentation for the UserIdentityInfo object to accurately reflect the character limits for the FirstName and LastName fields, which were previously listed as 1-100 characters. +* api-change:``datasync``: AWS DataSync now supports Enhanced mode tasks. This task mode supports transfer of virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. This mode currently supports transfers between Amazon S3 locations. +* api-change:``ec2``: This release adds two new capabilities to VPC Security Groups: Security Group VPC Associations and Shared Security Groups. +* api-change:``ecs``: This release supports service deployments and service revisions which provide a comprehensive view of your Amazon ECS service history. +* api-change:``geo-maps``: Release of Amazon Location Maps API. Maps enables you to build digital maps that showcase your locations, visualize your data, and unlock insights to drive your business +* api-change:``geo-places``: Release of Amazon Location Places API. Places enables you to quickly search, display, and filter places, businesses, and locations based on proximity, category, and name +* api-change:``geo-routes``: Release of Amazon Location Routes API. Routes enables you to plan efficient routes and streamline deliveries by leveraging real-time traffic, vehicle restrictions, and turn-by-turn directions. +* api-change:``keyspaces``: Adds support for interacting with user-defined types (UDTs) through the following new operations: Create-Type, Delete-Type, List-Types, Get-Type. +* api-change:``network-firewall``: AWS Network Firewall now supports configuring TCP idle timeout +* api-change:``opensearch``: This release introduces the new OpenSearch user interface (Dashboards), a new web-based application that can be associated with multiple data sources across OpenSearch managed clusters, serverless collections, and Amazon S3, so that users can gain a comprehensive insights in an unified interface. +* api-change:``opensearchserverless``: Neo Integration via IAM Identity Center (IdC) +* api-change:``redshift``: This release launches S3 event integrations to create and manage integrations from an Amazon S3 source into an Amazon Redshift database. +* api-change:``redshift-serverless``: Adds and updates API members for the Redshift Serverless AI-driven scaling and optimization feature using the price-performance target setting. +* api-change:``route53``: This release adds support for TLSA, SSHFP, SVCB, and HTTPS record types. +* api-change:``sagemaker``: Added support for Model Registry Staging construct. Users can define series of stages that models can progress through for model workflows and lifecycle. This simplifies tracking and managing models as they transition through development, testing, and production stages. +* api-change:``workmail``: This release adds support for Multi-Factor Authentication (MFA) and Personal Access Tokens through integration with AWS IAM Identity Center. + + 1.35.51 ======= diff --git a/botocore/__init__.py b/botocore/__init__.py index c33143e68d..52d5707539 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re -__version__ = '1.35.51' +__version__ = '1.35.52' class NullHandler(logging.Handler): diff --git a/botocore/data/appsync/2017-07-25/paginators-1.json b/botocore/data/appsync/2017-07-25/paginators-1.json index 0da53b21f4..fbb7de0b6e 100644 --- a/botocore/data/appsync/2017-07-25/paginators-1.json +++ b/botocore/data/appsync/2017-07-25/paginators-1.json @@ -59,6 +59,18 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "types" + }, + "ListApis": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "apis" + }, + "ListChannelNamespaces": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "channelNamespaces" } } } diff --git a/botocore/data/appsync/2017-07-25/service-2.json b/botocore/data/appsync/2017-07-25/service-2.json index 3cda40eb24..4ecd0e692a 100644 --- a/botocore/data/appsync/2017-07-25/service-2.json +++ b/botocore/data/appsync/2017-07-25/service-2.json @@ -67,6 +67,23 @@ ], "documentation":"

Creates an association between a Merged API and source API using the Merged API's identifier.

" }, + "CreateApi":{ + "name":"CreateApi", + "http":{ + "method":"POST", + "requestUri":"/v2/apis" + }, + "input":{"shape":"CreateApiRequest"}, + "output":{"shape":"CreateApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an Api object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

" + }, "CreateApiCache":{ "name":"CreateApiCache", "http":{ @@ -104,6 +121,25 @@ ], "documentation":"

Creates a unique key that you can distribute to clients who invoke your API.

" }, + "CreateChannelNamespace":{ + "name":"CreateChannelNamespace", + "http":{ + "method":"POST", + "requestUri":"/v2/apis/{apiId}/channelNamespaces" + }, + "input":{"shape":"CreateChannelNamespaceRequest"}, + "output":{"shape":"CreateChannelNamespaceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates a ChannelNamespace for an Api.

" + }, "CreateDataSource":{ "name":"CreateDataSource", "http":{ @@ -205,6 +241,25 @@ ], "documentation":"

Creates a Type object.

" }, + "DeleteApi":{ + "name":"DeleteApi", + "http":{ + "method":"DELETE", + "requestUri":"/v2/apis/{apiId}" + }, + "input":{"shape":"DeleteApiRequest"}, + "output":{"shape":"DeleteApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes an Api object

", + "idempotent":true + }, "DeleteApiCache":{ "name":"DeleteApiCache", "http":{ @@ -238,6 +293,25 @@ ], "documentation":"

Deletes an API key.

" }, + "DeleteChannelNamespace":{ + "name":"DeleteChannelNamespace", + "http":{ + "method":"DELETE", + "requestUri":"/v2/apis/{apiId}/channelNamespaces/{name}" + }, + "input":{"shape":"DeleteChannelNamespaceRequest"}, + "output":{"shape":"DeleteChannelNamespaceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a ChannelNamespace.

", + "idempotent":true + }, "DeleteDataSource":{ "name":"DeleteDataSource", "http":{ @@ -439,6 +513,23 @@ ], "documentation":"

Flushes an ApiCache object.

" }, + "GetApi":{ + "name":"GetApi", + "http":{ + "method":"GET", + "requestUri":"/v2/apis/{apiId}" + }, + "input":{"shape":"GetApiRequest"}, + "output":{"shape":"GetApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves an Api object.

" + }, "GetApiAssociation":{ "name":"GetApiAssociation", "http":{ @@ -472,6 +563,23 @@ ], "documentation":"

Retrieves an ApiCache object.

" }, + "GetChannelNamespace":{ + "name":"GetChannelNamespace", + "http":{ + "method":"GET", + "requestUri":"/v2/apis/{apiId}/channelNamespaces/{name}" + }, + "input":{"shape":"GetChannelNamespaceRequest"}, + "output":{"shape":"GetChannelNamespaceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves the channel namespace for a specified Api.

" + }, "GetDataSource":{ "name":"GetDataSource", "http":{ @@ -665,6 +773,37 @@ ], "documentation":"

Lists the API keys for a given API.

API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.

" }, + "ListApis":{ + "name":"ListApis", + "http":{ + "method":"GET", + "requestUri":"/v2/apis" + }, + "input":{"shape":"ListApisRequest"}, + "output":{"shape":"ListApisResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the APIs in your AppSync account.

ListApis returns only the high level API details. For more detailed information about an API, use GetApi.

" + }, + "ListChannelNamespaces":{ + "name":"ListChannelNamespaces", + "http":{ + "method":"GET", + "requestUri":"/v2/apis/{apiId}/channelNamespaces" + }, + "input":{"shape":"ListChannelNamespacesRequest"}, + "output":{"shape":"ListChannelNamespacesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the channel namespaces for a specified Api.

ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace.

" + }, "ListDataSources":{ "name":"ListDataSources", "http":{ @@ -931,6 +1070,24 @@ ], "documentation":"

Untags a resource.

" }, + "UpdateApi":{ + "name":"UpdateApi", + "http":{ + "method":"POST", + "requestUri":"/v2/apis/{apiId}" + }, + "input":{"shape":"UpdateApiRequest"}, + "output":{"shape":"UpdateApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates an Api.

" + }, "UpdateApiCache":{ "name":"UpdateApiCache", "http":{ @@ -966,6 +1123,24 @@ ], "documentation":"

Updates an API key. You can update the key as long as it's not deleted.

" }, + "UpdateChannelNamespace":{ + "name":"UpdateChannelNamespace", + "http":{ + "method":"POST", + "requestUri":"/v2/apis/{apiId}/channelNamespaces/{name}" + }, + "input":{"shape":"UpdateChannelNamespaceRequest"}, + "output":{"shape":"UpdateChannelNamespaceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates a ChannelNamespace associated with an Api.

" + }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ @@ -1123,6 +1298,49 @@ "type":"list", "member":{"shape":"AdditionalAuthenticationProvider"} }, + "Api":{ + "type":"structure", + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

" + }, + "name":{ + "shape":"ApiName", + "documentation":"

The name of the Api.

" + }, + "ownerContact":{ + "shape":"OwnerContact", + "documentation":"

The owner contact information for the Api

" + }, + "tags":{"shape":"TagMap"}, + "dns":{ + "shape":"MapOfStringToString", + "documentation":"

The DNS records for the API. This will include an HTTP and a real-time endpoint.

" + }, + "apiArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the Api.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time that the Api was created.

" + }, + "xrayEnabled":{ + "shape":"Boolean", + "documentation":"

A flag indicating whether to use X-Ray tracing for this Api.

" + }, + "wafWebAclArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

" + }, + "eventConfig":{ + "shape":"EventConfig", + "documentation":"

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

" + } + }, + "documentation":"

Describes an AppSync API. You can use Api for an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

" + }, "ApiAssociation":{ "type":"structure", "members":{ @@ -1269,6 +1487,16 @@ "error":{"httpStatusCode":400}, "exception":true }, + "ApiName":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[A-Za-z0-9_\\-\\ ]+" + }, + "Apis":{ + "type":"list", + "member":{"shape":"Api"} + }, "AppSyncRuntime":{ "type":"structure", "required":[ @@ -1395,6 +1623,42 @@ "SUCCESS" ] }, + "AuthMode":{ + "type":"structure", + "required":["authType"], + "members":{ + "authType":{ + "shape":"AuthenticationType", + "documentation":"

The authorization type.

" + } + }, + "documentation":"

Describes an authorization configuration. Use AuthMode to specify the publishing and subscription authorization configuration for an Event API.

" + }, + "AuthModes":{ + "type":"list", + "member":{"shape":"AuthMode"} + }, + "AuthProvider":{ + "type":"structure", + "required":["authType"], + "members":{ + "authType":{ + "shape":"AuthenticationType", + "documentation":"

The authorization type.

" + }, + "cognitoConfig":{ + "shape":"CognitoConfig", + "documentation":"

Describes an Amazon Cognito user pool configuration.

" + }, + "openIDConnectConfig":{"shape":"OpenIDConnectConfig"}, + "lambdaAuthorizerConfig":{"shape":"LambdaAuthorizerConfig"} + }, + "documentation":"

Describes an authorization provider.

" + }, + "AuthProviders":{ + "type":"list", + "member":{"shape":"AuthProvider"} + }, "AuthenticationType":{ "type":"string", "enum":[ @@ -1499,6 +1763,49 @@ "min":20, "pattern":"^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$" }, + "ChannelNamespace":{ + "type":"structure", + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

" + }, + "name":{ + "shape":"Namespace", + "documentation":"

The name of the channel namespace. This name must be unique within the Api.

" + }, + "subscribeAuthModes":{ + "shape":"AuthModes", + "documentation":"

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

" + }, + "publishAuthModes":{ + "shape":"AuthModes", + "documentation":"

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

" + }, + "codeHandlers":{ + "shape":"Code", + "documentation":"

The event handler functions that run custom business logic to process published events and subscribe requests.

" + }, + "tags":{"shape":"TagMap"}, + "channelNamespaceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the ChannelNamespace.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time that the ChannelNamespace was created.

" + }, + "lastModified":{ + "shape":"Timestamp", + "documentation":"

The date and time that the ChannelNamespace was last changed.

" + } + }, + "documentation":"

Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.

" + }, + "ChannelNamespaces":{ + "type":"list", + "member":{"shape":"ChannelNamespace"} + }, "Code":{ "type":"string", "max":32768, @@ -1547,6 +1854,28 @@ "type":"list", "member":{"shape":"CodeError"} }, + "CognitoConfig":{ + "type":"structure", + "required":[ + "userPoolId", + "awsRegion" + ], + "members":{ + "userPoolId":{ + "shape":"String", + "documentation":"

The user pool ID.

" + }, + "awsRegion":{ + "shape":"String", + "documentation":"

The Amazon Web Services Region in which the user pool was created.

" + }, + "appIdClientRegex":{ + "shape":"String", + "documentation":"

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

" + } + }, + "documentation":"

Describes an Amazon Cognito configuration.

" + }, "CognitoUserPoolConfig":{ "type":"structure", "required":[ @@ -1585,6 +1914,15 @@ "NONE" ] }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.

", + "error":{"httpStatusCode":409}, + "exception":true + }, "ConflictHandlerType":{ "type":"string", "enum":[ @@ -1681,6 +2019,75 @@ } } }, + "CreateApiRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"ApiName", + "documentation":"

The name for the Api.

" + }, + "ownerContact":{ + "shape":"String", + "documentation":"

The owner contact information for the Api.

" + }, + "tags":{"shape":"TagMap"}, + "eventConfig":{ + "shape":"EventConfig", + "documentation":"

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

" + } + } + }, + "CreateApiResponse":{ + "type":"structure", + "members":{ + "api":{ + "shape":"Api", + "documentation":"

The Api object.

" + } + } + }, + "CreateChannelNamespaceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"Namespace", + "documentation":"

The name of the ChannelNamespace. This name must be unique within the Api

" + }, + "subscribeAuthModes":{ + "shape":"AuthModes", + "documentation":"

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

" + }, + "publishAuthModes":{ + "shape":"AuthModes", + "documentation":"

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

" + }, + "codeHandlers":{ + "shape":"Code", + "documentation":"

The event handler functions that run custom business logic to process published events and subscribe requests.

" + }, + "tags":{"shape":"TagMap"} + } + }, + "CreateChannelNamespaceResponse":{ + "type":"structure", + "members":{ + "channelNamespace":{ + "shape":"ChannelNamespace", + "documentation":"

The ChannelNamespace object.

" + } + } + }, "CreateDataSourceRequest":{ "type":"structure", "required":[ @@ -1886,10 +2293,6 @@ "shape":"LambdaAuthorizerConfig", "documentation":"

Configuration for Lambda function authorization.

" }, - "visibility":{ - "shape":"GraphQLApiVisibility", - "documentation":"

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

" - }, "apiType":{ "shape":"GraphQLApiType", "documentation":"

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

" @@ -1898,6 +2301,10 @@ "shape":"String", "documentation":"

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

" }, + "visibility":{ + "shape":"GraphQLApiVisibility", + "documentation":"

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

" + }, "ownerContact":{ "shape":"String", "documentation":"

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

" @@ -2302,6 +2709,49 @@ "members":{ } }, + "DeleteApiRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + } + } + }, + "DeleteApiResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteChannelNamespaceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The ID of the Api associated with the ChannelNamespace.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"Namespace", + "documentation":"

The name of the ChannelNamespace.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteChannelNamespaceResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteDataSourceRequest":{ "type":"structure", "required":[ @@ -2792,6 +3242,66 @@ }, "documentation":"

Describes an Amazon EventBridge bus data source configuration.

" }, + "EventConfig":{ + "type":"structure", + "required":[ + "authProviders", + "connectionAuthModes", + "defaultPublishAuthModes", + "defaultSubscribeAuthModes" + ], + "members":{ + "authProviders":{ + "shape":"AuthProviders", + "documentation":"

A list of authorization providers.

" + }, + "connectionAuthModes":{ + "shape":"AuthModes", + "documentation":"

A list of valid authorization modes for the Event API connections.

" + }, + "defaultPublishAuthModes":{ + "shape":"AuthModes", + "documentation":"

A list of valid authorization modes for the Event API publishing.

" + }, + "defaultSubscribeAuthModes":{ + "shape":"AuthModes", + "documentation":"

A list of valid authorization modes for the Event API subscriptions.

" + }, + "logConfig":{ + "shape":"EventLogConfig", + "documentation":"

The CloudWatch Logs configuration for the Event API.

" + } + }, + "documentation":"

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

" + }, + "EventLogConfig":{ + "type":"structure", + "required":[ + "logLevel", + "cloudWatchLogsRoleArn" + ], + "members":{ + "logLevel":{ + "shape":"EventLogLevel", + "documentation":"

The type of information to log for the Event API.

" + }, + "cloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.

" + } + }, + "documentation":"

Describes the CloudWatch Logs configuration for the Event API.

" + }, + "EventLogLevel":{ + "type":"string", + "enum":[ + "NONE", + "ERROR", + "ALL", + "INFO", + "DEBUG" + ] + }, "FieldLogLevel":{ "type":"string", "enum":[ @@ -2921,6 +3431,57 @@ }, "documentation":"

Represents the output of a GetApiCache operation.

" }, + "GetApiRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + } + } + }, + "GetApiResponse":{ + "type":"structure", + "members":{ + "api":{ + "shape":"Api", + "documentation":"

The Api object.

" + } + } + }, + "GetChannelNamespaceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"Namespace", + "documentation":"

The name of the ChannelNamespace.

", + "location":"uri", + "locationName":"name" + } + } + }, + "GetChannelNamespaceResponse":{ + "type":"structure", + "members":{ + "channelNamespace":{ + "shape":"ChannelNamespace", + "documentation":"

The ChannelNamespace object.

" + } + } + }, "GetDataSourceIntrospectionRequest":{ "type":"structure", "required":["introspectionId"], @@ -2933,7 +3494,7 @@ }, "includeModelsSDL":{ "shape":"Boolean", - "documentation":"

A boolean flag that determines whether SDL should be generated for introspected types or not. If set to true, each model will contain an sdl property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.

", + "documentation":"

A boolean flag that determines whether SDL should be generated for introspected types. If set to true, each model will contain an sdl property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives.

", "location":"querystring", "locationName":"includeModelsSDL" }, @@ -3503,6 +4064,73 @@ } } }, + "ListApisRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results that you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListApisResponse":{ + "type":"structure", + "members":{ + "apis":{ + "shape":"Apis", + "documentation":"

The Api objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

" + } + } + }, + "ListChannelNamespacesRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results that you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListChannelNamespacesResponse":{ + "type":"structure", + "members":{ + "channelNamespaces":{ + "shape":"ChannelNamespaces", + "documentation":"

The ChannelNamespace objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

" + } + } + }, "ListDataSourcesRequest":{ "type":"structure", "required":["apiId"], @@ -3907,7 +4535,7 @@ "members":{ "fieldLogLevel":{ "shape":"FieldLogLevel", - "documentation":"

The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

" + "documentation":"

The field logging level. Values can be NONE, ERROR, or ALL.

" }, "cloudWatchLogsRoleArn":{ "shape":"String", @@ -3953,6 +4581,12 @@ "AUTO_MERGE" ] }, + "Namespace":{ + "type":"string", + "max":50, + "min":1, + "pattern":"([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,48}[A-Za-z0-9])?)" + }, "NotFoundException":{ "type":"structure", "members":{ @@ -4017,6 +4651,12 @@ "JSON" ] }, + "OwnerContact":{ + "type":"string", + "max":250, + "min":0, + "pattern":"[A-Za-z0-9_\\-\\ \\.]+" + }, "Ownership":{ "type":"string", "enum":[ @@ -4028,7 +4668,7 @@ "type":"string", "max":65536, "min":1, - "pattern":"[\\\\S]+" + "pattern":"[\\S]+" }, "PipelineConfig":{ "type":"structure", @@ -4273,6 +4913,15 @@ "NOT_APPLICABLE" ] }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The operation exceeded the service quota for this resource.

", + "error":{"httpStatusCode":402}, + "exception":true + }, "SourceApiAssociation":{ "type":"structure", "members":{ @@ -4549,6 +5198,7 @@ "min":2, "pattern":"^[\\s\\S]*$" }, + "Timestamp":{"type":"timestamp"}, "Type":{ "type":"structure", "members":{ @@ -4703,6 +5353,84 @@ } } }, + "UpdateApiRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ApiName", + "documentation":"

The name of the Api.

" + }, + "ownerContact":{ + "shape":"String", + "documentation":"

The owner contact information for the Api.

" + }, + "eventConfig":{ + "shape":"EventConfig", + "documentation":"

The new event configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

" + } + } + }, + "UpdateApiResponse":{ + "type":"structure", + "members":{ + "api":{ + "shape":"Api", + "documentation":"

The Api object.

" + } + } + }, + "UpdateChannelNamespaceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The Api ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"Namespace", + "documentation":"

The name of the ChannelNamespace.

", + "location":"uri", + "locationName":"name" + }, + "subscribeAuthModes":{ + "shape":"AuthModes", + "documentation":"

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Api authorization configuration.

" + }, + "publishAuthModes":{ + "shape":"AuthModes", + "documentation":"

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Api authorization configuration.

" + }, + "codeHandlers":{ + "shape":"Code", + "documentation":"

The event handler functions that run custom business logic to process published events and subscribe requests.

" + } + } + }, + "UpdateChannelNamespaceResponse":{ + "type":"structure", + "members":{ + "channelNamespace":{ + "shape":"ChannelNamespace", + "documentation":"

The ChannelNamespace object.

" + } + } + }, "UpdateDataSourceRequest":{ "type":"structure", "required":[ @@ -4873,8 +5601,7 @@ "type":"structure", "required":[ "apiId", - "name", - "authenticationType" + "name" ], "members":{ "apiId":{ diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index a50c4cf497..9f88a10acb 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -4593,8 +4593,8 @@ }, "AgentFirstName":{ "type":"string", - "max":100, - "min":1, + "max":255, + "min":0, "sensitive":true }, "AgentHierarchyGroup":{ @@ -4670,8 +4670,8 @@ }, "AgentLastName":{ "type":"string", - "max":100, - "min":1, + "max":300, + "min":0, "sensitive":true }, "AgentPauseDurationInSeconds":{ @@ -23364,7 +23364,7 @@ "documentation":"

The user's mobile number.

" } }, - "documentation":"

Contains information about the identity of a user.

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

" + "documentation":"

Contains information about the identity of a user.

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.

" }, "UserIdentityInfoLite":{ "type":"structure", diff --git a/botocore/data/datasync/2018-11-09/service-2.json b/botocore/data/datasync/2018-11-09/service-2.json index f441250f3f..2c3e37a55d 100644 --- a/botocore/data/datasync/2018-11-09/service-2.json +++ b/botocore/data/datasync/2018-11-09/service-2.json @@ -12,7 +12,8 @@ "signatureVersion":"v4", "signingName":"datasync", "targetPrefix":"FmrsService", - "uid":"datasync-2018-11-09" + "uid":"datasync-2018-11-09", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddStorageSystem":{ @@ -56,7 +57,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.

If you haven't deployed an agent yet, see the following topics to learn more:

If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.

" + "documentation":"

Activates an DataSync agent that you deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account.

If you haven't deployed an agent yet, see Do I need a DataSync agent?

" }, "CreateLocationAzureBlob":{ "name":"CreateLocationAzureBlob", @@ -522,7 +523,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.

" + "documentation":"

Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer.

Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance metrics.

" }, "GenerateRecommendations":{ "name":"GenerateRecommendations", @@ -681,7 +682,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"

Starts an DataSync transfer task. For each task, you can only run one task execution at a time.

There are several phases to a task execution. For more information, see Task execution statuses.

If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

" + "documentation":"

Starts an DataSync transfer task. For each task, you can only run one task execution at a time.

There are several steps to a task execution. For more information, see Task execution statuses.

If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

" }, "StopDiscoveryJob":{ "name":"StopDiscoveryJob", @@ -1084,11 +1085,11 @@ "members":{ "ActivationKey":{ "shape":"ActivationKey", - "documentation":"

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

" + "documentation":"

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent.

" }, "AgentName":{ "shape":"TagValue", - "documentation":"

Specifies a name for your agent. You can see this name in the DataSync console.

" + "documentation":"

Specifies a name for your agent. We recommend specifying a name that you can remember.

" }, "Tags":{ "shape":"InputTagList", @@ -1096,15 +1097,15 @@ }, "VpcEndpointId":{ "shape":"VpcEndpointId", - "documentation":"

Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

" + "documentation":"

Specifies the ID of the VPC service endpoint that you're using. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC service endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

" }, "SubnetArns":{ "shape":"PLSubnetArnList", - "documentation":"

Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

" + "documentation":"

Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.

" }, "SecurityGroupArns":{ "shape":"PLSecurityGroupArnList", - "documentation":"

Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between your agent and VPC service endpoint. You can only specify one ARN.

" } }, "documentation":"

CreateAgentRequest

" @@ -1179,15 +1180,15 @@ "members":{ "Subdirectory":{ "shape":"EfsSubdirectory", - "documentation":"

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

You must specify a value with forward slashes (for example, /path/to/folder).

" + "documentation":"

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location) on your file system.

By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).

" }, "EfsFilesystemArn":{ "shape":"EfsFilesystemArn", - "documentation":"

Specifies the ARN for the Amazon EFS file system.

" + "documentation":"

Specifies the ARN for your Amazon EFS file system.

" }, "Ec2Config":{ "shape":"Ec2Config", - "documentation":"

Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

" + "documentation":"

Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's mount targets.

" }, "Tags":{ "shape":"InputTagList", @@ -1195,15 +1196,15 @@ }, "AccessPointArn":{ "shape":"EfsAccessPointArn", - "documentation":"

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

For more information, see Accessing restricted file systems.

" }, "FileSystemAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"

Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

" + "documentation":"

Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For information on creating this role, see Creating a DataSync IAM role for file system access.

" }, "InTransitEncryption":{ "shape":"EfsInTransitEncryption", - "documentation":"

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

" + "documentation":"

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

" } }, "documentation":"

CreateLocationEfsRequest

" @@ -1346,7 +1347,7 @@ }, "SecurityGroupArns":{ "shape":"Ec2SecurityGroupArnList", - "documentation":"

Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.

If you choose a security group that doesn't allow connections from within itself, do one of the following:

" + "documentation":"

Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .

If you choose a security group that doesn't allow connections from within itself, do one of the following:

" }, "Tags":{ "shape":"InputTagList", @@ -1429,7 +1430,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

" + "documentation":"

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

" }, "Tags":{ "shape":"InputTagList", @@ -1442,7 +1443,7 @@ "members":{ "LocationArn":{ "shape":"LocationArn", - "documentation":"

The ARN of the source HDFS cluster location that's created.

" + "documentation":"

The ARN of the source HDFS cluster location that you create.

" } } }, @@ -1464,7 +1465,7 @@ }, "OnPremConfig":{ "shape":"OnPremConfig", - "documentation":"

Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to connect to your NFS file server.

You can specify more than one agent. For more information, see Using multiple agents for transfers.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.

You can specify more than one agent. For more information, see Using multiple DataSync agents.

" }, "MountOptions":{ "shape":"NfsMountOptions", @@ -1525,7 +1526,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

" + "documentation":"

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

" }, "Tags":{ "shape":"InputTagList", @@ -1621,7 +1622,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

" + "documentation":"

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

" }, "MountOptions":{ "shape":"SmbMountOptions", @@ -1661,7 +1662,7 @@ }, "CloudWatchLogGroupArn":{ "shape":"LogGroupArn", - "documentation":"

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync.

" }, "Name":{ "shape":"TagValue", @@ -1685,7 +1686,7 @@ }, "Includes":{ "shape":"FilterList", - "documentation":"

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

" + "documentation":"

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

" }, "ManifestConfig":{ "shape":"ManifestConfig", @@ -1694,6 +1695,10 @@ "TaskReportConfig":{ "shape":"TaskReportConfig", "documentation":"

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

" + }, + "TaskMode":{ + "shape":"TaskMode", + "documentation":"

Specifies one of the following task modes for your data transfer:

For more information, see Understanding task mode differences.

" } }, "documentation":"

CreateTaskRequest

" @@ -1934,15 +1939,15 @@ }, "AccessPointArn":{ "shape":"EfsAccessPointArn", - "documentation":"

The ARN of the access point that DataSync uses to access the Amazon EFS file system.

" + "documentation":"

The ARN of the access point that DataSync uses to access the Amazon EFS file system.

For more information, see Accessing restricted file systems.

" }, "FileSystemAccessRoleArn":{ "shape":"IamRoleArn", - "documentation":"

The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

" + "documentation":"

The Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For more information, see Creating a DataSync IAM role for file system access.

" }, "InTransitEncryption":{ "shape":"EfsInTransitEncryption", - "documentation":"

Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.

" + "documentation":"

Indicates whether DataSync uses Transport Layer Security (TLS) encryption when transferring data to or from the Amazon EFS file system.

" } }, "documentation":"

DescribeLocationEfsResponse

" @@ -2076,7 +2081,7 @@ }, "SecurityGroupArns":{ "shape":"Ec2SecurityGroupArnList", - "documentation":"

The ARNs of the security groups that are configured for the FSx for Windows File Server file system.

" + "documentation":"

The ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .

" }, "CreationTime":{ "shape":"Time", @@ -2514,27 +2519,27 @@ }, "EstimatedFilesToTransfer":{ "shape":"long", - "documentation":"

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

" + "documentation":"

The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated during the task execution's PREPARING step before the TRANSFERRING step.

How this gets calculated depends primarily on your task’s transfer mode configuration:

" }, "EstimatedBytesToTransfer":{ "shape":"long", - "documentation":"

The estimated physical number of bytes that will transfer over the network.

" + "documentation":"

The number of logical bytes that DataSync expects to write to the destination location.

" }, "FilesTransferred":{ "shape":"long", - "documentation":"

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what transferred or to monitor your task execution.

" + "documentation":"

The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during the task execution's TRANSFERRING step when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.

" }, "BytesWritten":{ "shape":"long", - "documentation":"

The number of logical bytes written to the destination location.

" + "documentation":"

The number of logical bytes that DataSync actually writes to the destination location.

" }, "BytesTransferred":{ "shape":"long", - "documentation":"

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

" + "documentation":"

The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.

" }, "BytesCompressed":{ "shape":"long", - "documentation":"

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn't compressible.

" + "documentation":"

The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.

Not currently supported with Enhanced mode tasks.

" }, "Result":{ "shape":"TaskExecutionResultDetail", @@ -2546,15 +2551,15 @@ }, "FilesDeleted":{ "shape":"long", - "documentation":"

The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

" + "documentation":"

The number of files, objects, and directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

" }, "FilesSkipped":{ "shape":"long", - "documentation":"

The number of files, objects, and directories that DataSync skipped during your transfer.

" + "documentation":"

The number of files, objects, and directories that DataSync skips during your transfer.

" }, "FilesVerified":{ "shape":"long", - "documentation":"

The number of files, objects, and directories that DataSync verified during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

" + "documentation":"

The number of files, objects, and directories that DataSync verifies during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

" }, "ReportResult":{ "shape":"ReportResult", @@ -2562,7 +2567,23 @@ }, "EstimatedFilesToDelete":{ "shape":"long", - "documentation":"

The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

" + "documentation":"

The number of files, objects, and directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

" + }, + "TaskMode":{ + "shape":"TaskMode", + "documentation":"

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

" + }, + "FilesPrepared":{ + "shape":"long", + "documentation":"

The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.

Applies only to Enhanced mode tasks.

This metric isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

" + }, + "FilesListed":{ + "shape":"TaskExecutionFilesListedDetail", + "documentation":"

The number of objects that DataSync finds at your locations.

Applies only to Enhanced mode tasks.

" + }, + "FilesFailed":{ + "shape":"TaskExecutionFilesFailedDetail", + "documentation":"

The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.

Applies only to Enhanced mode tasks.

" } }, "documentation":"

DescribeTaskExecutionResponse

" @@ -2607,7 +2628,7 @@ }, "CloudWatchLogGroupArn":{ "shape":"LogGroupArn", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For more information, see Monitoring DataSync with Amazon CloudWatch.

" + "documentation":"

The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For more information, see Monitoring data transfers with CloudWatch Logs.

" }, "SourceNetworkInterfaceArns":{ "shape":"SourceNetworkInterfaceArns", @@ -2656,6 +2677,10 @@ "ScheduleDetails":{ "shape":"TaskScheduleDetails", "documentation":"

The details about your task schedule.

" + }, + "TaskMode":{ + "shape":"TaskMode", + "documentation":"

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

" } }, "documentation":"

DescribeTaskResponse

" @@ -2778,7 +2803,7 @@ "documentation":"

Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.

" } }, - "documentation":"

The subnet and security groups that DataSync uses to access your Amazon EFS file system.

" + "documentation":"

The subnet and security groups that DataSync uses to connect to one of your Amazon EFS file system's mount targets.

" }, "Ec2SecurityGroupArn":{ "type":"string", @@ -3846,10 +3871,10 @@ "members":{ "AgentArns":{ "shape":"AgentArnList", - "documentation":"

The Amazon Resource Names (ARNs) of the agents connecting to a transfer location.

" + "documentation":"

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.

You can specify more than one agent. For more information, see Using multiple DataSync agents.

" } }, - "documentation":"

The DataSync agents that are connecting to a Network File System (NFS) location.

" + "documentation":"

The DataSync agents that can connect to your Network File System (NFS) file server.

" }, "Operator":{ "type":"string", @@ -3871,7 +3896,7 @@ "members":{ "VerifyMode":{ "shape":"VerifyMode", - "documentation":"

Specifies how and when DataSync checks the integrity of your data during a transfer.

" + "documentation":"

Specifies if and how DataSync checks the integrity of your data at the end of your transfer.

" }, "OverwriteMode":{ "shape":"OverwriteMode", @@ -3879,11 +3904,11 @@ }, "Atime":{ "shape":"Atime", - "documentation":"

Specifies whether to preserve metadata indicating the last time a file was read or written to.

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

" + "documentation":"

Specifies whether to preserve metadata indicating the last time a file was read or written to.

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

" }, "Mtime":{ "shape":"Mtime", - "documentation":"

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

" + "documentation":"

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

" }, "Uid":{ "shape":"Uid", @@ -3891,7 +3916,7 @@ }, "Gid":{ "shape":"Gid", - "documentation":"

Specifies the POSIX group ID (GID) of the file's owners.

For more information, see Metadata copied by DataSync.

" + "documentation":"

Specifies the POSIX group ID (GID) of the file's owners.

For more information, see Understanding how DataSync handles file and object metadata.

" }, "PreserveDeletedFiles":{ "shape":"PreserveDeletedFiles", @@ -3903,11 +3928,11 @@ }, "PosixPermissions":{ "shape":"PosixPermissions", - "documentation":"

Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

For more information, see Metadata copied by DataSync.

DataSync can preserve extant permissions of a source location.

" + "documentation":"

Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

For more information, see Understanding how DataSync handles file and object metadata.

DataSync can preserve extant permissions of a source location.

" }, "BytesPerSecond":{ "shape":"BytesPerSecond", - "documentation":"

Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

" + "documentation":"

Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Not applicable to Enhanced mode tasks.

" }, "TaskQueueing":{ "shape":"TaskQueueing", @@ -3919,11 +3944,11 @@ }, "TransferMode":{ "shape":"TransferMode", - "documentation":"

Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).

" + "documentation":"

Specifies whether DataSync transfers only the data (including metadata) that differs between locations following an initial copy or transfers all data every time you run the task. If you're planning on recurring transfers, you might only want to transfer what's changed since your previous task execution.

" }, "SecurityDescriptorCopyFlags":{ "shape":"SmbSecurityDescriptorCopyFlags", - "documentation":"

Specifies which components of the SMB security descriptor are copied from source to destination objects.

This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

" + "documentation":"

Specifies which components of the SMB security descriptor are copied from source to destination objects.

This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see Understanding how DataSync handles file and object metadata.

" }, "ObjectTags":{ "shape":"ObjectTags", @@ -4023,7 +4048,7 @@ }, "PrivateLinkEndpoint":{ "shape":"Endpoint", - "documentation":"

Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

" + "documentation":"

Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

" }, "SubnetArns":{ "shape":"PLSubnetArnList", @@ -4280,8 +4305,8 @@ }, "S3BucketArn":{ "type":"string", - "max":156, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$" + "max":268, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3-outposts:[a-z\\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\\-_]{1,255}$" }, "S3Config":{ "type":"structure", @@ -4643,6 +4668,42 @@ "max":128, "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$" }, + "TaskExecutionFilesFailedDetail":{ + "type":"structure", + "members":{ + "Prepare":{ + "shape":"long", + "documentation":"

The number of objects that DataSync fails to prepare during your task execution.

" + }, + "Transfer":{ + "shape":"long", + "documentation":"

The number of objects that DataSync fails to transfer during your task execution.

" + }, + "Verify":{ + "shape":"long", + "documentation":"

The number of objects that DataSync fails to verify during your task execution.

" + }, + "Delete":{ + "shape":"long", + "documentation":"

The number of objects that DataSync fails to delete during your task execution.

" + } + }, + "documentation":"

The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.

Applies only to Enhanced mode tasks.

" + }, + "TaskExecutionFilesListedDetail":{ + "type":"structure", + "members":{ + "AtSource":{ + "shape":"long", + "documentation":"

The number of objects that DataSync finds at your source location.

" + }, + "AtDestinationForDelete":{ + "shape":"long", + "documentation":"

The number of objects that DataSync finds at your destination location. This metric is only applicable if you configure your task to delete data in the destination that isn't in the source.

" + } + }, + "documentation":"

The number of objects that DataSync finds at your locations.

Applies only to Enhanced mode tasks.

" + }, "TaskExecutionList":{ "type":"list", "member":{"shape":"TaskExecutionListEntry"} @@ -4657,6 +4718,10 @@ "Status":{ "shape":"TaskExecutionStatus", "documentation":"

The status of a task execution. For more information, see Task execution statuses.

" + }, + "TaskMode":{ + "shape":"TaskMode", + "documentation":"

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

" } }, "documentation":"

Represents a single entry in a list of DataSync task executions that's returned with the ListTaskExecutions operation.

" @@ -4666,42 +4731,42 @@ "members":{ "PrepareDuration":{ "shape":"Duration", - "documentation":"

The total time in milliseconds that DataSync spent in the PREPARING phase.

" + "documentation":"

The time in milliseconds that your task execution was in the PREPARING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync prepares your data transfer.

" }, "PrepareStatus":{ "shape":"PhaseStatus", - "documentation":"

The status of the PREPARING phase.

" + "documentation":"

The status of the PREPARING step for your task execution. For more information, see Task execution statuses.

" }, "TotalDuration":{ "shape":"Duration", - "documentation":"

The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.

" + "documentation":"

The time in milliseconds that your task execution ran.

" }, "TransferDuration":{ "shape":"Duration", - "documentation":"

The total time in milliseconds that DataSync spent in the TRANSFERRING phase.

" + "documentation":"

The time in milliseconds that your task execution was in the TRANSFERRING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync transfers your data.

" }, "TransferStatus":{ "shape":"PhaseStatus", - "documentation":"

The status of the TRANSFERRING phase.

" + "documentation":"

The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses.

" }, "VerifyDuration":{ "shape":"Duration", - "documentation":"

The total time in milliseconds that DataSync spent in the VERIFYING phase.

" + "documentation":"

The time in milliseconds that your task execution was in the VERIFYING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync verifies your data's integrity.

" }, "VerifyStatus":{ "shape":"PhaseStatus", - "documentation":"

The status of the VERIFYING phase.

" + "documentation":"

The status of the VERIFYING step for your task execution. For more information, see Task execution statuses.

" }, "ErrorCode":{ "shape":"string", - "documentation":"

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

" + "documentation":"

An error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

" }, "ErrorDetail":{ "shape":"string", - "documentation":"

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

" + "documentation":"

The detailed description of an error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

" } }, - "documentation":"

Describes the detailed result of a TaskExecution operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.

" + "documentation":"

Provides detailed information about the result of your DataSync task execution.

" }, "TaskExecutionStatus":{ "type":"string", @@ -4768,10 +4833,21 @@ "Name":{ "shape":"TagValue", "documentation":"

The name of the task.

" + }, + "TaskMode":{ + "shape":"TaskMode", + "documentation":"

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

" } }, "documentation":"

Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

" }, + "TaskMode":{ + "type":"string", + "enum":[ + "BASIC", + "ENHANCED" + ] + }, "TaskQueueing":{ "type":"string", "enum":[ @@ -4811,7 +4887,7 @@ "members":{ "ScheduleExpression":{ "shape":"ScheduleExpressionCron", - "documentation":"

Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

" + "documentation":"

Specifies your task schedule by using a cron or rate expression.

Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month:

cron(0 8 * * 3#1)

Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours:

rate(12 hours)

For information about cron and rate expression syntax, see the Amazon EventBridge User Guide .

" }, "Status":{ "shape":"ScheduleStatus", @@ -5046,7 +5122,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

The ARNs of the agents that are used to connect to the HDFS cluster.

" + "documentation":"

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

" } } }, @@ -5106,7 +5182,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

" + "documentation":"

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.

" }, "ServerCertificate":{ "shape":"ObjectStorageCertificate", @@ -5145,7 +5221,7 @@ }, "AgentArns":{ "shape":"AgentArnList", - "documentation":"

Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

" + "documentation":"

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

" }, "MountOptions":{"shape":"SmbMountOptions"} } @@ -5232,7 +5308,7 @@ }, "CloudWatchLogGroupArn":{ "shape":"LogGroupArn", - "documentation":"

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

" + "documentation":"

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you must use /aws/datasync as your log group name. For example:

arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*

For more information, see Monitoring data transfers with CloudWatch Logs.

" }, "Includes":{ "shape":"FilterList", diff --git a/botocore/data/ec2/2016-11-15/paginators-1.json b/botocore/data/ec2/2016-11-15/paginators-1.json index 39121405e8..dd8661242a 100644 --- a/botocore/data/ec2/2016-11-15/paginators-1.json +++ b/botocore/data/ec2/2016-11-15/paginators-1.json @@ -865,6 +865,12 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "InstanceImageMetadata" + }, + "DescribeSecurityGroupVpcAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SecurityGroupVpcAssociations" } } } diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 671308adbd..8102c612bc 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -283,6 +283,16 @@ "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.

For more information, see Route tables in the Amazon VPC User Guide.

" }, + "AssociateSecurityGroupVpc":{ + "name":"AssociateSecurityGroupVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSecurityGroupVpcRequest"}, + "output":{"shape":"AssociateSecurityGroupVpcResult"}, + "documentation":"

Associates a security group with another VPC in the same Region. This enables you to use the same security group with network interfaces and instances in the specified VPC.

" + }, "AssociateSubnetCidrBlock":{ "name":"AssociateSubnetCidrBlock", "http":{ @@ -1166,7 +1176,7 @@ }, "input":{"shape":"CreateTrafficMirrorSessionRequest"}, "output":{"shape":"CreateTrafficMirrorSessionResult"}, - "documentation":"

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

" + "documentation":"

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

" }, "CreateTrafficMirrorTarget":{ "name":"CreateTrafficMirrorTarget", @@ -1825,7 +1835,7 @@ "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, - "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance or network interface or is referenced by another security group in the same VPC, the operation fails with DependencyViolation.

" + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance or network interface, is referenced by another security group in the same VPC, or has a VPC association, the operation fails with DependencyViolation.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", @@ -3245,7 +3255,7 @@ }, "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, "output":{"shape":"DescribeSecurityGroupReferencesResult"}, - "documentation":"

Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" + "documentation":"

Describes the VPCs on the other side of a VPC peering or Transit Gateway connection that are referencing the security groups you've specified in this request.

" }, "DescribeSecurityGroupRules":{ "name":"DescribeSecurityGroupRules", @@ -3257,6 +3267,16 @@ "output":{"shape":"DescribeSecurityGroupRulesResult"}, "documentation":"

Describes one or more of your security group rules.

" }, + "DescribeSecurityGroupVpcAssociations":{ + "name":"DescribeSecurityGroupVpcAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupVpcAssociationsRequest"}, + "output":{"shape":"DescribeSecurityGroupVpcAssociationsResult"}, + "documentation":"

Describes security group VPC associations made with AssociateSecurityGroupVpc.

" + }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ @@ -3365,7 +3385,7 @@ }, "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, "output":{"shape":"DescribeStaleSecurityGroupsResult"}, - "documentation":"

Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peered VPC. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.

" + "documentation":"

Describes the stale security group rules for security groups referenced across a VPC peering connection, transit gateway connection, or with a security group VPC association. Rules are stale when they reference a deleted security group. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted, across a transit gateway where the transit gateway has been deleted (or the transit gateway security group referencing feature has been disabled), or if a security group VPC association has been disassociated.

" }, "DescribeStoreImageTasks":{ "name":"DescribeStoreImageTasks", @@ -4081,6 +4101,16 @@ "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet or gateway from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the Amazon VPC User Guide.

" }, + "DisassociateSecurityGroupVpc":{ + "name":"DisassociateSecurityGroupVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSecurityGroupVpcRequest"}, + "output":{"shape":"DisassociateSecurityGroupVpcResult"}, + "documentation":"

Disassociates a security group from a VPC. You cannot disassociate the security group if any Elastic network interfaces in the associated VPC are still associated with the security group. Note that the disassociation is asynchronous and you can check the status of the request with DescribeSecurityGroupVpcAssociations.

" + }, "DisassociateSubnetCidrBlock":{ "name":"DisassociateSubnetCidrBlock", "http":{ @@ -8489,6 +8519,37 @@ } } }, + "AssociateSecurityGroupVpcRequest":{ + "type":"structure", + "required":[ + "GroupId", + "VpcId" + ], + "members":{ + "GroupId":{ + "shape":"SecurityGroupId", + "documentation":"

A security group ID.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

A VPC ID.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AssociateSecurityGroupVpcResult":{ + "type":"structure", + "members":{ + "State":{ + "shape":"SecurityGroupVpcAssociationState", + "documentation":"

The state of the association.

", + "locationName":"state" + } + } + }, "AssociateSubnetCidrBlockRequest":{ "type":"structure", "required":["SubnetId"], @@ -14457,7 +14518,7 @@ }, "InterfaceType":{ "shape":"NetworkInterfaceCreationType", - "documentation":"

The type of network interface. The default is interface.

The only supported values are interface, efa, and trunk.

" + "documentation":"

The type of network interface. The default is interface.

If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.

The only supported values are interface, efa, efa-only, and trunk.

" }, "TagSpecifications":{ "shape":"TagSpecificationList", @@ -14914,6 +14975,11 @@ "shape":"TagList", "documentation":"

The tags assigned to the security group.

", "locationName":"tagSet" + }, + "SecurityGroupArn":{ + "shape":"String", + "documentation":"

The security group ARN.

", + "locationName":"securityGroupArn" } } }, @@ -21708,7 +21774,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"

One or more filters. Filter names and values are case-sensitive.

", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

", "locationName":"Filter" }, "MaxResults":{ @@ -23164,7 +23230,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"

One or more filters.

", + "documentation":"

One or more filters.

", "locationName":"filter" } }, @@ -23854,6 +23920,48 @@ } } }, + "DescribeSecurityGroupVpcAssociationsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeSecurityGroupVpcAssociationsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Security group VPC association filters.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + }, + "MaxResults":{ + "shape":"DescribeSecurityGroupVpcAssociationsMaxResults", + "documentation":"

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeSecurityGroupVpcAssociationsResult":{ + "type":"structure", + "members":{ + "SecurityGroupVpcAssociations":{ + "shape":"SecurityGroupVpcAssociationList", + "documentation":"

The security group VPC associations.

", + "locationName":"securityGroupVpcAssociationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", + "locationName":"nextToken" + } + } + }, "DescribeSecurityGroupsMaxResults":{ "type":"integer", "max":1000, @@ -24382,7 +24490,7 @@ "members":{ "NextToken":{ "shape":"String", - "documentation":"

The token to include in another request to get the next page of items. If there are no additional items to return, the string is empty.

", + "documentation":"

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", "locationName":"nextToken" }, "StaleSecurityGroupSet":{ @@ -27292,6 +27400,38 @@ } } }, + "DisassociateSecurityGroupVpcRequest":{ + "type":"structure", + "required":[ + "GroupId", + "VpcId" + ], + "members":{ + "GroupId":{ + "shape":"DisassociateSecurityGroupVpcSecurityGroupId", + "documentation":"

A security group ID.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

A VPC ID.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DisassociateSecurityGroupVpcResult":{ + "type":"structure", + "members":{ + "State":{ + "shape":"SecurityGroupVpcAssociationState", + "documentation":"

The state of the disassociation.

", + "locationName":"state" + } + } + }, + "DisassociateSecurityGroupVpcSecurityGroupId":{"type":"string"}, "DisassociateSubnetCidrBlockRequest":{ "type":"structure", "required":["AssociationId"], @@ -36293,7 +36433,7 @@ }, "InterfaceType":{ "shape":"String", - "documentation":"

The type of network interface.

Valid values: interface | efa | trunk

", + "documentation":"

The type of network interface.

Valid values: interface | efa | efa-only | trunk

", "locationName":"interfaceType" }, "Ipv4Prefixes":{ @@ -36464,7 +36604,7 @@ }, "InterfaceType":{ "shape":"String", - "documentation":"

The type of network interface.

Valid values: interface | efa

" + "documentation":"

The type of network interface.

If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.

Valid values: interface | efa | efa-only

" }, "NetworkCardIndex":{ "shape":"Integer", @@ -38014,7 +38154,7 @@ }, "SupportedUsageClasses":{ "shape":"UsageClassTypeList", - "documentation":"

Indicates whether the instance type is offered for spot or On-Demand.

", + "documentation":"

Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.

", "locationName":"supportedUsageClasses" }, "SupportedRootDeviceTypes":{ @@ -41191,7 +41331,7 @@ }, "InterfaceType":{ "shape":"String", - "documentation":"

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon EC2 User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

" + "documentation":"

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa or efa. For more information, see Elastic Fabric Adapter in the Amazon EC2 User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.

Valid values: interface | efa | efa-only

" }, "Ipv6AddressCount":{ "shape":"Integer", @@ -52532,6 +52672,11 @@ "shape":"IpPermissionList", "documentation":"

The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.

", "locationName":"unknownIpPermissionSet" + }, + "RevokedSecurityGroupRules":{ + "shape":"RevokedSecurityGroupRuleList", + "documentation":"

Details about the revoked security group rules.

", + "locationName":"revokedSecurityGroupRuleSet" } } }, @@ -52598,7 +52743,80 @@ "shape":"IpPermissionList", "documentation":"

The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter.

", "locationName":"unknownIpPermissionSet" + }, + "RevokedSecurityGroupRules":{ + "shape":"RevokedSecurityGroupRuleList", + "documentation":"

Details about the revoked security group rules.

", + "locationName":"revokedSecurityGroupRuleSet" + } + } + }, + "RevokedSecurityGroupRule":{ + "type":"structure", + "members":{ + "SecurityGroupRuleId":{ + "shape":"SecurityGroupRuleId", + "documentation":"

A security group rule ID.

", + "locationName":"securityGroupRuleId" + }, + "GroupId":{ + "shape":"SecurityGroupId", + "documentation":"

A security group ID.

", + "locationName":"groupId" + }, + "IsEgress":{ + "shape":"Boolean", + "documentation":"

Defines if a security group rule is an outbound rule.

", + "locationName":"isEgress" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The security group rule's protocol.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The 'from' port number of the security group rule.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The 'to' port number of the security group rule.

", + "locationName":"toPort" + }, + "CidrIpv4":{ + "shape":"String", + "documentation":"

The IPv4 CIDR of the traffic source.

", + "locationName":"cidrIpv4" + }, + "CidrIpv6":{ + "shape":"String", + "documentation":"

The IPv6 CIDR of the traffic source.

", + "locationName":"cidrIpv6" + }, + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of a prefix list that's the traffic source.

", + "locationName":"prefixListId" + }, + "ReferencedGroupId":{ + "shape":"SecurityGroupId", + "documentation":"

The ID of a referenced security group.

", + "locationName":"referencedGroupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the revoked security group rule.

", + "locationName":"description" } + }, + "documentation":"

A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress.

" + }, + "RevokedSecurityGroupRuleList":{ + "type":"list", + "member":{ + "shape":"RevokedSecurityGroupRule", + "locationName":"item" } }, "RoleId":{"type":"string"}, @@ -53888,6 +54106,11 @@ "documentation":"

The ID of the VPC for the security group.

", "locationName":"vpcId" }, + "SecurityGroupArn":{ + "shape":"String", + "documentation":"

The ARN of the security group.

", + "locationName":"securityGroupArn" + }, "OwnerId":{ "shape":"String", "documentation":"

The Amazon Web Services account ID of the owner of the security group.

", @@ -54116,6 +54339,11 @@ "shape":"TagList", "documentation":"

The tags applied to the security group rule.

", "locationName":"tagSet" + }, + "SecurityGroupRuleArn":{ + "shape":"String", + "documentation":"

The ARN of the security group rule.

", + "locationName":"securityGroupRuleArn" } }, "documentation":"

Describes a security group rule.

" @@ -54223,6 +54451,55 @@ "locationName":"SecurityGroup" } }, + "SecurityGroupVpcAssociation":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"SecurityGroupId", + "documentation":"

The association's security group ID.

", + "locationName":"groupId" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The association's VPC ID.

", + "locationName":"vpcId" + }, + "VpcOwnerId":{ + "shape":"String", + "documentation":"

The Amazon Web Services account ID of the owner of the VPC.

", + "locationName":"vpcOwnerId" + }, + "State":{ + "shape":"SecurityGroupVpcAssociationState", + "documentation":"

The association's state.

", + "locationName":"state" + }, + "StateReason":{ + "shape":"String", + "documentation":"

The association's state reason.

", + "locationName":"stateReason" + } + }, + "documentation":"

A security group association with a VPC that you made with AssociateSecurityGroupVpc.

" + }, + "SecurityGroupVpcAssociationList":{ + "type":"list", + "member":{ + "shape":"SecurityGroupVpcAssociation", + "locationName":"item" + } + }, + "SecurityGroupVpcAssociationState":{ + "type":"string", + "enum":[ + "associating", + "associated", + "association-failed", + "disassociating", + "disassociated", + "disassociation-failed" + ] + }, "SelfServicePortal":{ "type":"string", "enum":[ diff --git a/botocore/data/ecs/2014-11-13/service-2.json b/botocore/data/ecs/2014-11-13/service-2.json index bd62f69592..5653b3ee8c 100644 --- a/botocore/data/ecs/2014-11-13/service-2.json +++ b/botocore/data/ecs/2014-11-13/service-2.json @@ -46,7 +46,7 @@ {"shape":"InvalidParameterException"}, {"shape":"NamespaceNotFoundException"} ], - "documentation":"

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" + "documentation":"

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" }, "CreateService":{ "name":"CreateService", @@ -67,7 +67,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NamespaceNotFoundException"} ], - "documentation":"

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Amazon Elastic Inference (EI) is no longer available to customers.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide

" + "documentation":"

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Amazon Elastic Inference (EI) is no longer available to customers.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide

" }, "CreateTaskSet":{ "name":"CreateTaskSet", @@ -288,6 +288,44 @@ ], "documentation":"

Describes one or more container instances. Returns metadata about each container instance requested.

" }, + "DescribeServiceDeployments":{ + "name":"DescribeServiceDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceDeploymentsRequest"}, + "output":{"shape":"DescribeServiceDeploymentsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ClientException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"UnsupportedFeatureException"} + ], + "documentation":"

Describes one or more of your service deployments.

A service deployment happens when you release a software update for the service. For more information, see Amazon ECS service deployments.

" + }, + "DescribeServiceRevisions":{ + "name":"DescribeServiceRevisions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceRevisionsRequest"}, + "output":{"shape":"DescribeServiceRevisionsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ClientException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"UnsupportedFeatureException"} + ], + "documentation":"

Describes one or more service revisions.

A service revision is a version of the service that includes the values for the Amazon ECS resources (for example, task definition) and the environment resources (for example, load balancers, subnets, and security groups). For more information, see Amazon ECS service revisions.

You can't describe a service revision that was created before October 25, 2024.

" + }, "DescribeServices":{ "name":"DescribeServices", "http":{ @@ -466,6 +504,24 @@ ], "documentation":"

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" }, + "ListServiceDeployments":{ + "name":"ListServiceDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServiceDeploymentsRequest"}, + "output":{"shape":"ListServiceDeploymentsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"UnsupportedFeatureException"} + ], + "documentation":"

This operation lists all the service deployments that meet the specified filter criteria.

A service deployment happens when you release a softwre update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks.

This API returns the values that you use for the request parameters in DescribeServiceRevisions.

" + }, "ListServices":{ "name":"ListServices", "http":{ @@ -1752,6 +1808,28 @@ }, "documentation":"

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks that use the Fargate launch type, the task or service requires the following platforms:

For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.

" }, + "ContainerImage":{ + "type":"structure", + "members":{ + "containerName":{ + "shape":"String", + "documentation":"

The name of the container.

" + }, + "imageDigest":{ + "shape":"String", + "documentation":"

The container image digest.

" + }, + "image":{ + "shape":"String", + "documentation":"

The container image.

" + } + }, + "documentation":"

The details about the container image a service revision uses.

To ensure that all tasks in a service use the same container image, Amazon ECS resolves container image names and any image tags specified in the task definition to container image digests.

After the container image digest has been established, Amazon ECS uses the digest to start any other desired tasks, and for any future service and service revision updates. This leads to all tasks in a service always running identical container images, resulting in version consistency for your software. For more information, see Container image resolution in the Amazon ECS Developer Guide.

" + }, + "ContainerImages":{ + "type":"list", + "member":{"shape":"ContainerImage"} + }, "ContainerInstance":{ "type":"structure", "members":{ @@ -2094,7 +2172,7 @@ }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", - "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" + "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.

" }, "placementConstraints":{ "shape":"PlacementConstraints", @@ -2226,6 +2304,20 @@ } } }, + "CreatedAt":{ + "type":"structure", + "members":{ + "before":{ + "shape":"Timestamp", + "documentation":"

Include service deployments in the result that were created before this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "after":{ + "shape":"Timestamp", + "documentation":"

Include service deployments in the result that were created after this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + } + }, + "documentation":"

The optional filter to narrow the ListServiceDeployment results.

If you do not specify a value, service deployments that were created before the current time are included in the result.

" + }, "DeleteAccountSettingRequest":{ "type":"structure", "required":["name"], @@ -2485,21 +2577,21 @@ "type":"structure", "required":[ "alarmNames", - "enable", - "rollback" + "rollback", + "enable" ], "members":{ "alarmNames":{ "shape":"StringList", "documentation":"

One or more CloudWatch alarm names. Use a \",\" to separate the alarms.

" }, - "enable":{ - "shape":"Boolean", - "documentation":"

Determines whether to use the CloudWatch alarm option in the service deployment process.

" - }, "rollback":{ "shape":"Boolean", "documentation":"

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

" + }, + "enable":{ + "shape":"Boolean", + "documentation":"

Determines whether to use the CloudWatch alarm option in the service deployment process.

" } }, "documentation":"

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

" @@ -2542,7 +2634,7 @@ "documentation":"

Information about the CloudWatch alarms.

" } }, - "documentation":"

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

" + "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.

" }, "DeploymentController":{ "type":"structure", @@ -2568,7 +2660,7 @@ "members":{ "kmsKeyId":{ "shape":"String", - "documentation":"

Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

" + "documentation":"

Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for deployment.

" } }, "documentation":"

The amount of ephemeral storage to allocate for the deployment.

" @@ -2726,6 +2818,52 @@ } } }, + "DescribeServiceDeploymentsRequest":{ + "type":"structure", + "required":["serviceDeploymentArns"], + "members":{ + "serviceDeploymentArns":{ + "shape":"StringList", + "documentation":"

The ARN of the service deployment.

You can specify a maximum of 20 ARNs.

" + } + } + }, + "DescribeServiceDeploymentsResponse":{ + "type":"structure", + "members":{ + "serviceDeployments":{ + "shape":"ServiceDeployments", + "documentation":"

The list of service deployments described.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

If you decsribe a deployment with a service revision created before October 25, 2024, the call fails. The failure includes the service revision ARN and the reason set to MISSING.

" + } + } + }, + "DescribeServiceRevisionsRequest":{ + "type":"structure", + "required":["serviceRevisionArns"], + "members":{ + "serviceRevisionArns":{ + "shape":"StringList", + "documentation":"

The ARN of the service revision.

You can specify a maximum of 20 ARNs.

You can call ListServiceDeployments to get the ARNs.

" + } + } + }, + "DescribeServiceRevisionsResponse":{ + "type":"structure", + "members":{ + "serviceRevisions":{ + "shape":"ServiceRevisions", + "documentation":"

The list of service revisions described.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, "DescribeServicesRequest":{ "type":"structure", "required":["services"], @@ -3715,6 +3853,49 @@ } } }, + "ListServiceDeploymentsRequest":{ + "type":"structure", + "required":["service"], + "members":{ + "service":{ + "shape":"String", + "documentation":"

The ARN or name of the service

" + }, + "cluster":{ + "shape":"String", + "documentation":"

The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performanceIf you don't specify a cluster, deault is used.

" + }, + "status":{ + "shape":"ServiceDeploymentStatusList", + "documentation":"

An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a ListServiceDeployments request indicating that more results are available to fulfill the request and further calls are needed. If you provided maxResults, it's possible the number of results is fewer than maxResults.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of service deployment results that ListServiceDeployments returned in paginated output. When this parameter is used, ListServiceDeployments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceDeployments returns up to 20 results and a nextToken value if applicable.

" + } + } + }, + "ListServiceDeploymentsResponse":{ + "type":"structure", + "members":{ + "serviceDeployments":{ + "shape":"ServiceDeploymentsBrief", + "documentation":"

An overview of the service deployment, including the following properties:

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListServiceDeployments request. When the results of a ListServiceDeployments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, "ListServicesByNamespaceRequest":{ "type":"structure", "required":["namespace"], @@ -3938,7 +4119,7 @@ }, "loadBalancerName":{ "shape":"String", - "documentation":"

The name of the load balancer to associate with the Amazon ECS service or task set.

If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

" + "documentation":"

The name of the load balancer to associate with the service or task set.

If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

" }, "containerName":{ "shape":"String", @@ -4074,7 +4255,7 @@ }, "minimumScalingStepSize":{ "shape":"ManagedScalingStepSize", - "documentation":"

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in process is not affected by this parameter If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

" + "documentation":"

The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default value of 1 is used.

When additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size.

If you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand.

" }, "maximumScalingStepSize":{ "shape":"ManagedScalingStepSize", @@ -4114,7 +4295,7 @@ "members":{ "kmsKeyId":{ "shape":"String", - "documentation":"

Specify a Key Management Service key ID to encrypt the managed storage.

" + "documentation":"

Specify a Amazon Web Services Key Management Service key ID to encrypt the managed storage.

" }, "fargateEphemeralStorageKmsKeyId":{ "shape":"String", @@ -4364,7 +4545,7 @@ "members":{ "containerPort":{ "shape":"BoxedInteger", - "documentation":"

The port number on the container that's bound to the user-specified or automatically assigned host port.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort.

If you use containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

" + "documentation":"

The port number on the container that's bound to the user-specified or automatically assigned host port.

For tasks that use the Fargate launch type or EC2 tasks that use the awsvpc network mode, you use containerPort to specify the exposed ports.

For Windows containers on Fargate, you can't use port 3150 for the containerPort. This is because it's reserved.

Suppose that you're using containers in a task with the EC2 launch type and you specify a container port and not a host port. Then, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way don't count toward the 100 reserved ports quota of a container instance.

" }, "hostPort":{ "shape":"BoxedInteger", @@ -4387,7 +4568,7 @@ "documentation":"

The port number range on the container that's bound to the dynamically mapped host port range.

The following rules apply when you specify a containerPortRange:

You can call DescribeTasks to view the hostPortRange which are the host ports that are bound to the container ports.

" } }, - "documentation":"

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you use containers in a task with the awsvpc or host network mode, specify the exposed ports using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the docker container create command and the --publish option to docker run. If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.

You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

" + "documentation":"

Port mappings expose your container's network ports to the outside world. this allows clients to access your application. It's also used for inter-container communication within the same task.

For task definitions (both the Fargate and EC2 launch type) that use the awsvpc network mode, only specify the containerPort. The hostPort is always ignored, and the container port is automatically mapped to a random high-numbered port on the host.

Most fields of this parameter (containerPort, hostPort, protocol) maps to PortBindings in the docker container create command and the --publish option to docker run. If the network mode of a task definition is set to host, host ports must either be undefined or match the container port in the port mapping.

You can't expose the same container port for multiple protocols. If you attempt this, an error is returned.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

" }, "PortMappingList":{ "type":"list", @@ -4637,7 +4818,7 @@ }, "networkMode":{ "shape":"NetworkMode", - "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

" + "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

" }, "containerDefinitions":{ "shape":"ContainerDefinitions", @@ -4669,11 +4850,11 @@ }, "pidMode":{ "shape":"PidMode", - "documentation":"

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container.

If the host PID mode is used, there's a heightened risk of undesired process namespace exposure.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

" + "documentation":"

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

" }, "ipcMode":{ "shape":"IpcMode", - "documentation":"

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks run on Fargate.

" + "documentation":"

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks run on Fargate.

" }, "proxyConfiguration":{ "shape":"ProxyConfiguration", @@ -4802,6 +4983,24 @@ "type":"list", "member":{"shape":"Resource"} }, + "Rollback":{ + "type":"structure", + "members":{ + "reason":{ + "shape":"String", + "documentation":"

The reason the rollback happened. For example, the circuit breaker initiated the rollback operation.

" + }, + "startedAt":{ + "shape":"Timestamp", + "documentation":"

Time time that the rollback started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "serviceRevisionArn":{ + "shape":"String", + "documentation":"

The ARN of the service revision deployed as part of the rollback.

When the type is GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

When the type is InferenceAccelerator, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

" + } + }, + "documentation":"

Information about the service deployment rollback.

" + }, "RunTaskRequest":{ "type":"structure", "required":["taskDefinition"], @@ -4903,11 +5102,11 @@ "members":{ "cpuArchitecture":{ "shape":"CPUArchitecture", - "documentation":"

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

" + "documentation":"

The CPU architecture.

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.

The default is X86_64.

" }, "operatingSystemFamily":{ "shape":"OSFamily", - "documentation":"

The operating system.

" + "documentation":"

The operating system.

The default is Linux.

" } }, "documentation":"

Information about the platform for the Amazon ECS service or task.

For more information about RuntimePlatform, see RuntimePlatform in the Amazon Elastic Container Service Developer Guide.

" @@ -5027,7 +5226,7 @@ }, "capacityProviderStrategy":{ "shape":"CapacityProviderStrategy", - "documentation":"

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

" + "documentation":"

The capacity provider strategy the service uses. When using DescribeServices, this field is omitted if the service was created using a launch type.

" }, "platformVersion":{ "shape":"String", @@ -5091,7 +5290,7 @@ }, "tags":{ "shape":"Tags", - "documentation":"

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

" + "documentation":"

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define both the key and value.

The following basic restrictions apply to tags:

" }, "createdBy":{ "shape":"String", @@ -5233,6 +5432,185 @@ }, "documentation":"

The key that encrypts and decrypts your resources for Service Connect TLS.

" }, + "ServiceDeployment":{ + "type":"structure", + "members":{ + "serviceDeploymentArn":{ + "shape":"String", + "documentation":"

The ARN of the service deployment.

" + }, + "serviceArn":{ + "shape":"String", + "documentation":"

The ARN of the service for this service deployment.

" + }, + "clusterArn":{ + "shape":"String", + "documentation":"

The ARN of the cluster that hosts the service.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "startedAt":{ + "shape":"Timestamp", + "documentation":"

The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "finishedAt":{ + "shape":"Timestamp", + "documentation":"

The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "stoppedAt":{ + "shape":"Timestamp", + "documentation":"

The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

The service deployment stops when any of the following actions happen:

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The time that the service deployment was last updated. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "sourceServiceRevisions":{ + "shape":"ServiceRevisionsSummaryList", + "documentation":"

The currently deployed workload configuration.

" + }, + "targetServiceRevision":{ + "shape":"ServiceRevisionSummary", + "documentation":"

The workload configuration being deployed.

" + }, + "status":{ + "shape":"ServiceDeploymentStatus", + "documentation":"

The service deployment state.

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.

" + }, + "deploymentConfiguration":{"shape":"DeploymentConfiguration"}, + "rollback":{ + "shape":"Rollback", + "documentation":"

The rollback options the service deployment uses when the deployment fails.

" + }, + "deploymentCircuitBreaker":{ + "shape":"ServiceDeploymentCircuitBreaker", + "documentation":"

The circuit breaker configuration that determines a service deployment failed.

" + }, + "alarms":{ + "shape":"ServiceDeploymentAlarms", + "documentation":"

The CloudWatch alarms that determine when a service deployment fails.

" + } + }, + "documentation":"

Information about the service deployment.

Service deployments provide a comprehensive view of your deployments. For information about service deployments, see View service history using Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide .

" + }, + "ServiceDeploymentAlarms":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ServiceDeploymentRollbackMonitorsStatus", + "documentation":"

The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.

" + }, + "alarmNames":{ + "shape":"StringList", + "documentation":"

The name of the CloudWatch alarms that determine when a service deployment failed. A \",\" separates the alarms.

" + }, + "triggeredAlarmNames":{ + "shape":"StringList", + "documentation":"

One or more CloudWatch alarm names that have been triggered during the service deployment. A \",\" separates the alarm names.

" + } + }, + "documentation":"

The CloudWatch alarms used to determine a service deployment failed.

Amazon ECS considers the service deployment as failed when any of the alarms move to the ALARM state. For more information, see How CloudWatch alarms detect Amazon ECS deployment failures in the Amazon ECS Developer Guide.

" + }, + "ServiceDeploymentBrief":{ + "type":"structure", + "members":{ + "serviceDeploymentArn":{ + "shape":"String", + "documentation":"

The ARN of the service deployment.

" + }, + "serviceArn":{ + "shape":"String", + "documentation":"

The ARN of the service for this service deployment.

" + }, + "clusterArn":{ + "shape":"String", + "documentation":"

The ARN of the cluster that hosts the service.

" + }, + "startedAt":{ + "shape":"Timestamp", + "documentation":"

The time that the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time that the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "finishedAt":{ + "shape":"Timestamp", + "documentation":"

The time that the service deployment completed. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

" + }, + "targetServiceRevisionArn":{ + "shape":"String", + "documentation":"

The ARN of the service revision being deplyed.

" + }, + "status":{ + "shape":"ServiceDeploymentStatus", + "documentation":"

The status of the service deployment

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

Information about why the service deployment is in the current status. For example, the circuit breaker detected a deployment failure.

" + } + }, + "documentation":"

The service deployment properties that are retured when you call ListServiceDeployments.

This provides a high-level overview of the service deployment.

" + }, + "ServiceDeploymentCircuitBreaker":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ServiceDeploymentRollbackMonitorsStatus", + "documentation":"

The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.

" + }, + "failureCount":{ + "shape":"Integer", + "documentation":"

The number of times the circuit breaker detected a service deploymeny failure.

" + }, + "threshold":{ + "shape":"Integer", + "documentation":"

The threshhold which determines that the service deployment failed.

The deployment circuit breaker calculates the threshold value, and then uses the value to determine when to move the deployment to a FAILED state. The deployment circuit breaker has a minimum threshold of 3 and a maximum threshold of 200. and uses the values in the following formula to determine the deployment failure.

0.5 * desired task count

" + } + }, + "documentation":"

Information about the circuit breaker used to determine when a service deployment has failed.

The deployment circuit breaker is the rolling update mechanism that determines if the tasks reach a steady state. The deployment circuit breaker has an option that will automatically roll back a failed deployment to the last cpompleted service revision. For more information, see How the Amazon ECS deployment circuit breaker detects failures in the Amazon ECS Developer Guide.

" + }, + "ServiceDeploymentRollbackMonitorsStatus":{ + "type":"string", + "enum":[ + "TRIGGERED", + "MONITORING", + "MONITORING_COMPLETE", + "DISABLED" + ] + }, + "ServiceDeploymentStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCESSFUL", + "STOPPED", + "STOP_REQUESTED", + "IN_PROGRESS", + "ROLLBACK_IN_PROGRESS", + "ROLLBACK_SUCCESSFUL", + "ROLLBACK_FAILED" + ] + }, + "ServiceDeploymentStatusList":{ + "type":"list", + "member":{"shape":"ServiceDeploymentStatus"} + }, + "ServiceDeployments":{ + "type":"list", + "member":{"shape":"ServiceDeployment"} + }, + "ServiceDeploymentsBrief":{ + "type":"list", + "member":{"shape":"ServiceDeploymentBrief"} + }, "ServiceEvent":{ "type":"structure", "members":{ @@ -5350,6 +5728,101 @@ }, "documentation":"

The details for the service registry.

Each service may be associated with one service registry. Multiple service registries for each service are not supported.

When you add, update, or remove the service registries configuration, Amazon ECS starts a new deployment. New tasks are registered and deregistered to the updated service registry configuration.

" }, + "ServiceRevision":{ + "type":"structure", + "members":{ + "serviceRevisionArn":{ + "shape":"String", + "documentation":"

The ARN of the service revision.

" + }, + "serviceArn":{ + "shape":"String", + "documentation":"

The ARN of the service for the service revision.

" + }, + "clusterArn":{ + "shape":"String", + "documentation":"

The ARN of the cluster that hosts the service.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The task definition the service revision uses.

" + }, + "capacityProviderStrategy":{ + "shape":"CapacityProviderStrategy", + "documentation":"

The capacity provider strategy the service revision uses.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type the service revision uses.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

For the Fargate launch type, the platform version the service revision uses.

" + }, + "platformFamily":{ + "shape":"String", + "documentation":"

The platform family the service revision uses.

" + }, + "loadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

The load balancers the service revision uses.

" + }, + "serviceRegistries":{ + "shape":"ServiceRegistries", + "documentation":"

The service registries (for Service Discovery) the service revision uses.

" + }, + "networkConfiguration":{"shape":"NetworkConfiguration"}, + "containerImages":{ + "shape":"ContainerImages", + "documentation":"

The container images the service revision uses.

" + }, + "guardDutyEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether Runtime Monitoring is turned on.

" + }, + "serviceConnectConfiguration":{"shape":"ServiceConnectConfiguration"}, + "volumeConfigurations":{ + "shape":"ServiceVolumeConfigurations", + "documentation":"

The volumes that are configured at deployment that the service revision uses.

" + }, + "fargateEphemeralStorage":{"shape":"DeploymentEphemeralStorage"}, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time that the service revision was created. The format is yyyy-mm-dd HH:mm:ss.SSSSS.

" + } + }, + "documentation":"

Information about the service revision.

A service revision contains a record of the workload configuration Amazon ECS is attempting to deploy. Whenever you create or deploy a service, Amazon ECS automatically creates and captures the configuration that you're trying to deploy in the service revision. For information about service revisions, see Amazon ECS service revisions in the Amazon Elastic Container Service Developer Guide .

" + }, + "ServiceRevisionSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"

The ARN of the service revision.

" + }, + "requestedTaskCount":{ + "shape":"Integer", + "documentation":"

The number of requested tasks for the service revision.

" + }, + "runningTaskCount":{ + "shape":"Integer", + "documentation":"

The number of running tasks for the service revision.

" + }, + "pendingTaskCount":{ + "shape":"Integer", + "documentation":"

The number of pending tasks for the service revision.

" + } + }, + "documentation":"

The information about the number of requested, pending, and running tasks for a service revision.

" + }, + "ServiceRevisions":{ + "type":"list", + "member":{"shape":"ServiceRevision"} + }, + "ServiceRevisionsSummaryList":{ + "type":"list", + "member":{"shape":"ServiceRevisionSummary"} + }, "ServiceVolumeConfiguration":{ "type":"structure", "required":["name"], @@ -5963,7 +6436,7 @@ }, "networkMode":{ "shape":"NetworkMode", - "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

" + "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference.

" }, "revision":{ "shape":"Integer", @@ -6011,11 +6484,11 @@ }, "pidMode":{ "shape":"PidMode", - "documentation":"

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container.

If the host PID mode is used, there's a heightened risk of undesired process namespace exposure.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

" + "documentation":"

The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see Docker security.

This parameter is not supported for Windows containers.

This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

" }, "ipcMode":{ "shape":"IpcMode", - "documentation":"

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks run on Fargate.

" + "documentation":"

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers or tasks run on Fargate.

" }, "proxyConfiguration":{ "shape":"ProxyConfiguration", @@ -6099,7 +6572,7 @@ }, "kmsKeyId":{ "shape":"String", - "documentation":"

Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.

" + "documentation":"

Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for the task.

" } }, "documentation":"

The amount of ephemeral storage to allocate for the task.

" @@ -6704,7 +7177,7 @@ }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", - "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" + "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the failure detection methods.

" }, "networkConfiguration":{ "shape":"NetworkConfiguration", diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 402bb50da5..43bbe1e77d 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -27551,6 +27551,12 @@ } } }, + "memory-db" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "metering.marketplace" : { "defaults" : { "credentialScope" : { diff --git a/botocore/data/geo-maps/2020-11-19/endpoint-rule-set-1.json b/botocore/data/geo-maps/2020-11-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000..f5ada18835 --- /dev/null +++ b/botocore/data/geo-maps/2020-11-19/endpoint-rule-set-1.json @@ -0,0 +1,688 @@ +{ + "version": "1.0", + "parameters": { + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://maps.geo.{Region}.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://maps.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://maps.geo-fips.{Region}.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://maps.geo.{Region}.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://maps.geo.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://maps.geo-fips.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://maps.geo-fips.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://maps.geo.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-maps-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-maps-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-maps.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://geo-maps.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/botocore/data/geo-maps/2020-11-19/paginators-1.json b/botocore/data/geo-maps/2020-11-19/paginators-1.json new file mode 100644 index 0000000000..ea142457a6 --- /dev/null +++ b/botocore/data/geo-maps/2020-11-19/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/botocore/data/geo-maps/2020-11-19/service-2.json b/botocore/data/geo-maps/2020-11-19/service-2.json new file mode 100644 index 0000000000..40b986cee4 --- /dev/null +++ b/botocore/data/geo-maps/2020-11-19/service-2.json @@ -0,0 +1,706 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-11-19", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"geo-maps", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Location Service Maps V2", + "serviceId":"Geo Maps", + "signatureVersion":"v4", + "signingName":"geo-maps", + "uid":"geo-maps-2020-11-19" + }, + "operations":{ + "GetGlyphs":{ + "name":"GetGlyphs", + "http":{ + "method":"GET", + "requestUri":"/glyphs/{FontStack}/{FontUnicodeRange}", + "responseCode":200 + }, + "input":{"shape":"GetGlyphsRequest"}, + "output":{"shape":"GetGlyphsResponse"}, + "documentation":"

Returns the map's glyphs.

" + }, + "GetSprites":{ + "name":"GetSprites", + "http":{ + "method":"GET", + "requestUri":"/styles/{Style}/{ColorScheme}/{Variant}/sprites/{FileName}", + "responseCode":200 + }, + "input":{"shape":"GetSpritesRequest"}, + "output":{"shape":"GetSpritesResponse"}, + "documentation":"

Returns the map's sprites.

" + }, + "GetStaticMap":{ + "name":"GetStaticMap", + "http":{ + "method":"GET", + "requestUri":"/static/{FileName}", + "responseCode":200 + }, + "input":{"shape":"GetStaticMapRequest"}, + "output":{"shape":"GetStaticMapResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

" + }, + "GetStyleDescriptor":{ + "name":"GetStyleDescriptor", + "http":{ + "method":"GET", + "requestUri":"/styles/{Style}/descriptor", + "responseCode":200 + }, + "input":{"shape":"GetStyleDescriptorRequest"}, + "output":{"shape":"GetStyleDescriptorResponse"}, + "documentation":"

Returns information about the style.

" + }, + "GetTile":{ + "name":"GetTile", + "http":{ + "method":"GET", + "requestUri":"/tiles/{Tileset}/{Z}/{X}/{Y}", + "responseCode":200 + }, + "input":{"shape":"GetTileRequest"}, + "output":{"shape":"GetTileResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Returns a tile. Map tiles are used by clients to render a map. they're addressed using a grid arrangement with an X coordinate, Y coordinate, and Z (zoom) level.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ApiKey":{ + "type":"string", + "max":1000, + "min":0, + "sensitive":true + }, + "Blob":{"type":"blob"}, + "ColorScheme":{ + "type":"string", + "enum":[ + "Light", + "Dark" + ] + }, + "CompactOverlay":{ + "type":"string", + "max":7000, + "min":1 + }, + "CountryCode":{ + "type":"string", + "max":3, + "min":2, + "pattern":"([A-Z]{2}|[A-Z]{3})" + }, + "DistanceMeters":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "GeoJsonOverlay":{ + "type":"string", + "max":7000, + "min":1 + }, + "GetGlyphsRequest":{ + "type":"structure", + "required":[ + "FontStack", + "FontUnicodeRange" + ], + "members":{ + "FontStack":{ + "shape":"GetGlyphsRequestFontStackString", + "documentation":"

Name of the FontStack to retrieve.

Example: Amazon Ember Bold,Noto Sans Bold.

The supported font stacks are as follows:

", + "location":"uri", + "locationName":"FontStack" + }, + "FontUnicodeRange":{ + "shape":"GetGlyphsRequestFontUnicodeRangeString", + "documentation":"

A Unicode range of characters to download glyphs for. This must be aligned to multiples of 256.

Example: 0-255.pdf

", + "location":"uri", + "locationName":"FontUnicodeRange" + } + } + }, + "GetGlyphsRequestFontStackString":{ + "type":"string", + "max":1000, + "min":0 + }, + "GetGlyphsRequestFontUnicodeRangeString":{ + "type":"string", + "pattern":"[0-9]+-[0-9]+\\.pbf" + }, + "GetGlyphsResponse":{ + "type":"structure", + "members":{ + "Blob":{ + "shape":"Blob", + "documentation":"

The Glyph, as a binary blob.

" + }, + "ContentType":{ + "shape":"String", + "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", + "location":"header", + "locationName":"Content-Type" + }, + "CacheControl":{ + "shape":"String", + "documentation":"

Header that instructs caching configuration for the client.

", + "location":"header", + "locationName":"Cache-Control" + }, + "ETag":{ + "shape":"String", + "documentation":"

The glyph's Etag.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"Blob" + }, + "GetSpritesRequest":{ + "type":"structure", + "required":[ + "FileName", + "Style", + "ColorScheme", + "Variant" + ], + "members":{ + "FileName":{ + "shape":"GetSpritesRequestFileNameString", + "documentation":"

Sprites API: The name of the sprite file to retrieve, following pattern sprites(@2x)?\\.(png|json).

Example: sprites.png

", + "location":"uri", + "locationName":"FileName" + }, + "Style":{ + "shape":"MapStyle", + "documentation":"

Style specifies the desired map style for the Sprites APIs.

", + "location":"uri", + "locationName":"Style" + }, + "ColorScheme":{ + "shape":"ColorScheme", + "documentation":"

Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", + "location":"uri", + "locationName":"ColorScheme" + }, + "Variant":{ + "shape":"Variant", + "documentation":"

Optimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.

Example: Default

Valid values for Variant are case sensitive.

", + "location":"uri", + "locationName":"Variant" + } + } + }, + "GetSpritesRequestFileNameString":{ + "type":"string", + "pattern":"sprites(@2x)?\\.(png|json)" + }, + "GetSpritesResponse":{ + "type":"structure", + "members":{ + "Blob":{ + "shape":"Blob", + "documentation":"

The body of the sprite sheet or JSON offset file (image/png or application/json, depending on input).

" + }, + "ContentType":{ + "shape":"String", + "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", + "location":"header", + "locationName":"Content-Type" + }, + "CacheControl":{ + "shape":"String", + "documentation":"

Header that instructs caching configuration for the client.

", + "location":"header", + "locationName":"Cache-Control" + }, + "ETag":{ + "shape":"String", + "documentation":"

The sprite's Etag.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"Blob" + }, + "GetStaticMapRequest":{ + "type":"structure", + "required":[ + "Height", + "FileName", + "Width" + ], + "members":{ + "BoundingBox":{ + "shape":"PositionListString", + "documentation":"

Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

Example: -123.17075,49.26959,-123.08125,49.31429

", + "location":"querystring", + "locationName":"bounding-box" + }, + "BoundedPositions":{ + "shape":"PositionListString", + "documentation":"

Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

Cannot be used with Zoom and or Radius

Example: 97.170451,78.039098,99.045536,27.176178

", + "location":"querystring", + "locationName":"bounded-positions" + }, + "Center":{ + "shape":"PositionString", + "documentation":"

Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

Cannot be used with Zoom and or Radius

Example: 49.295,-123.108

", + "location":"querystring", + "locationName":"center" + }, + "CompactOverlay":{ + "shape":"CompactOverlay", + "documentation":"

Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

", + "location":"querystring", + "locationName":"compact-overlay" + }, + "GeoJsonOverlay":{ + "shape":"GeoJsonOverlay", + "documentation":"

Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

Example: {\"type\":\"FeatureCollection\",\"features\": [{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPoint\",\"coordinates\": [[-90.076345,51.504107],[-0.074451,51.506892]]},\"properties\": {\"color\":\"#00DD00\"}}]}

", + "location":"querystring", + "locationName":"geojson-overlay" + }, + "Height":{ + "shape":"GetStaticMapRequestHeightInteger", + "documentation":"

Specifies the height of the map image.

", + "location":"querystring", + "locationName":"height" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + }, + "Padding":{ + "shape":"Integer", + "documentation":"

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

Value for max and min is determined by:

Min: 1

Max: min(height, width)/4

Example: 100

", + "location":"querystring", + "locationName":"padding" + }, + "Radius":{ + "shape":"DistanceMeters", + "documentation":"

Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

Example: 1500

Cannot be used with Zoom.

Unit: Meters

", + "box":true, + "location":"querystring", + "locationName":"radius" + }, + "FileName":{ + "shape":"GetStaticMapRequestFileNameString", + "documentation":"

The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

Example: map, map@2x

", + "location":"uri", + "locationName":"FileName" + }, + "ScaleBarUnit":{ + "shape":"ScaleBarUnit", + "documentation":"

Displays a scale on the bottom right of the map image with the unit specified in the input.

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

", + "location":"querystring", + "locationName":"scale-unit" + }, + "Style":{ + "shape":"StaticMapStyle", + "documentation":"

Style specifies the desired map style for the Style APIs.

", + "location":"querystring", + "locationName":"style" + }, + "Width":{ + "shape":"GetStaticMapRequestWidthInteger", + "documentation":"

Specifies the width of the map image.

", + "location":"querystring", + "locationName":"width" + }, + "Zoom":{ + "shape":"GetStaticMapRequestZoomFloat", + "documentation":"

Specifies the zoom level of the map image.

Cannot be used with Radius.

", + "location":"querystring", + "locationName":"zoom" + } + } + }, + "GetStaticMapRequestFileNameString":{ + "type":"string", + "pattern":"map(@2x)?" + }, + "GetStaticMapRequestHeightInteger":{ + "type":"integer", + "box":true, + "max":1400, + "min":64 + }, + "GetStaticMapRequestWidthInteger":{ + "type":"integer", + "box":true, + "max":1400, + "min":64 + }, + "GetStaticMapRequestZoomFloat":{ + "type":"float", + "box":true, + "max":20, + "min":0 + }, + "GetStaticMapResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "Blob":{ + "shape":"Blob", + "documentation":"

The blob represents a map image as a jpeg for the GetStaticMap API.

" + }, + "ContentType":{ + "shape":"String", + "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", + "location":"header", + "locationName":"Content-Type" + }, + "CacheControl":{ + "shape":"String", + "documentation":"

Header that instructs caching configuration for the client.

", + "location":"header", + "locationName":"Cache-Control" + }, + "ETag":{ + "shape":"String", + "documentation":"

The static map's Etag.

", + "location":"header", + "locationName":"ETag" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the request is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + } + }, + "payload":"Blob" + }, + "GetStyleDescriptorRequest":{ + "type":"structure", + "required":["Style"], + "members":{ + "Style":{ + "shape":"MapStyle", + "documentation":"

Style specifies the desired map style.

", + "location":"uri", + "locationName":"Style" + }, + "ColorScheme":{ + "shape":"ColorScheme", + "documentation":"

Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.

Example: Light

Default value: Light

Valid values for ColorScheme are case sensitive.

", + "location":"querystring", + "locationName":"color-scheme" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.

The following political views are currently supported:

", + "location":"querystring", + "locationName":"political-view" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "GetStyleDescriptorResponse":{ + "type":"structure", + "members":{ + "Blob":{ + "shape":"Blob", + "documentation":"

This Blob contains the body of the style descriptor which is in application/json format.

" + }, + "ContentType":{ + "shape":"String", + "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", + "location":"header", + "locationName":"Content-Type" + }, + "CacheControl":{ + "shape":"String", + "documentation":"

Header that instructs caching configuration for the client.

", + "location":"header", + "locationName":"Cache-Control" + }, + "ETag":{ + "shape":"String", + "documentation":"

The style descriptor's Etag.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"Blob" + }, + "GetTileRequest":{ + "type":"structure", + "required":[ + "Tileset", + "Z", + "X", + "Y" + ], + "members":{ + "Tileset":{ + "shape":"Tileset", + "documentation":"

Specifies the desired tile set.

Valid Values: raster.satellite | vector.basemap

", + "location":"uri", + "locationName":"Tileset" + }, + "Z":{ + "shape":"GetTileRequestZString", + "documentation":"

The zoom value for the map tile.

", + "location":"uri", + "locationName":"Z" + }, + "X":{ + "shape":"GetTileRequestXString", + "documentation":"

The X axis value for the map tile. Must be between 0 and 19.

", + "location":"uri", + "locationName":"X" + }, + "Y":{ + "shape":"GetTileRequestYString", + "documentation":"

The Y axis value for the map tile.

", + "location":"uri", + "locationName":"Y" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "GetTileRequestXString":{ + "type":"string", + "pattern":".*\\d+.*" + }, + "GetTileRequestYString":{ + "type":"string", + "pattern":".*\\d+.*" + }, + "GetTileRequestZString":{ + "type":"string", + "pattern":".*\\d+.*" + }, + "GetTileResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "Blob":{ + "shape":"Blob", + "documentation":"

The blob represents a vector tile in mvt format for the GetTile API.

" + }, + "ContentType":{ + "shape":"String", + "documentation":"

Header that represents the format of the response. The response returns the following as the HTTP body.

", + "location":"header", + "locationName":"Content-Type" + }, + "CacheControl":{ + "shape":"String", + "documentation":"

Header that instructs caching configuration for the client.

", + "location":"header", + "locationName":"Cache-Control" + }, + "ETag":{ + "shape":"String", + "documentation":"

The pricing bucket for which the request is charged at.

", + "location":"header", + "locationName":"ETag" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the request is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + } + }, + "payload":"Blob" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "MapStyle":{ + "type":"string", + "enum":[ + "Standard", + "Monochrome", + "Hybrid", + "Satellite" + ] + }, + "PositionListString":{ + "type":"string", + "min":7, + "pattern":"(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?)(,(-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?))*" + }, + "PositionString":{ + "type":"string", + "max":36, + "min":3, + "pattern":"-?\\d{1,3}(\\.\\d{1,14})?,-?\\d{1,2}(\\.\\d{1,14})?" + }, + "ScaleBarUnit":{ + "type":"string", + "enum":[ + "Kilometers", + "KilometersMiles", + "Miles", + "MilesKilometers" + ] + }, + "StaticMapStyle":{ + "type":"string", + "enum":["Satellite"] + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request was denied due to request throttling.

", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "Tileset":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[-.\\w]+" + }, + "ValidationException":{ + "type":"structure", + "required":[ + "Message", + "Reason", + "FieldList" + ], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + }, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"

The field where thebb invalid entry was detected.

", + "locationName":"reason" + }, + "FieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"

A message with the reason for the validation exception error.

", + "locationName":"fieldList" + } + }, + "documentation":"

The input fails to satisfy the constraints specified by an AWS service.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the resource.

", + "locationName":"name" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

The input fails to satisfy the constraints specified by the Amazon Location service.

" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UnknownOperation", + "Missing", + "CannotParse", + "FieldValidationFailed", + "Other", + "UnknownField" + ] + }, + "Variant":{ + "type":"string", + "enum":["Default"] + } + }, + "documentation":"

Integrate high-quality base map data into your applications using MapLibre. Capabilities include:

" +} diff --git a/botocore/data/geo-places/2020-11-19/endpoint-rule-set-1.json b/botocore/data/geo-places/2020-11-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000..d4ff8f54a2 --- /dev/null +++ b/botocore/data/geo-places/2020-11-19/endpoint-rule-set-1.json @@ -0,0 +1,688 @@ +{ + "version": "1.0", + "parameters": { + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://places.geo.{Region}.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://places.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://places.geo-fips.{Region}.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://places.geo.{Region}.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://places.geo.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://places.geo-fips.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://places.geo-fips.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://places.geo.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-places-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-places-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-places.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://geo-places.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/botocore/data/geo-places/2020-11-19/paginators-1.json b/botocore/data/geo-places/2020-11-19/paginators-1.json new file mode 100644 index 0000000000..ea142457a6 --- /dev/null +++ b/botocore/data/geo-places/2020-11-19/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/botocore/data/geo-places/2020-11-19/service-2.json b/botocore/data/geo-places/2020-11-19/service-2.json new file mode 100644 index 0000000000..cfd5e79bab --- /dev/null +++ b/botocore/data/geo-places/2020-11-19/service-2.json @@ -0,0 +1,3082 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-11-19", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"geo-places", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Location Service Places V2", + "serviceId":"Geo Places", + "signatureVersion":"v4", + "signingName":"geo-places", + "uid":"geo-places-2020-11-19" + }, + "operations":{ + "Autocomplete":{ + "name":"Autocomplete", + "http":{ + "method":"POST", + "requestUri":"/autocomplete", + "responseCode":200 + }, + "input":{"shape":"AutocompleteRequest"}, + "output":{"shape":"AutocompleteResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The autocomplete operation speeds up and increases the accuracy of entering addresses by providing a list of address candidates matching a partially entered address. Results are sorted from most to least matching. Filtering and biasing can be used to increase the relevance of the results if additional search context is known

" + }, + "Geocode":{ + "name":"Geocode", + "http":{ + "method":"POST", + "requestUri":"/geocode", + "responseCode":200 + }, + "input":{"shape":"GeocodeRequest"}, + "output":{"shape":"GeocodeResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The Geocode action allows you to obtain coordinates, addresses, and other information about places.

" + }, + "GetPlace":{ + "name":"GetPlace", + "http":{ + "method":"GET", + "requestUri":"/place/{PlaceId}", + "responseCode":200 + }, + "input":{"shape":"GetPlaceRequest"}, + "output":{"shape":"GetPlaceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Finds a place by its unique ID. A PlaceId is returned by other place operations.

" + }, + "ReverseGeocode":{ + "name":"ReverseGeocode", + "http":{ + "method":"POST", + "requestUri":"/reverse-geocode", + "responseCode":200 + }, + "input":{"shape":"ReverseGeocodeRequest"}, + "output":{"shape":"ReverseGeocodeResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The ReverseGeocode operation allows you to retrieve addresses and place information from coordinates.

" + }, + "SearchNearby":{ + "name":"SearchNearby", + "http":{ + "method":"POST", + "requestUri":"/search-nearby", + "responseCode":200 + }, + "input":{"shape":"SearchNearbyRequest"}, + "output":{"shape":"SearchNearbyResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Search nearby a specified location.

" + }, + "SearchText":{ + "name":"SearchText", + "http":{ + "method":"POST", + "requestUri":"/search-text", + "responseCode":200 + }, + "input":{"shape":"SearchTextRequest"}, + "output":{"shape":"SearchTextResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Use the SearchText operation to search for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id.

" + }, + "Suggest":{ + "name":"Suggest", + "http":{ + "method":"POST", + "requestUri":"/suggest", + "responseCode":200 + }, + "input":{"shape":"SuggestRequest"}, + "output":{"shape":"SuggestResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The Suggest operation finds addresses or place candidates based on incomplete or misspelled queries. You then select the best query to submit based on the returned results.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

You don't have sufficient access to perform this action.

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccessPoint":{ + "type":"structure", + "members":{ + "Position":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude.

" + } + }, + "documentation":"

Position of the access point represented by longitude and latitude for a vehicle.

" + }, + "AccessPointList":{ + "type":"list", + "member":{"shape":"AccessPoint"}, + "max":100, + "min":0 + }, + "AccessRestriction":{ + "type":"structure", + "members":{ + "Restricted":{ + "shape":"Boolean", + "documentation":"

The restriction.

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong too.

" + } + }, + "documentation":"

Indicates if the access location is restricted. Index correlates to that of an access point and indicates if access through this point has some form of restriction.

" + }, + "AccessRestrictionList":{ + "type":"list", + "member":{"shape":"AccessRestriction"}, + "max":100, + "min":1 + }, + "Address":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"AddressLabelString", + "documentation":"

Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.

" + }, + "Country":{ + "shape":"Country", + "documentation":"

The country component of the address.

" + }, + "Region":{ + "shape":"Region", + "documentation":"

The region or state results should be present in.

Example: North Rhine-Westphalia.

" + }, + "SubRegion":{ + "shape":"SubRegion", + "documentation":"

The sub-region or county for which results should be present in.

" + }, + "Locality":{ + "shape":"AddressLocalityString", + "documentation":"

The locality or city of the address.

Example: Vancouver.

" + }, + "District":{ + "shape":"AddressDistrictString", + "documentation":"

The district or division of a locality associated with this address.

" + }, + "SubDistrict":{ + "shape":"AddressSubDistrictString", + "documentation":"

A subdivision of a district.

Example: Minden-Lübbecke.

" + }, + "PostalCode":{ + "shape":"AddressPostalCodeString", + "documentation":"

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should posses.

" + }, + "Block":{ + "shape":"AddressBlockString", + "documentation":"

Name of the block.

Example: Sunny Mansion 203 block: 2 Chome

" + }, + "SubBlock":{ + "shape":"AddressSubBlockString", + "documentation":"

Name of sub-block.

Example: Sunny Mansion 203 sub-block: 4

" + }, + "Intersection":{ + "shape":"IntersectionList", + "documentation":"

Name of the streets in the intersection.

Example: [\"Friedrichstraße\",\"Unter den Linden\"]

" + }, + "Street":{ + "shape":"AddressStreetString", + "documentation":"

The name of the street results should be present in.

" + }, + "StreetComponents":{ + "shape":"StreetComponentsList", + "documentation":"

Components of the street.

Example: Younge from the \"Younge street\".

" + }, + "AddressNumber":{ + "shape":"AddressAddressNumberString", + "documentation":"

The number that identifies an address within a street.

" + }, + "Building":{ + "shape":"AddressBuildingString", + "documentation":"

The name of the building at the address.

" + } + }, + "documentation":"

The place address.

" + }, + "AddressAddressNumberString":{ + "type":"string", + "max":10, + "min":0 + }, + "AddressBlockString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressBuildingString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressComponentMatchScores":{ + "type":"structure", + "members":{ + "Country":{ + "shape":"MatchScore", + "documentation":"

The alpha-2 or alpha-3 character code for the country that the results will be present in.

" + }, + "Region":{ + "shape":"MatchScore", + "documentation":"

The region or state results should be to be present in.

Example: North Rhine-Westphalia.

" + }, + "SubRegion":{ + "shape":"MatchScore", + "documentation":"

The sub-region or county for which results should be present in.

" + }, + "Locality":{ + "shape":"MatchScore", + "documentation":"

The city or locality results should be present in.

Example: Vancouver.

" + }, + "District":{ + "shape":"MatchScore", + "documentation":"

The district or division of a city the results should be present in.

" + }, + "SubDistrict":{ + "shape":"MatchScore", + "documentation":"

A subdivision of a district.

Example: Minden-Lübbecke

" + }, + "PostalCode":{ + "shape":"MatchScore", + "documentation":"

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should posses.

" + }, + "Block":{ + "shape":"MatchScore", + "documentation":"

Name of the block.

Example: Sunny Mansion 203 block: 2 Chome

" + }, + "SubBlock":{ + "shape":"MatchScore", + "documentation":"

Name of sub-block.

Example: Sunny Mansion 203 sub-block: 4

" + }, + "Intersection":{ + "shape":"AddressComponentMatchScoresIntersectionList", + "documentation":"

Name of the streets in the intersection.

Example: [\"Friedrichstraße\",\"Unter den Linden\"]

" + }, + "AddressNumber":{ + "shape":"MatchScore", + "documentation":"

The house number or address results should have.

" + }, + "Building":{ + "shape":"MatchScore", + "documentation":"

The name of the building at the address.

" + } + }, + "documentation":"

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

" + }, + "AddressComponentMatchScoresIntersectionList":{ + "type":"list", + "member":{"shape":"MatchScore"}, + "max":2, + "min":1 + }, + "AddressComponentPhonemes":{ + "type":"structure", + "members":{ + "Country":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

The alpha-2 or alpha-3 character code for the country that the results will be present in.

" + }, + "Region":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the region or state results should be to be present in.

" + }, + "SubRegion":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the sub-region or county for which results should be present in.

" + }, + "Locality":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the city or locality results should be present in.

Example: Vancouver.

" + }, + "District":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the district or division of a city results should be present in.

" + }, + "SubDistrict":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the sub-district or division of a city results should be present in.

" + }, + "Block":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the name of the block.

" + }, + "SubBlock":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the name of the sub-block.

" + }, + "Street":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

How to pronounce the name of the street results should be present in.

" + } + }, + "documentation":"

How to pronounce the various components of the address or place.

" + }, + "AddressDistrictString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressLabelString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressLocalityString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressPostalCodeString":{ + "type":"string", + "max":50, + "min":0 + }, + "AddressStreetString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressSubBlockString":{ + "type":"string", + "max":200, + "min":0 + }, + "AddressSubDistrictString":{ + "type":"string", + "max":200, + "min":0 + }, + "ApiKey":{ + "type":"string", + "max":1000, + "min":0, + "sensitive":true + }, + "AutocompleteAdditionalFeature":{ + "type":"string", + "enum":["Core"] + }, + "AutocompleteAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"AutocompleteAdditionalFeature"}, + "max":1, + "min":1 + }, + "AutocompleteAddressHighlights":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.

" + }, + "Country":{ + "shape":"CountryHighlights", + "documentation":"

The alpha-2 or alpha-3 character code for the country that the results will be present in.

" + }, + "Region":{ + "shape":"RegionHighlights", + "documentation":"

The region or state results should be to be present in.

Example: North Rhine-Westphalia.

" + }, + "SubRegion":{ + "shape":"SubRegionHighlights", + "documentation":"

The sub-region or county for which results should be present in.

" + }, + "Locality":{ + "shape":"HighlightList", + "documentation":"

The city or locality results should be present in.

Example: Vancouver.

" + }, + "District":{ + "shape":"HighlightList", + "documentation":"

The district or division of a city the results should be present in.

" + }, + "SubDistrict":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the title in the text query that match the found title.

" + }, + "Street":{ + "shape":"HighlightList", + "documentation":"

The name of the street results should be present in.

" + }, + "Block":{ + "shape":"HighlightList", + "documentation":"

Name of the block. Example: Sunny Mansion 203 block: 2 Chome

" + }, + "SubBlock":{ + "shape":"HighlightList", + "documentation":"

Name of sub-block. Example Sunny Mansion 203 sub-block: 4

" + }, + "Intersection":{ + "shape":"IntersectionHighlightsList", + "documentation":"

Name of the streets in the intersection. For example: e.g. [\"Friedrichstraße\",\"Unter den Linden\"]

" + }, + "PostalCode":{ + "shape":"HighlightList", + "documentation":"

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

" + }, + "AddressNumber":{ + "shape":"HighlightList", + "documentation":"

The house number or address results should have.

" + }, + "Building":{ + "shape":"HighlightList", + "documentation":"

The name of the building at the address.

" + } + }, + "documentation":"

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

" + }, + "AutocompleteFilter":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Circle":{"shape":"FilterCircle"}, + "IncludeCountries":{ + "shape":"CountryCodeList", + "documentation":"

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

" + }, + "IncludePlaceTypes":{ + "shape":"AutocompleteFilterPlaceTypeList", + "documentation":"

The included place types.

" + } + }, + "documentation":"

Autocomplete structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "AutocompleteFilterPlaceType":{ + "type":"string", + "enum":[ + "Locality", + "PostalCode" + ] + }, + "AutocompleteFilterPlaceTypeList":{ + "type":"list", + "member":{"shape":"AutocompleteFilterPlaceType"}, + "max":2, + "min":1 + }, + "AutocompleteHighlights":{ + "type":"structure", + "members":{ + "Title":{ + "shape":"HighlightList", + "documentation":"

Indicates where the title field in the result matches the input query.

" + }, + "Address":{ + "shape":"AutocompleteAddressHighlights", + "documentation":"

Describes how part of the result address match the input query.

" + } + }, + "documentation":"

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

" + }, + "AutocompleteIntendedUse":{ + "type":"string", + "enum":["SingleUse"] + }, + "AutocompleteRequest":{ + "type":"structure", + "required":["QueryText"], + "members":{ + "QueryText":{ + "shape":"AutocompleteRequestQueryTextString", + "documentation":"

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

" + }, + "MaxResults":{ + "shape":"AutocompleteRequestMaxResultsInteger", + "documentation":"

An optional limit for the number of results returned in a single call.

" + }, + "BiasPosition":{ + "shape":"Position", + "documentation":"

The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

" + }, + "Filter":{ + "shape":"AutocompleteFilter", + "documentation":"

A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "PostalCodeMode":{ + "shape":"PostalCodeMode", + "documentation":"

The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value cityLookup, all cities in that postal code are returned.

" + }, + "AdditionalFeatures":{ + "shape":"AutocompleteAdditionalFeatureList", + "documentation":"

A list of optional additional parameters that can be requested for each result.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "IntendedUse":{ + "shape":"AutocompleteIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "AutocompleteRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "AutocompleteRequestQueryTextString":{ + "type":"string", + "max":200, + "min":1, + "sensitive":true + }, + "AutocompleteResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "ResultItems":{ + "shape":"AutocompleteResultItemList", + "documentation":"

List of places or results returned for a query.

" + } + } + }, + "AutocompleteResultItem":{ + "type":"structure", + "required":[ + "PlaceId", + "PlaceType", + "Title" + ], + "members":{ + "PlaceId":{ + "shape":"AutocompleteResultItemPlaceIdString", + "documentation":"

The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

PlaceType describes the type of result entry returned.

" + }, + "Title":{ + "shape":"AutocompleteResultItemTitleString", + "documentation":"

A formatted string for display when presenting this result to an end user.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The address associated with this result.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The distance in meters between the center of the search area and this result. Useful to evaluate how far away from the original bias position the result is.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "Highlights":{ + "shape":"AutocompleteHighlights", + "documentation":"

Indicates the starting and ending index of the place in the text query that match the found title.

" + } + }, + "documentation":"

A result matching the input query text.

" + }, + "AutocompleteResultItemList":{ + "type":"list", + "member":{"shape":"AutocompleteResultItem"}, + "max":20, + "min":0 + }, + "AutocompleteResultItemPlaceIdString":{ + "type":"string", + "max":200, + "min":0 + }, + "AutocompleteResultItemTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "BoundingBox":{ + "type":"list", + "member":{"shape":"Double"}, + "max":4, + "min":4, + "sensitive":true + }, + "BusinessChain":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"BusinessChainNameString", + "documentation":"

The business chain name.

" + }, + "Id":{ + "shape":"BusinessChainIdString", + "documentation":"

The Business Chain Id.

" + } + }, + "documentation":"

A businesschain is a chain of businesses that belong to the same brand. For example 7-11.

" + }, + "BusinessChainIdString":{ + "type":"string", + "max":100, + "min":1 + }, + "BusinessChainList":{ + "type":"list", + "member":{"shape":"BusinessChain"}, + "max":100, + "min":1 + }, + "BusinessChainNameString":{ + "type":"string", + "max":100, + "min":1 + }, + "Category":{ + "type":"structure", + "required":[ + "Id", + "Name" + ], + "members":{ + "Id":{ + "shape":"CategoryIdString", + "documentation":"

The category ID.

" + }, + "Name":{ + "shape":"CategoryNameString", + "documentation":"

The category name.

" + }, + "LocalizedName":{ + "shape":"CategoryLocalizedNameString", + "documentation":"

Localized name of the category type.

" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Boolean which indicates if this category is the primary offered by the place.

" + } + }, + "documentation":"

Category of the Place returned.

" + }, + "CategoryIdString":{ + "type":"string", + "max":100, + "min":1 + }, + "CategoryList":{ + "type":"list", + "member":{"shape":"Category"}, + "max":100, + "min":1 + }, + "CategoryLocalizedNameString":{ + "type":"string", + "max":100, + "min":1 + }, + "CategoryNameString":{ + "type":"string", + "max":100, + "min":1 + }, + "ComponentMatchScores":{ + "type":"structure", + "members":{ + "Title":{ + "shape":"MatchScore", + "documentation":"

Indicates the starting and ending index of the title in the text query that match the found title.

" + }, + "Address":{ + "shape":"AddressComponentMatchScores", + "documentation":"

The place's address.

" + } + }, + "documentation":"

Indicates how well the input matches the returned element. It is equal to 1 if all input tokens are recognized and matched to the title in the result.

" + }, + "ContactDetails":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"ContactDetailsLabelString", + "documentation":"

The contact's label.

" + }, + "Value":{ + "shape":"ContactDetailsValueString", + "documentation":"

The contact's value.

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong too.

" + } + }, + "documentation":"

Details related to contacts.

" + }, + "ContactDetailsLabelString":{ + "type":"string", + "max":200, + "min":0 + }, + "ContactDetailsList":{ + "type":"list", + "member":{"shape":"ContactDetails"}, + "max":100, + "min":1 + }, + "ContactDetailsValueString":{ + "type":"string", + "max":200, + "min":0 + }, + "Contacts":{ + "type":"structure", + "members":{ + "Phones":{ + "shape":"ContactDetailsList", + "documentation":"

List of phone numbers for the results contact.

" + }, + "Faxes":{ + "shape":"ContactDetailsList", + "documentation":"

List of fax addresses for the result contact.

" + }, + "Websites":{ + "shape":"ContactDetailsList", + "documentation":"

List of website URLs that belong to the result.

" + }, + "Emails":{ + "shape":"ContactDetailsList", + "documentation":"

List of emails for contacts of the result.

" + } + }, + "documentation":"

A list of potential contact methods for the result/place.

" + }, + "Country":{ + "type":"structure", + "members":{ + "Code2":{ + "shape":"CountryCode2", + "documentation":"

Country, represented by its alpha 2-character code.

" + }, + "Code3":{ + "shape":"CountryCode3", + "documentation":"

Country, represented by its alpha t-character code.

" + }, + "Name":{ + "shape":"CountryNameString", + "documentation":"

Name of the country.

" + } + }, + "documentation":"

The alpha-2 or alpha-3 character code for the country that the results will be present in.

" + }, + "CountryCode":{ + "type":"string", + "max":3, + "min":2, + "pattern":"([A-Z]{2}|[A-Z]{3})" + }, + "CountryCode2":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[A-Z]{2}" + }, + "CountryCode3":{ + "type":"string", + "max":3, + "min":3, + "pattern":"[A-Z]{3}" + }, + "CountryCodeList":{ + "type":"list", + "member":{"shape":"CountryCode"}, + "max":100, + "min":1 + }, + "CountryHighlights":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the country code in the text query that match the found title.

" + }, + "Name":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the country code in the text query that match the found title.

" + } + }, + "documentation":"

Indicates the starting and ending index of the country in the text query that match the found title.

" + }, + "CountryNameString":{ + "type":"string", + "max":100, + "min":0 + }, + "DistanceMeters":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "Double":{ + "type":"double", + "box":true + }, + "FilterBusinessChainList":{ + "type":"list", + "member":{"shape":"FilterBusinessChainListMemberString"}, + "max":10, + "min":1 + }, + "FilterBusinessChainListMemberString":{ + "type":"string", + "max":100, + "min":1 + }, + "FilterCategoryList":{ + "type":"list", + "member":{"shape":"FilterCategoryListMemberString"}, + "max":10, + "min":1 + }, + "FilterCategoryListMemberString":{ + "type":"string", + "max":100, + "min":1 + }, + "FilterCircle":{ + "type":"structure", + "required":[ + "Center", + "Radius" + ], + "members":{ + "Center":{ + "shape":"Position", + "documentation":"

The center position, in longitude and latitude, of the FilterCircle.

" + }, + "Radius":{ + "shape":"FilterCircleRadiusLong", + "documentation":"

The radius, in meters, of the FilterCircle.

", + "box":true + } + }, + "documentation":"

The Circle that all results must be in.

", + "sensitive":true + }, + "FilterCircleRadiusLong":{ + "type":"long", + "max":21000000, + "min":1 + }, + "FilterFoodTypeList":{ + "type":"list", + "member":{"shape":"FilterFoodTypeListMemberString"}, + "max":10, + "min":1 + }, + "FilterFoodTypeListMemberString":{ + "type":"string", + "max":100, + "min":1 + }, + "FoodType":{ + "type":"structure", + "required":["LocalizedName"], + "members":{ + "LocalizedName":{ + "shape":"FoodTypeLocalizedNameString", + "documentation":"

Localized name of the food type.

" + }, + "Id":{ + "shape":"FoodTypeIdString", + "documentation":"

The Food Type Id.

" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Boolean which indicates if this food type is the primary offered by the place. For example, if a location serves fast food, but also dessert, he primary would likely be fast food.

" + } + }, + "documentation":"

List of Food types offered by this result.

" + }, + "FoodTypeIdString":{ + "type":"string", + "max":100, + "min":1 + }, + "FoodTypeList":{ + "type":"list", + "member":{"shape":"FoodType"}, + "max":100, + "min":1 + }, + "FoodTypeLocalizedNameString":{ + "type":"string", + "max":100, + "min":1 + }, + "GeocodeAdditionalFeature":{ + "type":"string", + "enum":[ + "TimeZone", + "Access" + ] + }, + "GeocodeAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"GeocodeAdditionalFeature"}, + "max":2, + "min":1 + }, + "GeocodeFilter":{ + "type":"structure", + "members":{ + "IncludeCountries":{ + "shape":"CountryCodeList", + "documentation":"

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

" + }, + "IncludePlaceTypes":{ + "shape":"GeocodeFilterPlaceTypeList", + "documentation":"

The included place types.

" + } + }, + "documentation":"

Geocode structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "GeocodeFilterPlaceType":{ + "type":"string", + "enum":[ + "Locality", + "PostalCode", + "Intersection", + "Street", + "PointAddress", + "InterpolatedAddress" + ] + }, + "GeocodeFilterPlaceTypeList":{ + "type":"list", + "member":{"shape":"GeocodeFilterPlaceType"}, + "max":6, + "min":1 + }, + "GeocodeIntendedUse":{ + "type":"string", + "enum":[ + "SingleUse", + "Storage" + ] + }, + "GeocodeQueryComponents":{ + "type":"structure", + "members":{ + "Country":{ + "shape":"GeocodeQueryComponentsCountryString", + "documentation":"

The alpha-2 or alpha-3 character code for the country that the results will be present in.

" + }, + "Region":{ + "shape":"GeocodeQueryComponentsRegionString", + "documentation":"

The region or state results should be to be present in.

Example: North Rhine-Westphalia.

" + }, + "SubRegion":{ + "shape":"GeocodeQueryComponentsSubRegionString", + "documentation":"

The sub-region or county for which results should be present in.

" + }, + "Locality":{ + "shape":"GeocodeQueryComponentsLocalityString", + "documentation":"

City or locality results should be present in.

Example: Vancouver.

" + }, + "District":{ + "shape":"GeocodeQueryComponentsDistrictString", + "documentation":"

The district or division of a city the results should be present in.

" + }, + "Street":{ + "shape":"GeocodeQueryComponentsStreetString", + "documentation":"

The name of the street results should be present in.

" + }, + "AddressNumber":{ + "shape":"GeocodeQueryComponentsAddressNumberString", + "documentation":"

The house number or address results should have.

" + }, + "PostalCode":{ + "shape":"GeocodeQueryComponentsPostalCodeString", + "documentation":"

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

" + } + }, + "documentation":"

A structured free text query allows you to search for places by the name or text representation of specific properties of the place.

" + }, + "GeocodeQueryComponentsAddressNumberString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsCountryString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsDistrictString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsLocalityString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsPostalCodeString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsRegionString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsStreetString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeQueryComponentsSubRegionString":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[^;]+", + "sensitive":true + }, + "GeocodeRequest":{ + "type":"structure", + "members":{ + "QueryText":{ + "shape":"GeocodeRequestQueryTextString", + "documentation":"

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

" + }, + "QueryComponents":{"shape":"GeocodeQueryComponents"}, + "MaxResults":{ + "shape":"GeocodeRequestMaxResultsInteger", + "documentation":"

An optional limit for the number of results returned in a single call.

" + }, + "BiasPosition":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

" + }, + "Filter":{ + "shape":"GeocodeFilter", + "documentation":"

A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "AdditionalFeatures":{ + "shape":"GeocodeAdditionalFeatureList", + "documentation":"

A list of optional additional parameters, such as time zone, that can be requested for each result.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "IntendedUse":{ + "shape":"GeocodeIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "GeocodeRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "GeocodeRequestQueryTextString":{ + "type":"string", + "max":200, + "min":1, + "sensitive":true + }, + "GeocodeResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "ResultItems":{ + "shape":"GeocodeResultItemList", + "documentation":"

List of places or results returned for a query.

" + } + } + }, + "GeocodeResultItem":{ + "type":"structure", + "required":[ + "PlaceId", + "PlaceType", + "Title" + ], + "members":{ + "PlaceId":{ + "shape":"GeocodeResultItemPlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

A PlaceType is a category that the result place must belong to.

" + }, + "Title":{ + "shape":"GeocodeResultItemTitleString", + "documentation":"

The localized display name of this result item based on request parameter language.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The place's address.

" + }, + "AddressNumberCorrected":{ + "shape":"Boolean", + "documentation":"

Boolean indicating if the address provided has been corrected.

" + }, + "PostalCodeDetails":{ + "shape":"PostalCodeDetailsList", + "documentation":"

Contains details about the postal code of the place/result.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

The position in longitude and latitude.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The distance in meters from the QueryPosition.

" + }, + "MapView":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong to.

" + }, + "FoodTypes":{ + "shape":"FoodTypeList", + "documentation":"

List of food types offered by this result.

" + }, + "AccessPoints":{ + "shape":"AccessPointList", + "documentation":"

Position of the access point represent by longitude and latitude.

" + }, + "TimeZone":{ + "shape":"TimeZone", + "documentation":"

The time zone in which the place is located.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "MatchScores":{ + "shape":"MatchScoreDetails", + "documentation":"

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

" + } + }, + "documentation":"

The Geocoded result.

" + }, + "GeocodeResultItemList":{ + "type":"list", + "member":{"shape":"GeocodeResultItem"}, + "max":100, + "min":0 + }, + "GeocodeResultItemPlaceIdString":{ + "type":"string", + "max":200, + "min":0 + }, + "GeocodeResultItemTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "GetPlaceAdditionalFeature":{ + "type":"string", + "enum":[ + "TimeZone", + "Phonemes", + "Access", + "Contact" + ] + }, + "GetPlaceAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"GetPlaceAdditionalFeature"}, + "max":4, + "min":1 + }, + "GetPlaceIntendedUse":{ + "type":"string", + "enum":[ + "SingleUse", + "Storage" + ] + }, + "GetPlaceRequest":{ + "type":"structure", + "required":["PlaceId"], + "members":{ + "PlaceId":{ + "shape":"GetPlaceRequestPlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

", + "location":"uri", + "locationName":"PlaceId" + }, + "AdditionalFeatures":{ + "shape":"GetPlaceAdditionalFeatureList", + "documentation":"

A list of optional additional parameters such as time zone that can be requested for each result.

", + "location":"querystring", + "locationName":"additional-features" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

", + "location":"querystring", + "locationName":"language" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

", + "location":"querystring", + "locationName":"political-view" + }, + "IntendedUse":{ + "shape":"GetPlaceIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

", + "location":"querystring", + "locationName":"intended-use" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "GetPlaceRequestPlaceIdString":{ + "type":"string", + "max":200, + "min":0, + "sensitive":true + }, + "GetPlaceResponse":{ + "type":"structure", + "required":[ + "PlaceId", + "PlaceType", + "Title", + "PricingBucket" + ], + "members":{ + "PlaceId":{ + "shape":"GetPlaceResponsePlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

A PlaceType is a category that the result place must belong to.

" + }, + "Title":{ + "shape":"GetPlaceResponseTitleString", + "documentation":"

The localized display name of this result item based on request parameter language.

" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "Address":{ + "shape":"Address", + "documentation":"

The place's address.

" + }, + "AddressNumberCorrected":{ + "shape":"Boolean", + "documentation":"

Boolean indicating if the address provided has been corrected.

" + }, + "PostalCodeDetails":{ + "shape":"PostalCodeDetailsList", + "documentation":"

Contains details about the postal code of the place/result.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude.

" + }, + "MapView":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set of four coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong to.

" + }, + "FoodTypes":{ + "shape":"FoodTypeList", + "documentation":"

List of food types offered by this result.

" + }, + "BusinessChains":{ + "shape":"BusinessChainList", + "documentation":"

The Business Chains associated with the place.

" + }, + "Contacts":{ + "shape":"Contacts", + "documentation":"

List of potential contact methods for the result/place.

" + }, + "OpeningHours":{ + "shape":"OpeningHoursList", + "documentation":"

List of opening hours objects.

" + }, + "AccessPoints":{ + "shape":"AccessPointList", + "documentation":"

Position of the access point in (lng,lat).

" + }, + "AccessRestrictions":{ + "shape":"AccessRestrictionList", + "documentation":"

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

" + }, + "TimeZone":{ + "shape":"TimeZone", + "documentation":"

The time zone in which the place is located.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "Phonemes":{ + "shape":"PhonemeDetails", + "documentation":"

How the various components of the result's address are pronounced in various languages.

" + } + } + }, + "GetPlaceResponsePlaceIdString":{ + "type":"string", + "max":200, + "min":0 + }, + "GetPlaceResponseTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "Highlight":{ + "type":"structure", + "members":{ + "StartIndex":{ + "shape":"HighlightStartIndexInteger", + "documentation":"

Start index of the highlight.

" + }, + "EndIndex":{ + "shape":"HighlightEndIndexInteger", + "documentation":"

End index of the highlight.

" + }, + "Value":{ + "shape":"HighlightValueString", + "documentation":"

The highlight's value.

" + } + }, + "documentation":"

Describes how parts of the result response match the input query.

" + }, + "HighlightEndIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "HighlightList":{ + "type":"list", + "member":{"shape":"Highlight"}, + "max":200, + "min":0 + }, + "HighlightStartIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "HighlightValueString":{ + "type":"string", + "max":200, + "min":0 + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "IntersectionHighlightsList":{ + "type":"list", + "member":{"shape":"HighlightList"}, + "max":100, + "min":1 + }, + "IntersectionList":{ + "type":"list", + "member":{"shape":"IntersectionStreet"}, + "max":100, + "min":1 + }, + "IntersectionStreet":{ + "type":"string", + "max":200, + "min":0 + }, + "LanguageTag":{ + "type":"string", + "max":35, + "min":2 + }, + "MatchScore":{ + "type":"double", + "max":1, + "min":0 + }, + "MatchScoreDetails":{ + "type":"structure", + "members":{ + "Overall":{ + "shape":"MatchScore", + "documentation":"

Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

" + }, + "Components":{ + "shape":"ComponentMatchScores", + "documentation":"

Indicates how well the component input matches the returned. It is equal to 1 if all input tokens are recognized and matched.

" + } + }, + "documentation":"

Details related to the match score.

" + }, + "OpeningHours":{ + "type":"structure", + "members":{ + "Display":{ + "shape":"OpeningHoursDisplayList", + "documentation":"

List of opening hours in the format they are displayed in. This can vary by result and in most cases represents how the result uniquely formats their opening hours.

" + }, + "OpenNow":{ + "shape":"Boolean", + "documentation":"

Boolean which indicates if the result/place is currently open.

" + }, + "Components":{ + "shape":"OpeningHoursComponentsList", + "documentation":"

Components of the opening hours object.

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong too.

" + } + }, + "documentation":"

List of opening hours objects.

" + }, + "OpeningHoursComponents":{ + "type":"structure", + "members":{ + "OpenTime":{ + "shape":"OpeningHoursComponentsOpenTimeString", + "documentation":"

String which represents the opening hours, such as \"T070000\".

" + }, + "OpenDuration":{ + "shape":"OpeningHoursComponentsOpenDurationString", + "documentation":"

String which represents the duration of the opening period, such as \"PT12H00M\".

" + }, + "Recurrence":{ + "shape":"OpeningHoursComponentsRecurrenceString", + "documentation":"

Days or periods when the provided opening hours are in affect.

Example: FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU

" + } + }, + "documentation":"

Components of the opening hours object.

" + }, + "OpeningHoursComponentsList":{ + "type":"list", + "member":{"shape":"OpeningHoursComponents"}, + "max":100, + "min":1 + }, + "OpeningHoursComponentsOpenDurationString":{ + "type":"string", + "max":200, + "min":0 + }, + "OpeningHoursComponentsOpenTimeString":{ + "type":"string", + "max":21, + "min":0 + }, + "OpeningHoursComponentsRecurrenceString":{ + "type":"string", + "max":200, + "min":0 + }, + "OpeningHoursDisplay":{ + "type":"string", + "max":200, + "min":0 + }, + "OpeningHoursDisplayList":{ + "type":"list", + "member":{"shape":"OpeningHoursDisplay"}, + "max":100, + "min":1 + }, + "OpeningHoursList":{ + "type":"list", + "member":{"shape":"OpeningHours"}, + "max":100, + "min":1 + }, + "PhonemeDetails":{ + "type":"structure", + "members":{ + "Title":{ + "shape":"PhonemeTranscriptionList", + "documentation":"

List of PhonemeTranscription. See PhonemeTranscription for fields.

" + }, + "Address":{ + "shape":"AddressComponentPhonemes", + "documentation":"

How to pronounce the address.

" + } + }, + "documentation":"

The phoneme details.

" + }, + "PhonemeTranscription":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"PhonemeTranscriptionValueString", + "documentation":"

Value which indicates how to pronounce the value.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "Preferred":{ + "shape":"Boolean", + "documentation":"

Boolean which indicates if it the preferred pronunciation.

" + } + }, + "documentation":"

How to pronounce the various components of the address or place.

" + }, + "PhonemeTranscriptionList":{ + "type":"list", + "member":{"shape":"PhonemeTranscription"}, + "max":100, + "min":0 + }, + "PhonemeTranscriptionValueString":{ + "type":"string", + "max":50, + "min":0 + }, + "PlaceType":{ + "type":"string", + "enum":[ + "Country", + "Region", + "SubRegion", + "Locality", + "District", + "SubDistrict", + "PostalCode", + "Block", + "SubBlock", + "Intersection", + "Street", + "PointOfInterest", + "PointAddress", + "InterpolatedAddress" + ] + }, + "Position":{ + "type":"list", + "member":{"shape":"Double"}, + "max":2, + "min":2, + "sensitive":true + }, + "PostalAuthority":{ + "type":"string", + "enum":["Usps"] + }, + "PostalCodeDetails":{ + "type":"structure", + "members":{ + "PostalCode":{ + "shape":"PostalCodeDetailsPostalCodeString", + "documentation":"

An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code for which the result should posses.

" + }, + "PostalAuthority":{ + "shape":"PostalAuthority", + "documentation":"

The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.

" + }, + "PostalCodeType":{ + "shape":"PostalCodeType", + "documentation":"

The postal code type.

" + }, + "UspsZip":{ + "shape":"UspsZip", + "documentation":"

The ZIP Classification Code, or in other words what type of postal code is it.

" + }, + "UspsZipPlus4":{ + "shape":"UspsZipPlus4", + "documentation":"

The USPS ZIP+4 Record Type Code.

" + } + }, + "documentation":"

Contains details about the postal code of the place or result.

" + }, + "PostalCodeDetailsList":{ + "type":"list", + "member":{"shape":"PostalCodeDetails"}, + "max":100, + "min":0 + }, + "PostalCodeDetailsPostalCodeString":{ + "type":"string", + "max":50, + "min":0 + }, + "PostalCodeMode":{ + "type":"string", + "enum":[ + "MergeAllSpannedLocalities", + "EnumerateSpannedLocalities" + ] + }, + "PostalCodeType":{ + "type":"string", + "enum":[ + "UspsZip", + "UspsZipPlus4" + ] + }, + "QueryRefinement":{ + "type":"structure", + "required":[ + "RefinedTerm", + "OriginalTerm", + "StartIndex", + "EndIndex" + ], + "members":{ + "RefinedTerm":{ + "shape":"QueryRefinementRefinedTermString", + "documentation":"

The term that will be suggested to the user.

" + }, + "OriginalTerm":{ + "shape":"QueryRefinementOriginalTermString", + "documentation":"

The sub-string of the original query that is replaced by this query term.

" + }, + "StartIndex":{ + "shape":"QueryRefinementStartIndexInteger", + "documentation":"

Start index of the parsed component.

" + }, + "EndIndex":{ + "shape":"QueryRefinementEndIndexInteger", + "documentation":"

End index of the parsed query.

" + } + }, + "documentation":"

Suggestions for refining individual query terms. Suggestions are returned as objects which note the term, suggested replacement, and its index in the query.

" + }, + "QueryRefinementEndIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "QueryRefinementList":{ + "type":"list", + "member":{"shape":"QueryRefinement"}, + "max":10, + "min":0 + }, + "QueryRefinementOriginalTermString":{ + "type":"string", + "max":200, + "min":0 + }, + "QueryRefinementRefinedTermString":{ + "type":"string", + "max":200, + "min":0 + }, + "QueryRefinementStartIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "QueryType":{ + "type":"string", + "enum":[ + "Category", + "BusinessChain" + ] + }, + "RecordTypeCode":{ + "type":"string", + "enum":[ + "Firm", + "General", + "HighRise", + "PostOfficeBox", + "Rural", + "Street" + ] + }, + "Region":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"RegionCodeString", + "documentation":"

Abbreviated code for a the state, province or region of the country.

Example: BC.

" + }, + "Name":{ + "shape":"RegionNameString", + "documentation":"

Name for a the state, province, or region of the country.

Example: British Columbia.

" + } + }, + "documentation":"

The region or state results should be to be present in.

Example: North Rhine-Westphalia.

" + }, + "RegionCodeString":{ + "type":"string", + "max":3, + "min":0 + }, + "RegionHighlights":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the region in the text query that match the found title.

" + }, + "Name":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the region name in the text query that match the found title.

" + } + }, + "documentation":"

Indicates the starting and ending index of the region in the text query that match the found title.

" + }, + "RegionNameString":{ + "type":"string", + "max":200, + "min":0 + }, + "ReverseGeocodeAdditionalFeature":{ + "type":"string", + "enum":[ + "TimeZone", + "Access" + ] + }, + "ReverseGeocodeAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"ReverseGeocodeAdditionalFeature"}, + "max":2, + "min":1 + }, + "ReverseGeocodeFilter":{ + "type":"structure", + "members":{ + "IncludePlaceTypes":{ + "shape":"ReverseGeocodeFilterPlaceTypeList", + "documentation":"

The included place types.

" + } + }, + "documentation":"

The included place types.

" + }, + "ReverseGeocodeFilterPlaceType":{ + "type":"string", + "enum":[ + "Locality", + "Intersection", + "Street", + "PointAddress", + "InterpolatedAddress" + ] + }, + "ReverseGeocodeFilterPlaceTypeList":{ + "type":"list", + "member":{"shape":"ReverseGeocodeFilterPlaceType"}, + "max":5, + "min":1 + }, + "ReverseGeocodeIntendedUse":{ + "type":"string", + "enum":[ + "SingleUse", + "Storage" + ] + }, + "ReverseGeocodeRequest":{ + "type":"structure", + "required":["QueryPosition"], + "members":{ + "QueryPosition":{ + "shape":"Position", + "documentation":"

The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

" + }, + "QueryRadius":{ + "shape":"ReverseGeocodeRequestQueryRadiusLong", + "documentation":"

The maximum distance in meters from the QueryPosition from which a result will be returned.

", + "box":true + }, + "MaxResults":{ + "shape":"ReverseGeocodeRequestMaxResultsInteger", + "documentation":"

An optional limit for the number of results returned in a single call.

" + }, + "Filter":{ + "shape":"ReverseGeocodeFilter", + "documentation":"

A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "AdditionalFeatures":{ + "shape":"ReverseGeocodeAdditionalFeatureList", + "documentation":"

A list of optional additional parameters, such as time zone that can be requested for each result.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "IntendedUse":{ + "shape":"ReverseGeocodeIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "ReverseGeocodeRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ReverseGeocodeRequestQueryRadiusLong":{ + "type":"long", + "max":21000000, + "min":1 + }, + "ReverseGeocodeResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "ResultItems":{ + "shape":"ReverseGeocodeResultItemList", + "documentation":"

List of places or results returned for a query.

" + } + } + }, + "ReverseGeocodeResultItem":{ + "type":"structure", + "required":[ + "PlaceId", + "PlaceType", + "Title" + ], + "members":{ + "PlaceId":{ + "shape":"ReverseGeocodeResultItemPlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

A PlaceType is a category that the result place must belong to.

" + }, + "Title":{ + "shape":"ReverseGeocodeResultItemTitleString", + "documentation":"

The localized display name of this result item based on request parameter language.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The place's address.

" + }, + "AddressNumberCorrected":{ + "shape":"Boolean", + "documentation":"

Boolean indicating if the address provided has been corrected.

" + }, + "PostalCodeDetails":{ + "shape":"PostalCodeDetailsList", + "documentation":"

Contains details about the postal code of the place/result.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

The position in longitude and latitude.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The distance in meters from the QueryPosition.

" + }, + "MapView":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong to.

" + }, + "FoodTypes":{ + "shape":"FoodTypeList", + "documentation":"

List of food types offered by this result.

" + }, + "AccessPoints":{ + "shape":"AccessPointList", + "documentation":"

Position of the access point represent by longitude and latitude.

" + }, + "TimeZone":{ + "shape":"TimeZone", + "documentation":"

The time zone in which the place is located.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + } + }, + "documentation":"

The returned location from the Reverse Geocode action.

" + }, + "ReverseGeocodeResultItemList":{ + "type":"list", + "member":{"shape":"ReverseGeocodeResultItem"}, + "max":100, + "min":0 + }, + "ReverseGeocodeResultItemPlaceIdString":{ + "type":"string", + "max":200, + "min":0 + }, + "ReverseGeocodeResultItemTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "SearchNearbyAdditionalFeature":{ + "type":"string", + "enum":[ + "TimeZone", + "Phonemes", + "Access", + "Contact" + ] + }, + "SearchNearbyAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"SearchNearbyAdditionalFeature"}, + "max":4, + "min":1 + }, + "SearchNearbyFilter":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "IncludeCountries":{ + "shape":"CountryCodeList", + "documentation":"

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

" + }, + "IncludeCategories":{ + "shape":"FilterCategoryList", + "documentation":"

Categories of results that results must belong too.

" + }, + "ExcludeCategories":{ + "shape":"FilterCategoryList", + "documentation":"

Categories of results that results are excluded from.

" + }, + "IncludeBusinessChains":{ + "shape":"FilterBusinessChainList", + "documentation":"

The Business Chains associated with the place.

" + }, + "ExcludeBusinessChains":{ + "shape":"FilterBusinessChainList", + "documentation":"

The Business Chains associated with the place.

" + }, + "IncludeFoodTypes":{ + "shape":"FilterFoodTypeList", + "documentation":"

Food types that results are included from.

" + }, + "ExcludeFoodTypes":{ + "shape":"FilterFoodTypeList", + "documentation":"

Food types that results are excluded from.

" + } + }, + "documentation":"

SearchNearby structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "SearchNearbyIntendedUse":{ + "type":"string", + "enum":[ + "SingleUse", + "Storage" + ] + }, + "SearchNearbyRequest":{ + "type":"structure", + "required":["QueryPosition"], + "members":{ + "QueryPosition":{ + "shape":"Position", + "documentation":"

The position, in [lng, lat] for which you are querying nearby resultsfor. Results closer to the position will be ranked higher then results further away from the position

" + }, + "QueryRadius":{ + "shape":"SearchNearbyRequestQueryRadiusLong", + "documentation":"

The maximum distance in meters from the QueryPosition from which a result will be returned.

", + "box":true + }, + "MaxResults":{ + "shape":"SearchNearbyRequestMaxResultsInteger", + "documentation":"

An optional limit for the number of results returned in a single call.

" + }, + "Filter":{ + "shape":"SearchNearbyFilter", + "documentation":"

A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "AdditionalFeatures":{ + "shape":"SearchNearbyAdditionalFeatureList", + "documentation":"

A list of optional additional parameters, such as time zone, that can be requested for each result.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "IntendedUse":{ + "shape":"SearchNearbyIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "SearchNearbyRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "SearchNearbyRequestQueryRadiusLong":{ + "type":"long", + "max":21000000, + "min":1 + }, + "SearchNearbyResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "ResultItems":{ + "shape":"SearchNearbyResultItemList", + "documentation":"

List of places or results returned for a query.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

" + } + } + }, + "SearchNearbyResultItem":{ + "type":"structure", + "required":[ + "PlaceId", + "PlaceType", + "Title" + ], + "members":{ + "PlaceId":{ + "shape":"SearchNearbyResultItemPlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

A PlaceType is a category that the result place must belong to.

" + }, + "Title":{ + "shape":"SearchNearbyResultItemTitleString", + "documentation":"

The item's title.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The place's address.

" + }, + "AddressNumberCorrected":{ + "shape":"Boolean", + "documentation":"

Boolean indicating if the address provided has been corrected.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

The position in longitude and latitude.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The distance in meters from the QueryPosition.

" + }, + "MapView":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong to.

" + }, + "FoodTypes":{ + "shape":"FoodTypeList", + "documentation":"

List of food types offered by this result.

" + }, + "BusinessChains":{ + "shape":"BusinessChainList", + "documentation":"

The Business Chains associated with the place.

" + }, + "Contacts":{ + "shape":"Contacts", + "documentation":"

List of potential contact methods for the result/place.

" + }, + "OpeningHours":{ + "shape":"OpeningHoursList", + "documentation":"

List of opening hours objects.

" + }, + "AccessPoints":{ + "shape":"AccessPointList", + "documentation":"

Position of the access point represent by longitude and latitude.

" + }, + "AccessRestrictions":{ + "shape":"AccessRestrictionList", + "documentation":"

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

" + }, + "TimeZone":{ + "shape":"TimeZone", + "documentation":"

The time zone in which the place is located.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "Phonemes":{ + "shape":"PhonemeDetails", + "documentation":"

How the various components of the result's address are pronounced in various languages.

" + } + }, + "documentation":"

The search results of nearby places.

" + }, + "SearchNearbyResultItemList":{ + "type":"list", + "member":{"shape":"SearchNearbyResultItem"}, + "max":100, + "min":0 + }, + "SearchNearbyResultItemPlaceIdString":{ + "type":"string", + "max":200, + "min":0 + }, + "SearchNearbyResultItemTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "SearchTextAdditionalFeature":{ + "type":"string", + "enum":[ + "TimeZone", + "Phonemes", + "Access", + "Contact" + ] + }, + "SearchTextAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"SearchTextAdditionalFeature"}, + "max":4, + "min":1 + }, + "SearchTextFilter":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Circle":{"shape":"FilterCircle"}, + "IncludeCountries":{ + "shape":"CountryCodeList", + "documentation":"

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

" + } + }, + "documentation":"

SearchText structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "SearchTextIntendedUse":{ + "type":"string", + "enum":[ + "SingleUse", + "Storage" + ] + }, + "SearchTextRequest":{ + "type":"structure", + "members":{ + "QueryText":{ + "shape":"SearchTextRequestQueryTextString", + "documentation":"

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

" + }, + "QueryId":{ + "shape":"SearchTextRequestQueryIdString", + "documentation":"

The query Id.

" + }, + "MaxResults":{ + "shape":"SearchTextRequestMaxResultsInteger", + "documentation":"

An optional limit for the number of results returned in a single call.

" + }, + "BiasPosition":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

" + }, + "Filter":{ + "shape":"SearchTextFilter", + "documentation":"

A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "AdditionalFeatures":{ + "shape":"SearchTextAdditionalFeatureList", + "documentation":"

A list of optional additional parameters, such as time zone, that can be requested for each result.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "IntendedUse":{ + "shape":"SearchTextIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "SearchTextRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "SearchTextRequestQueryIdString":{ + "type":"string", + "max":400, + "min":1, + "sensitive":true + }, + "SearchTextRequestQueryTextString":{ + "type":"string", + "max":200, + "min":1, + "sensitive":true + }, + "SearchTextResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "ResultItems":{ + "shape":"SearchTextResultItemList", + "documentation":"

List of places or results returned for a query.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.

" + } + } + }, + "SearchTextResultItem":{ + "type":"structure", + "required":[ + "PlaceId", + "PlaceType", + "Title" + ], + "members":{ + "PlaceId":{ + "shape":"SearchTextResultItemPlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

A PlaceType is a category that the result place must belong to.

" + }, + "Title":{ + "shape":"SearchTextResultItemTitleString", + "documentation":"

The item's title.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The place's address.

" + }, + "AddressNumberCorrected":{ + "shape":"Boolean", + "documentation":"

Boolean indicating if the address provided has been corrected.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The distance in meters from the QueryPosition.

" + }, + "MapView":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong to.

" + }, + "FoodTypes":{ + "shape":"FoodTypeList", + "documentation":"

List of food types offered by this result.

" + }, + "BusinessChains":{ + "shape":"BusinessChainList", + "documentation":"

The Business Chains associated with the place.

" + }, + "Contacts":{ + "shape":"Contacts", + "documentation":"

List of potential contact methods for the result/place.

" + }, + "OpeningHours":{ + "shape":"OpeningHoursList", + "documentation":"

List of opening hours objects.

" + }, + "AccessPoints":{ + "shape":"AccessPointList", + "documentation":"

Position of the access point represent by longitude and latitude.

" + }, + "AccessRestrictions":{ + "shape":"AccessRestrictionList", + "documentation":"

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

" + }, + "TimeZone":{ + "shape":"TimeZone", + "documentation":"

The time zone in which the place is located.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "Phonemes":{ + "shape":"PhonemeDetails", + "documentation":"

How the various components of the result's address are pronounced in various languages.

" + } + }, + "documentation":"

The text search result.

" + }, + "SearchTextResultItemList":{ + "type":"list", + "member":{"shape":"SearchTextResultItem"}, + "max":100, + "min":0 + }, + "SearchTextResultItemPlaceIdString":{ + "type":"string", + "max":200, + "min":0 + }, + "SearchTextResultItemTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "StreetComponents":{ + "type":"structure", + "members":{ + "BaseName":{ + "shape":"StreetComponentsBaseNameString", + "documentation":"

Base name part of the street name.

Example: Younge from the “Younge street\".

" + }, + "Type":{ + "shape":"StreetComponentsTypeString", + "documentation":"

Street type part of the street name.

Example: “avenue\".

" + }, + "TypePlacement":{ + "shape":"TypePlacement", + "documentation":"

Defines if the street type is before or after the base name.

" + }, + "TypeSeparator":{ + "shape":"TypeSeparator", + "documentation":"

What character(s) separates the string from its type.

" + }, + "Prefix":{ + "shape":"StreetComponentsPrefixString", + "documentation":"

A prefix is a directional identifier that precedes, but is not included in, the base name of a road.

Example: E for East.

" + }, + "Suffix":{ + "shape":"StreetComponentsSuffixString", + "documentation":"

A suffix is a directional identifier that follows, but is not included in, the base name of a road.

Example W for West.

" + }, + "Direction":{ + "shape":"StreetComponentsDirectionString", + "documentation":"

Indicates the official directional identifiers assigned to highways.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + } + }, + "documentation":"

Components of a street.

" + }, + "StreetComponentsBaseNameString":{ + "type":"string", + "max":200, + "min":0 + }, + "StreetComponentsDirectionString":{ + "type":"string", + "max":50, + "min":0 + }, + "StreetComponentsList":{ + "type":"list", + "member":{"shape":"StreetComponents"}, + "max":100, + "min":0 + }, + "StreetComponentsPrefixString":{ + "type":"string", + "max":50, + "min":0 + }, + "StreetComponentsSuffixString":{ + "type":"string", + "max":50, + "min":0 + }, + "StreetComponentsTypeString":{ + "type":"string", + "max":50, + "min":0 + }, + "String":{"type":"string"}, + "SubRegion":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"SubRegionCodeString", + "documentation":"

Abbreviated code for the county or sub-region.

" + }, + "Name":{ + "shape":"SubRegionNameString", + "documentation":"

Name for the county or sub-region.

" + } + }, + "documentation":"

The sub-region.

" + }, + "SubRegionCodeString":{ + "type":"string", + "max":3, + "min":0 + }, + "SubRegionHighlights":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the sub-region in the text query that match the found title.

" + }, + "Name":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the name in the text query that match the found title.

" + } + }, + "documentation":"

Indicates the starting and ending index of the sub-region in the text query that match the found title.

" + }, + "SubRegionNameString":{ + "type":"string", + "max":200, + "min":0 + }, + "SuggestAdditionalFeature":{ + "type":"string", + "enum":[ + "Core", + "TimeZone", + "Phonemes", + "Access" + ] + }, + "SuggestAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"SuggestAdditionalFeature"}, + "max":4, + "min":1 + }, + "SuggestAddressHighlights":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending indexes of the places in the result which were identified to match the textQuery. This result is useful for providing emphasis to results where the user query directly matched to make selecting the correct result from a list easier for an end user.

" + } + }, + "documentation":"

Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.

" + }, + "SuggestFilter":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Circle":{"shape":"FilterCircle"}, + "IncludeCountries":{ + "shape":"CountryCodeList", + "documentation":"

A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

" + } + }, + "documentation":"

SuggestFilter structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "SuggestHighlights":{ + "type":"structure", + "members":{ + "Title":{ + "shape":"HighlightList", + "documentation":"

Indicates the starting and ending index of the title in the text query that match the found title.

" + }, + "Address":{ + "shape":"SuggestAddressHighlights", + "documentation":"

The place's address.

" + } + }, + "documentation":"

Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.

" + }, + "SuggestIntendedUse":{ + "type":"string", + "enum":["SingleUse"] + }, + "SuggestPlaceResult":{ + "type":"structure", + "members":{ + "PlaceId":{ + "shape":"SuggestPlaceResultPlaceIdString", + "documentation":"

The PlaceId of the place you wish to receive the information for.

" + }, + "PlaceType":{ + "shape":"PlaceType", + "documentation":"

A PlaceType is a category that the result place must belong to.

" + }, + "Address":{ + "shape":"Address", + "documentation":"

The place's address.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The distance in meters from the QueryPosition.

" + }, + "MapView":{ + "shape":"BoundingBox", + "documentation":"

The bounding box enclosing the geometric shape (area or line) that an individual result covers.

The bounding box formed is defined as a set 4 coordinates: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]

" + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

Categories of results that results must belong to.

" + }, + "FoodTypes":{ + "shape":"FoodTypeList", + "documentation":"

List of food types offered by this result.

" + }, + "BusinessChains":{ + "shape":"BusinessChainList", + "documentation":"

The Business Chains associated with the place.

" + }, + "AccessPoints":{ + "shape":"AccessPointList", + "documentation":"

Position of the access point represent by longitude and latitude.

" + }, + "AccessRestrictions":{ + "shape":"AccessRestrictionList", + "documentation":"

Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

" + }, + "TimeZone":{ + "shape":"TimeZone", + "documentation":"

The time zone in which the place is located.

" + }, + "PoliticalView":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "Phonemes":{ + "shape":"PhonemeDetails", + "documentation":"

How the various components of the result's address are pronounced in various languages.

" + } + }, + "documentation":"

The suggested place results.

" + }, + "SuggestPlaceResultPlaceIdString":{ + "type":"string", + "max":200, + "min":1 + }, + "SuggestQueryResult":{ + "type":"structure", + "members":{ + "QueryId":{ + "shape":"SuggestQueryResultQueryIdString", + "documentation":"

QueryId can be used to complete a follow up query through the SearchText API. The QueryId retains context from the original Suggest request such as filters, political view and language. See the SearchText API documentation for more details SearchText API docs.

" + }, + "QueryType":{ + "shape":"QueryType", + "documentation":"

The query type. Category qeuries will search for places which have an entry matching the given category, for example \"doctor office\". BusinessChain queries will search for instances of a given business.

" + } + }, + "documentation":"

The suggested query results.

" + }, + "SuggestQueryResultQueryIdString":{ + "type":"string", + "max":400, + "min":0 + }, + "SuggestRequest":{ + "type":"structure", + "required":["QueryText"], + "members":{ + "QueryText":{ + "shape":"SuggestRequestQueryTextString", + "documentation":"

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.

" + }, + "MaxResults":{ + "shape":"SuggestRequestMaxResultsInteger", + "documentation":"

An optional limit for the number of results returned in a single call.

" + }, + "MaxQueryRefinements":{ + "shape":"SuggestRequestMaxQueryRefinementsInteger", + "documentation":"

Maximum number of query terms to be returned for use with a search text query.

" + }, + "BiasPosition":{ + "shape":"Position", + "documentation":"

The position, in longitude and latitude, that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.

" + }, + "Filter":{ + "shape":"SuggestFilter", + "documentation":"

A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

" + }, + "AdditionalFeatures":{ + "shape":"SuggestAdditionalFeatureList", + "documentation":"

A list of optional additional parameters, such as time zone, that can be requested for each result.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

" + }, + "PoliticalView":{ + "shape":"CountryCode", + "documentation":"

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

" + }, + "IntendedUse":{ + "shape":"SuggestIntendedUse", + "documentation":"

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + } + } + }, + "SuggestRequestMaxQueryRefinementsInteger":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "SuggestRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "SuggestRequestQueryTextString":{ + "type":"string", + "max":200, + "min":1, + "sensitive":true + }, + "SuggestResponse":{ + "type":"structure", + "required":["PricingBucket"], + "members":{ + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

For more inforamtion on pricing, please visit Amazon Location Service Pricing.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "ResultItems":{ + "shape":"SuggestResultItemList", + "documentation":"

List of places or results returned for a query.

" + }, + "QueryRefinements":{ + "shape":"QueryRefinementList", + "documentation":"

Maximum number of query terms to be returned for use with a search text query.

" + } + } + }, + "SuggestResultItem":{ + "type":"structure", + "required":[ + "Title", + "SuggestResultItemType" + ], + "members":{ + "Title":{ + "shape":"SuggestResultItemTitleString", + "documentation":"

The display title that should be used when presenting this option to the end user.

" + }, + "SuggestResultItemType":{ + "shape":"SuggestResultItemType", + "documentation":"

The result type. Place results represent the final result for a point of interest, Query results represent a follow up query which can be completed through the SearchText operation.

" + }, + "Place":{ + "shape":"SuggestPlaceResult", + "documentation":"

The suggested place by its unique ID.

" + }, + "Query":{"shape":"SuggestQueryResult"}, + "Highlights":{ + "shape":"SuggestHighlights", + "documentation":"

Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.

" + } + }, + "documentation":"

The resulting item from the suggested query.

" + }, + "SuggestResultItemList":{ + "type":"list", + "member":{"shape":"SuggestResultItem"}, + "max":100, + "min":0 + }, + "SuggestResultItemTitleString":{ + "type":"string", + "max":200, + "min":0 + }, + "SuggestResultItemType":{ + "type":"string", + "enum":[ + "Place", + "Query" + ] + }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request was denied due to request throttling.

", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "TimeZone":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"TimeZoneNameString", + "documentation":"

The time zone name.

" + }, + "Offset":{ + "shape":"TimeZoneOffsetString", + "documentation":"

Time zone offset of the timezone from UTC.

" + }, + "OffsetSeconds":{ + "shape":"TimeZoneOffsetSecondsLong", + "documentation":"

The offset of the time zone from UTC, in seconds.

" + } + }, + "documentation":"

The time zone in which the place is located.

" + }, + "TimeZoneNameString":{ + "type":"string", + "max":200, + "min":0 + }, + "TimeZoneOffsetSecondsLong":{ + "type":"long", + "min":0 + }, + "TimeZoneOffsetString":{ + "type":"string", + "max":6, + "min":0 + }, + "Token":{ + "type":"string", + "max":2000, + "min":1 + }, + "TypePlacement":{ + "type":"string", + "enum":[ + "BeforeBaseName", + "AfterBaseName" + ] + }, + "TypeSeparator":{ + "type":"string", + "max":1, + "min":0, + "pattern":"$|^ " + }, + "UspsZip":{ + "type":"structure", + "members":{ + "ZipClassificationCode":{ + "shape":"ZipClassificationCode", + "documentation":"

The ZIP Classification Code, or in other words what type of postal code is it.

" + } + }, + "documentation":"

The USPS zip code.

" + }, + "UspsZipPlus4":{ + "type":"structure", + "members":{ + "RecordTypeCode":{ + "shape":"RecordTypeCode", + "documentation":"

The USPS ZIP+4 Record Type Code.

" + } + }, + "documentation":"

The USPS zip+4 code.

" + }, + "ValidationException":{ + "type":"structure", + "required":[ + "Message", + "Reason", + "FieldList" + ], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + }, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"

Test stub for reason

", + "locationName":"reason" + }, + "FieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"

Test stub for FieldList.

", + "locationName":"fieldList" + } + }, + "documentation":"

The input fails to satisfy the constraints specified by an AWS service.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the resource.

", + "locationName":"name" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

The input fails to satisfy the constraints specified by the Amazon Location service.

" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UnknownOperation", + "Missing", + "CannotParse", + "FieldValidationFailed", + "Other", + "UnknownField" + ] + }, + "ZipClassificationCode":{ + "type":"string", + "enum":[ + "Military", + "PostOfficeBoxes", + "Unique" + ] + } + }, + "documentation":"

The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include:

" +} diff --git a/botocore/data/geo-routes/2020-11-19/endpoint-rule-set-1.json b/botocore/data/geo-routes/2020-11-19/endpoint-rule-set-1.json new file mode 100644 index 0000000000..caebb42f6e --- /dev/null +++ b/botocore/data/geo-routes/2020-11-19/endpoint-rule-set-1.json @@ -0,0 +1,688 @@ +{ + "version": "1.0", + "parameters": { + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://routes.geo.{Region}.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://routes.geo-fips.{Region}.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://routes.geo-fips.{Region}.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://routes.geo.{Region}.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://routes.geo.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://routes.geo-fips.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://routes.geo-fips.{Region}.us-gov.{PartitionResult#dnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "endpoint": { + "url": "https://routes.geo.{Region}.us-gov.{PartitionResult#dualStackDnsSuffix}/v2", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-routes-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-routes-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://geo-routes.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://geo-routes.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/botocore/data/geo-routes/2020-11-19/paginators-1.json b/botocore/data/geo-routes/2020-11-19/paginators-1.json new file mode 100644 index 0000000000..ea142457a6 --- /dev/null +++ b/botocore/data/geo-routes/2020-11-19/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/botocore/data/geo-routes/2020-11-19/service-2.json b/botocore/data/geo-routes/2020-11-19/service-2.json new file mode 100644 index 0000000000..d1e8278842 --- /dev/null +++ b/botocore/data/geo-routes/2020-11-19/service-2.json @@ -0,0 +1,6531 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-11-19", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"geo-routes", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"Amazon Location Service Routes V2", + "serviceId":"Geo Routes", + "signatureVersion":"v4", + "signingName":"geo-routes", + "uid":"geo-routes-2020-11-19" + }, + "operations":{ + "CalculateIsolines":{ + "name":"CalculateIsolines", + "http":{ + "method":"POST", + "requestUri":"/isolines", + "responseCode":200 + }, + "input":{"shape":"CalculateIsolinesRequest"}, + "output":{"shape":"CalculateIsolinesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Use the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.

" + }, + "CalculateRouteMatrix":{ + "name":"CalculateRouteMatrix", + "http":{ + "method":"POST", + "requestUri":"/route-matrix", + "responseCode":200 + }, + "input":{"shape":"CalculateRouteMatrixRequest"}, + "output":{"shape":"CalculateRouteMatrixResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Calculates route matrix containing the results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

" + }, + "CalculateRoutes":{ + "name":"CalculateRoutes", + "http":{ + "method":"POST", + "requestUri":"/routes", + "responseCode":200 + }, + "input":{"shape":"CalculateRoutesRequest"}, + "output":{"shape":"CalculateRoutesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Calculates a route given the following required parameters: Origin and Destination.

" + }, + "OptimizeWaypoints":{ + "name":"OptimizeWaypoints", + "http":{ + "method":"POST", + "requestUri":"/optimize-waypoints", + "responseCode":200 + }, + "input":{"shape":"OptimizeWaypointsRequest"}, + "output":{"shape":"OptimizeWaypointsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.

" + }, + "SnapToRoads":{ + "name":"SnapToRoads", + "http":{ + "method":"POST", + "requestUri":"/snap-to-roads", + "responseCode":200 + }, + "input":{"shape":"SnapToRoadsRequest"}, + "output":{"shape":"SnapToRoadsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

The SnapToRoads action matches GPS trace to roads most likely traveled on.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

You don't have sufficient access to perform this action.

", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ApiKey":{ + "type":"string", + "max":1000, + "min":0, + "sensitive":true + }, + "BeforeWaypointsList":{ + "type":"list", + "member":{"shape":"WaypointIndex"} + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "BoundingBox":{ + "type":"list", + "member":{"shape":"Double"}, + "max":4, + "min":4, + "sensitive":true + }, + "CalculateIsolinesRequest":{ + "type":"structure", + "required":["Thresholds"], + "members":{ + "Allow":{ + "shape":"IsolineAllowOptions", + "documentation":"

Features that are allowed while calculating. a route

" + }, + "ArrivalTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of arrival at the destination.

Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Avoid":{ + "shape":"IsolineAvoidanceOptions", + "documentation":"

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" + }, + "DepartNow":{ + "shape":"Boolean", + "documentation":"

Uses the current time as the time of departure.

" + }, + "DepartureTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Destination":{ + "shape":"Position", + "documentation":"

The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

" + }, + "DestinationOptions":{ + "shape":"IsolineDestinationOptions", + "documentation":"

Destination related options.

" + }, + "IsolineGeometryFormat":{ + "shape":"GeometryFormat", + "documentation":"

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

" + }, + "IsolineGranularity":{ + "shape":"IsolineGranularityOptions", + "documentation":"

Defines the granularity of the returned Isoline

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + }, + "OptimizeIsolineFor":{ + "shape":"IsolineOptimizationObjective", + "documentation":"

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: BalancedCalculation

" + }, + "OptimizeRoutingFor":{ + "shape":"RoutingObjective", + "documentation":"

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

" + }, + "Origin":{ + "shape":"Position", + "documentation":"

The start position for the route.

" + }, + "OriginOptions":{ + "shape":"IsolineOriginOptions", + "documentation":"

Origin related options.

" + }, + "Thresholds":{ + "shape":"IsolineThresholds", + "documentation":"

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.

" + }, + "Traffic":{ + "shape":"IsolineTrafficOptions", + "documentation":"

Traffic related options.

" + }, + "TravelMode":{ + "shape":"IsolineTravelMode", + "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.

Default Value: Car

" + }, + "TravelModeOptions":{ + "shape":"IsolineTravelModeOptions", + "documentation":"

Travel mode related options for the provided travel mode.

" + } + } + }, + "CalculateIsolinesResponse":{ + "type":"structure", + "required":[ + "IsolineGeometryFormat", + "Isolines", + "PricingBucket" + ], + "members":{ + "ArrivalTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of arrival at the destination. This parameter is returned only if the Destination parameters was provided in the request.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "DepartureTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "IsolineGeometryFormat":{ + "shape":"GeometryFormat", + "documentation":"

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

" + }, + "Isolines":{ + "shape":"IsolineList", + "documentation":"

Calculated isolines and associated properties.

" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "SnappedDestination":{ + "shape":"Position", + "documentation":"

Snapped destination that was used for the Isoline calculation.

" + }, + "SnappedOrigin":{ + "shape":"Position", + "documentation":"

Snapped origin that was used for the Isoline calculation.

" + } + } + }, + "CalculateRouteMatrixRequest":{ + "type":"structure", + "required":[ + "Destinations", + "Origins", + "RoutingBoundary" + ], + "members":{ + "Allow":{ + "shape":"RouteMatrixAllowOptions", + "documentation":"

Features that are allowed while calculating. a route

" + }, + "Avoid":{ + "shape":"RouteMatrixAvoidanceOptions", + "documentation":"

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" + }, + "DepartNow":{ + "shape":"Boolean", + "documentation":"

Uses the current time as the time of departure.

" + }, + "DepartureTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Destinations":{ + "shape":"CalculateRouteMatrixRequestDestinationsList", + "documentation":"

List of destinations for the route.

" + }, + "Exclude":{ + "shape":"RouteMatrixExclusionOptions", + "documentation":"

Features to be strictly excluded while calculating the route.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + }, + "OptimizeRoutingFor":{ + "shape":"RoutingObjective", + "documentation":"

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

" + }, + "Origins":{ + "shape":"CalculateRouteMatrixRequestOriginsList", + "documentation":"

The position in longitude and latitude for the origin.

" + }, + "RoutingBoundary":{ + "shape":"RouteMatrixBoundary", + "documentation":"

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

" + }, + "Traffic":{ + "shape":"RouteMatrixTrafficOptions", + "documentation":"

Traffic related options.

" + }, + "TravelMode":{ + "shape":"RouteMatrixTravelMode", + "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" + }, + "TravelModeOptions":{ + "shape":"RouteMatrixTravelModeOptions", + "documentation":"

Travel mode related options for the provided travel mode.

" + } + } + }, + "CalculateRouteMatrixRequestDestinationsList":{ + "type":"list", + "member":{"shape":"RouteMatrixDestination"}, + "min":1 + }, + "CalculateRouteMatrixRequestOriginsList":{ + "type":"list", + "member":{"shape":"RouteMatrixOrigin"}, + "min":1 + }, + "CalculateRouteMatrixResponse":{ + "type":"structure", + "required":[ + "ErrorCount", + "PricingBucket", + "RouteMatrix", + "RoutingBoundary" + ], + "members":{ + "ErrorCount":{ + "shape":"CalculateRouteMatrixResponseErrorCountInteger", + "documentation":"

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "RouteMatrix":{ + "shape":"RouteMatrix", + "documentation":"

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

" + }, + "RoutingBoundary":{ + "shape":"RouteMatrixBoundary", + "documentation":"

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

" + } + } + }, + "CalculateRouteMatrixResponseErrorCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "CalculateRoutesRequest":{ + "type":"structure", + "required":[ + "Destination", + "Origin" + ], + "members":{ + "Allow":{ + "shape":"RouteAllowOptions", + "documentation":"

Features that are allowed while calculating. a route

" + }, + "ArrivalTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Avoid":{ + "shape":"RouteAvoidanceOptions", + "documentation":"

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" + }, + "DepartNow":{ + "shape":"Boolean", + "documentation":"

Uses the current time as the time of departure.

" + }, + "DepartureTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Destination":{ + "shape":"Position", + "documentation":"

The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

" + }, + "DestinationOptions":{ + "shape":"RouteDestinationOptions", + "documentation":"

Destination related options.

" + }, + "Driver":{ + "shape":"RouteDriverOptions", + "documentation":"

Driver related options.

" + }, + "Exclude":{ + "shape":"RouteExclusionOptions", + "documentation":"

Features to be strictly excluded while calculating the route.

" + }, + "InstructionsMeasurementSystem":{ + "shape":"MeasurementSystem", + "documentation":"

Measurement system to be used for instructions within steps in the response.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + }, + "Languages":{ + "shape":"CalculateRoutesRequestLanguagesList", + "documentation":"

List of languages for instructions within steps in the response.

Instructions in the requested language are returned only if they are available.

" + }, + "LegAdditionalFeatures":{ + "shape":"RouteLegAdditionalFeatureList", + "documentation":"

A list of optional additional parameters such as timezone that can be requested for each result.

" + }, + "LegGeometryFormat":{ + "shape":"GeometryFormat", + "documentation":"

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

" + }, + "MaxAlternatives":{ + "shape":"CalculateRoutesRequestMaxAlternativesInteger", + "documentation":"

Maximum number of alternative routes to be provided in the response, if available.

" + }, + "OptimizeRoutingFor":{ + "shape":"RoutingObjective", + "documentation":"

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

" + }, + "Origin":{ + "shape":"Position", + "documentation":"

The start position for the route.

" + }, + "OriginOptions":{ + "shape":"RouteOriginOptions", + "documentation":"

Origin related options.

" + }, + "SpanAdditionalFeatures":{ + "shape":"RouteSpanAdditionalFeatureList", + "documentation":"

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

" + }, + "Tolls":{ + "shape":"RouteTollOptions", + "documentation":"

Toll related options.

" + }, + "Traffic":{ + "shape":"RouteTrafficOptions", + "documentation":"

Traffic related options.

" + }, + "TravelMode":{ + "shape":"RouteTravelMode", + "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" + }, + "TravelModeOptions":{ + "shape":"RouteTravelModeOptions", + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "TravelStepType":{ + "shape":"RouteTravelStepType", + "documentation":"

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based naviagtion system.

" + }, + "Waypoints":{ + "shape":"RouteWaypointList", + "documentation":"

List of waypoints between the Origin and Destination.

" + } + } + }, + "CalculateRoutesRequestLanguagesList":{ + "type":"list", + "member":{"shape":"LanguageTag"}, + "max":10, + "min":0 + }, + "CalculateRoutesRequestMaxAlternativesInteger":{ + "type":"integer", + "box":true, + "max":5, + "min":0 + }, + "CalculateRoutesResponse":{ + "type":"structure", + "required":[ + "LegGeometryFormat", + "Notices", + "PricingBucket", + "Routes" + ], + "members":{ + "LegGeometryFormat":{ + "shape":"GeometryFormat", + "documentation":"

Specifies the format of the geometry returned for each leg of the route.

" + }, + "Notices":{ + "shape":"RouteResponseNoticeList", + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The path from the origin to the destination.

" + } + } + }, + "Circle":{ + "type":"structure", + "required":[ + "Center", + "Radius" + ], + "members":{ + "Center":{ + "shape":"Position", + "documentation":"

Center of the Circle defined in longitude and latitude coordinates.

Example: [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.

" + }, + "Radius":{ + "shape":"Double", + "documentation":"

Radius of the Circle.

Unit: meters

" + } + }, + "documentation":"

Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

", + "sensitive":true + }, + "Corridor":{ + "type":"structure", + "required":[ + "LineString", + "Radius" + ], + "members":{ + "LineString":{ + "shape":"LineString", + "documentation":"

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" + }, + "Radius":{ + "shape":"Integer", + "documentation":"

Radius that defines the width of the corridor.

" + } + }, + "documentation":"

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

", + "sensitive":true + }, + "CountryCode":{ + "type":"string", + "max":3, + "min":2, + "pattern":"([A-Z]{2}|[A-Z]{3})" + }, + "CountryCode3":{ + "type":"string", + "max":3, + "min":3, + "pattern":"[A-Z]{3}" + }, + "CountryCodeList":{ + "type":"list", + "member":{"shape":"CountryCode"}, + "max":100, + "min":1 + }, + "CurrencyCode":{ + "type":"string", + "max":3, + "min":3, + "pattern":"[A-Z]{3}" + }, + "DayOfWeek":{ + "type":"string", + "enum":[ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ] + }, + "DimensionCentimeters":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "DistanceMeters":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "DistanceThresholdList":{ + "type":"list", + "member":{"shape":"DistanceThresholdListMemberLong"}, + "max":5, + "min":1 + }, + "DistanceThresholdListMemberLong":{ + "type":"long", + "max":300000, + "min":0 + }, + "Double":{ + "type":"double", + "box":true + }, + "DurationSeconds":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "GeometryFormat":{ + "type":"string", + "enum":[ + "FlexiblePolyline", + "Simple" + ] + }, + "Heading":{ + "type":"double", + "max":360.0, + "min":0.0 + }, + "IndexList":{ + "type":"list", + "member":{"shape":"Integer"} + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "Isoline":{ + "type":"structure", + "required":[ + "Connections", + "Geometries" + ], + "members":{ + "Connections":{ + "shape":"IsolineConnectionList", + "documentation":"

Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.

" + }, + "DistanceThreshold":{ + "shape":"DistanceMeters", + "documentation":"

Distance threshold corresponding to the calculated Isoline.

" + }, + "Geometries":{ + "shape":"IsolineShapeGeometryList", + "documentation":"

Geometries for the Calculated isolines.

" + }, + "TimeThreshold":{ + "shape":"DurationSeconds", + "documentation":"

Time threshold corresponding to the calculated isoline.

" + } + }, + "documentation":"

Calculated isolines and associated properties.

" + }, + "IsolineAllowOptions":{ + "type":"structure", + "members":{ + "Hot":{ + "shape":"Boolean", + "documentation":"

Allow Hot (High Occupancy Toll) lanes while calculating the route.

" + }, + "Hov":{ + "shape":"Boolean", + "documentation":"

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

" + } + }, + "documentation":"

Features that are allowed while calculating. a route

" + }, + "IsolineAvoidanceArea":{ + "type":"structure", + "required":["Geometry"], + "members":{ + "Except":{ + "shape":"IsolineAvoidanceAreaGeometryList", + "documentation":"

Exceptions to the provided avoidance geometry, to be included while calculating the route.

" + }, + "Geometry":{ + "shape":"IsolineAvoidanceAreaGeometry", + "documentation":"

Geometry of the area to be avoided.

" + } + }, + "documentation":"

The area to be avoided.

" + }, + "IsolineAvoidanceAreaGeometry":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + }, + "Corridor":{ + "shape":"Corridor", + "documentation":"

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

" + }, + "Polygon":{ + "shape":"IsolineAvoidanceAreaGeometryPolygonList", + "documentation":"

A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon.

" + }, + "PolylineCorridor":{ + "shape":"PolylineCorridor", + "documentation":"

Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + }, + "PolylinePolygon":{ + "shape":"IsolineAvoidanceAreaGeometryPolylinePolygonList", + "documentation":"

A list of PolylinePolygon's that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + } + }, + "documentation":"

The avoidance geometry, to be included while calculating the route.

" + }, + "IsolineAvoidanceAreaGeometryList":{ + "type":"list", + "member":{"shape":"IsolineAvoidanceAreaGeometry"} + }, + "IsolineAvoidanceAreaGeometryPolygonList":{ + "type":"list", + "member":{"shape":"LinearRing"}, + "max":1, + "min":1 + }, + "IsolineAvoidanceAreaGeometryPolylinePolygonList":{ + "type":"list", + "member":{"shape":"PolylineRing"}, + "max":1, + "min":1 + }, + "IsolineAvoidanceAreaList":{ + "type":"list", + "member":{"shape":"IsolineAvoidanceArea"} + }, + "IsolineAvoidanceOptions":{ + "type":"structure", + "members":{ + "Areas":{ + "shape":"IsolineAvoidanceAreaList", + "documentation":"

Areas to be avoided.

" + }, + "CarShuttleTrains":{ + "shape":"Boolean", + "documentation":"

Avoid car-shuttle-trains while calculating the route.

" + }, + "ControlledAccessHighways":{ + "shape":"Boolean", + "documentation":"

Avoid controlled access highways while calculating the route.

" + }, + "DirtRoads":{ + "shape":"Boolean", + "documentation":"

Avoid dirt roads while calculating the route.

" + }, + "Ferries":{ + "shape":"Boolean", + "documentation":"

Avoid ferries while calculating the route.

" + }, + "SeasonalClosure":{ + "shape":"Boolean", + "documentation":"

Avoid roads that have seasonal closure while calculating the route.

" + }, + "TollRoads":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "TollTransponders":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "TruckRoadTypes":{ + "shape":"TruckRoadTypeList", + "documentation":"

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" + }, + "Tunnels":{ + "shape":"Boolean", + "documentation":"

Avoid tunnels while calculating the route.

" + }, + "UTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + }, + "ZoneCategories":{ + "shape":"IsolineAvoidanceZoneCategoryList", + "documentation":"

Zone categories to be avoided.

" + } + }, + "documentation":"

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

" + }, + "IsolineAvoidanceZoneCategory":{ + "type":"structure", + "members":{ + "Category":{ + "shape":"IsolineZoneCategory", + "documentation":"

Zone category to be avoided.

" + } + }, + "documentation":"

Zone category to be avoided.

" + }, + "IsolineAvoidanceZoneCategoryList":{ + "type":"list", + "member":{"shape":"IsolineAvoidanceZoneCategory"}, + "max":3, + "min":0 + }, + "IsolineCarOptions":{ + "type":"structure", + "members":{ + "EngineType":{ + "shape":"IsolineEngineType", + "documentation":"

Engine type of the vehicle.

" + }, + "LicensePlate":{ + "shape":"IsolineVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"IsolineCarOptionsMaxSpeedDouble", + "documentation":"

Maximum speed.

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"IsolineCarOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + } + }, + "documentation":"

Options for vehicles.

" + }, + "IsolineCarOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "IsolineCarOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "IsolineConnection":{ + "type":"structure", + "required":[ + "FromPolygonIndex", + "Geometry", + "ToPolygonIndex" + ], + "members":{ + "FromPolygonIndex":{ + "shape":"IsolineConnectionFromPolygonIndexInteger", + "documentation":"

Index of the polygon corresponding to the \"from\" component of the connection. The polygon is available from Isoline[].Geometries.

" + }, + "Geometry":{ + "shape":"IsolineConnectionGeometry", + "documentation":"

The isoline geometry.

" + }, + "ToPolygonIndex":{ + "shape":"IsolineConnectionToPolygonIndexInteger", + "documentation":"

Index of the polygon corresponding to the \"to\" component of the connection. The polygon is available from Isoline[].Geometries.

" + } + }, + "documentation":"

Isolines may contain multiple components, if these components are connected by ferry links. These components are returned as separate polygons while the ferry links are returned as connections.

" + }, + "IsolineConnectionFromPolygonIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "IsolineConnectionGeometry":{ + "type":"structure", + "members":{ + "LineString":{ + "shape":"LineString", + "documentation":"

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" + }, + "Polyline":{ + "shape":"Polyline", + "documentation":"

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" + } + }, + "documentation":"

Geometry of the connection between different Isoline components.

" + }, + "IsolineConnectionList":{ + "type":"list", + "member":{"shape":"IsolineConnection"} + }, + "IsolineConnectionToPolygonIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "IsolineDestinationOptions":{ + "type":"structure", + "members":{ + "AvoidActionsForDistance":{ + "shape":"DistanceMeters", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"IsolineMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "SideOfStreet":{ + "shape":"IsolineSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Destination related options.

" + }, + "IsolineEngineType":{ + "type":"string", + "enum":[ + "Electric", + "InternalCombustion", + "PluginHybrid" + ] + }, + "IsolineGranularityOptions":{ + "type":"structure", + "members":{ + "MaxPoints":{ + "shape":"IsolineGranularityOptionsMaxPointsInteger", + "documentation":"

Maximum number of points of returned Isoline.

" + }, + "MaxResolution":{ + "shape":"DistanceMeters", + "documentation":"

Maximum resolution of the returned isoline.

Unit: centimeters

" + } + }, + "documentation":"

Isoline granularity related options.

" + }, + "IsolineGranularityOptionsMaxPointsInteger":{ + "type":"integer", + "box":true, + "min":31 + }, + "IsolineHazardousCargoType":{ + "type":"string", + "enum":[ + "Combustible", + "Corrosive", + "Explosive", + "Flammable", + "Gas", + "HarmfulToWater", + "Organic", + "Other", + "Poison", + "PoisonousInhalation", + "Radioactive" + ] + }, + "IsolineHazardousCargoTypeList":{ + "type":"list", + "member":{"shape":"IsolineHazardousCargoType"}, + "max":11, + "min":0 + }, + "IsolineList":{ + "type":"list", + "member":{"shape":"Isoline"}, + "max":5, + "min":1 + }, + "IsolineMatchingOptions":{ + "type":"structure", + "members":{ + "NameHint":{ + "shape":"SensitiveString", + "documentation":"

Attempts to match the provided position to a road similar to the provided name.

" + }, + "OnRoadThreshold":{ + "shape":"DistanceMeters", + "documentation":"

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

" + }, + "Radius":{ + "shape":"DistanceMeters", + "documentation":"

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" + }, + "Strategy":{ + "shape":"MatchingStrategy", + "documentation":"

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

" + } + }, + "documentation":"

Isoline matching related options.

" + }, + "IsolineOptimizationObjective":{ + "type":"string", + "enum":[ + "AccurateCalculation", + "BalancedCalculation", + "FastCalculation" + ] + }, + "IsolineOriginOptions":{ + "type":"structure", + "members":{ + "AvoidActionsForDistance":{ + "shape":"DistanceMeters", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"IsolineMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "SideOfStreet":{ + "shape":"IsolineSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Options for the property.

" + }, + "IsolineScooterOptions":{ + "type":"structure", + "members":{ + "EngineType":{ + "shape":"IsolineEngineType", + "documentation":"

Engine type of the vehicle.

" + }, + "LicensePlate":{ + "shape":"IsolineVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"IsolineScooterOptionsMaxSpeedDouble", + "documentation":"

Maximum speed specified.

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"IsolineScooterOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + } + }, + "documentation":"

Options for the property.

" + }, + "IsolineScooterOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "IsolineScooterOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "IsolineShapeGeometry":{ + "type":"structure", + "members":{ + "Polygon":{ + "shape":"LinearRings", + "documentation":"

A list of Isoline Polygons, for each isoline polygon, it contains polygons of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings).

" + }, + "PolylinePolygon":{ + "shape":"PolylineRingList", + "documentation":"

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + } + }, + "documentation":"

Geometry of the connection between different Isoline components.

" + }, + "IsolineShapeGeometryList":{ + "type":"list", + "member":{"shape":"IsolineShapeGeometry"} + }, + "IsolineSideOfStreetOptions":{ + "type":"structure", + "required":["Position"], + "members":{ + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "UseWith":{ + "shape":"SideOfStreetMatchingStrategy", + "documentation":"

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

" + } + }, + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "IsolineThresholds":{ + "type":"structure", + "members":{ + "Distance":{ + "shape":"DistanceThresholdList", + "documentation":"

Distance to be used for the isoline calculation.

" + }, + "Time":{ + "shape":"TimeThresholdList", + "documentation":"

Time to be used for the isoline calculation.

" + } + }, + "documentation":"

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.

" + }, + "IsolineTrafficOptions":{ + "type":"structure", + "members":{ + "FlowEventThresholdOverride":{ + "shape":"DurationSeconds", + "documentation":"

Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

Unit: seconds

" + }, + "Usage":{ + "shape":"TrafficUsage", + "documentation":"

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" + } + }, + "documentation":"

Options related to traffic.

" + }, + "IsolineTrailerOptions":{ + "type":"structure", + "members":{ + "AxleCount":{ + "shape":"IsolineTrailerOptionsAxleCountInteger", + "documentation":"

Total number of axles of the vehicle.

" + }, + "TrailerCount":{ + "shape":"IsolineTrailerOptionsTrailerCountInteger", + "documentation":"

Number of trailers attached to the vehicle.

Default Value: 0

" + } + }, + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "IsolineTrailerOptionsAxleCountInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "IsolineTrailerOptionsTrailerCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":1 + }, + "IsolineTravelMode":{ + "type":"string", + "enum":[ + "Car", + "Pedestrian", + "Scooter", + "Truck" + ] + }, + "IsolineTravelModeOptions":{ + "type":"structure", + "members":{ + "Car":{ + "shape":"IsolineCarOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Car\"

" + }, + "Scooter":{ + "shape":"IsolineScooterOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Scooter\"

" + }, + "Truck":{ + "shape":"IsolineTruckOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + } + }, + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "IsolineTruckOptions":{ + "type":"structure", + "members":{ + "AxleCount":{ + "shape":"IsolineTruckOptionsAxleCountInteger", + "documentation":"

Total number of axles of the vehicle.

" + }, + "EngineType":{ + "shape":"IsolineEngineType", + "documentation":"

Engine type of the vehicle.

" + }, + "GrossWeight":{ + "shape":"WeightKilograms", + "documentation":"

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" + }, + "HazardousCargos":{ + "shape":"IsolineHazardousCargoTypeList", + "documentation":"

List of Hazardous cargo contained in the vehicle.

" + }, + "Height":{ + "shape":"IsolineTruckOptionsHeightLong", + "documentation":"

Height of the vehicle.

Unit: centimeters

" + }, + "HeightAboveFirstAxle":{ + "shape":"IsolineTruckOptionsHeightAboveFirstAxleLong", + "documentation":"

Height of the vehicle above its first axle.

Unit: centimeters

" + }, + "KpraLength":{ + "shape":"DimensionCentimeters", + "documentation":"

Kingpin to rear axle length of the vehicle.

Unit: centimeters

" + }, + "Length":{ + "shape":"IsolineTruckOptionsLengthLong", + "documentation":"

Length of the vehicle.

Unit: centimeters

" + }, + "LicensePlate":{ + "shape":"IsolineVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"IsolineTruckOptionsMaxSpeedDouble", + "documentation":"

Maximum speed specified.

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"IsolineTruckOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + }, + "PayloadCapacity":{ + "shape":"WeightKilograms", + "documentation":"

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

" + }, + "TireCount":{ + "shape":"IsolineTruckOptionsTireCountInteger", + "documentation":"

Number of tires on the vehicle.

" + }, + "Trailer":{ + "shape":"IsolineTrailerOptions", + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "TruckType":{ + "shape":"IsolineTruckType", + "documentation":"

Type of the truck.

" + }, + "TunnelRestrictionCode":{ + "shape":"TunnelRestrictionCode", + "documentation":"

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

" + }, + "WeightPerAxle":{ + "shape":"WeightKilograms", + "documentation":"

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" + }, + "WeightPerAxleGroup":{ + "shape":"WeightPerAxleGroup", + "documentation":"

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

Unit: Kilograms

" + }, + "Width":{ + "shape":"IsolineTruckOptionsWidthLong", + "documentation":"

Width of the vehicle.

Unit: centimeters

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + }, + "IsolineTruckOptionsAxleCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":2 + }, + "IsolineTruckOptionsHeightAboveFirstAxleLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "IsolineTruckOptionsHeightLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "IsolineTruckOptionsLengthLong":{ + "type":"long", + "max":30000, + "min":0 + }, + "IsolineTruckOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "IsolineTruckOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "IsolineTruckOptionsTireCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":1 + }, + "IsolineTruckOptionsWidthLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "IsolineTruckType":{ + "type":"string", + "enum":[ + "LightTruck", + "StraightTruck", + "Tractor" + ] + }, + "IsolineVehicleLicensePlate":{ + "type":"structure", + "members":{ + "LastCharacter":{ + "shape":"IsolineVehicleLicensePlateLastCharacterString", + "documentation":"

The last character of the License Plate.

" + } + }, + "documentation":"

The vehicle license plate.

" + }, + "IsolineVehicleLicensePlateLastCharacterString":{ + "type":"string", + "max":1, + "min":1 + }, + "IsolineZoneCategory":{ + "type":"string", + "enum":[ + "CongestionPricing", + "Environmental", + "Vignette" + ] + }, + "LanguageTag":{ + "type":"string", + "max":35, + "min":2 + }, + "LineString":{ + "type":"list", + "member":{"shape":"Position"}, + "min":2 + }, + "LinearRing":{ + "type":"list", + "member":{"shape":"Position"}, + "min":4 + }, + "LinearRings":{ + "type":"list", + "member":{"shape":"LinearRing"}, + "min":1 + }, + "LocalizedString":{ + "type":"structure", + "required":["Value"], + "members":{ + "Language":{ + "shape":"LanguageTag", + "documentation":"

A list of BCP 47 compliant language codes for the results to be rendered in. The request uses the regional default as the fallback if the requested language can't be provided.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the localized string.

" + } + }, + "documentation":"

The localized string.

" + }, + "LocalizedStringList":{ + "type":"list", + "member":{"shape":"LocalizedString"} + }, + "MatchingStrategy":{ + "type":"string", + "enum":[ + "MatchAny", + "MatchMostSignificantRoad" + ] + }, + "MeasurementSystem":{ + "type":"string", + "enum":[ + "Metric", + "Imperial" + ] + }, + "OptimizeWaypointsRequest":{ + "type":"structure", + "required":["Origin"], + "members":{ + "Avoid":{ + "shape":"WaypointOptimizationAvoidanceOptions", + "documentation":"

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

" + }, + "DepartureTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Departure time from the waypoint.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Destination":{ + "shape":"Position", + "documentation":"

The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

" + }, + "DestinationOptions":{ + "shape":"WaypointOptimizationDestinationOptions", + "documentation":"

Destination related options.

" + }, + "Driver":{ + "shape":"WaypointOptimizationDriverOptions", + "documentation":"

Driver related options.

" + }, + "Exclude":{ + "shape":"WaypointOptimizationExclusionOptions", + "documentation":"

Features to be strictly excluded while calculating the route.

" + }, + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + }, + "OptimizeSequencingFor":{ + "shape":"WaypointOptimizationSequencingObjective", + "documentation":"

Specifies the optimization criteria for the calculated sequence.

Default Value: FastestRoute.

" + }, + "Origin":{ + "shape":"Position", + "documentation":"

The start position for the route.

" + }, + "OriginOptions":{ + "shape":"WaypointOptimizationOriginOptions", + "documentation":"

Origin related options.

" + }, + "Traffic":{ + "shape":"WaypointOptimizationTrafficOptions", + "documentation":"

Traffic-related options.

" + }, + "TravelMode":{ + "shape":"WaypointOptimizationTravelMode", + "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" + }, + "TravelModeOptions":{ + "shape":"WaypointOptimizationTravelModeOptions", + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "Waypoints":{ + "shape":"WaypointOptimizationWaypointList", + "documentation":"

List of waypoints between the Origin and Destination.

" + } + } + }, + "OptimizeWaypointsResponse":{ + "type":"structure", + "required":[ + "Connections", + "Distance", + "Duration", + "ImpedingWaypoints", + "OptimizedWaypoints", + "PricingBucket", + "TimeBreakdown" + ], + "members":{ + "Connections":{ + "shape":"WaypointOptimizationConnectionList", + "documentation":"

Details about the connection from one waypoint to the next, within the optimized sequence.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Overall distance to travel the whole sequence.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Overall duration to travel the whole sequence.

Unit: seconds

" + }, + "ImpedingWaypoints":{ + "shape":"WaypointOptimizationImpedingWaypointList", + "documentation":"

Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.

" + }, + "OptimizedWaypoints":{ + "shape":"WaypointOptimizationOptimizedWaypointList", + "documentation":"

Waypoints in the order of the optimized sequence.

" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "TimeBreakdown":{ + "shape":"WaypointOptimizationTimeBreakdown", + "documentation":"

Time breakdown for the sequence.

" + } + } + }, + "Polyline":{ + "type":"string", + "min":1, + "sensitive":true + }, + "PolylineCorridor":{ + "type":"structure", + "required":[ + "Polyline", + "Radius" + ], + "members":{ + "Polyline":{ + "shape":"Polyline", + "documentation":"

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" + }, + "Radius":{ + "shape":"Integer", + "documentation":"

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" + } + }, + "documentation":"

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

", + "sensitive":true + }, + "PolylineRing":{ + "type":"string", + "min":1, + "sensitive":true + }, + "PolylineRingList":{ + "type":"list", + "member":{"shape":"PolylineRing"}, + "min":1 + }, + "Position":{ + "type":"list", + "member":{"shape":"Double"}, + "max":2, + "min":2, + "sensitive":true + }, + "Position23":{ + "type":"list", + "member":{"shape":"Double"}, + "max":3, + "min":2, + "sensitive":true + }, + "RoadSnapHazardousCargoType":{ + "type":"string", + "enum":[ + "Combustible", + "Corrosive", + "Explosive", + "Flammable", + "Gas", + "HarmfulToWater", + "Organic", + "Other", + "Poison", + "PoisonousInhalation", + "Radioactive" + ] + }, + "RoadSnapHazardousCargoTypeList":{ + "type":"list", + "member":{"shape":"RoadSnapHazardousCargoType"}, + "max":11, + "min":0 + }, + "RoadSnapNotice":{ + "type":"structure", + "required":[ + "Code", + "Title", + "TracePointIndexes" + ], + "members":{ + "Code":{ + "shape":"RoadSnapNoticeCode", + "documentation":"

Code corresponding to the issue.

" + }, + "Title":{ + "shape":"String", + "documentation":"

The notice title.

" + }, + "TracePointIndexes":{ + "shape":"RoadSnapTracePointIndexList", + "documentation":"

TracePoint indices for which the provided notice code corresponds to.

" + } + }, + "documentation":"

Notices provide information around factors that may have influenced snapping in a manner atypical to the standard use cases.

" + }, + "RoadSnapNoticeCode":{ + "type":"string", + "enum":[ + "TracePointsHeadingIgnored", + "TracePointsIgnored", + "TracePointsMovedByLargeDistance", + "TracePointsNotMatched", + "TracePointsOutOfSequence", + "TracePointsSpeedEstimated", + "TracePointsSpeedIgnored" + ] + }, + "RoadSnapNoticeList":{ + "type":"list", + "member":{"shape":"RoadSnapNotice"} + }, + "RoadSnapSnappedGeometry":{ + "type":"structure", + "members":{ + "LineString":{ + "shape":"LineString", + "documentation":"

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" + }, + "Polyline":{ + "shape":"Polyline", + "documentation":"

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" + } + }, + "documentation":"

Interpolated geometry for the snapped route that is overlay-able onto a map.

" + }, + "RoadSnapSnappedTracePoint":{ + "type":"structure", + "required":[ + "Confidence", + "OriginalPosition", + "SnappedPosition" + ], + "members":{ + "Confidence":{ + "shape":"RoadSnapSnappedTracePointConfidenceDouble", + "documentation":"

Confidence value for the correctness of this point match.

" + }, + "OriginalPosition":{ + "shape":"Position", + "documentation":"

Position of the TracePoint provided within the request, at the same index.

" + }, + "SnappedPosition":{ + "shape":"Position", + "documentation":"

Snapped position of the TracePoint provided within the request, at the same index.

" + } + }, + "documentation":"

TracePoints snapped onto the road network.

" + }, + "RoadSnapSnappedTracePointConfidenceDouble":{ + "type":"double", + "box":true, + "max":1, + "min":0 + }, + "RoadSnapSnappedTracePointList":{ + "type":"list", + "member":{"shape":"RoadSnapSnappedTracePoint"} + }, + "RoadSnapTracePoint":{ + "type":"structure", + "required":["Position"], + "members":{ + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "Speed":{ + "shape":"SpeedKilometersPerHour", + "documentation":"

Speed at the specified trace point .

Unit: KilometersPerHour

" + }, + "Timestamp":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Timestamp of the event.

" + } + }, + "documentation":"

TracePoint indices for which the provided notice code corresponds to.

" + }, + "RoadSnapTracePointIndexList":{ + "type":"list", + "member":{"shape":"Integer"}, + "max":1000, + "min":1 + }, + "RoadSnapTrailerOptions":{ + "type":"structure", + "members":{ + "TrailerCount":{ + "shape":"RoadSnapTrailerOptionsTrailerCountInteger", + "documentation":"

Number of trailers attached to the vehicle.

Default Value: 0

" + } + }, + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "RoadSnapTrailerOptionsTrailerCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":0 + }, + "RoadSnapTravelMode":{ + "type":"string", + "enum":[ + "Car", + "Pedestrian", + "Scooter", + "Truck" + ] + }, + "RoadSnapTravelModeOptions":{ + "type":"structure", + "members":{ + "Truck":{ + "shape":"RoadSnapTruckOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Truck\".

" + } + }, + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "RoadSnapTruckOptions":{ + "type":"structure", + "members":{ + "GrossWeight":{ + "shape":"WeightKilograms", + "documentation":"

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" + }, + "HazardousCargos":{ + "shape":"RoadSnapHazardousCargoTypeList", + "documentation":"

List of Hazardous cargos contained in the vehicle.

" + }, + "Height":{ + "shape":"RoadSnapTruckOptionsHeightLong", + "documentation":"

Height of the vehicle.

Unit: centimeters

" + }, + "Length":{ + "shape":"RoadSnapTruckOptionsLengthLong", + "documentation":"

Length of the vehicle.

Unit: centimeters

" + }, + "Trailer":{ + "shape":"RoadSnapTrailerOptions", + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "TunnelRestrictionCode":{ + "shape":"TunnelRestrictionCode", + "documentation":"

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

" + }, + "Width":{ + "shape":"RoadSnapTruckOptionsWidthLong", + "documentation":"

Width of the vehicle in centimenters.

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Truck\".

" + }, + "RoadSnapTruckOptionsHeightLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RoadSnapTruckOptionsLengthLong":{ + "type":"long", + "max":30000, + "min":0 + }, + "RoadSnapTruckOptionsWidthLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RoundaboutAngle":{ + "type":"double", + "max":360, + "min":-360 + }, + "Route":{ + "type":"structure", + "required":[ + "Legs", + "MajorRoadLabels" + ], + "members":{ + "Legs":{ + "shape":"RouteLegList", + "documentation":"

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

" + }, + "MajorRoadLabels":{ + "shape":"RouteMajorRoadLabelsList", + "documentation":"

Important labels including names and route numbers that differentiate the current route from the alternatives presented.

" + }, + "Summary":{ + "shape":"RouteSummary", + "documentation":"

Summarized details of the leg.

" + } + }, + "documentation":"

The route.

" + }, + "RouteAllowOptions":{ + "type":"structure", + "members":{ + "Hot":{ + "shape":"Boolean", + "documentation":"

Allow Hot (High Occupancy Toll) lanes while calculating the route.

" + }, + "Hov":{ + "shape":"Boolean", + "documentation":"

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

" + } + }, + "documentation":"

Features that are allowed while calculating. a route

" + }, + "RouteAvoidanceArea":{ + "type":"structure", + "required":["Geometry"], + "members":{ + "Except":{ + "shape":"RouteAvoidanceAreaGeometryList", + "documentation":"

Exceptions to the provided avoidance geometry, to be included while calculating the route.

" + }, + "Geometry":{"shape":"RouteAvoidanceAreaGeometry"} + }, + "documentation":"

Areas to be avoided.

" + }, + "RouteAvoidanceAreaGeometry":{ + "type":"structure", + "members":{ + "Corridor":{ + "shape":"Corridor", + "documentation":"

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

" + }, + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + }, + "Polygon":{ + "shape":"RouteAvoidanceAreaGeometryPolygonList", + "documentation":"

Geometry defined as a polygon with only one linear ring.

" + }, + "PolylineCorridor":{ + "shape":"PolylineCorridor", + "documentation":"

Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

" + }, + "PolylinePolygon":{ + "shape":"RouteAvoidanceAreaGeometryPolylinePolygonList", + "documentation":"

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + } + }, + "documentation":"

Geometry of the area to be avoided.

" + }, + "RouteAvoidanceAreaGeometryList":{ + "type":"list", + "member":{"shape":"RouteAvoidanceAreaGeometry"} + }, + "RouteAvoidanceAreaGeometryPolygonList":{ + "type":"list", + "member":{"shape":"LinearRing"}, + "max":1, + "min":1 + }, + "RouteAvoidanceAreaGeometryPolylinePolygonList":{ + "type":"list", + "member":{"shape":"PolylineRing"}, + "max":1, + "min":1 + }, + "RouteAvoidanceAreaList":{ + "type":"list", + "member":{"shape":"RouteAvoidanceArea"} + }, + "RouteAvoidanceOptions":{ + "type":"structure", + "members":{ + "Areas":{ + "shape":"RouteAvoidanceAreaList", + "documentation":"

Areas to be avoided.

" + }, + "CarShuttleTrains":{ + "shape":"Boolean", + "documentation":"

Avoid car-shuttle-trains while calculating the route.

" + }, + "ControlledAccessHighways":{ + "shape":"Boolean", + "documentation":"

Avoid controlled access highways while calculating the route.

" + }, + "DirtRoads":{ + "shape":"Boolean", + "documentation":"

Avoid dirt roads while calculating the route.

" + }, + "Ferries":{ + "shape":"Boolean", + "documentation":"

Avoid ferries while calculating the route.

" + }, + "SeasonalClosure":{ + "shape":"Boolean", + "documentation":"

Avoid roads that have seasonal closure while calculating the route.

" + }, + "TollRoads":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "TollTransponders":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "TruckRoadTypes":{ + "shape":"TruckRoadTypeList", + "documentation":"

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" + }, + "Tunnels":{ + "shape":"Boolean", + "documentation":"

Avoid tunnels while calculating the route.

" + }, + "UTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + }, + "ZoneCategories":{ + "shape":"RouteAvoidanceZoneCategoryList", + "documentation":"

Zone categories to be avoided.

" + } + }, + "documentation":"

Options related to areas to be avoided.

" + }, + "RouteAvoidanceZoneCategory":{ + "type":"structure", + "required":["Category"], + "members":{ + "Category":{ + "shape":"RouteZoneCategory", + "documentation":"

Zone category to be avoided.

" + } + }, + "documentation":"

Zone categories to be avoided.

" + }, + "RouteAvoidanceZoneCategoryList":{ + "type":"list", + "member":{"shape":"RouteAvoidanceZoneCategory"}, + "max":3, + "min":0 + }, + "RouteCarOptions":{ + "type":"structure", + "members":{ + "EngineType":{ + "shape":"RouteEngineType", + "documentation":"

Engine type of the vehicle.

" + }, + "LicensePlate":{ + "shape":"RouteVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"RouteCarOptionsMaxSpeedDouble", + "documentation":"

Maximum speed specified.

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"RouteCarOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Car\"

" + }, + "RouteCarOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "RouteCarOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteContinueHighwayStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details related to the continue highway step.

" + }, + "RouteContinueStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + } + }, + "documentation":"

Details related to the continue step.

" + }, + "RouteDestinationOptions":{ + "type":"structure", + "members":{ + "AvoidActionsForDistance":{ + "shape":"RouteDestinationOptionsAvoidActionsForDistanceLong", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "AvoidUTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"RouteMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "SideOfStreet":{ + "shape":"RouteSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "StopDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the stop.

Unit: seconds

" + } + }, + "documentation":"

Options related to the destination.

" + }, + "RouteDestinationOptionsAvoidActionsForDistanceLong":{ + "type":"long", + "max":2000 + }, + "RouteDirection":{ + "type":"string", + "enum":[ + "East", + "North", + "South", + "West" + ] + }, + "RouteDriverOptions":{ + "type":"structure", + "members":{ + "Schedule":{ + "shape":"RouteDriverScheduleIntervalList", + "documentation":"

Driver work-rest schedule. Stops are added to fulfil the provided rest schedule.

" + } + }, + "documentation":"

Driver related options.

" + }, + "RouteDriverScheduleInterval":{ + "type":"structure", + "required":[ + "DriveDuration", + "RestDuration" + ], + "members":{ + "DriveDuration":{ + "shape":"DurationSeconds", + "documentation":"

Maximum allowed driving time before stopping to rest.

Unit: seconds

" + }, + "RestDuration":{ + "shape":"DurationSeconds", + "documentation":"

Resting time before the driver can continue driving.

Unit: seconds

" + } + }, + "documentation":"

Interval of the driver work-rest schedule. Stops are added to fulfil the provided rest schedule.

" + }, + "RouteDriverScheduleIntervalList":{ + "type":"list", + "member":{"shape":"RouteDriverScheduleInterval"} + }, + "RouteEmissionType":{ + "type":"structure", + "required":["Type"], + "members":{ + "Co2EmissionClass":{ + "shape":"String", + "documentation":"

The CO 2 emission classes.

" + }, + "Type":{ + "shape":"String", + "documentation":"

Type of the emission.

Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

" + } + }, + "documentation":"

Type of the emission.

Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

" + }, + "RouteEngineType":{ + "type":"string", + "enum":[ + "Electric", + "InternalCombustion", + "PluginHybrid" + ] + }, + "RouteEnterHighwayStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details related to the enter highway step.

" + }, + "RouteExclusionOptions":{ + "type":"structure", + "required":["Countries"], + "members":{ + "Countries":{ + "shape":"CountryCodeList", + "documentation":"

List of countries to be avoided defined by two-letter or three-letter country codes.

" + } + }, + "documentation":"

Exclusion options for the route.

" + }, + "RouteExitStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "RelativeExit":{ + "shape":"RouteExitStepDetailsRelativeExitInteger", + "documentation":"

Exit to be taken.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details related to the exit step.

" + }, + "RouteExitStepDetailsRelativeExitInteger":{ + "type":"integer", + "box":true, + "max":12, + "min":1 + }, + "RouteFerryAfterTravelStep":{ + "type":"structure", + "required":[ + "Duration", + "Type" + ], + "members":{ + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "Instruction":{ + "shape":"String", + "documentation":"

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" + }, + "Type":{ + "shape":"RouteFerryAfterTravelStepType", + "documentation":"

Type of the step.

" + } + }, + "documentation":"

Steps of a leg that must be performed after the travel portion of the leg.

" + }, + "RouteFerryAfterTravelStepList":{ + "type":"list", + "member":{"shape":"RouteFerryAfterTravelStep"} + }, + "RouteFerryAfterTravelStepType":{ + "type":"string", + "enum":["Deboard"] + }, + "RouteFerryArrival":{ + "type":"structure", + "required":["Place"], + "members":{ + "Place":{ + "shape":"RouteFerryPlace", + "documentation":"

The place details.

" + }, + "Time":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

The time.

" + } + }, + "documentation":"

Details corresponding to the arrival for the leg.

" + }, + "RouteFerryBeforeTravelStep":{ + "type":"structure", + "required":[ + "Duration", + "Type" + ], + "members":{ + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "Instruction":{ + "shape":"String", + "documentation":"

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" + }, + "Type":{ + "shape":"RouteFerryBeforeTravelStepType", + "documentation":"

Type of the step.

" + } + }, + "documentation":"

Steps of a leg that must be performed before the travel portion of the leg.

" + }, + "RouteFerryBeforeTravelStepList":{ + "type":"list", + "member":{"shape":"RouteFerryBeforeTravelStep"} + }, + "RouteFerryBeforeTravelStepType":{ + "type":"string", + "enum":["Board"] + }, + "RouteFerryDeparture":{ + "type":"structure", + "required":["Place"], + "members":{ + "Place":{ + "shape":"RouteFerryPlace", + "documentation":"

The place details.

" + }, + "Time":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

The time.

" + } + }, + "documentation":"

Details corresponding to the departure for the leg.

" + }, + "RouteFerryLegDetails":{ + "type":"structure", + "required":[ + "AfterTravelSteps", + "Arrival", + "BeforeTravelSteps", + "Departure", + "Notices", + "PassThroughWaypoints", + "Spans", + "TravelSteps" + ], + "members":{ + "AfterTravelSteps":{ + "shape":"RouteFerryAfterTravelStepList", + "documentation":"

Steps of a leg that must be performed after the travel portion of the leg.

" + }, + "Arrival":{ + "shape":"RouteFerryArrival", + "documentation":"

Details corresponding to the arrival for the leg.

" + }, + "BeforeTravelSteps":{ + "shape":"RouteFerryBeforeTravelStepList", + "documentation":"

Steps of a leg that must be performed before the travel portion of the leg.

" + }, + "Departure":{ + "shape":"RouteFerryDeparture", + "documentation":"

Details corresponding to the departure for the leg.

" + }, + "Notices":{ + "shape":"RouteFerryNoticeList", + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "PassThroughWaypoints":{ + "shape":"RoutePassThroughWaypointList", + "documentation":"

Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

" + }, + "RouteName":{ + "shape":"String", + "documentation":"

Route name of the ferry line.

" + }, + "Spans":{ + "shape":"RouteFerrySpanList", + "documentation":"

Spans that were computed for the requested SpanAdditionalFeatures.

" + }, + "Summary":{ + "shape":"RouteFerrySummary", + "documentation":"

Summarized details of the leg.

" + }, + "TravelSteps":{ + "shape":"RouteFerryTravelStepList", + "documentation":"

Steps of a leg that must be performed before the travel portion of the leg.

" + } + }, + "documentation":"

FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

" + }, + "RouteFerryNotice":{ + "type":"structure", + "required":["Code"], + "members":{ + "Code":{ + "shape":"RouteFerryNoticeCode", + "documentation":"

Code corresponding to the issue.

" + }, + "Impact":{ + "shape":"RouteNoticeImpact", + "documentation":"

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" + } + }, + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "RouteFerryNoticeCode":{ + "type":"string", + "enum":[ + "AccuratePolylineUnavailable", + "NoSchedule", + "Other", + "ViolatedAvoidFerry", + "ViolatedAvoidRailFerry" + ] + }, + "RouteFerryNoticeList":{ + "type":"list", + "member":{"shape":"RouteFerryNotice"} + }, + "RouteFerryOverviewSummary":{ + "type":"structure", + "required":[ + "Distance", + "Duration" + ], + "members":{ + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + } + }, + "documentation":"

Summarized details of the leg.

" + }, + "RouteFerryPlace":{ + "type":"structure", + "required":["Position"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the place.

" + }, + "OriginalPosition":{ + "shape":"Position23", + "documentation":"

Position provided in the request.

" + }, + "Position":{ + "shape":"Position23", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "WaypointIndex":{ + "shape":"RouteFerryPlaceWaypointIndexInteger", + "documentation":"

Index of the waypoint in the request.

" + } + }, + "documentation":"

Position provided in the request.

" + }, + "RouteFerryPlaceWaypointIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteFerrySpan":{ + "type":"structure", + "members":{ + "Country":{ + "shape":"CountryCode3", + "documentation":"

3 letter Country code corresponding to the Span.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

" + }, + "GeometryOffset":{ + "shape":"RouteFerrySpanGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this span.

" + }, + "Names":{ + "shape":"LocalizedStringList", + "documentation":"

Provides an array of names of the ferry span in available languages.

" + }, + "Region":{ + "shape":"RouteFerrySpanRegionString", + "documentation":"

2-3 letter Region code corresponding to the Span. This is either a province or a state.

" + } + }, + "documentation":"

Span computed for the requested SpanAdditionalFeatures.

" + }, + "RouteFerrySpanGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteFerrySpanList":{ + "type":"list", + "member":{"shape":"RouteFerrySpan"} + }, + "RouteFerrySpanRegionString":{ + "type":"string", + "max":3, + "min":0 + }, + "RouteFerrySummary":{ + "type":"structure", + "members":{ + "Overview":{ + "shape":"RouteFerryOverviewSummary", + "documentation":"

Summarized details for the leg including before travel, travel and after travel steps.

" + }, + "TravelOnly":{ + "shape":"RouteFerryTravelOnlySummary", + "documentation":"

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters

" + } + }, + "documentation":"

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

" + }, + "RouteFerryTravelOnlySummary":{ + "type":"structure", + "required":["Duration"], + "members":{ + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.

Unit: seconds

" + } + }, + "documentation":"

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

" + }, + "RouteFerryTravelStep":{ + "type":"structure", + "required":[ + "Duration", + "Type" + ], + "members":{ + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "GeometryOffset":{ + "shape":"RouteFerryTravelStepGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this step.

" + }, + "Instruction":{ + "shape":"String", + "documentation":"

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" + }, + "Type":{ + "shape":"RouteFerryTravelStepType", + "documentation":"

Type of the step.

" + } + }, + "documentation":"

Steps of a leg that must be performed during the travel portion of the leg.

" + }, + "RouteFerryTravelStepGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteFerryTravelStepList":{ + "type":"list", + "member":{"shape":"RouteFerryTravelStep"} + }, + "RouteFerryTravelStepType":{ + "type":"string", + "enum":[ + "Depart", + "Continue", + "Arrive" + ] + }, + "RouteHazardousCargoType":{ + "type":"string", + "enum":[ + "Combustible", + "Corrosive", + "Explosive", + "Flammable", + "Gas", + "HarmfulToWater", + "Organic", + "Other", + "Poison", + "PoisonousInhalation", + "Radioactive" + ] + }, + "RouteHazardousCargoTypeList":{ + "type":"list", + "member":{"shape":"RouteHazardousCargoType"}, + "max":11, + "min":0 + }, + "RouteKeepStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details that are specific to a Keep step.

" + }, + "RouteLeg":{ + "type":"structure", + "required":[ + "Geometry", + "TravelMode", + "Type" + ], + "members":{ + "FerryLegDetails":{ + "shape":"RouteFerryLegDetails", + "documentation":"

FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

" + }, + "Geometry":{ + "shape":"RouteLegGeometry", + "documentation":"

Geometry of the area to be avoided.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

List of languages for instructions within steps in the response.

" + }, + "PedestrianLegDetails":{ + "shape":"RoutePedestrianLegDetails", + "documentation":"

Details related to the pedestrian leg.

" + }, + "TravelMode":{ + "shape":"RouteLegTravelMode", + "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" + }, + "Type":{ + "shape":"RouteLegType", + "documentation":"

Type of the leg.

" + }, + "VehicleLegDetails":{ + "shape":"RouteVehicleLegDetails", + "documentation":"

Details related to the vehicle leg.

" + } + }, + "documentation":"

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

" + }, + "RouteLegAdditionalFeature":{ + "type":"string", + "enum":[ + "Elevation", + "Incidents", + "PassThroughWaypoints", + "Summary", + "Tolls", + "TravelStepInstructions", + "TruckRoadTypes", + "TypicalDuration", + "Zones" + ] + }, + "RouteLegAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"RouteLegAdditionalFeature"}, + "max":9, + "min":0 + }, + "RouteLegGeometry":{ + "type":"structure", + "members":{ + "LineString":{ + "shape":"LineString", + "documentation":"

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

" + }, + "Polyline":{ + "shape":"Polyline", + "documentation":"

An ordered list of positions used to plot a route on a map in a lossy compression format.

LineString and Polyline are mutually exclusive properties.

" + } + }, + "documentation":"

The returned Route leg geometry.

" + }, + "RouteLegList":{ + "type":"list", + "member":{"shape":"RouteLeg"} + }, + "RouteLegTravelMode":{ + "type":"string", + "enum":[ + "Car", + "Ferry", + "Pedestrian", + "Scooter", + "Truck" + ] + }, + "RouteLegType":{ + "type":"string", + "enum":[ + "Ferry", + "Pedestrian", + "Vehicle" + ] + }, + "RouteList":{ + "type":"list", + "member":{"shape":"Route"} + }, + "RouteMajorRoadLabel":{ + "type":"structure", + "members":{ + "RoadName":{ + "shape":"LocalizedString", + "documentation":"

Name of the road (localized).

" + }, + "RouteNumber":{ + "shape":"RouteNumber", + "documentation":"

Route number of the road.

" + } + }, + "documentation":"

Important labels including names and route numbers that differentiate the current route from the alternatives presented.

" + }, + "RouteMajorRoadLabelsList":{ + "type":"list", + "member":{"shape":"RouteMajorRoadLabel"}, + "max":2, + "min":0 + }, + "RouteMatchingOptions":{ + "type":"structure", + "members":{ + "NameHint":{ + "shape":"RouteMatchingOptionsNameHintString", + "documentation":"

Attempts to match the provided position to a road similar to the provided name.

" + }, + "OnRoadThreshold":{ + "shape":"DistanceMeters", + "documentation":"

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

" + }, + "Radius":{ + "shape":"DistanceMeters", + "documentation":"

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" + }, + "Strategy":{ + "shape":"MatchingStrategy", + "documentation":"

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

" + } + }, + "documentation":"

Options related to route matching.

" + }, + "RouteMatchingOptionsNameHintString":{ + "type":"string", + "max":100, + "min":0, + "sensitive":true + }, + "RouteMatrix":{ + "type":"list", + "member":{"shape":"RouteMatrixRow"} + }, + "RouteMatrixAllowOptions":{ + "type":"structure", + "members":{ + "Hot":{ + "shape":"Boolean", + "documentation":"

Allow Hot (High Occupancy Toll) lanes while calculating the route.

" + }, + "Hov":{ + "shape":"Boolean", + "documentation":"

Allow Hov (High Occupancy vehicle) lanes while calculating the route.

" + } + }, + "documentation":"

Allow Options related to the route matrix.

" + }, + "RouteMatrixAutoCircle":{ + "type":"structure", + "members":{ + "Margin":{ + "shape":"RouteMatrixAutoCircleMarginLong", + "documentation":"

The margin provided for the calculation.

" + }, + "MaxRadius":{ + "shape":"RouteMatrixAutoCircleMaxRadiusLong", + "documentation":"

The maximum size of the radius provided for the calculation.

" + } + }, + "documentation":"

Provides the circle that was used while calculating the route.

" + }, + "RouteMatrixAutoCircleMarginLong":{ + "type":"long", + "max":200000, + "min":0 + }, + "RouteMatrixAutoCircleMaxRadiusLong":{ + "type":"long", + "max":200000, + "min":0 + }, + "RouteMatrixAvoidanceArea":{ + "type":"structure", + "required":["Geometry"], + "members":{ + "Geometry":{ + "shape":"RouteMatrixAvoidanceAreaGeometry", + "documentation":"

Geometry of the area to be avoided.

" + } + }, + "documentation":"

Area to be avoided.

" + }, + "RouteMatrixAvoidanceAreaGeometry":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + }, + "Polygon":{ + "shape":"RouteMatrixAvoidanceAreaGeometryPolygonList", + "documentation":"

Geometry defined as a polygon with only one linear ring.

" + }, + "PolylinePolygon":{ + "shape":"RouteMatrixAvoidanceAreaGeometryPolylinePolygonList", + "documentation":"

A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from second item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.

" + } + }, + "documentation":"

Geometry of the area to be avoided.

" + }, + "RouteMatrixAvoidanceAreaGeometryPolygonList":{ + "type":"list", + "member":{"shape":"LinearRing"}, + "max":1, + "min":1 + }, + "RouteMatrixAvoidanceAreaGeometryPolylinePolygonList":{ + "type":"list", + "member":{"shape":"PolylineRing"}, + "max":1, + "min":1 + }, + "RouteMatrixAvoidanceOptions":{ + "type":"structure", + "members":{ + "Areas":{ + "shape":"RouteMatrixAvoidanceOptionsAreasList", + "documentation":"

Areas to be avoided.

" + }, + "CarShuttleTrains":{ + "shape":"Boolean", + "documentation":"

Avoid car-shuttle-trains while calculating the route.

" + }, + "ControlledAccessHighways":{ + "shape":"Boolean", + "documentation":"

Avoid controlled access highways while calculating the route.

" + }, + "DirtRoads":{ + "shape":"Boolean", + "documentation":"

Avoid dirt roads while calculating the route.

" + }, + "Ferries":{ + "shape":"Boolean", + "documentation":"

Avoid ferries while calculating the route.

" + }, + "TollRoads":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "TollTransponders":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "TruckRoadTypes":{ + "shape":"TruckRoadTypeList", + "documentation":"

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" + }, + "Tunnels":{ + "shape":"Boolean", + "documentation":"

Avoid tunnels while calculating the route.

" + }, + "UTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + }, + "ZoneCategories":{ + "shape":"RouteMatrixAvoidanceZoneCategoryList", + "documentation":"

Zone categories to be avoided.

" + } + }, + "documentation":"

Options related to the route matrix.

" + }, + "RouteMatrixAvoidanceOptionsAreasList":{ + "type":"list", + "member":{"shape":"RouteMatrixAvoidanceArea"}, + "max":250, + "min":0 + }, + "RouteMatrixAvoidanceZoneCategory":{ + "type":"structure", + "members":{ + "Category":{ + "shape":"RouteMatrixZoneCategory", + "documentation":"

Zone category to be avoided.

" + } + }, + "documentation":"

Zone categories to be avoided.

" + }, + "RouteMatrixAvoidanceZoneCategoryList":{ + "type":"list", + "member":{"shape":"RouteMatrixAvoidanceZoneCategory"}, + "max":3, + "min":0 + }, + "RouteMatrixBoundary":{ + "type":"structure", + "members":{ + "Geometry":{ + "shape":"RouteMatrixBoundaryGeometry", + "documentation":"

Geometry of the area to be avoided.

" + }, + "Unbounded":{ + "shape":"Boolean", + "documentation":"

No restrictions in terms of a routing boundary, and is typically used for longer routes.

" + } + }, + "documentation":"

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

" + }, + "RouteMatrixBoundaryGeometry":{ + "type":"structure", + "members":{ + "AutoCircle":{ + "shape":"RouteMatrixAutoCircle", + "documentation":"

Provides the circle that was used while calculating the route.

" + }, + "Circle":{ + "shape":"Circle", + "documentation":"

Geometry defined as a circle. When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

" + }, + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + }, + "Polygon":{ + "shape":"RouteMatrixBoundaryGeometryPolygonList", + "documentation":"

Geometry defined as a polygon with only one linear ring.

" + } + }, + "documentation":"

Geometry of the routing boundary.

" + }, + "RouteMatrixBoundaryGeometryPolygonList":{ + "type":"list", + "member":{"shape":"LinearRing"}, + "max":1, + "min":1 + }, + "RouteMatrixCarOptions":{ + "type":"structure", + "members":{ + "LicensePlate":{ + "shape":"RouteMatrixVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"RouteMatrixCarOptionsMaxSpeedDouble", + "documentation":"

Maximum speed

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"RouteMatrixCarOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + } + }, + "documentation":"

Options related to the car.

" + }, + "RouteMatrixCarOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "RouteMatrixCarOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteMatrixDestination":{ + "type":"structure", + "required":["Position"], + "members":{ + "Options":{ + "shape":"RouteMatrixDestinationOptions", + "documentation":"

Destination related options.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + } + }, + "documentation":"

The route destination.

" + }, + "RouteMatrixDestinationOptions":{ + "type":"structure", + "members":{ + "AvoidActionsForDistance":{ + "shape":"RouteMatrixDestinationOptionsAvoidActionsForDistanceLong", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"RouteMatrixMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "SideOfStreet":{ + "shape":"RouteMatrixSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Options related to the destination.

" + }, + "RouteMatrixDestinationOptionsAvoidActionsForDistanceLong":{ + "type":"long", + "min":0 + }, + "RouteMatrixEntry":{ + "type":"structure", + "required":[ + "Distance", + "Duration" + ], + "members":{ + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

The total distance of travel for the route.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

The expected duration of travel for the route.

Unit: seconds

" + }, + "Error":{ + "shape":"RouteMatrixErrorCode", + "documentation":"

Error code that occurred during calculation of the route.

" + } + }, + "documentation":"

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

" + }, + "RouteMatrixErrorCode":{ + "type":"string", + "enum":[ + "NoMatch", + "NoMatchDestination", + "NoMatchOrigin", + "NoRoute", + "OutOfBounds", + "OutOfBoundsDestination", + "OutOfBoundsOrigin", + "Other", + "Violation" + ] + }, + "RouteMatrixExclusionOptions":{ + "type":"structure", + "required":["Countries"], + "members":{ + "Countries":{ + "shape":"CountryCodeList", + "documentation":"

List of countries to be avoided defined by two-letter or three-letter country codes.

" + } + }, + "documentation":"

Exclusion options.

" + }, + "RouteMatrixHazardousCargoType":{ + "type":"string", + "enum":[ + "Combustible", + "Corrosive", + "Explosive", + "Flammable", + "Gas", + "HarmfulToWater", + "Organic", + "Other", + "Poison", + "PoisonousInhalation", + "Radioactive" + ] + }, + "RouteMatrixHazardousCargoTypeList":{ + "type":"list", + "member":{"shape":"RouteMatrixHazardousCargoType"}, + "max":11, + "min":0 + }, + "RouteMatrixMatchingOptions":{ + "type":"structure", + "members":{ + "NameHint":{ + "shape":"SensitiveString", + "documentation":"

Attempts to match the provided position to a road similar to the provided name.

" + }, + "OnRoadThreshold":{ + "shape":"RouteMatrixMatchingOptionsOnRoadThresholdLong", + "documentation":"

If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

Unit: meters

" + }, + "Radius":{ + "shape":"DistanceMeters", + "documentation":"

Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

Unit: Meters

" + }, + "Strategy":{ + "shape":"MatchingStrategy", + "documentation":"

Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

" + } + }, + "documentation":"

Matching options.

" + }, + "RouteMatrixMatchingOptionsOnRoadThresholdLong":{ + "type":"long", + "min":0 + }, + "RouteMatrixOrigin":{ + "type":"structure", + "required":["Position"], + "members":{ + "Options":{ + "shape":"RouteMatrixOriginOptions", + "documentation":"

Origin related options.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + } + }, + "documentation":"

The start position for the route.

" + }, + "RouteMatrixOriginOptions":{ + "type":"structure", + "members":{ + "AvoidActionsForDistance":{ + "shape":"RouteMatrixOriginOptionsAvoidActionsForDistanceLong", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"RouteMatrixMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "SideOfStreet":{ + "shape":"RouteMatrixSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Origin related options.

" + }, + "RouteMatrixOriginOptionsAvoidActionsForDistanceLong":{ + "type":"long", + "min":0 + }, + "RouteMatrixRow":{ + "type":"list", + "member":{"shape":"RouteMatrixEntry"} + }, + "RouteMatrixScooterOptions":{ + "type":"structure", + "members":{ + "LicensePlate":{ + "shape":"RouteMatrixVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"RouteMatrixScooterOptionsMaxSpeedDouble", + "documentation":"

Maximum speed.

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"RouteMatrixScooterOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Scooter\"

" + }, + "RouteMatrixScooterOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "RouteMatrixScooterOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteMatrixSideOfStreetOptions":{ + "type":"structure", + "required":["Position"], + "members":{ + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "UseWith":{ + "shape":"SideOfStreetMatchingStrategy", + "documentation":"

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

" + } + }, + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "RouteMatrixTrafficOptions":{ + "type":"structure", + "members":{ + "FlowEventThresholdOverride":{ + "shape":"DurationSeconds", + "documentation":"

Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

" + }, + "Usage":{ + "shape":"TrafficUsage", + "documentation":"

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" + } + }, + "documentation":"

Traffic related options.

" + }, + "RouteMatrixTrailerOptions":{ + "type":"structure", + "members":{ + "TrailerCount":{ + "shape":"RouteMatrixTrailerOptionsTrailerCountInteger", + "documentation":"

Number of trailers attached to the vehicle.

Default Value: 0

" + } + }, + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "RouteMatrixTrailerOptionsTrailerCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":0 + }, + "RouteMatrixTravelMode":{ + "type":"string", + "enum":[ + "Car", + "Pedestrian", + "Scooter", + "Truck" + ] + }, + "RouteMatrixTravelModeOptions":{ + "type":"structure", + "members":{ + "Car":{ + "shape":"RouteMatrixCarOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Car\"

" + }, + "Scooter":{ + "shape":"RouteMatrixScooterOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Scooter\"

" + }, + "Truck":{ + "shape":"RouteMatrixTruckOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + } + }, + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "RouteMatrixTruckOptions":{ + "type":"structure", + "members":{ + "AxleCount":{ + "shape":"RouteMatrixTruckOptionsAxleCountInteger", + "documentation":"

Total number of axles of the vehicle.

" + }, + "GrossWeight":{ + "shape":"WeightKilograms", + "documentation":"

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" + }, + "HazardousCargos":{ + "shape":"RouteMatrixHazardousCargoTypeList", + "documentation":"

List of Hazardous cargo contained in the vehicle.

" + }, + "Height":{ + "shape":"RouteMatrixTruckOptionsHeightLong", + "documentation":"

Height of the vehicle.

Unit: centimeters

" + }, + "KpraLength":{ + "shape":"DimensionCentimeters", + "documentation":"

Kingpin to rear axle length of the vehicle

Unit: centimeters

" + }, + "Length":{ + "shape":"RouteMatrixTruckOptionsLengthLong", + "documentation":"

Length of the vehicle.

Unit: centimeters

" + }, + "LicensePlate":{ + "shape":"RouteMatrixVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"RouteMatrixTruckOptionsMaxSpeedDouble", + "documentation":"

Maximum speed

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"RouteMatrixTruckOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + }, + "PayloadCapacity":{ + "shape":"WeightKilograms", + "documentation":"

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

" + }, + "Trailer":{ + "shape":"RouteMatrixTrailerOptions", + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "TruckType":{ + "shape":"RouteMatrixTruckType", + "documentation":"

Type of the truck.

" + }, + "TunnelRestrictionCode":{ + "shape":"TunnelRestrictionCode", + "documentation":"

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

" + }, + "WeightPerAxle":{ + "shape":"WeightKilograms", + "documentation":"

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" + }, + "WeightPerAxleGroup":{ + "shape":"WeightPerAxleGroup", + "documentation":"

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

" + }, + "Width":{ + "shape":"RouteMatrixTruckOptionsWidthLong", + "documentation":"

Width of the vehicle.

Unit: centimeters

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + }, + "RouteMatrixTruckOptionsAxleCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":2 + }, + "RouteMatrixTruckOptionsHeightLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RouteMatrixTruckOptionsLengthLong":{ + "type":"long", + "max":30000, + "min":0 + }, + "RouteMatrixTruckOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "RouteMatrixTruckOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteMatrixTruckOptionsWidthLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RouteMatrixTruckType":{ + "type":"string", + "enum":[ + "LightTruck", + "StraightTruck", + "Tractor" + ] + }, + "RouteMatrixVehicleLicensePlate":{ + "type":"structure", + "members":{ + "LastCharacter":{ + "shape":"RouteMatrixVehicleLicensePlateLastCharacterString", + "documentation":"

The last character of the License Plate.

" + } + }, + "documentation":"

The vehicle License Plate.

" + }, + "RouteMatrixVehicleLicensePlateLastCharacterString":{ + "type":"string", + "max":1, + "min":1 + }, + "RouteMatrixZoneCategory":{ + "type":"string", + "enum":[ + "CongestionPricing", + "Environmental", + "Vignette" + ] + }, + "RouteNoticeDetailRange":{ + "type":"structure", + "members":{ + "Min":{ + "shape":"RouteNoticeDetailRangeMinInteger", + "documentation":"

Minimum value for the range.

" + }, + "Max":{ + "shape":"RouteNoticeDetailRangeMaxInteger", + "documentation":"

Maximum value for the range.

" + } + }, + "documentation":"

Notice Detail that is a range.

" + }, + "RouteNoticeDetailRangeMaxInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteNoticeDetailRangeMinInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteNoticeImpact":{ + "type":"string", + "enum":[ + "High", + "Low" + ] + }, + "RouteNumber":{ + "type":"structure", + "required":["Value"], + "members":{ + "Direction":{ + "shape":"RouteDirection", + "documentation":"

Directional identifier of the route.

" + }, + "Language":{ + "shape":"LanguageTag", + "documentation":"

List of languages for instructions corresponding to the route number.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The route number.

" + } + }, + "documentation":"

The route number.

" + }, + "RouteNumberList":{ + "type":"list", + "member":{"shape":"RouteNumber"} + }, + "RouteOriginOptions":{ + "type":"structure", + "members":{ + "AvoidActionsForDistance":{ + "shape":"RouteOriginOptionsAvoidActionsForDistanceLong", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "AvoidUTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"RouteMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "SideOfStreet":{ + "shape":"RouteSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Origin related options.

" + }, + "RouteOriginOptionsAvoidActionsForDistanceLong":{ + "type":"long", + "max":2000 + }, + "RoutePassThroughPlace":{ + "type":"structure", + "required":["Position"], + "members":{ + "OriginalPosition":{ + "shape":"Position23", + "documentation":"

Position provided in the request.

" + }, + "Position":{ + "shape":"Position23", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "WaypointIndex":{ + "shape":"RoutePassThroughPlaceWaypointIndexInteger", + "documentation":"

Index of the waypoint in the request.

" + } + }, + "documentation":"

The place where the waypoint is passed through and not treated as a stop.

" + }, + "RoutePassThroughPlaceWaypointIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RoutePassThroughWaypoint":{ + "type":"structure", + "required":["Place"], + "members":{ + "GeometryOffset":{ + "shape":"RoutePassThroughWaypointGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this step.

" + }, + "Place":{ + "shape":"RoutePassThroughPlace", + "documentation":"

The place details.

" + } + }, + "documentation":"

If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.

" + }, + "RoutePassThroughWaypointGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RoutePassThroughWaypointList":{ + "type":"list", + "member":{"shape":"RoutePassThroughWaypoint"} + }, + "RoutePedestrianArrival":{ + "type":"structure", + "required":["Place"], + "members":{ + "Place":{ + "shape":"RoutePedestrianPlace", + "documentation":"

The place details.

" + }, + "Time":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

The time.

" + } + }, + "documentation":"

Details corresponding to the arrival for a leg.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "RoutePedestrianDeparture":{ + "type":"structure", + "required":["Place"], + "members":{ + "Place":{ + "shape":"RoutePedestrianPlace", + "documentation":"

The place details.

" + }, + "Time":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

The time.

" + } + }, + "documentation":"

Details corresponding to the departure for a leg.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "RoutePedestrianLegDetails":{ + "type":"structure", + "required":[ + "Arrival", + "Departure", + "Notices", + "PassThroughWaypoints", + "Spans", + "TravelSteps" + ], + "members":{ + "Arrival":{ + "shape":"RoutePedestrianArrival", + "documentation":"

Details corresponding to the arrival for the leg.

" + }, + "Departure":{ + "shape":"RoutePedestrianDeparture", + "documentation":"

Details corresponding to the departure for the leg.

" + }, + "Notices":{ + "shape":"RoutePedestrianNoticeList", + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "PassThroughWaypoints":{ + "shape":"RoutePassThroughWaypointList", + "documentation":"

Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

" + }, + "Spans":{ + "shape":"RoutePedestrianSpanList", + "documentation":"

Spans that were computed for the requested SpanAdditionalFeatures.

" + }, + "Summary":{ + "shape":"RoutePedestrianSummary", + "documentation":"

Summarized details of the leg.

" + }, + "TravelSteps":{ + "shape":"RoutePedestrianTravelStepList", + "documentation":"

Steps of a leg that must be performed before the travel portion of the leg.

" + } + }, + "documentation":"

Details that are specific to a pedestrian leg.

" + }, + "RoutePedestrianNotice":{ + "type":"structure", + "required":["Code"], + "members":{ + "Code":{ + "shape":"RoutePedestrianNoticeCode", + "documentation":"

Code corresponding to the issue.

" + }, + "Impact":{ + "shape":"RouteNoticeImpact", + "documentation":"

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" + } + }, + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "RoutePedestrianNoticeCode":{ + "type":"string", + "enum":[ + "AccuratePolylineUnavailable", + "Other", + "ViolatedAvoidDirtRoad", + "ViolatedAvoidTunnel", + "ViolatedPedestrianOption" + ] + }, + "RoutePedestrianNoticeList":{ + "type":"list", + "member":{"shape":"RoutePedestrianNotice"} + }, + "RoutePedestrianOptions":{ + "type":"structure", + "members":{ + "Speed":{ + "shape":"RoutePedestrianOptionsSpeedDouble", + "documentation":"

Walking speed in Kilometers per hour.

", + "box":true + } + }, + "documentation":"

Options related to the pedestrian.

" + }, + "RoutePedestrianOptionsSpeedDouble":{ + "type":"double", + "max":7.2, + "min":1.8 + }, + "RoutePedestrianOverviewSummary":{ + "type":"structure", + "required":[ + "Distance", + "Duration" + ], + "members":{ + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

" + } + }, + "documentation":"

Provides a summary of a pedestrian route step.

" + }, + "RoutePedestrianPlace":{ + "type":"structure", + "required":["Position"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the place.

" + }, + "OriginalPosition":{ + "shape":"Position23", + "documentation":"

Position provided in the request.

" + }, + "Position":{ + "shape":"Position23", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "SideOfStreet":{ + "shape":"RouteSideOfStreet", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "WaypointIndex":{ + "shape":"RoutePedestrianPlaceWaypointIndexInteger", + "documentation":"

Index of the waypoint in the request.

" + } + }, + "documentation":"

Place details corresponding to the arrival or departure.

" + }, + "RoutePedestrianPlaceWaypointIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RoutePedestrianSpan":{ + "type":"structure", + "members":{ + "BestCaseDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span without traffic congestion.

Unit: seconds

" + }, + "Country":{ + "shape":"CountryCode3", + "documentation":"

3 letter Country code corresponding to the Span.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

" + }, + "DynamicSpeed":{ + "shape":"RouteSpanDynamicSpeedDetails", + "documentation":"

Dynamic speed details corresponding to the span.

Unit: KilometersPerHour

" + }, + "FunctionalClassification":{ + "shape":"RoutePedestrianSpanFunctionalClassificationInteger", + "documentation":"

Functional classification of the road segment corresponding to the span.

" + }, + "GeometryOffset":{ + "shape":"RoutePedestrianSpanGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this span.

" + }, + "Incidents":{ + "shape":"IndexList", + "documentation":"

Incidents corresponding to the span. These index into the Incidents in the parent Leg.

" + }, + "Names":{ + "shape":"LocalizedStringList", + "documentation":"

Provides an array of names of the pedestrian span in available languages.

" + }, + "PedestrianAccess":{ + "shape":"RouteSpanPedestrianAccessAttributeList", + "documentation":"

Access attributes for a pedestrian corresponding to the span.

" + }, + "Region":{ + "shape":"RoutePedestrianSpanRegionString", + "documentation":"

2-3 letter Region code corresponding to the Span. This is either a province or a state.

" + }, + "RoadAttributes":{ + "shape":"RouteSpanRoadAttributeList", + "documentation":"

Attributes for the road segment corresponding to the span.

" + }, + "RouteNumbers":{ + "shape":"RouteNumberList", + "documentation":"

Designated route name or number corresponding to the span.

" + }, + "SpeedLimit":{ + "shape":"RouteSpanSpeedLimitDetails", + "documentation":"

Speed limit details corresponding to the span.

Unit: KilometersPerHour

" + }, + "TypicalDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span under typical traffic congestion.

Unit: seconds

" + } + }, + "documentation":"

Span computed for the requested SpanAdditionalFeatures.

" + }, + "RoutePedestrianSpanFunctionalClassificationInteger":{ + "type":"integer", + "box":true, + "max":5, + "min":1 + }, + "RoutePedestrianSpanGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RoutePedestrianSpanList":{ + "type":"list", + "member":{"shape":"RoutePedestrianSpan"} + }, + "RoutePedestrianSpanRegionString":{ + "type":"string", + "max":3, + "min":0 + }, + "RoutePedestrianSummary":{ + "type":"structure", + "members":{ + "Overview":{ + "shape":"RoutePedestrianOverviewSummary", + "documentation":"

Summarized details for the leg including before travel, travel and after travel steps.

" + }, + "TravelOnly":{ + "shape":"RoutePedestrianTravelOnlySummary", + "documentation":"

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters

" + } + }, + "documentation":"

Summarized details for the leg including before travel, travel and after travel steps.

" + }, + "RoutePedestrianTravelOnlySummary":{ + "type":"structure", + "required":["Duration"], + "members":{ + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + } + }, + "documentation":"

Summarized details for the leg including travel steps.

" + }, + "RoutePedestrianTravelStep":{ + "type":"structure", + "required":[ + "Duration", + "Type" + ], + "members":{ + "ContinueStepDetails":{ + "shape":"RouteContinueStepDetails", + "documentation":"

Details related to the continue step.

" + }, + "CurrentRoad":{ + "shape":"RouteRoad", + "documentation":"

Details of the current road. See RouteRoad for details of sub-attributes.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "ExitNumber":{ + "shape":"LocalizedStringList", + "documentation":"

Exit number of the road exit, if applicable.

" + }, + "GeometryOffset":{ + "shape":"RoutePedestrianTravelStepGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this step.

" + }, + "Instruction":{ + "shape":"String", + "documentation":"

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" + }, + "KeepStepDetails":{ + "shape":"RouteKeepStepDetails", + "documentation":"

Details that are specific to a Keep step.

" + }, + "NextRoad":{ + "shape":"RouteRoad", + "documentation":"

Details of the next road. See RouteRoad for details of sub-attributes.

" + }, + "RoundaboutEnterStepDetails":{ + "shape":"RouteRoundaboutEnterStepDetails", + "documentation":"

Details that are specific to a Roundabout Enter step.

" + }, + "RoundaboutExitStepDetails":{ + "shape":"RouteRoundaboutExitStepDetails", + "documentation":"

Details that are specific to a Roundabout Exit step.

" + }, + "RoundaboutPassStepDetails":{ + "shape":"RouteRoundaboutPassStepDetails", + "documentation":"

Details that are specific to a Roundabout Pass step.

" + }, + "Signpost":{ + "shape":"RouteSignpost", + "documentation":"

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

" + }, + "TurnStepDetails":{ + "shape":"RouteTurnStepDetails", + "documentation":"

Details that are specific to a turn step.

" + }, + "Type":{ + "shape":"RoutePedestrianTravelStepType", + "documentation":"

Type of the step.

" + } + }, + "documentation":"

Steps of a leg that must be performed during the travel portion of the leg.

" + }, + "RoutePedestrianTravelStepGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RoutePedestrianTravelStepList":{ + "type":"list", + "member":{"shape":"RoutePedestrianTravelStep"} + }, + "RoutePedestrianTravelStepType":{ + "type":"string", + "enum":[ + "Arrive", + "Continue", + "Depart", + "Keep", + "RoundaboutEnter", + "RoundaboutExit", + "RoundaboutPass", + "Turn", + "Exit", + "Ramp", + "UTurn" + ] + }, + "RouteRampStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details that are specific to a ramp step.

" + }, + "RouteResponseNotice":{ + "type":"structure", + "required":["Code"], + "members":{ + "Code":{ + "shape":"RouteResponseNoticeCode", + "documentation":"

Code corresponding to the issue.

" + }, + "Impact":{ + "shape":"RouteNoticeImpact", + "documentation":"

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" + } + }, + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "RouteResponseNoticeCode":{ + "type":"string", + "enum":[ + "MainLanguageNotFound", + "Other", + "TravelTimeExceedsDriverWorkHours" + ] + }, + "RouteResponseNoticeList":{ + "type":"list", + "member":{"shape":"RouteResponseNotice"} + }, + "RouteRoad":{ + "type":"structure", + "required":[ + "RoadName", + "RouteNumber", + "Towards" + ], + "members":{ + "RoadName":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the road (localized).

" + }, + "RouteNumber":{ + "shape":"RouteNumberList", + "documentation":"

Route number of the road.

" + }, + "Towards":{ + "shape":"LocalizedStringList", + "documentation":"

Names of destinations that can be reached when traveling on the road.

" + }, + "Type":{ + "shape":"RouteRoadType", + "documentation":"

The type of road.

" + } + }, + "documentation":"

The road on the route.

" + }, + "RouteRoadType":{ + "type":"string", + "enum":[ + "Highway", + "Rural", + "Urban" + ] + }, + "RouteRoundaboutEnterStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details about the roundabout leg.

" + }, + "RouteRoundaboutExitStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "RelativeExit":{ + "shape":"RouteRoundaboutExitStepDetailsRelativeExitInteger", + "documentation":"

Exit to be taken.

" + }, + "RoundaboutAngle":{ + "shape":"RoundaboutAngle", + "documentation":"

Angle of the roundabout.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + } + }, + "documentation":"

Details about the roundabout step.

" + }, + "RouteRoundaboutExitStepDetailsRelativeExitInteger":{ + "type":"integer", + "box":true, + "max":12, + "min":1 + }, + "RouteRoundaboutPassStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details about the step.

" + }, + "RouteScooterOptions":{ + "type":"structure", + "members":{ + "EngineType":{ + "shape":"RouteEngineType", + "documentation":"

Engine type of the vehicle.

" + }, + "LicensePlate":{ + "shape":"RouteVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"RouteScooterOptionsMaxSpeedDouble", + "documentation":"

Maximum speed

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"RouteScooterOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Scooter\"

" + }, + "RouteScooterOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "RouteScooterOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteSideOfStreet":{ + "type":"string", + "enum":[ + "Left", + "Right" + ] + }, + "RouteSideOfStreetOptions":{ + "type":"structure", + "required":["Position"], + "members":{ + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "UseWith":{ + "shape":"SideOfStreetMatchingStrategy", + "documentation":"

Strategy that defines when the side of street position should be used.

Default Value: DividedStreetOnly

" + } + }, + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "RouteSignpost":{ + "type":"structure", + "required":["Labels"], + "members":{ + "Labels":{ + "shape":"RouteSignpostLabelList", + "documentation":"

Labels present on the sign post.

" + } + }, + "documentation":"

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

" + }, + "RouteSignpostLabel":{ + "type":"structure", + "members":{ + "RouteNumber":{ + "shape":"RouteNumber", + "documentation":"

Route number of the road.

" + }, + "Text":{ + "shape":"LocalizedString", + "documentation":"

The Signpost text.

" + } + }, + "documentation":"

Labels presented on the sign post.

" + }, + "RouteSignpostLabelList":{ + "type":"list", + "member":{"shape":"RouteSignpostLabel"} + }, + "RouteSpanAdditionalFeature":{ + "type":"string", + "enum":[ + "BestCaseDuration", + "CarAccess", + "Country", + "Distance", + "Duration", + "DynamicSpeed", + "FunctionalClassification", + "Gates", + "Incidents", + "Names", + "Notices", + "PedestrianAccess", + "RailwayCrossings", + "Region", + "RoadAttributes", + "RouteNumbers", + "ScooterAccess", + "SpeedLimit", + "TollSystems", + "TruckAccess", + "TruckRoadTypes", + "TypicalDuration", + "Zones", + "Consumption" + ] + }, + "RouteSpanAdditionalFeatureList":{ + "type":"list", + "member":{"shape":"RouteSpanAdditionalFeature"}, + "max":24, + "min":0 + }, + "RouteSpanCarAccessAttribute":{ + "type":"string", + "enum":[ + "Allowed", + "NoThroughTraffic", + "TollRoad" + ] + }, + "RouteSpanCarAccessAttributeList":{ + "type":"list", + "member":{"shape":"RouteSpanCarAccessAttribute"}, + "max":3, + "min":0 + }, + "RouteSpanDynamicSpeedDetails":{ + "type":"structure", + "members":{ + "BestCaseSpeed":{ + "shape":"SpeedKilometersPerHour", + "documentation":"

Estimated speed while traversing the span without traffic congestion.

Unit: KilometersPerHour

" + }, + "TurnDuration":{ + "shape":"DurationSeconds", + "documentation":"

Estimated time to turn from this span into the next.

Unit: seconds

" + }, + "TypicalSpeed":{ + "shape":"SpeedKilometersPerHour", + "documentation":"

Estimated speed while traversing the span under typical traffic congestion.

Unit: KilometersPerHour

" + } + }, + "documentation":"

Details about the dynamic speed.

Unit: KilometersPerHour

" + }, + "RouteSpanGateAttribute":{ + "type":"string", + "enum":[ + "Emergency", + "KeyAccess", + "PermissionRequired" + ] + }, + "RouteSpanPedestrianAccessAttribute":{ + "type":"string", + "enum":[ + "Allowed", + "Indoors", + "NoThroughTraffic", + "Park", + "Stairs", + "TollRoad" + ] + }, + "RouteSpanPedestrianAccessAttributeList":{ + "type":"list", + "member":{"shape":"RouteSpanPedestrianAccessAttribute"}, + "max":6, + "min":0 + }, + "RouteSpanRailwayCrossingAttribute":{ + "type":"string", + "enum":[ + "Protected", + "Unprotected" + ] + }, + "RouteSpanRoadAttribute":{ + "type":"string", + "enum":[ + "Bridge", + "BuiltUpArea", + "ControlledAccessHighway", + "DirtRoad", + "DividedRoad", + "Motorway", + "PrivateRoad", + "Ramp", + "RightHandTraffic", + "Roundabout", + "Tunnel", + "UnderConstruction" + ] + }, + "RouteSpanRoadAttributeList":{ + "type":"list", + "member":{"shape":"RouteSpanRoadAttribute"}, + "max":12, + "min":0 + }, + "RouteSpanScooterAccessAttribute":{ + "type":"string", + "enum":[ + "Allowed", + "NoThroughTraffic", + "TollRoad" + ] + }, + "RouteSpanScooterAccessAttributeList":{ + "type":"list", + "member":{"shape":"RouteSpanScooterAccessAttribute"}, + "max":3, + "min":0 + }, + "RouteSpanSpeedLimitDetails":{ + "type":"structure", + "members":{ + "MaxSpeed":{ + "shape":"SpeedKilometersPerHour", + "documentation":"

Maximum speed.

Unit: KilometersPerHour

" + }, + "Unlimited":{ + "shape":"Boolean", + "documentation":"

If the span doesn't have a speed limit like the Autobahn.

" + } + }, + "documentation":"

Details about the speed limit corresponding to the span.

Unit: KilometersPerHour

" + }, + "RouteSpanTruckAccessAttribute":{ + "type":"string", + "enum":[ + "Allowed", + "NoThroughTraffic", + "TollRoad" + ] + }, + "RouteSpanTruckAccessAttributeList":{ + "type":"list", + "member":{"shape":"RouteSpanTruckAccessAttribute"}, + "max":3, + "min":0 + }, + "RouteSteeringDirection":{ + "type":"string", + "enum":[ + "Left", + "Right", + "Straight" + ] + }, + "RouteSummary":{ + "type":"structure", + "members":{ + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the route.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the route.

Unit: seconds

" + }, + "Tolls":{ + "shape":"RouteTollSummary", + "documentation":"

Toll summary for the complete route.

" + } + }, + "documentation":"

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is the same as the Distance within the Overview summary.

" + }, + "RouteToll":{ + "type":"structure", + "required":[ + "PaymentSites", + "Rates", + "Systems" + ], + "members":{ + "Country":{ + "shape":"CountryCode3", + "documentation":"

The alpha-2 or alpha-3 character code for the country.

" + }, + "PaymentSites":{ + "shape":"RouteTollPaymentSiteList", + "documentation":"

Locations or sites where the toll fare is collected.

" + }, + "Rates":{ + "shape":"RouteTollRateList", + "documentation":"

Toll rates that need to be paid to travel this leg of the route.

" + }, + "Systems":{ + "shape":"IndexList", + "documentation":"

Toll systems are authorities that collect payments for the toll.

" + } + }, + "documentation":"

Provides details about toll information along a route, including the payment sites, applicable toll rates, toll systems, and the country associated with the toll collection.

" + }, + "RouteTollList":{ + "type":"list", + "member":{"shape":"RouteToll"} + }, + "RouteTollOptions":{ + "type":"structure", + "members":{ + "AllTransponders":{ + "shape":"Boolean", + "documentation":"

Specifies if the user has valid transponder with access to all toll systems. This impacts toll calculation, and if true the price with transponders is used.

" + }, + "AllVignettes":{ + "shape":"Boolean", + "documentation":"

Specifies if the user has valid vignettes with access for all toll roads. If a user has a vignette for a toll road, then toll cost for that road is omitted since no further payment is necessary.

" + }, + "Currency":{ + "shape":"CurrencyCode", + "documentation":"

Currency code corresponding to the price. This is the same as Currency specified in the request.

" + }, + "EmissionType":{ + "shape":"RouteEmissionType", + "documentation":"

Emission type of the vehicle for toll cost calculation.

Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev

" + }, + "VehicleCategory":{ + "shape":"RouteTollVehicleCategory", + "documentation":"

Vehicle category for toll cost calculation.

" + } + }, + "documentation":"

Options related to Tolls on a route.

" + }, + "RouteTollPass":{ + "type":"structure", + "members":{ + "IncludesReturnTrip":{ + "shape":"Boolean", + "documentation":"

If the pass includes the rate for the return leg of the trip.

" + }, + "SeniorPass":{ + "shape":"Boolean", + "documentation":"

If the pass is only valid for senior persons.

" + }, + "TransferCount":{ + "shape":"RouteTollPassTransferCountInteger", + "documentation":"

If the toll pass can be transferred, and how many times.

" + }, + "TripCount":{ + "shape":"RouteTollPassTripCountInteger", + "documentation":"

Number of trips the pass is valid for.

" + }, + "ValidityPeriod":{ + "shape":"RouteTollPassValidityPeriod", + "documentation":"

Period for which the pass is valid.

" + } + }, + "documentation":"

Details if the toll rate can be a pass that supports multiple trips.

" + }, + "RouteTollPassTransferCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteTollPassTripCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteTollPassValidityPeriod":{ + "type":"structure", + "required":["Period"], + "members":{ + "Period":{ + "shape":"RouteTollPassValidityPeriodType", + "documentation":"

Validity period.

" + }, + "PeriodCount":{ + "shape":"RouteTollPassValidityPeriodPeriodCountInteger", + "documentation":"

Counts for the validity period.

" + } + }, + "documentation":"

Period for which the pass is valid.

" + }, + "RouteTollPassValidityPeriodPeriodCountInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteTollPassValidityPeriodType":{ + "type":"string", + "enum":[ + "Annual", + "Days", + "ExtendedAnnual", + "Minutes", + "Months" + ] + }, + "RouteTollPaymentMethod":{ + "type":"string", + "enum":[ + "BankCard", + "Cash", + "CashExact", + "CreditCard", + "PassSubscription", + "TravelCard", + "Transponder", + "VideoToll" + ] + }, + "RouteTollPaymentMethodList":{ + "type":"list", + "member":{"shape":"RouteTollPaymentMethod"}, + "max":8, + "min":0 + }, + "RouteTollPaymentSite":{ + "type":"structure", + "required":["Position"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Name of the payment site.

" + }, + "Position":{ + "shape":"Position23", + "documentation":"

Position defined as [longitude, latitude].

" + } + }, + "documentation":"

Locations or sites where the toll fare is collected.

" + }, + "RouteTollPaymentSiteList":{ + "type":"list", + "member":{"shape":"RouteTollPaymentSite"} + }, + "RouteTollPrice":{ + "type":"structure", + "required":[ + "Currency", + "Estimate", + "Range", + "Value" + ], + "members":{ + "Currency":{ + "shape":"CurrencyCode", + "documentation":"

Currency code corresponding to the price. This is the same as Currency specified in the request.

" + }, + "Estimate":{ + "shape":"Boolean", + "documentation":"

If the price is an estimate or an exact value.

" + }, + "PerDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration for which the price corresponds to.

Unit: seconds

" + }, + "Range":{ + "shape":"Boolean", + "documentation":"

If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.

" + }, + "RangeValue":{ + "shape":"RouteTollPriceValueRange", + "documentation":"

Price range with a minimum and maximum value, if a range.

" + }, + "Value":{ + "shape":"RouteTollPriceValueDouble", + "documentation":"

Exact price, if not a range.

" + } + }, + "documentation":"

The toll price.

" + }, + "RouteTollPriceSummary":{ + "type":"structure", + "required":[ + "Currency", + "Estimate", + "Range", + "Value" + ], + "members":{ + "Currency":{ + "shape":"CurrencyCode", + "documentation":"

Currency code corresponding to the price. This is the same as Currency specified in the request.

" + }, + "Estimate":{ + "shape":"Boolean", + "documentation":"

If the price is an estimate or an exact value.

" + }, + "Range":{ + "shape":"Boolean", + "documentation":"

If the price is a range or an exact value. If any of the toll fares making up the route is a range, the overall price is also a range.

" + }, + "RangeValue":{ + "shape":"RouteTollPriceValueRange", + "documentation":"

Price range with a minimum and maximum value, if a range.

" + }, + "Value":{ + "shape":"RouteTollPriceSummaryValueDouble", + "documentation":"

Exact price, if not a range.

" + } + }, + "documentation":"

Summary of the route and toll price.

" + }, + "RouteTollPriceSummaryValueDouble":{ + "type":"double", + "box":true, + "min":0.0 + }, + "RouteTollPriceValueDouble":{ + "type":"double", + "box":true, + "min":0.0 + }, + "RouteTollPriceValueRange":{ + "type":"structure", + "required":[ + "Min", + "Max" + ], + "members":{ + "Min":{ + "shape":"RouteTollPriceValueRangeMinDouble", + "documentation":"

Minimum price.

" + }, + "Max":{ + "shape":"RouteTollPriceValueRangeMaxDouble", + "documentation":"

Maximum price.

" + } + }, + "documentation":"

Price range with a minimum and maximum value, if a range.

" + }, + "RouteTollPriceValueRangeMaxDouble":{ + "type":"double", + "box":true, + "min":0.0 + }, + "RouteTollPriceValueRangeMinDouble":{ + "type":"double", + "box":true, + "min":0.0 + }, + "RouteTollRate":{ + "type":"structure", + "required":[ + "Id", + "LocalPrice", + "Name", + "PaymentMethods", + "Transponders" + ], + "members":{ + "ApplicableTimes":{ + "shape":"String", + "documentation":"

Time when the rate is valid.

" + }, + "ConvertedPrice":{ + "shape":"RouteTollPrice", + "documentation":"

Price in the converted currency as specified in the request.

" + }, + "Id":{ + "shape":"String", + "documentation":"

The Toll rate Id.

" + }, + "LocalPrice":{ + "shape":"RouteTollPrice", + "documentation":"

Price in the local regional currency.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the toll.

" + }, + "Pass":{ + "shape":"RouteTollPass", + "documentation":"

Details if the toll rate can be a pass that supports multiple trips.

" + }, + "PaymentMethods":{ + "shape":"RouteTollPaymentMethodList", + "documentation":"

Accepted payment methods at the toll.

" + }, + "Transponders":{ + "shape":"RouteTransponderList", + "documentation":"

Transponders for which this toll can be applied.

" + } + }, + "documentation":"

The toll rate.

" + }, + "RouteTollRateList":{ + "type":"list", + "member":{"shape":"RouteTollRate"} + }, + "RouteTollSummary":{ + "type":"structure", + "members":{ + "Total":{ + "shape":"RouteTollPriceSummary", + "documentation":"

Total toll summary for the complete route. Total is the only summary available today.

" + } + }, + "documentation":"

The toll summary for the complete route.

" + }, + "RouteTollSystem":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The toll system name.

" + } + }, + "documentation":"

Toll systems are authorities that collect payments for the toll.

" + }, + "RouteTollSystemList":{ + "type":"list", + "member":{"shape":"RouteTollSystem"} + }, + "RouteTollVehicleCategory":{ + "type":"string", + "enum":["Minibus"] + }, + "RouteTrafficOptions":{ + "type":"structure", + "members":{ + "FlowEventThresholdOverride":{ + "shape":"DurationSeconds", + "documentation":"

Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

" + }, + "Usage":{ + "shape":"TrafficUsage", + "documentation":"

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" + } + }, + "documentation":"

Traffic options for the route.

" + }, + "RouteTrailerOptions":{ + "type":"structure", + "members":{ + "AxleCount":{ + "shape":"RouteTrailerOptionsAxleCountInteger", + "documentation":"

Total number of axles of the vehicle.

" + }, + "TrailerCount":{ + "shape":"RouteTrailerOptionsTrailerCountInteger", + "documentation":"

Number of trailers attached to the vehicle.

Default Value: 0

" + } + }, + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "RouteTrailerOptionsAxleCountInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteTrailerOptionsTrailerCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":1 + }, + "RouteTransponder":{ + "type":"structure", + "members":{ + "SystemName":{ + "shape":"String", + "documentation":"

Names of the toll system collecting the toll.

" + } + }, + "documentation":"

Transponders for which this toll can be applied.

" + }, + "RouteTransponderList":{ + "type":"list", + "member":{"shape":"RouteTransponder"} + }, + "RouteTravelMode":{ + "type":"string", + "enum":[ + "Car", + "Pedestrian", + "Scooter", + "Truck" + ] + }, + "RouteTravelModeOptions":{ + "type":"structure", + "members":{ + "Car":{ + "shape":"RouteCarOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Car\"

" + }, + "Pedestrian":{ + "shape":"RoutePedestrianOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Pedestrian\"

" + }, + "Scooter":{ + "shape":"RouteScooterOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Scooter\"

" + }, + "Truck":{ + "shape":"RouteTruckOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + } + }, + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "RouteTravelStepType":{ + "type":"string", + "enum":[ + "Default", + "TurnByTurn" + ] + }, + "RouteTruckOptions":{ + "type":"structure", + "members":{ + "AxleCount":{ + "shape":"RouteTruckOptionsAxleCountInteger", + "documentation":"

Total number of axles of the vehicle.

" + }, + "EngineType":{ + "shape":"RouteEngineType", + "documentation":"

Engine type of the vehicle.

" + }, + "GrossWeight":{ + "shape":"WeightKilograms", + "documentation":"

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" + }, + "HazardousCargos":{ + "shape":"RouteHazardousCargoTypeList", + "documentation":"

List of Hazardous cargo contained in the vehicle.

" + }, + "Height":{ + "shape":"RouteTruckOptionsHeightLong", + "documentation":"

Height of the vehicle.

Unit: centimeters

" + }, + "HeightAboveFirstAxle":{ + "shape":"RouteTruckOptionsHeightAboveFirstAxleLong", + "documentation":"

Height of the vehicle above its first axle.

Unit: centimeters

" + }, + "KpraLength":{ + "shape":"DimensionCentimeters", + "documentation":"

Kingpin to rear axle length of the vehicle.

Unit: centimeters

" + }, + "Length":{ + "shape":"RouteTruckOptionsLengthLong", + "documentation":"

Length of the vehicle.

Unit: c

" + }, + "LicensePlate":{ + "shape":"RouteVehicleLicensePlate", + "documentation":"

The vehicle License Plate.

" + }, + "MaxSpeed":{ + "shape":"RouteTruckOptionsMaxSpeedDouble", + "documentation":"

Maximum speed

Unit: KilometersPerHour

", + "box":true + }, + "Occupancy":{ + "shape":"RouteTruckOptionsOccupancyInteger", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + }, + "PayloadCapacity":{ + "shape":"WeightKilograms", + "documentation":"

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

" + }, + "TireCount":{ + "shape":"RouteTruckOptionsTireCountInteger", + "documentation":"

Number of tires on the vehicle.

" + }, + "Trailer":{ + "shape":"RouteTrailerOptions", + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "TruckType":{ + "shape":"RouteTruckType", + "documentation":"

Type of the truck.

" + }, + "TunnelRestrictionCode":{ + "shape":"RouteTruckOptionsTunnelRestrictionCodeString", + "documentation":"

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

" + }, + "WeightPerAxle":{ + "shape":"WeightKilograms", + "documentation":"

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" + }, + "WeightPerAxleGroup":{ + "shape":"WeightPerAxleGroup", + "documentation":"

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

Unit: Kilograms

" + }, + "Width":{ + "shape":"RouteTruckOptionsWidthLong", + "documentation":"

Width of the vehicle.

Unit: centimeters

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + }, + "RouteTruckOptionsAxleCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":2 + }, + "RouteTruckOptionsHeightAboveFirstAxleLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RouteTruckOptionsHeightLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RouteTruckOptionsLengthLong":{ + "type":"long", + "max":30000, + "min":0 + }, + "RouteTruckOptionsMaxSpeedDouble":{ + "type":"double", + "max":252.0, + "min":3.6 + }, + "RouteTruckOptionsOccupancyInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "RouteTruckOptionsTireCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":1 + }, + "RouteTruckOptionsTunnelRestrictionCodeString":{ + "type":"string", + "max":20, + "min":0 + }, + "RouteTruckOptionsWidthLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "RouteTruckType":{ + "type":"string", + "enum":[ + "LightTruck", + "StraightTruck", + "Tractor" + ] + }, + "RouteTurnIntensity":{ + "type":"string", + "enum":[ + "Sharp", + "Slight", + "Typical" + ] + }, + "RouteTurnStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details related to the turn step.

" + }, + "RouteUTurnStepDetails":{ + "type":"structure", + "required":["Intersection"], + "members":{ + "Intersection":{ + "shape":"LocalizedStringList", + "documentation":"

Name of the intersection, if applicable to the step.

" + }, + "SteeringDirection":{ + "shape":"RouteSteeringDirection", + "documentation":"

Steering direction for the step.

" + }, + "TurnAngle":{ + "shape":"TurnAngle", + "documentation":"

Angle of the turn.

" + }, + "TurnIntensity":{ + "shape":"RouteTurnIntensity", + "documentation":"

Intensity of the turn.

" + } + }, + "documentation":"

Details related to the U-turn step.

" + }, + "RouteVehicleArrival":{ + "type":"structure", + "required":["Place"], + "members":{ + "Place":{ + "shape":"RouteVehiclePlace", + "documentation":"

The place details.

" + }, + "Time":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

The time.

" + } + }, + "documentation":"

Details corresponding to the arrival for a leg.

" + }, + "RouteVehicleDeparture":{ + "type":"structure", + "required":["Place"], + "members":{ + "Place":{ + "shape":"RouteVehiclePlace", + "documentation":"

The place details.

" + }, + "Time":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

The departure time.

" + } + }, + "documentation":"

Details corresponding to the departure for the leg.

" + }, + "RouteVehicleIncident":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

Brief readable description of the incident.

" + }, + "EndTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

End timestamp of the incident.

" + }, + "Severity":{ + "shape":"RouteVehicleIncidentSeverity", + "documentation":"

Severity of the incident Critical - The part of the route the incident affects is unusable. Major- Major impact on the leg duration, for example stop and go Minor- Minor impact on the leg duration, for example traffic jam Low - Low on duration, for example slightly increased traffic

" + }, + "StartTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Start time of the incident.

" + }, + "Type":{ + "shape":"RouteVehicleIncidentType", + "documentation":"

Type of the incident.

" + } + }, + "documentation":"

Incidents corresponding to this leg of the route.

" + }, + "RouteVehicleIncidentList":{ + "type":"list", + "member":{"shape":"RouteVehicleIncident"} + }, + "RouteVehicleIncidentSeverity":{ + "type":"string", + "enum":[ + "Critical", + "High", + "Medium", + "Low" + ] + }, + "RouteVehicleIncidentType":{ + "type":"string", + "enum":[ + "Accident", + "Congestion", + "Construction", + "DisabledVehicle", + "LaneRestriction", + "MassTransit", + "Other", + "PlannedEvent", + "RoadClosure", + "RoadHazard", + "Weather" + ] + }, + "RouteVehicleLegDetails":{ + "type":"structure", + "required":[ + "Arrival", + "Departure", + "Incidents", + "Notices", + "PassThroughWaypoints", + "Spans", + "Tolls", + "TollSystems", + "TravelSteps", + "TruckRoadTypes", + "Zones" + ], + "members":{ + "Arrival":{ + "shape":"RouteVehicleArrival", + "documentation":"

Details corresponding to the arrival for the leg.

" + }, + "Departure":{ + "shape":"RouteVehicleDeparture", + "documentation":"

Details corresponding to the departure for the leg.

" + }, + "Incidents":{ + "shape":"RouteVehicleIncidentList", + "documentation":"

Incidents corresponding to this leg of the route.

" + }, + "Notices":{ + "shape":"RouteVehicleNoticeList", + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "PassThroughWaypoints":{ + "shape":"RoutePassThroughWaypointList", + "documentation":"

Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.

" + }, + "Spans":{ + "shape":"RouteVehicleSpanList", + "documentation":"

Spans that were computed for the requested SpanAdditionalFeatures.

" + }, + "Summary":{ + "shape":"RouteVehicleSummary", + "documentation":"

Summarized details of the leg.

" + }, + "Tolls":{ + "shape":"RouteTollList", + "documentation":"

Toll related options.

" + }, + "TollSystems":{ + "shape":"RouteTollSystemList", + "documentation":"

Toll systems are authorities that collect payments for the toll.

" + }, + "TravelSteps":{ + "shape":"RouteVehicleTravelStepList", + "documentation":"

Steps of a leg that must be performed before the travel portion of the leg.

" + }, + "TruckRoadTypes":{ + "shape":"TruckRoadTypeList", + "documentation":"

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" + }, + "Zones":{ + "shape":"RouteZoneList", + "documentation":"

Zones corresponding to this leg of the route.

" + } + }, + "documentation":"

Steps of a leg that correspond to the travel portion of the leg.

" + }, + "RouteVehicleLicensePlate":{ + "type":"structure", + "members":{ + "LastCharacter":{ + "shape":"RouteVehicleLicensePlateLastCharacterString", + "documentation":"

The last character of the License Plate.

" + } + }, + "documentation":"

License plate information of the vehicle. Currently, only the last character is used where license plate based controlled access is enforced.

" + }, + "RouteVehicleLicensePlateLastCharacterString":{ + "type":"string", + "max":1, + "min":1 + }, + "RouteVehicleNotice":{ + "type":"structure", + "required":[ + "Code", + "Details" + ], + "members":{ + "Code":{ + "shape":"RouteVehicleNoticeCode", + "documentation":"

Code corresponding to the issue.

" + }, + "Details":{ + "shape":"RouteVehicleNoticeDetailList", + "documentation":"

Additional details of the notice.

" + }, + "Impact":{ + "shape":"RouteNoticeImpact", + "documentation":"

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

" + } + }, + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "RouteVehicleNoticeCode":{ + "type":"string", + "enum":[ + "AccuratePolylineUnavailable", + "Other", + "PotentialViolatedAvoidTollRoadUsage", + "PotentialViolatedCarpoolUsage", + "PotentialViolatedTurnRestrictionUsage", + "PotentialViolatedVehicleRestrictionUsage", + "PotentialViolatedZoneRestrictionUsage", + "SeasonalClosure", + "TollsDataTemporarilyUnavailable", + "TollsDataUnavailable", + "TollTransponder", + "ViolatedAvoidControlledAccessHighway", + "ViolatedAvoidDifficultTurns", + "ViolatedAvoidDirtRoad", + "ViolatedAvoidSeasonalClosure", + "ViolatedAvoidTollRoad", + "ViolatedAvoidTollTransponder", + "ViolatedAvoidTruckRoadType", + "ViolatedAvoidTunnel", + "ViolatedAvoidUTurns", + "ViolatedBlockedRoad", + "ViolatedCarpool", + "ViolatedEmergencyGate", + "ViolatedStartDirection", + "ViolatedTurnRestriction", + "ViolatedVehicleRestriction", + "ViolatedZoneRestriction" + ] + }, + "RouteVehicleNoticeDetail":{ + "type":"structure", + "members":{ + "Title":{ + "shape":"String", + "documentation":"

The notice title.

" + }, + "ViolatedConstraints":{ + "shape":"RouteViolatedConstraints", + "documentation":"

Any violated constraints.

" + } + }, + "documentation":"

Additional details of the notice.

" + }, + "RouteVehicleNoticeDetailList":{ + "type":"list", + "member":{"shape":"RouteVehicleNoticeDetail"} + }, + "RouteVehicleNoticeList":{ + "type":"list", + "member":{"shape":"RouteVehicleNotice"} + }, + "RouteVehicleOverviewSummary":{ + "type":"structure", + "required":[ + "Distance", + "Duration" + ], + "members":{ + "BestCaseDuration":{ + "shape":"DurationSeconds", + "documentation":"

Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.

Unit: seconds

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "TypicalDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span under typical traffic congestion.

Unit: seconds

" + } + }, + "documentation":"

Summarized details of the leg.

" + }, + "RouteVehiclePlace":{ + "type":"structure", + "required":["Position"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the place.

" + }, + "OriginalPosition":{ + "shape":"Position23", + "documentation":"

Position provided in the request.

" + }, + "Position":{ + "shape":"Position23", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "SideOfStreet":{ + "shape":"RouteSideOfStreet", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "WaypointIndex":{ + "shape":"RouteVehiclePlaceWaypointIndexInteger", + "documentation":"

Index of the waypoint in the request.

" + } + }, + "documentation":"

Place details corresponding to the arrival or departure.

" + }, + "RouteVehiclePlaceWaypointIndexInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteVehicleSpan":{ + "type":"structure", + "members":{ + "BestCaseDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span without traffic congestion.

Unit: seconds

" + }, + "CarAccess":{ + "shape":"RouteSpanCarAccessAttributeList", + "documentation":"

Access attributes for a car corresponding to the span.

" + }, + "Country":{ + "shape":"CountryCode3", + "documentation":"

3 letter Country code corresponding to the Span.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

Unit: seconds

" + }, + "DynamicSpeed":{ + "shape":"RouteSpanDynamicSpeedDetails", + "documentation":"

Dynamic speed details corresponding to the span.

Unit: KilometersPerHour

" + }, + "FunctionalClassification":{ + "shape":"RouteVehicleSpanFunctionalClassificationInteger", + "documentation":"

Functional classification of the road segment corresponding to the span.

" + }, + "Gate":{ + "shape":"RouteSpanGateAttribute", + "documentation":"

Attributes corresponding to a gate. The gate is present at the end of the returned span.

" + }, + "GeometryOffset":{ + "shape":"RouteVehicleSpanGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this span.

" + }, + "Incidents":{ + "shape":"IndexList", + "documentation":"

Incidents corresponding to the span. These index into the Incidents in the parent Leg.

" + }, + "Names":{ + "shape":"LocalizedStringList", + "documentation":"

Provides an array of names of the vehicle span in available languages.

" + }, + "Notices":{ + "shape":"IndexList", + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "RailwayCrossing":{ + "shape":"RouteSpanRailwayCrossingAttribute", + "documentation":"

Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.

" + }, + "Region":{ + "shape":"RouteVehicleSpanRegionString", + "documentation":"

2-3 letter Region code corresponding to the Span. This is either a province or a state.

" + }, + "RoadAttributes":{ + "shape":"RouteSpanRoadAttributeList", + "documentation":"

Attributes for the road segment corresponding to the span.

" + }, + "RouteNumbers":{ + "shape":"RouteNumberList", + "documentation":"

Designated route name or number corresponding to the span.

" + }, + "ScooterAccess":{ + "shape":"RouteSpanScooterAccessAttributeList", + "documentation":"

Access attributes for a scooter corresponding to the span.

" + }, + "SpeedLimit":{ + "shape":"RouteSpanSpeedLimitDetails", + "documentation":"

Speed limit details corresponding to the span.

Unit: KilometersPerHour

" + }, + "TollSystems":{ + "shape":"IndexList", + "documentation":"

Toll systems are authorities that collect payments for the toll.

" + }, + "TruckAccess":{ + "shape":"RouteSpanTruckAccessAttributeList", + "documentation":"

Access attributes for a truck corresponding to the span.

" + }, + "TruckRoadTypes":{ + "shape":"IndexList", + "documentation":"

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" + }, + "TypicalDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span under typical traffic congestion.

Unit: seconds

" + }, + "Zones":{ + "shape":"IndexList", + "documentation":"

Zones corresponding to this leg of the route.

" + } + }, + "documentation":"

Span computed for the requested SpanAdditionalFeatures.

" + }, + "RouteVehicleSpanFunctionalClassificationInteger":{ + "type":"integer", + "box":true, + "max":5, + "min":1 + }, + "RouteVehicleSpanGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteVehicleSpanList":{ + "type":"list", + "member":{"shape":"RouteVehicleSpan"} + }, + "RouteVehicleSpanRegionString":{ + "type":"string", + "max":3, + "min":0 + }, + "RouteVehicleSummary":{ + "type":"structure", + "members":{ + "Overview":{ + "shape":"RouteVehicleOverviewSummary", + "documentation":"

Summarized details for the leg including before travel, travel and after travel steps.

" + }, + "TravelOnly":{ + "shape":"RouteVehicleTravelOnlySummary", + "documentation":"

Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters

" + } + }, + "documentation":"

Summarized details of the route.

" + }, + "RouteVehicleTravelOnlySummary":{ + "type":"structure", + "required":["Duration"], + "members":{ + "BestCaseDuration":{ + "shape":"DurationSeconds", + "documentation":"

Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.

Unit: seconds

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "TypicalDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the computed span under typical traffic congestion.

Unit: seconds

" + } + }, + "documentation":"

Summarized details of the route.

" + }, + "RouteVehicleTravelStep":{ + "type":"structure", + "required":[ + "Duration", + "Type" + ], + "members":{ + "ContinueHighwayStepDetails":{ + "shape":"RouteContinueHighwayStepDetails", + "documentation":"

Details that are specific to a Continue Highway step.

" + }, + "ContinueStepDetails":{ + "shape":"RouteContinueStepDetails", + "documentation":"

Details that are specific to a Continue step.

" + }, + "CurrentRoad":{ + "shape":"RouteRoad", + "documentation":"

Details of the current road.

" + }, + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "Duration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the step.

Unit: seconds

" + }, + "EnterHighwayStepDetails":{ + "shape":"RouteEnterHighwayStepDetails", + "documentation":"

Details that are specific to a Enter Highway step.

" + }, + "ExitNumber":{ + "shape":"LocalizedStringList", + "documentation":"

Exit number of the road exit, if applicable.

" + }, + "ExitStepDetails":{ + "shape":"RouteExitStepDetails", + "documentation":"

Details that are specific to a Roundabout Exit step.

" + }, + "GeometryOffset":{ + "shape":"RouteVehicleTravelStepGeometryOffsetInteger", + "documentation":"

Offset in the leg geometry corresponding to the start of this step.

" + }, + "Instruction":{ + "shape":"String", + "documentation":"

Brief description of the step in the requested language.

Only available when the TravelStepType is Default.

" + }, + "KeepStepDetails":{ + "shape":"RouteKeepStepDetails", + "documentation":"

Details that are specific to a Keep step.

" + }, + "NextRoad":{ + "shape":"RouteRoad", + "documentation":"

Details of the next road. See RouteRoad for details of sub-attributes.

" + }, + "RampStepDetails":{ + "shape":"RouteRampStepDetails", + "documentation":"

Details that are specific to a Ramp step.

" + }, + "RoundaboutEnterStepDetails":{ + "shape":"RouteRoundaboutEnterStepDetails", + "documentation":"

Details that are specific to a Roundabout Enter step.

" + }, + "RoundaboutExitStepDetails":{ + "shape":"RouteRoundaboutExitStepDetails", + "documentation":"

Details that are specific to a Roundabout Exit step.

" + }, + "RoundaboutPassStepDetails":{ + "shape":"RouteRoundaboutPassStepDetails", + "documentation":"

Details that are specific to a Roundabout Pass step.

" + }, + "Signpost":{ + "shape":"RouteSignpost", + "documentation":"

Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.

" + }, + "TurnStepDetails":{ + "shape":"RouteTurnStepDetails", + "documentation":"

Details that are specific to a Turn step.

" + }, + "Type":{ + "shape":"RouteVehicleTravelStepType", + "documentation":"

Type of the step.

" + }, + "UTurnStepDetails":{ + "shape":"RouteUTurnStepDetails", + "documentation":"

Details that are specific to a Turn step.

" + } + }, + "documentation":"

Steps of a leg that correspond to the travel portion of the leg.

" + }, + "RouteVehicleTravelStepGeometryOffsetInteger":{ + "type":"integer", + "box":true, + "min":0 + }, + "RouteVehicleTravelStepList":{ + "type":"list", + "member":{"shape":"RouteVehicleTravelStep"} + }, + "RouteVehicleTravelStepType":{ + "type":"string", + "enum":[ + "Arrive", + "Continue", + "ContinueHighway", + "Depart", + "EnterHighway", + "Exit", + "Keep", + "Ramp", + "RoundaboutEnter", + "RoundaboutExit", + "RoundaboutPass", + "Turn", + "UTurn" + ] + }, + "RouteViolatedConstraints":{ + "type":"structure", + "required":["HazardousCargos"], + "members":{ + "AllHazardsRestricted":{ + "shape":"Boolean", + "documentation":"

This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.

" + }, + "AxleCount":{ + "shape":"RouteNoticeDetailRange", + "documentation":"

Total number of axles of the vehicle.

" + }, + "HazardousCargos":{ + "shape":"RouteHazardousCargoTypeList", + "documentation":"

List of Hazardous cargo contained in the vehicle.

" + }, + "MaxHeight":{ + "shape":"DimensionCentimeters", + "documentation":"

The maximum height of the vehicle.

" + }, + "MaxKpraLength":{ + "shape":"DimensionCentimeters", + "documentation":"

The maximum Kpra length of the vehicle.

Unit: centimeters

" + }, + "MaxLength":{ + "shape":"DimensionCentimeters", + "documentation":"

The maximum length of the vehicle.

" + }, + "MaxPayloadCapacity":{ + "shape":"WeightKilograms", + "documentation":"

The maximum load capacity of the vehicle.

Unit: kilograms

" + }, + "MaxWeight":{ + "shape":"RouteWeightConstraint", + "documentation":"

The maximum weight of the route.

Unit: Kilograms

" + }, + "MaxWeightPerAxle":{ + "shape":"WeightKilograms", + "documentation":"

The maximum weight per axle of the vehicle.

Unit: Kilograms

" + }, + "MaxWeightPerAxleGroup":{ + "shape":"WeightPerAxleGroup", + "documentation":"

The maximum weight per axle group of the vehicle.

Unit: Kilograms

" + }, + "MaxWidth":{ + "shape":"DimensionCentimeters", + "documentation":"

The maximum width of the vehicle.

" + }, + "Occupancy":{ + "shape":"RouteNoticeDetailRange", + "documentation":"

The number of occupants in the vehicle.

Default Value: 1

" + }, + "RestrictedTimes":{ + "shape":"String", + "documentation":"

Access radius restrictions based on time.

" + }, + "TimeDependent":{ + "shape":"Boolean", + "documentation":"

The time dependent constraint.

" + }, + "TrailerCount":{ + "shape":"RouteNoticeDetailRange", + "documentation":"

Number of trailers attached to the vehicle.

Default Value: 0

" + }, + "TravelMode":{ + "shape":"Boolean", + "documentation":"

Travel mode corresponding to the leg.

" + }, + "TruckRoadType":{ + "shape":"String", + "documentation":"

Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

There are currently no other supported values as of 26th April 2024.

" + }, + "TruckType":{ + "shape":"RouteTruckType", + "documentation":"

Type of the truck.

" + }, + "TunnelRestrictionCode":{ + "shape":"TunnelRestrictionCode", + "documentation":"

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

" + } + }, + "documentation":"

This property contains a summary of violated constraints.

" + }, + "RouteWaypoint":{ + "type":"structure", + "required":["Position"], + "members":{ + "AvoidActionsForDistance":{ + "shape":"RouteWaypointAvoidActionsForDistanceLong", + "documentation":"

Avoids actions for the provided distance. This is typically to consider for users in moving vehicles who may not have sufficient time to make an action at an origin or a destination.

" + }, + "AvoidUTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Matching":{ + "shape":"RouteMatchingOptions", + "documentation":"

Options to configure matching the provided position to the road network.

" + }, + "PassThrough":{ + "shape":"Boolean", + "documentation":"

If the waypoint should not be treated as a stop. If yes, the waypoint is passed through and doesn't split the route into different legs.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "SideOfStreet":{ + "shape":"RouteSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "StopDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of the stop.

Unit: seconds

" + } + }, + "documentation":"

Waypoint between the Origin and Destination.

" + }, + "RouteWaypointAvoidActionsForDistanceLong":{ + "type":"long", + "max":2000 + }, + "RouteWaypointList":{ + "type":"list", + "member":{"shape":"RouteWaypoint"} + }, + "RouteWeightConstraint":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"RouteWeightConstraintType", + "documentation":"

The type of constraint.

" + }, + "Value":{ + "shape":"WeightKilograms", + "documentation":"

The constraint value.

Unit: Kilograms

" + } + }, + "documentation":"

The weight constraint for the route.

Unit: Kilograms

" + }, + "RouteWeightConstraintType":{ + "type":"string", + "enum":[ + "Current", + "Gross", + "Unknown" + ] + }, + "RouteZone":{ + "type":"structure", + "members":{ + "Category":{ + "shape":"RouteZoneCategory", + "documentation":"

The zone category.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the zone.

" + } + }, + "documentation":"

The zone.

" + }, + "RouteZoneCategory":{ + "type":"string", + "enum":[ + "CongestionPricing", + "Environmental", + "Vignette" + ] + }, + "RouteZoneList":{ + "type":"list", + "member":{"shape":"RouteZone"} + }, + "RoutingObjective":{ + "type":"string", + "enum":[ + "FastestRoute", + "ShortestRoute" + ] + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "SideOfStreetMatchingStrategy":{ + "type":"string", + "enum":[ + "AnyStreet", + "DividedStreetOnly" + ] + }, + "SnapToRoadsRequest":{ + "type":"structure", + "required":["TracePoints"], + "members":{ + "Key":{ + "shape":"ApiKey", + "documentation":"

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

", + "location":"querystring", + "locationName":"key" + }, + "SnappedGeometryFormat":{ + "shape":"GeometryFormat", + "documentation":"

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

" + }, + "SnapRadius":{ + "shape":"SnapToRoadsRequestSnapRadiusLong", + "documentation":"

The radius around the provided tracepoint that is considered for snapping.

Unit: meters

Default value: 300

" + }, + "TracePoints":{ + "shape":"SnapToRoadsRequestTracePointsList", + "documentation":"

List of trace points to be snapped onto the road network.

" + }, + "TravelMode":{ + "shape":"RoadSnapTravelMode", + "documentation":"

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

" + }, + "TravelModeOptions":{ + "shape":"RoadSnapTravelModeOptions", + "documentation":"

Travel mode related options for the provided travel mode.

" + } + } + }, + "SnapToRoadsRequestSnapRadiusLong":{ + "type":"long", + "max":10000, + "min":0 + }, + "SnapToRoadsRequestTracePointsList":{ + "type":"list", + "member":{"shape":"RoadSnapTracePoint"}, + "max":5000, + "min":2 + }, + "SnapToRoadsResponse":{ + "type":"structure", + "required":[ + "Notices", + "PricingBucket", + "SnappedGeometryFormat", + "SnappedTracePoints" + ], + "members":{ + "Notices":{ + "shape":"RoadSnapNoticeList", + "documentation":"

Notices are additional information returned that indicate issues that occurred during route calculation.

" + }, + "PricingBucket":{ + "shape":"String", + "documentation":"

The pricing bucket for which the query is charged at.

", + "location":"header", + "locationName":"x-amz-geo-pricing-bucket" + }, + "SnappedGeometry":{ + "shape":"RoadSnapSnappedGeometry", + "documentation":"

The interpolated geometry for the snapped route onto the road network.

" + }, + "SnappedGeometryFormat":{ + "shape":"GeometryFormat", + "documentation":"

Specifies the format of the geometry returned for each leg of the route.

" + }, + "SnappedTracePoints":{ + "shape":"RoadSnapSnappedTracePointList", + "documentation":"

The trace points snapped onto the road network.

" + } + } + }, + "SpeedKilometersPerHour":{ + "type":"double", + "min":0.0 + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + } + }, + "documentation":"

The request was denied due to request throttling.

", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "TimeOfDay":{ + "type":"string", + "pattern":"([0-1]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](Z|[+-]([0-1]?[0-9]|2[0-3]):[0-5][0-9])" + }, + "TimeThresholdList":{ + "type":"list", + "member":{"shape":"TimeThresholdListMemberLong"}, + "max":5, + "min":1 + }, + "TimeThresholdListMemberLong":{ + "type":"long", + "max":10800, + "min":0 + }, + "TimestampWithTimezoneOffset":{ + "type":"string", + "pattern":"([1-2][0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(\\.[0-9]{0,9})?(Z|[+-]([01][0-9]|2[0-3]):[0-5][0-9])" + }, + "TrafficUsage":{ + "type":"string", + "enum":[ + "IgnoreTrafficData", + "UseTrafficData" + ] + }, + "TruckRoadType":{ + "type":"string", + "max":3, + "min":1 + }, + "TruckRoadTypeList":{ + "type":"list", + "member":{"shape":"TruckRoadType"}, + "max":12, + "min":1 + }, + "TunnelRestrictionCode":{ + "type":"string", + "max":1, + "min":1 + }, + "TurnAngle":{ + "type":"double", + "max":180, + "min":-180 + }, + "ValidationException":{ + "type":"structure", + "required":[ + "Message", + "Reason", + "FieldList" + ], + "members":{ + "Message":{ + "shape":"String", + "locationName":"message" + }, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"

A message with the reason for the validation exception error.

", + "locationName":"reason" + }, + "FieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"

The field where the invalid entry was detected.

", + "locationName":"fieldList" + } + }, + "documentation":"

The input fails to satisfy the constraints specified by an AWS service.

", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the Validation Exception Field.

", + "locationName":"name" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

The input fails to satisfy the constraints specified by the Amazon Location service.

" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UnknownOperation", + "Missing", + "CannotParse", + "FieldValidationFailed", + "Other", + "UnknownField" + ] + }, + "WaypointId":{ + "type":"string", + "max":100, + "min":1 + }, + "WaypointIndex":{"type":"integer"}, + "WaypointOptimizationAccessHours":{ + "type":"structure", + "required":[ + "From", + "To" + ], + "members":{ + "From":{ + "shape":"WaypointOptimizationAccessHoursEntry", + "documentation":"

Contains the ID of the starting waypoint in this connection.

" + }, + "To":{ + "shape":"WaypointOptimizationAccessHoursEntry", + "documentation":"

Contains the ID of the ending waypoint in this connection.

" + } + }, + "documentation":"

Access hours corresponding to when a destination can be visited.

" + }, + "WaypointOptimizationAccessHoursEntry":{ + "type":"structure", + "required":[ + "DayOfWeek", + "TimeOfDay" + ], + "members":{ + "DayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

Day of the week.

" + }, + "TimeOfDay":{ + "shape":"TimeOfDay", + "documentation":"

Time of the day.

" + } + }, + "documentation":"

Hours of entry.

" + }, + "WaypointOptimizationAvoidanceArea":{ + "type":"structure", + "required":["Geometry"], + "members":{ + "Geometry":{ + "shape":"WaypointOptimizationAvoidanceAreaGeometry", + "documentation":"

Geometry of the area to be avoided.

" + } + }, + "documentation":"

The area to be avoided.

" + }, + "WaypointOptimizationAvoidanceAreaGeometry":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

" + } + }, + "documentation":"

Geometry of the area to be avoided.

" + }, + "WaypointOptimizationAvoidanceOptions":{ + "type":"structure", + "members":{ + "Areas":{ + "shape":"WaypointOptimizationAvoidanceOptionsAreasList", + "documentation":"

Areas to be avoided.

" + }, + "CarShuttleTrains":{ + "shape":"Boolean", + "documentation":"

Avoidance options for cars-shuttles-trains.

" + }, + "ControlledAccessHighways":{ + "shape":"Boolean", + "documentation":"

Avoid controlled access highways while calculating the route.

" + }, + "DirtRoads":{ + "shape":"Boolean", + "documentation":"

Avoid dirt roads while calculating the route.

" + }, + "Ferries":{ + "shape":"Boolean", + "documentation":"

Avoidance options for ferries.

" + }, + "TollRoads":{ + "shape":"Boolean", + "documentation":"

Avoids roads where the specified toll transponders are the only mode of payment.

" + }, + "Tunnels":{ + "shape":"Boolean", + "documentation":"

Avoid tunnels while calculating the route.

" + }, + "UTurns":{ + "shape":"Boolean", + "documentation":"

Avoid U-turns for calculation on highways and motorways.

" + } + }, + "documentation":"

Options for WaypointOptimizationAvoidance.

" + }, + "WaypointOptimizationAvoidanceOptionsAreasList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationAvoidanceArea"}, + "max":20, + "min":0 + }, + "WaypointOptimizationConnection":{ + "type":"structure", + "required":[ + "Distance", + "From", + "RestDuration", + "To", + "TravelDuration", + "WaitDuration" + ], + "members":{ + "Distance":{ + "shape":"DistanceMeters", + "documentation":"

Distance of the step.

" + }, + "From":{ + "shape":"WaypointId", + "documentation":"

contains the ID of the starting waypoint in this connection.

" + }, + "RestDuration":{ + "shape":"DurationSeconds", + "documentation":"

Resting time before the driver can continue driving.

" + }, + "To":{ + "shape":"WaypointId", + "documentation":"

Contains the ID of the ending waypoint in this connection.

" + }, + "TravelDuration":{ + "shape":"DurationSeconds", + "documentation":"

Total duration.

Unit: seconds

" + }, + "WaitDuration":{ + "shape":"DurationSeconds", + "documentation":"

Duration of a wait step.

Unit: seconds

" + } + }, + "documentation":"

This contains information such as distance and duration from one waypoint to the next waypoint in the sequence.

" + }, + "WaypointOptimizationConnectionList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationConnection"} + }, + "WaypointOptimizationConstraint":{ + "type":"string", + "enum":[ + "AccessHours", + "AppointmentTime", + "Before", + "Heading", + "ServiceDuration", + "SideOfStreet" + ] + }, + "WaypointOptimizationDestinationOptions":{ + "type":"structure", + "members":{ + "AccessHours":{ + "shape":"WaypointOptimizationAccessHours", + "documentation":"

Access hours corresponding to when a waypoint can be visited.

" + }, + "AppointmentTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Appointment time at the destination.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Id":{ + "shape":"WaypointId", + "documentation":"

The waypoint Id.

" + }, + "ServiceDuration":{ + "shape":"DurationSeconds", + "documentation":"

Service time spent at the destination. At an appointment, the service time should be the appointment duration.

Unit: seconds

" + }, + "SideOfStreet":{ + "shape":"WaypointOptimizationSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Destination related options.

" + }, + "WaypointOptimizationDriverOptions":{ + "type":"structure", + "members":{ + "RestCycles":{ + "shape":"WaypointOptimizationRestCycles", + "documentation":"

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

" + }, + "RestProfile":{ + "shape":"WaypointOptimizationRestProfile", + "documentation":"

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

" + }, + "TreatServiceTimeAs":{ + "shape":"WaypointOptimizationServiceTimeTreatment", + "documentation":"

If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.

" + } + }, + "documentation":"

Driver related options.

" + }, + "WaypointOptimizationExclusionOptions":{ + "type":"structure", + "required":["Countries"], + "members":{ + "Countries":{ + "shape":"CountryCodeList", + "documentation":"

List of countries to be avoided defined by two-letter or three-letter country codes.

" + } + }, + "documentation":"

Exclusion options.

" + }, + "WaypointOptimizationFailedConstraint":{ + "type":"structure", + "members":{ + "Constraint":{ + "shape":"WaypointOptimizationConstraint", + "documentation":"

The failed constraint.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

Reason for the failed constraint.

" + } + }, + "documentation":"

The failed constraint.

" + }, + "WaypointOptimizationFailedConstraintList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationFailedConstraint"} + }, + "WaypointOptimizationHazardousCargoType":{ + "type":"string", + "enum":[ + "Combustible", + "Corrosive", + "Explosive", + "Flammable", + "Gas", + "HarmfulToWater", + "Organic", + "Other", + "Poison", + "PoisonousInhalation", + "Radioactive" + ] + }, + "WaypointOptimizationHazardousCargoTypeList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationHazardousCargoType"} + }, + "WaypointOptimizationImpedingWaypoint":{ + "type":"structure", + "required":[ + "FailedConstraints", + "Id", + "Position" + ], + "members":{ + "FailedConstraints":{ + "shape":"WaypointOptimizationFailedConstraintList", + "documentation":"

Failed constraints for an impeding waypoint.

" + }, + "Id":{ + "shape":"WaypointId", + "documentation":"

The waypoint Id.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + } + }, + "documentation":"

The impeding waypoint.

" + }, + "WaypointOptimizationImpedingWaypointList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationImpedingWaypoint"} + }, + "WaypointOptimizationOptimizedWaypoint":{ + "type":"structure", + "required":[ + "DepartureTime", + "Id", + "Position" + ], + "members":{ + "ArrivalTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Estimated time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "DepartureTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Estimated time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

" + }, + "Id":{ + "shape":"WaypointId", + "documentation":"

The waypoint Id.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + } + }, + "documentation":"

The optimized waypoint.

" + }, + "WaypointOptimizationOptimizedWaypointList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationOptimizedWaypoint"} + }, + "WaypointOptimizationOriginOptions":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WaypointId", + "documentation":"

The Origin Id.

" + } + }, + "documentation":"

Options related to the origin.

" + }, + "WaypointOptimizationPedestrianOptions":{ + "type":"structure", + "members":{ + "Speed":{ + "shape":"WaypointOptimizationPedestrianOptionsSpeedDouble", + "documentation":"

Walking speed.

Unit: KilometersPerHour

", + "box":true + } + }, + "documentation":"

Options related to a pedestrian.

" + }, + "WaypointOptimizationPedestrianOptionsSpeedDouble":{ + "type":"double", + "max":7.2, + "min":1.8 + }, + "WaypointOptimizationRestCycleDurations":{ + "type":"structure", + "required":[ + "RestDuration", + "WorkDuration" + ], + "members":{ + "RestDuration":{ + "shape":"DurationSeconds", + "documentation":"

Resting phase of the cycle.

Unit: seconds

" + }, + "WorkDuration":{ + "shape":"DurationSeconds", + "documentation":"

Working phase of the cycle.

Unit: seconds

" + } + }, + "documentation":"

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

Unit: seconds

" + }, + "WaypointOptimizationRestCycles":{ + "type":"structure", + "required":[ + "LongCycle", + "ShortCycle" + ], + "members":{ + "LongCycle":{ + "shape":"WaypointOptimizationRestCycleDurations", + "documentation":"

Long cycle for a driver work-rest schedule.

" + }, + "ShortCycle":{ + "shape":"WaypointOptimizationRestCycleDurations", + "documentation":"

Short cycle for a driver work-rest schedule

" + } + }, + "documentation":"

Resting phase of the cycle.

" + }, + "WaypointOptimizationRestProfile":{ + "type":"structure", + "required":["Profile"], + "members":{ + "Profile":{ + "shape":"WaypointOptimizationRestProfileProfileString", + "documentation":"

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

" + } + }, + "documentation":"

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

" + }, + "WaypointOptimizationRestProfileProfileString":{ + "type":"string", + "max":2, + "min":2 + }, + "WaypointOptimizationSequencingObjective":{ + "type":"string", + "enum":[ + "FastestRoute", + "ShortestRoute" + ] + }, + "WaypointOptimizationServiceTimeTreatment":{ + "type":"string", + "enum":[ + "Rest", + "Work" + ] + }, + "WaypointOptimizationSideOfStreetOptions":{ + "type":"structure", + "required":["Position"], + "members":{ + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "UseWith":{ + "shape":"SideOfStreetMatchingStrategy", + "documentation":"

Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.

Default Value: DividedStreetOnly

" + } + }, + "documentation":"

Options to configure matching the provided position to a side of the street.

" + }, + "WaypointOptimizationTimeBreakdown":{ + "type":"structure", + "required":[ + "RestDuration", + "ServiceDuration", + "TravelDuration", + "WaitDuration" + ], + "members":{ + "RestDuration":{ + "shape":"DurationSeconds", + "documentation":"

Resting phase of the cycle.

Unit: seconds

" + }, + "ServiceDuration":{ + "shape":"DurationSeconds", + "documentation":"

Service time spent at the destination. At an appointment, the service time should be the appointment duration.

Unit: seconds

" + }, + "TravelDuration":{ + "shape":"DurationSeconds", + "documentation":"

Traveling phase of the cycle.

Unit: seconds

" + }, + "WaitDuration":{ + "shape":"DurationSeconds", + "documentation":"

Waiting phase of the cycle.

Unit: seconds

" + } + }, + "documentation":"

Time breakdown for the sequence.

" + }, + "WaypointOptimizationTrafficOptions":{ + "type":"structure", + "members":{ + "Usage":{ + "shape":"TrafficUsage", + "documentation":"

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

" + } + }, + "documentation":"

Options related to traffic.

" + }, + "WaypointOptimizationTrailerOptions":{ + "type":"structure", + "members":{ + "TrailerCount":{ + "shape":"WaypointOptimizationTrailerOptionsTrailerCountInteger", + "documentation":"

Number of trailers attached to the vehicle.

Default Value: 0

" + } + }, + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "WaypointOptimizationTrailerOptionsTrailerCountInteger":{ + "type":"integer", + "box":true, + "max":255, + "min":0 + }, + "WaypointOptimizationTravelMode":{ + "type":"string", + "enum":[ + "Car", + "Pedestrian", + "Scooter", + "Truck" + ] + }, + "WaypointOptimizationTravelModeOptions":{ + "type":"structure", + "members":{ + "Pedestrian":{ + "shape":"WaypointOptimizationPedestrianOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Pedestrian\"

" + }, + "Truck":{ + "shape":"WaypointOptimizationTruckOptions", + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + } + }, + "documentation":"

Travel mode related options for the provided travel mode.

" + }, + "WaypointOptimizationTruckOptions":{ + "type":"structure", + "members":{ + "GrossWeight":{ + "shape":"WeightKilograms", + "documentation":"

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: Kilograms

" + }, + "HazardousCargos":{ + "shape":"WaypointOptimizationHazardousCargoTypeList", + "documentation":"

List of Hazardous cargo contained in the vehicle.

" + }, + "Height":{ + "shape":"WaypointOptimizationTruckOptionsHeightLong", + "documentation":"

Height of the vehicle.

Unit: centimeters

" + }, + "Length":{ + "shape":"WaypointOptimizationTruckOptionsLengthLong", + "documentation":"

Length of the vehicle.

Unit: centimeters

" + }, + "Trailer":{ + "shape":"WaypointOptimizationTrailerOptions", + "documentation":"

Trailer options corresponding to the vehicle.

" + }, + "TruckType":{ + "shape":"WaypointOptimizationTruckType", + "documentation":"

Type of the truck.

" + }, + "TunnelRestrictionCode":{ + "shape":"TunnelRestrictionCode", + "documentation":"

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

" + }, + "WeightPerAxle":{ + "shape":"WeightKilograms", + "documentation":"

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: Kilograms

" + }, + "Width":{ + "shape":"WaypointOptimizationTruckOptionsWidthLong", + "documentation":"

Width of the vehicle.

Unit: centimeters

" + } + }, + "documentation":"

Travel mode options when the provided travel mode is \"Truck\"

" + }, + "WaypointOptimizationTruckOptionsHeightLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "WaypointOptimizationTruckOptionsLengthLong":{ + "type":"long", + "max":30000, + "min":0 + }, + "WaypointOptimizationTruckOptionsWidthLong":{ + "type":"long", + "max":5000, + "min":0 + }, + "WaypointOptimizationTruckType":{ + "type":"string", + "enum":[ + "StraightTruck", + "Tractor" + ] + }, + "WaypointOptimizationWaypoint":{ + "type":"structure", + "required":["Position"], + "members":{ + "AccessHours":{ + "shape":"WaypointOptimizationAccessHours", + "documentation":"

Access hours corresponding to when a waypoint can be visited.

" + }, + "AppointmentTime":{ + "shape":"TimestampWithTimezoneOffset", + "documentation":"

Appointment time at the waypoint.

" + }, + "Before":{ + "shape":"BeforeWaypointsList", + "documentation":"

Constraint defining what waypoints are to be visited after this waypoint.

" + }, + "Heading":{ + "shape":"Heading", + "documentation":"

GPS Heading at the position.

" + }, + "Id":{ + "shape":"WaypointId", + "documentation":"

The waypoint Id.

" + }, + "Position":{ + "shape":"Position", + "documentation":"

Position defined as [longitude, latitude].

" + }, + "ServiceDuration":{ + "shape":"DurationSeconds", + "documentation":"

Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.

Unit: seconds

" + }, + "SideOfStreet":{ + "shape":"WaypointOptimizationSideOfStreetOptions", + "documentation":"

Options to configure matching the provided position to a side of the street.

" + } + }, + "documentation":"

Waypoint between the Origin and Destination.

" + }, + "WaypointOptimizationWaypointList":{ + "type":"list", + "member":{"shape":"WaypointOptimizationWaypoint"} + }, + "WeightKilograms":{ + "type":"long", + "max":4294967295, + "min":0 + }, + "WeightPerAxleGroup":{ + "type":"structure", + "members":{ + "Single":{ + "shape":"WeightKilograms", + "documentation":"

Weight for single axle group.

Unit: Kilograms

" + }, + "Tandem":{ + "shape":"WeightKilograms", + "documentation":"

Weight for tandem axle group.

Unit: Kilograms

" + }, + "Triple":{ + "shape":"WeightKilograms", + "documentation":"

Weight for triple axle group.

Unit: Kilograms

" + }, + "Quad":{ + "shape":"WeightKilograms", + "documentation":"

Weight for quad axle group.

Unit: Kilograms

" + }, + "Quint":{ + "shape":"WeightKilograms", + "documentation":"

Weight for quad quint group.

Unit: Kilograms

" + } + }, + "documentation":"

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

Unit: Kilograms

" + } + }, + "documentation":"

With the Amazon Location Routes API you can calculate routes and estimate travel time based on up-to-date road network and live traffic information.

Calculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:

" +} diff --git a/botocore/data/keyspaces/2022-02-10/paginators-1.json b/botocore/data/keyspaces/2022-02-10/paginators-1.json index 885bf4e250..4145b28b30 100644 --- a/botocore/data/keyspaces/2022-02-10/paginators-1.json +++ b/botocore/data/keyspaces/2022-02-10/paginators-1.json @@ -17,6 +17,12 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "tags" + }, + "ListTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "types" } } } diff --git a/botocore/data/keyspaces/2022-02-10/service-2.json b/botocore/data/keyspaces/2022-02-10/service-2.json index 087dfd7c3c..864cd36198 100644 --- a/botocore/data/keyspaces/2022-02-10/service-2.json +++ b/botocore/data/keyspaces/2022-02-10/service-2.json @@ -2,9 +2,11 @@ "version":"2.0", "metadata":{ "apiVersion":"2022-02-10", + "auth":["aws.auth#sigv4"], "endpointPrefix":"cassandra", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceFullName":"Amazon Keyspaces", "serviceId":"Keyspaces", "signatureVersion":"v4", @@ -28,7 +30,7 @@ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], - "documentation":"

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.

" + "documentation":"

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide.

" }, "CreateTable":{ "name":"CreateTable", @@ -46,7 +48,25 @@ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

For more information, see Creating tables in the Amazon Keyspaces Developer Guide.

" + "documentation":"

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

For more information, see Create a table in the Amazon Keyspaces Developer Guide.

" + }, + "CreateType":{ + "name":"CreateType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTypeRequest"}, + "output":{"shape":"CreateTypeResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

The CreateType operation creates a new user-defined type in the specified keyspace.

For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.

" }, "DeleteKeyspace":{ "name":"DeleteKeyspace", @@ -84,6 +104,24 @@ ], "documentation":"

The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

" }, + "DeleteType":{ + "name":"DeleteType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTypeRequest"}, + "output":{"shape":"DeleteTypeResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

The DeleteType operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT.

" + }, "GetKeyspace":{ "name":"GetKeyspace", "http":{ @@ -116,7 +154,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using GetTable, Select action permissions for the table and system tables are required to complete the operation.

" + "documentation":"

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using GetTable, the IAM principal needs Select action permissions for the table and the system keyspace.

" }, "GetTableAutoScalingSettings":{ "name":"GetTableAutoScalingSettings", @@ -135,6 +173,23 @@ ], "documentation":"

Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.

Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

GetTableAutoScalingSettings can't be used as an action in an IAM policy.

To define permissions for GetTableAutoScalingSettings, you must allow the following two actions in the IAM policy statement's Action element:

" }, + "GetType":{ + "name":"GetType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTypeRequest"}, + "output":{"shape":"GetTypeResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

The GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.

To read keyspace metadata using GetType, the IAM principal needs Select action permissions for the system keyspace.

" + }, "ListKeyspaces":{ "name":"ListKeyspaces", "http":{ @@ -150,7 +205,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Returns a list of keyspaces.

" + "documentation":"

The ListKeyspaces operation returns a list of keyspaces.

" }, "ListTables":{ "name":"ListTables", @@ -167,7 +222,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Returns a list of tables for a specified keyspace.

" + "documentation":"

The ListTables operation returns a list of tables for a specified keyspace.

To read keyspace metadata using ListTables, the IAM principal needs Select action permissions for the system keyspace.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -184,7 +239,24 @@ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

" + "documentation":"

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

To read keyspace metadata using ListTagsForResource, the IAM principal needs Select action permissions for the specified resource and the system keyspace.

" + }, + "ListTypes":{ + "name":"ListTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTypesRequest"}, + "output":{"shape":"ListTypesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

The ListTypes operation returns a list of types for a specified keyspace.

To read keyspace metadata using ListTypes, the IAM principal needs Select action permissions for the system keyspace.

" }, "RestoreTable":{ "name":"RestoreTable", @@ -216,6 +288,7 @@ {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], @@ -552,6 +625,45 @@ } } }, + "CreateTypeRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "typeName", + "fieldDefinitions" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"

The name of the keyspace.

" + }, + "typeName":{ + "shape":"TypeName", + "documentation":"

The name of the user-defined type.

UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters.

Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.

You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.

" + }, + "fieldDefinitions":{ + "shape":"FieldList", + "documentation":"

The field definitions, consisting of names and types, that define this type.

" + } + } + }, + "CreateTypeResponse":{ + "type":"structure", + "required":[ + "keyspaceArn", + "typeName" + ], + "members":{ + "keyspaceArn":{ + "shape":"ARN", + "documentation":"

The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN).

" + }, + "typeName":{ + "shape":"TypeName", + "documentation":"

The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for other operations, for example GetType.

" + } + } + }, "DefaultTimeToLive":{ "type":"integer", "box":true, @@ -595,6 +707,41 @@ "members":{ } }, + "DeleteTypeRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "typeName" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"

The name of the keyspace of the to be deleted type.

" + }, + "typeName":{ + "shape":"TypeName", + "documentation":"

The name of the type to be deleted.

" + } + } + }, + "DeleteTypeResponse":{ + "type":"structure", + "required":[ + "keyspaceArn", + "typeName" + ], + "members":{ + "keyspaceArn":{ + "shape":"ARN", + "documentation":"

The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN).

" + }, + "typeName":{ + "shape":"TypeName", + "documentation":"

The name of the type that was deleted.

" + } + } + }, + "Depth":{"type":"integer"}, "DoubleObject":{"type":"double"}, "EncryptionSpecification":{ "type":"structure", @@ -618,6 +765,34 @@ "AWS_OWNED_KMS_KEY" ] }, + "FieldDefinition":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"FieldDefinitionNameString", + "documentation":"

The identifier.

" + }, + "type":{ + "shape":"GenericString", + "documentation":"

Any supported Cassandra data type, including collections and other user-defined types that are contained in the same keyspace.

For more information, see Cassandra data type support in the Amazon Keyspaces Developer Guide.

" + } + }, + "documentation":"

A field definition consists out of a name and a type.

" + }, + "FieldDefinitionNameString":{ + "type":"string", + "max":128, + "min":1 + }, + "FieldList":{ + "type":"list", + "member":{"shape":"FieldDefinition"}, + "min":1 + }, "GenericString":{"type":"string"}, "GetKeyspaceRequest":{ "type":"structure", @@ -785,6 +960,69 @@ } } }, + "GetTypeRequest":{ + "type":"structure", + "required":[ + "keyspaceName", + "typeName" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"

The name of the keyspace that contains this type.

" + }, + "typeName":{ + "shape":"TypeName", + "documentation":"

The formatted name of the type. For example, if the name of the type was created without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was created in double quotes, you must use double quotes to specify the type name.

" + } + } + }, + "GetTypeResponse":{ + "type":"structure", + "required":[ + "keyspaceName", + "typeName", + "keyspaceArn" + ], + "members":{ + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"

The name of the keyspace that contains this type.

" + }, + "typeName":{ + "shape":"TypeName", + "documentation":"

The name of the type.

" + }, + "fieldDefinitions":{ + "shape":"FieldList", + "documentation":"

The names and types that define this type.

" + }, + "lastModifiedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The timestamp that shows when this type was last modified.

" + }, + "status":{ + "shape":"TypeStatus", + "documentation":"

The status of this type.

" + }, + "directReferringTables":{ + "shape":"TableNameList", + "documentation":"

The tables that use this type.

" + }, + "directParentTypes":{ + "shape":"TypeNameList", + "documentation":"

The types that use this type.

" + }, + "maxNestingDepth":{ + "shape":"Depth", + "documentation":"

The level of nesting implemented for this type.

" + }, + "keyspaceArn":{ + "shape":"ARN", + "documentation":"

The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN).

" + } + } + }, "IntegerObject":{"type":"integer"}, "InternalServerException":{ "type":"structure", @@ -924,6 +1162,38 @@ } } }, + "ListTypesRequest":{ + "type":"structure", + "required":["keyspaceName"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The total number of types to return in the output. If the total number of types available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

" + }, + "keyspaceName":{ + "shape":"KeyspaceName", + "documentation":"

The name of the keyspace that contains the listed types.

" + } + } + }, + "ListTypesResponse":{ + "type":"structure", + "required":["types"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

" + }, + "types":{ + "shape":"TypeNameList", + "documentation":"

The list of types contained in the specified keyspace.

" + } + } + }, "MaxResults":{ "type":"integer", "box":true, @@ -1077,10 +1347,10 @@ }, "resourceArn":{ "shape":"ARN", - "documentation":"

The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.

" + "documentation":"

The unique identifier in the format of Amazon Resource Name (ARN) for the resource could't be found.

" } }, - "documentation":"

The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.

", + "documentation":"

The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be ACTIVE.

", "exception":true }, "RestoreTableRequest":{ @@ -1214,6 +1484,10 @@ "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_]{0,47}" }, + "TableNameList":{ + "type":"list", + "member":{"shape":"TableName"} + }, "TableStatus":{ "type":"string", "enum":[ @@ -1355,6 +1629,24 @@ "enum":["ENABLED"] }, "Timestamp":{"type":"timestamp"}, + "TypeName":{ + "type":"string", + "max":48, + "min":1 + }, + "TypeNameList":{ + "type":"list", + "member":{"shape":"TypeName"} + }, + "TypeStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "CREATING", + "DELETING", + "RESTORING" + ] + }, "UntagResourceRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/network-firewall/2020-11-12/service-2.json b/botocore/data/network-firewall/2020-11-12/service-2.json index 9b38531ba3..ec6854a661 100644 --- a/botocore/data/network-firewall/2020-11-12/service-2.json +++ b/botocore/data/network-firewall/2020-11-12/service-2.json @@ -1802,6 +1802,16 @@ "type":"list", "member":{"shape":"TCPFlag"} }, + "FlowTimeouts":{ + "type":"structure", + "members":{ + "TcpIdleTimeoutSeconds":{ + "shape":"TcpIdleTimeoutRangeBound", + "documentation":"

The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout.

You can define the TcpIdleTimeoutSeconds value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.

" + } + }, + "documentation":"

Describes the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle and Network Firewall removes the flow entry from its flow table. Existing connections and flows are not impacted when you update this value. Only new connections after you update this value are impacted.

" + }, "GeneratedRulesType":{ "type":"string", "enum":[ @@ -2837,6 +2847,10 @@ "StreamExceptionPolicy":{ "shape":"StreamExceptionPolicy", "documentation":"

Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.

" + }, + "FlowTimeouts":{ + "shape":"FlowTimeouts", + "documentation":"

Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.

" } }, "documentation":"

Configuration settings for the handling of the stateful rule groups in a firewall policy.

" @@ -3256,6 +3270,7 @@ "type":"list", "member":{"shape":"TargetType"} }, + "TcpIdleTimeoutRangeBound":{"type":"integer"}, "ThrottlingException":{ "type":"structure", "members":{ @@ -3751,5 +3766,5 @@ "member":{"shape":"VpcId"} } }, - "documentation":"

This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.

Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 6.0.9. For information about Suricata, see the Suricata website.

You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:

To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.

To start using Network Firewall, do the following:

  1. (Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.

  2. In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.

  3. In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.

  4. In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.

  5. In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.

  6. In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.

" + "documentation":"

This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors.

Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine.

You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples:

To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.

To start using Network Firewall, do the following:

  1. (Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC.

  2. In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall.

  3. In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.

  4. In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior.

  5. In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.

  6. In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.

" } diff --git a/botocore/data/opensearch/2021-01-01/paginators-1.json b/botocore/data/opensearch/2021-01-01/paginators-1.json index ea142457a6..1f134ccfcb 100644 --- a/botocore/data/opensearch/2021-01-01/paginators-1.json +++ b/botocore/data/opensearch/2021-01-01/paginators-1.json @@ -1,3 +1,10 @@ { - "pagination": {} + "pagination": { + "ListApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "ApplicationSummaries" + } + } } diff --git a/botocore/data/opensearch/2021-01-01/service-2.json b/botocore/data/opensearch/2021-01-01/service-2.json index 86452bc4e2..0dd3f5a57a 100644 --- a/botocore/data/opensearch/2021-01-01/service-2.json +++ b/botocore/data/opensearch/2021-01-01/service-2.json @@ -130,6 +130,25 @@ ], "documentation":"

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

" }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/2021-01-01/opensearch/application", + "responseCode":200 + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"} + ], + "documentation":"

Creates an OpenSearch Application.

" + }, "CreateDomain":{ "name":"CreateDomain", "http":{ @@ -202,6 +221,26 @@ ], "documentation":"

Creates an Amazon OpenSearch Service-managed VPC endpoint.

" }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"DELETE", + "requestUri":"/2021-01-01/opensearch/application/{id}", + "responseCode":200 + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"} + ], + "documentation":"

Deletes an existing OpenSearch Application.

" + }, "DeleteDataSource":{ "name":"DeleteDataSource", "http":{ @@ -558,6 +597,25 @@ ], "documentation":"

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

" }, + "GetApplication":{ + "name":"GetApplication", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/application/{id}", + "responseCode":200 + }, + "input":{"shape":"GetApplicationRequest"}, + "output":{"shape":"GetApplicationResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"} + ], + "documentation":"

Check the configuration and status of an existing OpenSearch Application.

" + }, "GetCompatibleVersions":{ "name":"GetCompatibleVersions", "http":{ @@ -661,6 +719,25 @@ ], "documentation":"

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

" }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"GET", + "requestUri":"/2021-01-01/opensearch/list-applications", + "responseCode":200 + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"} + ], + "documentation":"

List all OpenSearch Applications under your account.

" + }, "ListDataSources":{ "name":"ListDataSources", "http":{ @@ -952,6 +1029,26 @@ ], "documentation":"

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

" }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"PUT", + "requestUri":"/2021-01-01/opensearch/application/{id}", + "responseCode":200 + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalException"}, + {"shape":"DisabledOperationException"} + ], + "documentation":"

Update the OpenSearch Application.

" + }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ @@ -1124,6 +1221,10 @@ }, "documentation":"

Information about an Amazon OpenSearch Service domain.

" }, + "AWSServicePrincipal":{ + "type":"string", + "enum":["application.opensearchservice.amazonaws.com"] + }, "AcceptInboundConnectionRequest":{ "type":"structure", "required":["ConnectionId"], @@ -1377,6 +1478,92 @@ }, "documentation":"

The status of fine-grained access control settings for a domain.

" }, + "AppConfig":{ + "type":"structure", + "members":{ + "key":{ + "shape":"AppConfigType", + "documentation":"

Specify the item to configure, such as admin role for the OpenSearch Application.

" + }, + "value":{ + "shape":"AppConfigValue", + "documentation":"

Specifies the value to configure for the key, such as an IAM user ARN.

" + } + }, + "documentation":"

Configurations of the OpenSearch Application.

" + }, + "AppConfigType":{ + "type":"string", + "enum":[ + "opensearchDashboards.dashboardAdmin.users", + "opensearchDashboards.dashboardAdmin.groups" + ] + }, + "AppConfigValue":{ + "type":"string", + "max":4096, + "min":1 + }, + "AppConfigs":{ + "type":"list", + "member":{"shape":"AppConfig"}, + "max":200 + }, + "ApplicationName":{ + "type":"string", + "max":30, + "min":3, + "pattern":"[a-z][a-z0-9\\-]+" + }, + "ApplicationStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE", + "FAILED" + ] + }, + "ApplicationStatuses":{ + "type":"list", + "member":{"shape":"ApplicationStatus"} + }, + "ApplicationSummaries":{ + "type":"list", + "member":{"shape":"ApplicationSummary"} + }, + "ApplicationSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier for an OpenSearch application.

" + }, + "arn":{"shape":"ARN"}, + "name":{ + "shape":"ApplicationName", + "documentation":"

Name of an OpenSearch Application.

" + }, + "endpoint":{ + "shape":"String", + "documentation":"

Endpoint URL of an OpenSearch Application.

" + }, + "status":{ + "shape":"ApplicationStatus", + "documentation":"

Status of an OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp at which an OpenSearch Application was created.

" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp at which an OpenSearch Application was last updated.

" + } + }, + "documentation":"

Basic information of the OpenSearch Application.

" + }, "AssociatePackageRequest":{ "type":"structure", "required":[ @@ -1411,10 +1598,7 @@ }, "AuthorizeVpcEndpointAccessRequest":{ "type":"structure", - "required":[ - "DomainName", - "Account" - ], + "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", @@ -1425,6 +1609,10 @@ "Account":{ "shape":"AWSAccount", "documentation":"

The Amazon Web Services account ID to grant access to.

" + }, + "Service":{ + "shape":"AWSServicePrincipal", + "documentation":"

The Amazon Web Services service SP to grant access to.

" } } }, @@ -2111,6 +2299,65 @@ "documentation":"

The connection properties of an outbound connection.

" }, "ConnectionStatusMessage":{"type":"string"}, + "CreateApplicationRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"

A unique client idempotency token. It will be auto generated if not provided.

", + "idempotencyToken":true + }, + "name":{ + "shape":"ApplicationName", + "documentation":"

Name of the OpenSearch Appication to create. Application names are unique across the applications owned by an account within an Amazon Web Services Region.

" + }, + "dataSources":{ + "shape":"DataSources", + "documentation":"

Data sources to be associated with the OpenSearch Application.

" + }, + "iamIdentityCenterOptions":{ + "shape":"IamIdentityCenterOptionsInput", + "documentation":"

Settings of IAM Identity Center for the OpenSearch Application.

" + }, + "appConfigs":{ + "shape":"AppConfigs", + "documentation":"

Configurations of the OpenSearch Application, inlcuding admin configuration.

" + }, + "tagList":{"shape":"TagList"} + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier for the created OpenSearch Application.

" + }, + "name":{ + "shape":"ApplicationName", + "documentation":"

Name of the created OpenSearch Application.

" + }, + "arn":{"shape":"ARN"}, + "dataSources":{ + "shape":"DataSources", + "documentation":"

Data sources associated with the created OpenSearch Application.

" + }, + "iamIdentityCenterOptions":{ + "shape":"IamIdentityCenterOptions", + "documentation":"

Settings of IAM Identity Center for the created OpenSearch Application.

" + }, + "appConfigs":{ + "shape":"AppConfigs", + "documentation":"

Configurations of the OpenSearch Application, inlcuding admin configuration.

" + }, + "tagList":{"shape":"TagList"}, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp when the OpenSearch Application was created.

" + } + } + }, "CreateDomainRequest":{ "type":"structure", "required":["DomainName"], @@ -2175,6 +2422,10 @@ "shape":"AdvancedSecurityOptionsInput", "documentation":"

Options for fine-grained access control.

" }, + "IdentityCenterOptions":{ + "shape":"IdentityCenterOptionsInput", + "documentation":"

Options for IAM Identity Center Option control for the domain.

" + }, "TagList":{ "shape":"TagList", "documentation":"

List of tags to add to the domain upon creation.

" @@ -2351,6 +2602,17 @@ }, "documentation":"

Cross-cluster search specific connection properties.

" }, + "DataSource":{ + "type":"structure", + "members":{ + "dataSourceArn":{"shape":"ARN"}, + "dataSourceDescription":{ + "shape":"DataSourceDescription", + "documentation":"

Detailed description of a data source.

" + } + }, + "documentation":"

Data sources that are associated with an OpenSearch Application.

" + }, "DataSourceDescription":{ "type":"string", "max":1000, @@ -2406,6 +2668,27 @@ "documentation":"

The type of data source.

", "union":true }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier for the OpenSearch Application that you want to delete.

", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteDataSourceRequest":{ "type":"structure", "required":[ @@ -3227,6 +3510,10 @@ "shape":"AdvancedSecurityOptionsStatus", "documentation":"

Container for fine-grained access control settings for the domain.

" }, + "IdentityCenterOptions":{ + "shape":"IdentityCenterOptionsStatus", + "documentation":"

Container for IAM Identity Center Option control for the domain.

" + }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsStatus", "documentation":"

Container for Auto-Tune settings for the domain.

" @@ -3634,6 +3921,10 @@ "shape":"AdvancedSecurityOptions", "documentation":"

Settings for fine-grained access control.

" }, + "IdentityCenterOptions":{ + "shape":"IdentityCenterOptions", + "documentation":"

Container for IAM Identity Center Option control for the domain.

" + }, "AutoTuneOptions":{ "shape":"AutoTuneOptionsOutput", "documentation":"

Auto-Tune settings for the domain.

" @@ -3899,6 +4190,60 @@ "type":"list", "member":{"shape":"GUID"} }, + "GetApplicationRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier of the checked OpenSearch Application.

", + "location":"uri", + "locationName":"id" + } + } + }, + "GetApplicationResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier of the checked OpenSearch Application.

" + }, + "arn":{"shape":"ARN"}, + "name":{ + "shape":"ApplicationName", + "documentation":"

Name of the checked OpenSearch Application.

" + }, + "endpoint":{ + "shape":"String", + "documentation":"

Endpoint URL of the checked OpenSearch Application.

" + }, + "status":{ + "shape":"ApplicationStatus", + "documentation":"

Current status of the checked OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" + }, + "iamIdentityCenterOptions":{ + "shape":"IamIdentityCenterOptions", + "documentation":"

IAM Identity Center settings for the checked OpenSearch Application.

" + }, + "dataSources":{ + "shape":"DataSources", + "documentation":"

Associated data sources to the checked OpenSearch Application.

" + }, + "appConfigs":{ + "shape":"AppConfigs", + "documentation":"

App configurations of the checked OpenSearch Application.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp at which the checked OpenSearch Application was created.

" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp at which the checked OpenSearch Application was last updated.

" + } + } + }, "GetCompatibleVersionsRequest":{ "type":"structure", "members":{ @@ -4153,12 +4498,135 @@ }, "documentation":"

The IP address type status for the domain.

" }, + "IamIdentityCenterOptions":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"

IAM Identity Center is enabled for the OpenSearch Application.

" + }, + "iamIdentityCenterInstanceArn":{"shape":"ARN"}, + "iamRoleForIdentityCenterApplicationArn":{ + "shape":"RoleArn", + "documentation":"

Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.

" + }, + "iamIdentityCenterApplicationArn":{"shape":"ARN"} + }, + "documentation":"

Settings for IAM Identity Center for an OpenSearch Application.

" + }, + "IamIdentityCenterOptionsInput":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"

Enable/disable settings for IAM Identity Center.

" + }, + "iamIdentityCenterInstanceArn":{"shape":"ARN"}, + "iamRoleForIdentityCenterApplicationArn":{ + "shape":"RoleArn", + "documentation":"

Amazon Resource Name of IAM Identity Center's application.

" + } + }, + "documentation":"

Settings for IAM Identity Center.

" + }, + "Id":{ + "type":"string", + "pattern":"[a-z0-9]{3,30}" + }, + "IdentityCenterApplicationARN":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+" + }, + "IdentityCenterInstanceARN":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+" + }, + "IdentityCenterOptions":{ + "type":"structure", + "members":{ + "EnabledAPIAccess":{ + "shape":"Boolean", + "documentation":"

True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

" + }, + "IdentityCenterInstanceARN":{ + "shape":"IdentityCenterInstanceARN", + "documentation":"

The ARN for IAM Identity Center Instance.

" + }, + "SubjectKey":{ + "shape":"SubjectKeyIdCOption", + "documentation":"

Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

" + }, + "RolesKey":{ + "shape":"RolesKeyIdCOption", + "documentation":"

Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center

" + }, + "IdentityCenterApplicationARN":{ + "shape":"IdentityCenterApplicationARN", + "documentation":"

The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.

" + }, + "IdentityStoreId":{ + "shape":"IdentityStoreId", + "documentation":"

The ID of IAM Identity Store.

" + } + }, + "documentation":"

Container for IAM Identity Center Options settings.

" + }, + "IdentityCenterOptionsInput":{ + "type":"structure", + "members":{ + "EnabledAPIAccess":{ + "shape":"Boolean", + "documentation":"

True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

" + }, + "IdentityCenterInstanceARN":{ + "shape":"IdentityCenterInstanceARN", + "documentation":"

The ARN for IAM Identity Center Instance which will be used for IAM Identity Center Application creation.

" + }, + "SubjectKey":{ + "shape":"SubjectKeyIdCOption", + "documentation":"

Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

" + }, + "RolesKey":{ + "shape":"RolesKeyIdCOption", + "documentation":"

Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center

" + } + }, + "documentation":"

Container for IAM Identity Center Options settings.

" + }, + "IdentityCenterOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"IdentityCenterOptions", + "documentation":"

Container for IAM Identity Center Options settings.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

The status of IAM Identity Center Options settings for a domain.

" + } + }, + "documentation":"

The status of IAM Identity Center Options settings for a domain.

" + }, "IdentityPoolId":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+:[0-9a-f-]+" }, + "IdentityStoreId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\\\b[0-9a-f]{12}$" + }, "InboundConnection":{ "type":"structure", "members":{ @@ -4425,6 +4893,37 @@ "value":{"shape":"Limits"}, "documentation":"

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

" }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "statuses":{ + "shape":"ApplicationStatuses", + "documentation":"

OpenSearch Application Status can be used as filters for the listing request. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

", + "location":"querystring", + "locationName":"statuses" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListApplicationsResponse":{ + "type":"structure", + "members":{ + "ApplicationSummaries":{ + "shape":"ApplicationSummaries", + "documentation":"

Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, "ListDataSourcesRequest":{ "type":"structure", "required":["DomainName"], @@ -5859,10 +6358,7 @@ }, "RevokeVpcEndpointAccessRequest":{ "type":"structure", - "required":[ - "DomainName", - "Account" - ], + "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", @@ -5873,6 +6369,10 @@ "Account":{ "shape":"AWSAccount", "documentation":"

The account ID to revoke access from.

" + }, + "Service":{ + "shape":"AWSServicePrincipal", + "documentation":"

The service SP to revoke access from.

" } } }, @@ -5892,6 +6392,13 @@ "max":64, "min":1 }, + "RolesKeyIdCOption":{ + "type":"string", + "enum":[ + "GroupName", + "GroupId" + ] + }, "RollbackOnDisable":{ "type":"string", "documentation":"

The rollback state while disabling Auto-Tune for the domain.

", @@ -6369,6 +6876,14 @@ "max":64, "min":1 }, + "SubjectKeyIdCOption":{ + "type":"string", + "enum":[ + "UserName", + "UserId", + "Email" + ] + }, "TLSSecurityPolicy":{ "type":"string", "enum":[ @@ -6419,12 +6934,67 @@ "documentation":"

The unit of a maintenance schedule duration. Valid value is HOUR.

", "enum":["HOURS"] }, + "Timestamp":{"type":"timestamp"}, "TotalNumberOfStages":{"type":"integer"}, "UIntValue":{ "type":"integer", "min":0 }, "UncompressedPluginSizeInBytes":{"type":"long"}, + "UpdateApplicationRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier of the OpenSearch Application to be updated.

", + "location":"uri", + "locationName":"id" + }, + "dataSources":{ + "shape":"DataSources", + "documentation":"

Data sources to be associated with the OpenSearch Application.

" + }, + "appConfigs":{ + "shape":"AppConfigs", + "documentation":"

Configurations to be changed for the OpenSearch Application.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Id", + "documentation":"

Unique identifier of the updated OpenSearch Application.

" + }, + "name":{ + "shape":"ApplicationName", + "documentation":"

Name of the updated OpenSearch Application.

" + }, + "arn":{"shape":"ARN"}, + "dataSources":{ + "shape":"DataSources", + "documentation":"

Data sources associated with the updated OpenSearch Application.

" + }, + "iamIdentityCenterOptions":{ + "shape":"IamIdentityCenterOptions", + "documentation":"

IAM Identity Center settings for the updated OpenSearch Application.

" + }, + "appConfigs":{ + "shape":"AppConfigs", + "documentation":"

Configurations for the updated OpenSearch Application.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp at which the OpenSearch Application was created.

" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"

Timestamp at which the OpenSearch Application was last updated.

" + } + } + }, "UpdateDataSourceRequest":{ "type":"structure", "required":[ @@ -6532,6 +7102,7 @@ "shape":"AdvancedSecurityOptionsInput", "documentation":"

Options for fine-grained access control.

" }, + "IdentityCenterOptions":{"shape":"IdentityCenterOptionsInput"}, "AutoTuneOptions":{ "shape":"AutoTuneOptions", "documentation":"

Options for Auto-Tune.

" diff --git a/botocore/data/opensearchserverless/2021-11-01/service-2.json b/botocore/data/opensearchserverless/2021-11-01/service-2.json index 9d705d7c7b..1cfc970ee3 100644 --- a/botocore/data/opensearchserverless/2021-11-01/service-2.json +++ b/botocore/data/opensearchserverless/2021-11-01/service-2.json @@ -1133,6 +1133,25 @@ } } }, + "CreateIamIdentityCenterConfigOptions":{ + "type":"structure", + "required":["instanceArn"], + "members":{ + "groupAttribute":{ + "shape":"IamIdentityCenterGroupAttribute", + "documentation":"

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" + }, + "instanceArn":{ + "shape":"IamIdentityCenterInstanceArn", + "documentation":"

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

" + }, + "userAttribute":{ + "shape":"IamIdentityCenterUserAttribute", + "documentation":"

The user attribute for this IAM Identity Center integration. Defaults to UserId.

" + } + }, + "documentation":"

Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.

" + }, "CreateLifecyclePolicyRequest":{ "type":"structure", "required":[ @@ -1189,6 +1208,10 @@ "shape":"ConfigDescription", "documentation":"

A description of the security configuration.

" }, + "iamIdentityCenterOptions":{ + "shape":"CreateIamIdentityCenterConfigOptions", + "documentation":"

Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

" + }, "name":{ "shape":"ConfigName", "documentation":"

The name of the security configuration.

" @@ -1676,6 +1699,63 @@ } } }, + "IamIdentityCenterApplicationArn":{ + "type":"string", + "max":1224, + "min":10, + "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" + }, + "IamIdentityCenterConfigOptions":{ + "type":"structure", + "members":{ + "applicationArn":{ + "shape":"IamIdentityCenterApplicationArn", + "documentation":"

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" + }, + "applicationDescription":{ + "shape":"String", + "documentation":"

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" + }, + "applicationName":{ + "shape":"String", + "documentation":"

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" + }, + "groupAttribute":{ + "shape":"IamIdentityCenterGroupAttribute", + "documentation":"

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" + }, + "instanceArn":{ + "shape":"IamIdentityCenterInstanceArn", + "documentation":"

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

" + }, + "userAttribute":{ + "shape":"IamIdentityCenterUserAttribute", + "documentation":"

The user attribute for this IAM Identity Center integration. Defaults to UserId

" + } + }, + "documentation":"

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

" + }, + "IamIdentityCenterGroupAttribute":{ + "type":"string", + "enum":[ + "GroupId", + "GroupName" + ] + }, + "IamIdentityCenterInstanceArn":{ + "type":"string", + "max":1224, + "min":10, + "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + }, + "IamIdentityCenterUserAttribute":{ + "type":"string", + "enum":[ + "UserId", + "UserName", + "Email" + ] + }, "IndexingCapacityValue":{ "type":"integer", "box":true, @@ -2225,6 +2305,10 @@ "shape":"ConfigDescription", "documentation":"

The description of the security configuration.

" }, + "iamIdentityCenterOptions":{ + "shape":"IamIdentityCenterConfigOptions", + "documentation":"

Describes IAM Identity Center options in the form of a key-value map.

" + }, "id":{ "shape":"SecurityConfigId", "documentation":"

The unique identifier of the security configuration.

" @@ -2295,7 +2379,10 @@ }, "SecurityConfigType":{ "type":"string", - "enum":["saml"] + "enum":[ + "saml", + "iamidentitycenter" + ] }, "SecurityGroupId":{ "type":"string", @@ -2663,6 +2750,20 @@ } } }, + "UpdateIamIdentityCenterConfigOptions":{ + "type":"structure", + "members":{ + "groupAttribute":{ + "shape":"IamIdentityCenterGroupAttribute", + "documentation":"

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" + }, + "userAttribute":{ + "shape":"IamIdentityCenterUserAttribute", + "documentation":"

The user attribute for this IAM Identity Center integration. Defaults to UserId.

" + } + }, + "documentation":"

Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.

" + }, "UpdateLifecyclePolicyRequest":{ "type":"structure", "required":[ @@ -2727,6 +2828,10 @@ "shape":"ConfigDescription", "documentation":"

A description of the security configuration.

" }, + "iamIdentityCenterOptionsUpdates":{ + "shape":"UpdateIamIdentityCenterConfigOptions", + "documentation":"

Describes IAM Identity Center options in the form of a key-value map.

" + }, "id":{ "shape":"SecurityConfigId", "documentation":"

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

" diff --git a/botocore/data/redshift-serverless/2021-04-21/service-2.json b/botocore/data/redshift-serverless/2021-04-21/service-2.json index 26a91f59bb..5a71966458 100644 --- a/botocore/data/redshift-serverless/2021-04-21/service-2.json +++ b/botocore/data/redshift-serverless/2021-04-21/service-2.json @@ -1401,6 +1401,10 @@ "shape":"Integer", "documentation":"

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

" }, + "pricePerformanceTarget":{ + "shape":"PerformanceTarget", + "documentation":"

An object that represents the price performance target settings for the workgroup.

" + }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"

A value that specifies whether the workgroup can be accessed from a public network.

" @@ -2597,6 +2601,33 @@ }, "ParameterKey":{"type":"string"}, "ParameterValue":{"type":"string"}, + "PerformanceTarget":{ + "type":"structure", + "members":{ + "level":{ + "shape":"PerformanceTargetLevelInteger", + "documentation":"

The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.

" + }, + "status":{ + "shape":"PerformanceTargetStatus", + "documentation":"

Whether the price performance target is enabled for the workgroup.

" + } + }, + "documentation":"

An object that represents the price performance target settings for the workgroup.

" + }, + "PerformanceTargetLevelInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "PerformanceTargetStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "PutResourcePolicyRequest":{ "type":"structure", "required":[ @@ -3616,6 +3647,10 @@ "shape":"Integer", "documentation":"

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

" }, + "pricePerformanceTarget":{ + "shape":"PerformanceTarget", + "documentation":"

An object that represents the price performance target settings for the workgroup.

" + }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"

A value that specifies whether the workgroup can be accessible from a public network.

" @@ -3824,6 +3859,10 @@ "shape":"Integer", "documentation":"

The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

" }, + "pricePerformanceTarget":{ + "shape":"PerformanceTarget", + "documentation":"

An object that represents the price performance target settings for the workgroup.

" + }, "publiclyAccessible":{ "shape":"Boolean", "documentation":"

A value that specifies whether the workgroup can be accessible from a public network.

" diff --git a/botocore/data/redshift/2012-12-01/service-2.json b/botocore/data/redshift/2012-12-01/service-2.json index f28b14c844..aedb38de4b 100644 --- a/botocore/data/redshift/2012-12-01/service-2.json +++ b/botocore/data/redshift/2012-12-01/service-2.json @@ -492,7 +492,7 @@ {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], - "documentation":"

Creates a zero-ETL integration with Amazon Redshift.

" + "documentation":"

Creates a zero-ETL integration or S3 event integration with Amazon Redshift.

" }, "CreateRedshiftIdcApplication":{ "name":"CreateRedshiftIdcApplication", @@ -817,7 +817,7 @@ {"shape":"IntegrationConflictOperationFault"}, {"shape":"UnsupportedOperationFault"} ], - "documentation":"

Deletes a zero-ETL integration with Amazon Redshift.

" + "documentation":"

Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.

" }, "DeletePartner":{ "name":"DeletePartner", @@ -1334,7 +1334,7 @@ {"shape":"IntegrationNotFoundFault"}, {"shape":"UnsupportedOperationFault"} ], - "documentation":"

Describes one or more zero-ETL integrations with Amazon Redshift.

" + "documentation":"

Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.

" }, "DescribeLoggingStatus":{ "name":"DescribeLoggingStatus", @@ -2117,7 +2117,7 @@ {"shape":"IntegrationAlreadyExistsFault"}, {"shape":"UnsupportedOperationFault"} ], - "documentation":"

Modifies a zero-ETL integration with Amazon Redshift.

" + "documentation":"

Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.

" }, "ModifyRedshiftIdcApplication":{ "name":"ModifyRedshiftIdcApplication", @@ -4640,11 +4640,11 @@ ], "members":{ "SourceArn":{ - "shape":"String", + "shape":"SourceArn", "documentation":"

The Amazon Resource Name (ARN) of the database to use as the source for replication.

" }, "TargetArn":{ - "shape":"String", + "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

" }, "IntegrationName":{ @@ -6009,11 +6009,11 @@ "type":"structure", "members":{ "IntegrationArn":{ - "shape":"String", + "shape":"InboundIntegrationArn", "documentation":"

The Amazon Resource Name (ARN) of the inbound integration.

" }, "TargetArn":{ - "shape":"String", + "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the target of an inbound integration.

" }, "MaxRecords":{ @@ -6441,7 +6441,7 @@ }, "ResourceType":{ "shape":"String", - "documentation":"

The type of resource with which you want to view tags. Valid resource types are:

For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

" + "documentation":"

The type of resource with which you want to view tags. Valid resource types are:

For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

" }, "MaxRecords":{ "shape":"IntegerOptional", @@ -7520,7 +7520,7 @@ "type":"structure", "members":{ "IntegrationArn":{ - "shape":"String", + "shape":"InboundIntegrationArn", "documentation":"

The Amazon Resource Name (ARN) of an inbound integration.

" }, "SourceArn":{ @@ -7528,7 +7528,7 @@ "documentation":"

The Amazon Resource Name (ARN) of the source of an inbound integration.

" }, "TargetArn":{ - "shape":"String", + "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the target of an inbound integration.

" }, "Status":{ @@ -7546,6 +7546,12 @@ }, "documentation":"

The content of an inbound integration.

" }, + "InboundIntegrationArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^arn:aws[a-z\\-]*:.+:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + }, "InboundIntegrationList":{ "type":"list", "member":{ @@ -7608,7 +7614,7 @@ "type":"structure", "members":{ "IntegrationArn":{ - "shape":"String", + "shape":"IntegrationArn", "documentation":"

The Amazon Resource Name (ARN) of the integration.

" }, "IntegrationName":{ @@ -7616,11 +7622,11 @@ "documentation":"

The name of the integration.

" }, "SourceArn":{ - "shape":"String", + "shape":"SourceArn", "documentation":"

The Amazon Resource Name (ARN) of the database used as the source for replication.

" }, "TargetArn":{ - "shape":"String", + "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

" }, "Status":{ @@ -7669,7 +7675,7 @@ "type":"string", "max":255, "min":1, - "pattern":"arn:aws[a-z\\-]*:redshift:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "pattern":"^arn:aws[a-z\\-]*:redshift:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "IntegrationConflictOperationFault":{ "type":"structure", @@ -7752,7 +7758,7 @@ "type":"structure", "members":{ }, - "documentation":"

You can't create any more zero-ETL integrations because the quota has been reached.

", + "documentation":"

You can't create any more zero-ETL or S3 event integrations because the quota has been reached.

", "error":{ "code":"IntegrationQuotaExceededFault", "httpStatusCode":400, @@ -11319,6 +11325,12 @@ "DESC" ] }, + "SourceArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^arn:aws[a-z\\-]*:(s3|dynamodb):.*:.*:[a-zA-Z0-9._\\-\\/]+$" + }, "SourceIdsList":{ "type":"list", "member":{ @@ -11696,6 +11708,12 @@ }, "documentation":"

" }, + "TargetArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:redshift(-serverless)?:[a-z0-9\\-]+:[0-9]{12}:(namespace\\/|namespace:)[a-z0-9\\-]+$" + }, "TrackList":{ "type":"list", "member":{ diff --git a/botocore/data/route53/2013-04-01/service-2.json b/botocore/data/route53/2013-04-01/service-2.json index 590e550071..917e401213 100644 --- a/botocore/data/route53/2013-04-01/service-2.json +++ b/botocore/data/route53/2013-04-01/service-2.json @@ -235,7 +235,7 @@ {"shape":"QueryLoggingConfigAlreadyExists"}, {"shape":"InsufficientCloudWatchLogsResourcePolicy"} ], - "documentation":"

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

Log Group and Resource Policy

Before you create a query logging configuration, perform the following operations.

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

  1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

    • You must create the log group in the us-east-1 region.

    • You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.

    • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      /aws/route53/hosted zone name

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

  2. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

    arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

    To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:

    • For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID.

    • For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111.

    For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide.

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.
Log Streams and Edge Locations

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

The name of each log stream is in the following format:

hosted zone ID/edge location code

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.

Queries That Are Logged

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.

Log File Format

For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.

Pricing

For information about charges for query logs, see Amazon CloudWatch Pricing.

How to Stop Logging

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

" + "documentation":"

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

Log Group and Resource Policy

Before you create a query logging configuration, perform the following operations.

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

  1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

    • You must create the log group in the us-east-1 region.

    • You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.

    • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      /aws/route53/hosted zone name

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

  2. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

    arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

    To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:

    • For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID.

    • For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111.

    For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide.

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.
Log Streams and Edge Locations

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

The name of each log stream is in the following format:

hosted zone ID/edge location code

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.

Queries That Are Logged

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.

Log File Format

For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.

Pricing

For information about charges for query logs, see Amazon CloudWatch Pricing.

How to Stop Logging

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

" }, "CreateReusableDelegationSet":{ "name":"CreateReusableDelegationSet", @@ -708,7 +708,7 @@ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"} ], - "documentation":"

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

" + "documentation":"

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

returns the VPCs associated with the specified hosted zone and does not reflect the VPC associations by Route 53 Profiles. To get the associations to a Profile, call the ListProfileAssociations API.

" }, "GetHostedZoneCount":{ "name":"GetHostedZoneCount", @@ -929,7 +929,7 @@ {"shape":"InvalidInput"}, {"shape":"InvalidPaginationToken"} ], - "documentation":"

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:

When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

For more information, see Access Management in the Amazon Web Services General Reference.

" + "documentation":"

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:

ListHostedZonesByVPC returns the hosted zones associated with the specified VPC and does not reflect the hosted zone associations to VPCs via Route 53 Profiles. To get the associations to a Profile, call the ListProfileResourceAssociations API.

When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

For more information, see Access Management in the Amazon Web Services General Reference.

" }, "ListQueryLoggingConfigs":{ "name":"ListQueryLoggingConfigs", @@ -3442,7 +3442,7 @@ }, "Type":{ "shape":"HealthCheckType", - "documentation":"

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

" + "documentation":"

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

" }, "ResourcePath":{ "shape":"ResourcePath", @@ -5381,7 +5381,11 @@ "SPF", "AAAA", "CAA", - "DS" + "DS", + "TLSA", + "SSHFP", + "SVCB", + "HTTPS" ] }, "RecordData":{ @@ -5457,7 +5461,7 @@ }, "Type":{ "shape":"RRType", - "documentation":"

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

" + "documentation":"

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT| TLSA| SSHFP| SVCB| HTTPS

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT| TLSA| SSHFP| SVCB| HTTPS. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT| CAA| TLSA| SSHFP| SVCB| HTTPS

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

" }, "SetIdentifier":{ "shape":"ResourceRecordSetIdentifier", @@ -6430,6 +6434,7 @@ "sa-east-1", "ca-central-1", "cn-north-1", + "cn-northwest-1", "af-south-1", "eu-south-1", "eu-south-2", diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index dac3cca2e0..7307b931fe 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -696,7 +696,7 @@ "errors":[ {"shape":"ResourceNotFound"} ], - "documentation":"

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

" + "documentation":"

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint .

" }, "CreatePresignedMlflowTrackingServerUrl":{ "name":"CreatePresignedMlflowTrackingServerUrl", @@ -10206,6 +10206,10 @@ "ModelCard":{ "shape":"ModelPackageModelCard", "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" + }, + "ModelLifeCycle":{ + "shape":"ModelLifeCycle", + "documentation":"

A structure describing the current state of the model in its life cycle.

" } } }, @@ -15724,6 +15728,10 @@ "ModelCard":{ "shape":"ModelPackageModelCard", "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" + }, + "ModelLifeCycle":{ + "shape":"ModelLifeCycle", + "documentation":"

A structure describing the current state of the model in its life cycle.

" } } }, @@ -28104,6 +28112,28 @@ "max":1, "min":1 }, + "ModelLifeCycle":{ + "type":"structure", + "required":[ + "Stage", + "StageStatus" + ], + "members":{ + "Stage":{ + "shape":"EntityName", + "documentation":"

The current stage in the model life cycle.

" + }, + "StageStatus":{ + "shape":"EntityName", + "documentation":"

The current status of a stage in model life cycle.

" + }, + "StageDescription":{ + "shape":"StageDescription", + "documentation":"

Describes the stage related details.

" + } + }, + "documentation":"

A structure describing the current state of the model in its life cycle.

" + }, "ModelMetadataFilter":{ "type":"structure", "required":[ @@ -28317,6 +28347,10 @@ }, "SecurityConfig":{"shape":"ModelPackageSecurityConfig"}, "ModelCard":{"shape":"ModelPackageModelCard"}, + "ModelLifeCycle":{ + "shape":"ModelLifeCycle", + "documentation":"

A structure describing the current state of the model in its life cycle.

" + }, "Tags":{ "shape":"TagList", "documentation":"

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

" @@ -35034,6 +35068,12 @@ "TFRecord" ] }, + "StageDescription":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"^.{0,1024}$" + }, "StageStatus":{ "type":"string", "enum":[ @@ -36467,7 +36507,6 @@ "ml.p4de.24xlarge", "ml.p5.48xlarge", "ml.p5e.48xlarge", - "ml.p5en.48xlarge", "ml.c5.xlarge", "ml.c5.2xlarge", "ml.c5.4xlarge", @@ -36489,7 +36528,6 @@ "ml.trn1.2xlarge", "ml.trn1.32xlarge", "ml.trn1n.32xlarge", - "ml.trn2.48xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", @@ -38659,6 +38697,14 @@ "ModelCard":{ "shape":"ModelPackageModelCard", "documentation":"

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

" + }, + "ModelLifeCycle":{ + "shape":"ModelLifeCycle", + "documentation":"

A structure describing the current state of the model in its life cycle.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A unique token that guarantees that the call to this API is idempotent.

" } } }, @@ -39452,7 +39498,7 @@ "type":"string", "max":176, "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

", "idempotent":true }, + "CreateIdentityCenterApplication":{ + "name":"CreateIdentityCenterApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIdentityCenterApplicationRequest"}, + "output":{"shape":"CreateIdentityCenterApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"} + ], + "documentation":"

Creates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.

", + "idempotent":true + }, "CreateImpersonationRole":{ "name":"CreateImpersonationRole", "http":{ @@ -324,6 +340,37 @@ "documentation":"

Deletes a group from WorkMail.

", "idempotent":true }, + "DeleteIdentityCenterApplication":{ + "name":"DeleteIdentityCenterApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentityCenterApplicationRequest"}, + "output":{"shape":"DeleteIdentityCenterApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.

", + "idempotent":true + }, + "DeleteIdentityProviderConfiguration":{ + "name":"DeleteIdentityProviderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentityProviderConfigurationRequest"}, + "output":{"shape":"DeleteIdentityProviderConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

Disables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.

", + "idempotent":true + }, "DeleteImpersonationRole":{ "name":"DeleteImpersonationRole", "http":{ @@ -404,6 +451,22 @@ "documentation":"

Deletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the WorkMail Administrator Guide.

", "idempotent":true }, + "DeletePersonalAccessToken":{ + "name":"DeletePersonalAccessToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePersonalAccessTokenRequest"}, + "output":{"shape":"DeletePersonalAccessTokenResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

Deletes the Personal Access Token from the provided WorkMail Organization.

", + "idempotent":true + }, "DeleteResource":{ "name":"DeleteResource", "http":{ @@ -545,6 +608,23 @@ "documentation":"

Returns the data available for the group.

", "idempotent":true }, + "DescribeIdentityProviderConfiguration":{ + "name":"DescribeIdentityProviderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityProviderConfigurationRequest"}, + "output":{"shape":"DescribeIdentityProviderConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns detailed information on the current IdC setup for the WorkMail organization.

", + "idempotent":true + }, "DescribeInboundDmarcSettings":{ "name":"DescribeInboundDmarcSettings", "http":{ @@ -619,6 +699,8 @@ "input":{"shape":"DescribeUserRequest"}, "output":{"shape":"DescribeUserResponse"}, "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, {"shape":"EntityNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"OrganizationNotFoundException"}, @@ -801,6 +883,23 @@ ], "documentation":"

Gets the mobile device access override for the given WorkMail organization, user, and device.

" }, + "GetPersonalAccessTokenMetadata":{ + "name":"GetPersonalAccessTokenMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPersonalAccessTokenMetadataRequest"}, + "output":{"shape":"GetPersonalAccessTokenMetadataResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

Requests details of a specific Personal Access Token within the WorkMail organization.

", + "idempotent":true + }, "ListAccessControlRules":{ "name":"ListAccessControlRules", "http":{ @@ -843,7 +942,8 @@ "output":{"shape":"ListAvailabilityConfigurationsResponse"}, "errors":[ {"shape":"OrganizationNotFoundException"}, - {"shape":"OrganizationStateException"} + {"shape":"OrganizationStateException"}, + {"shape":"InvalidParameterException"} ], "documentation":"

List all the AvailabilityConfiguration's for the given WorkMail organization.

" }, @@ -1009,6 +1109,24 @@ "documentation":"

Returns summaries of the customer's organizations.

", "idempotent":true }, + "ListPersonalAccessTokens":{ + "name":"ListPersonalAccessTokens", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPersonalAccessTokensRequest"}, + "output":{"shape":"ListPersonalAccessTokensResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

Returns a summary of your Personal Access Tokens.

", + "idempotent":true + }, "ListResourceDelegates":{ "name":"ListResourceDelegates", "http":{ @@ -1109,6 +1227,23 @@ "documentation":"

Creates or updates the email monitoring configuration for a specified organization.

", "idempotent":true }, + "PutIdentityProviderConfiguration":{ + "name":"PutIdentityProviderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutIdentityProviderConfigurationRequest"}, + "output":{"shape":"PutIdentityProviderConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Enables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.

", + "idempotent":true + }, "PutInboundDmarcSettings":{ "name":"PutInboundDmarcSettings", "http":{ @@ -1354,7 +1489,7 @@ {"shape":"UnsupportedOperationException"}, {"shape":"InvalidParameterException"} ], - "documentation":"

Updates attibutes in a group.

", + "documentation":"

Updates attributes in a group.

", "idempotent":true }, "UpdateImpersonationRole":{ @@ -1601,6 +1736,12 @@ "min":1, "pattern":"arn:aws:workmail:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}" }, + "ApplicationArn":{ + "type":"string", + "max":1224, + "min":10, + "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" + }, "AssociateDelegateToResourceRequest":{ "type":"structure", "required":[ @@ -1866,6 +2007,37 @@ } } }, + "CreateIdentityCenterApplicationRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceArn" + ], + "members":{ + "Name":{ + "shape":"IdentityCenterApplicationName", + "documentation":"

The name of the IAM Identity Center application.

" + }, + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"

The Amazon Resource Name (ARN) of the instance.

" + }, + "ClientToken":{ + "shape":"IdempotencyClientToken", + "documentation":"

The idempotency token associated with the request.

", + "idempotencyToken":true + } + } + }, + "CreateIdentityCenterApplicationResponse":{ + "type":"structure", + "members":{ + "ApplicationArn":{ + "shape":"ApplicationArn", + "documentation":"

The Amazon Resource Name (ARN) of the application.

" + } + } + }, "CreateImpersonationRoleRequest":{ "type":"structure", "required":[ @@ -2101,6 +2273,10 @@ "HiddenFromGlobalAddressList":{ "shape":"Boolean", "documentation":"

If this parameter is enabled, the user will be hidden from the address book.

" + }, + "IdentityProviderUserId":{ + "shape":"IdentityProviderUserId", + "documentation":"

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

" } } }, @@ -2239,6 +2415,36 @@ "members":{ } }, + "DeleteIdentityCenterApplicationRequest":{ + "type":"structure", + "required":["ApplicationArn"], + "members":{ + "ApplicationArn":{ + "shape":"ApplicationArn", + "documentation":"

The Amazon Resource Name (ARN) of the application.

" + } + } + }, + "DeleteIdentityCenterApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIdentityProviderConfigurationRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

The Organization ID.

" + } + } + }, + "DeleteIdentityProviderConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteImpersonationRoleRequest":{ "type":"structure", "required":[ @@ -2360,6 +2566,10 @@ "ForceDelete":{ "shape":"Boolean", "documentation":"

Deletes a WorkMail organization even if the organization has enabled users.

" + }, + "DeleteIdentityCenterApplication":{ + "shape":"Boolean", + "documentation":"

Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization.

" } } }, @@ -2376,6 +2586,28 @@ } } }, + "DeletePersonalAccessTokenRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "PersonalAccessTokenId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

The Organization ID.

" + }, + "PersonalAccessTokenId":{ + "shape":"PersonalAccessTokenId", + "documentation":"

The Personal Access Token ID.

" + } + } + }, + "DeletePersonalAccessTokenResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteResourceRequest":{ "type":"structure", "required":[ @@ -2593,6 +2825,33 @@ } } }, + "DescribeIdentityProviderConfigurationRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

The Organization ID.

" + } + } + }, + "DescribeIdentityProviderConfigurationResponse":{ + "type":"structure", + "members":{ + "AuthenticationMode":{ + "shape":"IdentityProviderAuthenticationMode", + "documentation":"

The authentication mode used in WorkMail.

" + }, + "IdentityCenterConfiguration":{ + "shape":"IdentityCenterConfiguration", + "documentation":"

The details of the IAM Identity Center configuration.

" + }, + "PersonalAccessTokenConfiguration":{ + "shape":"PersonalAccessTokenConfiguration", + "documentation":"

The details of the Personal Access Token configuration.

" + } + } + }, "DescribeInboundDmarcSettingsRequest":{ "type":"structure", "required":["OrganizationId"], @@ -2914,6 +3173,14 @@ "Office":{ "shape":"UserAttribute", "documentation":"

Office where the user is located.

" + }, + "IdentityProviderUserId":{ + "shape":"IdentityProviderUserId", + "documentation":"

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

" + }, + "IdentityProviderIdentityStoreId":{ + "shape":"IdentityProviderIdentityStoreId", + "documentation":"

Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

" } } }, @@ -3571,6 +3838,56 @@ } } }, + "GetPersonalAccessTokenMetadataRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "PersonalAccessTokenId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

The Organization ID.

" + }, + "PersonalAccessTokenId":{ + "shape":"PersonalAccessTokenId", + "documentation":"

The Personal Access Token ID.

" + } + } + }, + "GetPersonalAccessTokenMetadataResponse":{ + "type":"structure", + "members":{ + "PersonalAccessTokenId":{ + "shape":"PersonalAccessTokenId", + "documentation":"

The Personal Access Token ID.

" + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

The WorkMail User ID.

" + }, + "Name":{ + "shape":"PersonalAccessTokenName", + "documentation":"

The Personal Access Token name.

" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"

The date when the Personal Access Token ID was created.

" + }, + "DateLastUsed":{ + "shape":"Timestamp", + "documentation":"

The date when the Personal Access Token ID was last used.

" + }, + "ExpiresTime":{ + "shape":"Timestamp", + "documentation":"

The time when the Personal Access Token ID will expire.

" + }, + "Scopes":{ + "shape":"PersonalAccessTokenScopeList", + "documentation":"

Lists all the Personal Access Token permissions for a mailbox.

" + } + } + }, "Group":{ "type":"structure", "members":{ @@ -3641,6 +3958,61 @@ "min":1, "pattern":"[\\x21-\\x7e]+" }, + "IdentityCenterApplicationName":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^[\\w+=,.@-]+$" + }, + "IdentityCenterConfiguration":{ + "type":"structure", + "required":[ + "InstanceArn", + "ApplicationArn" + ], + "members":{ + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"

The Amazon Resource Name (ARN) of the of IAM Identity Center instance. Must be in the same AWS account and region as WorkMail organization.

" + }, + "ApplicationArn":{ + "shape":"ApplicationArn", + "documentation":"

The Amazon Resource Name (ARN) of IAMIdentity Center Application for WorkMail. Must be created by the WorkMail API, see CreateIdentityCenterApplication.

" + } + }, + "documentation":"

The IAM Identity Center configuration.

" + }, + "IdentityProviderAuthenticationMode":{ + "type":"string", + "enum":[ + "IDENTITY_PROVIDER_ONLY", + "IDENTITY_PROVIDER_AND_DIRECTORY" + ] + }, + "IdentityProviderIdentityStoreId":{ + "type":"string", + "max":36, + "min":1, + "pattern":"^d-[0-9a-f]{10}$|^[0-9a-f]{8}\\\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\\\b[0-9a-f]{12}$" + }, + "IdentityProviderUserId":{ + "type":"string", + "max":47, + "min":1, + "pattern":"^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" + }, + "IdentityProviderUserIdForUpdate":{ + "type":"string", + "max":47, + "min":0, + "pattern":"^$|^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" + }, + "IdentityProviderUserIdPrefix":{ + "type":"string", + "max":47, + "min":1, + "pattern":"^[A-Fa-f0-9-]+$" + }, "ImpersonationMatchedRule":{ "type":"structure", "members":{ @@ -3788,6 +4160,12 @@ "min":1, "pattern":"[\\x21-\\x7e]+" }, + "InstanceArn":{ + "type":"string", + "max":1124, + "min":10, + "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + }, "InvalidConfigurationException":{ "type":"structure", "members":{ @@ -4319,6 +4697,41 @@ } } }, + "ListPersonalAccessTokensRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

The Organization ID.

" + }, + "UserId":{ + "shape":"EntityIdentifier", + "documentation":"

The WorkMail User ID.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token from the previous response to query the next page.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum amount of items that should be returned in a response.

" + } + } + }, + "ListPersonalAccessTokensResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token from the previous response to query the next page.

" + }, + "PersonalAccessTokenSummaries":{ + "shape":"PersonalAccessTokenSummaryList", + "documentation":"

Lists all the personal tokens in an organization or user, if user ID is provided.

" + } + } + }, "ListResourceDelegatesRequest":{ "type":"structure", "required":[ @@ -4447,6 +4860,10 @@ "State":{ "shape":"EntityState", "documentation":"

Filters only users with the provided state.

" + }, + "IdentityProviderUserIdPrefix":{ + "shape":"IdentityProviderUserIdPrefix", + "documentation":"

Filters only users with the ID from the IAM Identity Center.

" } }, "documentation":"

Filtering options for ListUsers operation. This is only used as input to Operation.

" @@ -4811,7 +5228,8 @@ "NewResourceDescription":{ "type":"string", "max":64, - "min":0 + "min":0, + "sensitive":true }, "NextToken":{ "type":"string", @@ -4927,6 +5345,96 @@ "type":"list", "member":{"shape":"Permission"} }, + "PersonalAccessTokenConfiguration":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"PersonalAccessTokenConfigurationStatus", + "documentation":"

The status of the Personal Access Token allowed for the organization.

" + }, + "LifetimeInDays":{ + "shape":"PersonalAccessTokenLifetimeInDays", + "documentation":"

The validity of the Personal Access Token status in days.

" + } + }, + "documentation":"

Displays the Personal Access Token status.

" + }, + "PersonalAccessTokenConfigurationStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "PersonalAccessTokenId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "PersonalAccessTokenLifetimeInDays":{ + "type":"integer", + "box":true, + "max":3653, + "min":1 + }, + "PersonalAccessTokenName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+" + }, + "PersonalAccessTokenScope":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+" + }, + "PersonalAccessTokenScopeList":{ + "type":"list", + "member":{"shape":"PersonalAccessTokenScope"}, + "max":10, + "min":1 + }, + "PersonalAccessTokenSummary":{ + "type":"structure", + "members":{ + "PersonalAccessTokenId":{ + "shape":"PersonalAccessTokenId", + "documentation":"

The ID of the Personal Access Token.

" + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

The user ID of the WorkMail user associated with the Personal Access Token.

" + }, + "Name":{ + "shape":"PersonalAccessTokenName", + "documentation":"

The name of the Personal Access Token.

" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"

The date when the Personal Access Token was created.

" + }, + "DateLastUsed":{ + "shape":"Timestamp", + "documentation":"

The date when the Personal Access Token was last used.

" + }, + "ExpiresTime":{ + "shape":"Timestamp", + "documentation":"

The date when the Personal Access Token will expire.

" + }, + "Scopes":{ + "shape":"PersonalAccessTokenScopeList", + "documentation":"

Lists all the Personal Access Token permissions for a mailbox.

" + } + }, + "documentation":"

The summary of the Personal Access Token.

" + }, + "PersonalAccessTokenSummaryList":{ + "type":"list", + "member":{"shape":"PersonalAccessTokenSummary"} + }, "PolicyDescription":{ "type":"string", "max":256, @@ -5024,6 +5532,38 @@ "members":{ } }, + "PutIdentityProviderConfigurationRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "AuthenticationMode", + "IdentityCenterConfiguration", + "PersonalAccessTokenConfiguration" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

The ID of the WorkMail Organization.

" + }, + "AuthenticationMode":{ + "shape":"IdentityProviderAuthenticationMode", + "documentation":"

The authentication mode used in WorkMail.

" + }, + "IdentityCenterConfiguration":{ + "shape":"IdentityCenterConfiguration", + "documentation":"

The details of the IAM Identity Center configuration.

" + }, + "PersonalAccessTokenConfiguration":{ + "shape":"PersonalAccessTokenConfiguration", + "documentation":"

The details of the Personal Access Token configuration.

" + } + } + }, + "PutIdentityProviderConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, "PutInboundDmarcSettingsRequest":{ "type":"structure", "required":[ @@ -5297,7 +5837,8 @@ "ResourceDescription":{ "type":"string", "max":64, - "min":1 + "min":1, + "sensitive":true }, "ResourceId":{ "type":"string", @@ -5908,7 +6449,7 @@ }, "ZipCode":{ "shape":"UserAttribute", - "documentation":"

Updates the user's zipcode.

" + "documentation":"

Updates the user's zip code.

" }, "Department":{ "shape":"UserAttribute", @@ -5921,6 +6462,10 @@ "Office":{ "shape":"UserAttribute", "documentation":"

Updates the user's office.

" + }, + "IdentityProviderUserId":{ + "shape":"IdentityProviderUserIdForUpdate", + "documentation":"

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

" } } }, @@ -5968,6 +6513,14 @@ "DisabledDate":{ "shape":"Timestamp", "documentation":"

The date indicating when the user was disabled from WorkMail use.

" + }, + "IdentityProviderUserId":{ + "shape":"IdentityProviderUserId", + "documentation":"

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

" + }, + "IdentityProviderIdentityStoreId":{ + "shape":"IdentityProviderIdentityStoreId", + "documentation":"

Identity store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

" } }, "documentation":"

The representation of an WorkMail user.

" diff --git a/docs/source/_templates/page.html b/docs/source/_templates/page.html index e15a8c8d08..68cc2615d4 100644 --- a/docs/source/_templates/page.html +++ b/docs/source/_templates/page.html @@ -183,7 +183,7 @@ }); shortbread.checkForCookieConsent(); - Privacy | Site Terms | Privacy | Site Terms | Cookie preferences {# end of AWS modification of Furo template #} diff --git a/docs/source/conf.py b/docs/source/conf.py index aa13184091..b709ae8733 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.35.' # The full version, including alpha/beta/rc tags. -release = '1.35.51' +release = '1.35.52' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/functional/endpoint-rules/geo-maps/endpoint-tests-1.json b/tests/functional/endpoint-rules/geo-maps/endpoint-tests-1.json new file mode 100644 index 0000000000..3caf56f693 --- /dev/null +++ b/tests/functional/endpoint-rules/geo-maps/endpoint-tests-1.json @@ -0,0 +1,392 @@ +{ + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://maps.geo-fips.us-east-1.api.aws/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://maps.geo-fips.us-east-1.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://maps.geo.us-east-1.api.aws/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://maps.geo.us-east-1.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://geo-maps-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://geo-maps.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://maps.geo-fips.us-gov-west-1.us-gov.api.aws/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://maps.geo-fips.us-gov-west-1.us-gov.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://maps.geo.us-gov-west-1.us-gov.api.aws/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://maps.geo.us-gov-west-1.us-gov.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-maps.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/geo-places/endpoint-tests-1.json b/tests/functional/endpoint-rules/geo-places/endpoint-tests-1.json new file mode 100644 index 0000000000..7203f13861 --- /dev/null +++ b/tests/functional/endpoint-rules/geo-places/endpoint-tests-1.json @@ -0,0 +1,392 @@ +{ + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://places.geo-fips.us-east-1.api.aws/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://places.geo-fips.us-east-1.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://places.geo.us-east-1.api.aws/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://places.geo.us-east-1.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://geo-places-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://geo-places.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://places.geo-fips.us-gov-west-1.us-gov.api.aws/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://places.geo-fips.us-gov-west-1.us-gov.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://places.geo.us-gov-west-1.us-gov.api.aws/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://places.geo.us-gov-west-1.us-gov.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-places.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/tests/functional/endpoint-rules/geo-routes/endpoint-tests-1.json b/tests/functional/endpoint-rules/geo-routes/endpoint-tests-1.json new file mode 100644 index 0000000000..9343368808 --- /dev/null +++ b/tests/functional/endpoint-rules/geo-routes/endpoint-tests-1.json @@ -0,0 +1,392 @@ +{ + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://routes.geo-fips.us-east-1.api.aws/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://routes.geo-fips.us-east-1.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://routes.geo.us-east-1.api.aws/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://routes.geo.us-east-1.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://geo-routes-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://geo-routes.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://routes.geo-fips.us-gov-west-1.us-gov.api.aws/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://routes.geo-fips.us-gov-west-1.us-gov.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://routes.geo.us-gov-west-1.us-gov.api.aws/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://routes.geo.us-gov-west-1.us-gov.amazonaws.com/v2" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://geo-routes.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file