AppSync provides API actions for creating and interacting with data sources using GraphQL\n from your application.
", + "smithy.api#documentation": "AppSync provides API actions for creating and interacting with data\n sources using GraphQL from your application.
", "smithy.api#title": "AWS AppSync", "smithy.api#xmlNamespace": { "uri": "http://appsync.amazonaws.com" @@ -1152,7 +1182,7 @@ "authenticationType": { "target": "com.amazonaws.appsync#AuthenticationType", "traits": { - "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
" + "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID\n Connect (OIDC), Amazon Cognito user pools, or Lambda.
" } }, "openIDConnectConfig": { @@ -1184,6 +1214,72 @@ "target": "com.amazonaws.appsync#AdditionalAuthenticationProvider" } }, + "com.amazonaws.appsync#Api": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Api ID.
The name of the Api.
The owner contact information for the Api\n
The DNS records for the API. This will include an HTTP and a real-time endpoint.
" + } + }, + "apiArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Api.
The date and time that the Api was created.
A flag indicating whether to use X-Ray tracing for this\n Api.
The Amazon Resource Name (ARN) of the WAF web access control list (web\n ACL) associated with this Api, if one exists.
The Event API configuration. This includes the default authorization configuration for\n connecting, publishing, and subscribing to an Event API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an AppSync API. You can use Api for an AppSync\n API with your preferred configuration, such as an Event API that provides real-time message\n publishing and message subscriptions over WebSockets.
Identifies the status of an association.
\n\n PROCESSING: The API association is being created. You cannot\n modify association requests during processing.
\n\n SUCCESS: The API association was successful. You can modify\n associations after success.
\n\n FAILED: The API association has failed. You can modify\n associations after failure.
\nIdentifies the status of an association.
\n\n PROCESSING: The API association is being\n created. You cannot modify association requests during processing.
\n\n SUCCESS: The API association was successful.\n You can modify associations after success.
\n\n FAILED: The API association has failed. You\n can modify associations after failure.
\nCaching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nCaching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nTransit encryption flag when connecting to cache. You cannot update this setting after creation.
" + "smithy.api#documentation": "Transit encryption flag when connecting to cache. You cannot update this setting after\n creation.
" } }, "atRestEncryptionEnabled": { @@ -1255,13 +1351,13 @@ "status": { "target": "com.amazonaws.appsync#ApiCacheStatus", "traits": { - "smithy.api#documentation": "The cache instance status.
\n\n AVAILABLE: The instance is available for use.
\n\n CREATING: The instance is currently creating.
\n\n DELETING: The instance is currently deleting.
\n\n MODIFYING: The instance is currently modifying.
\n\n FAILED: The instance has failed creation.
\nThe cache instance status.
\n\n AVAILABLE: The instance is available for\n use.
\n\n CREATING: The instance is currently\n creating.
\n\n DELETING: The instance is currently\n deleting.
\n\n MODIFYING: The instance is currently\n modifying.
\n\n FAILED: The instance has failed\n creation.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics\n include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the\n throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing\n bottlenecks in a cache configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis\n process. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down\n to the nearest hour.
" + "smithy.api#documentation": "The time after which the API key expires. The date is represented as seconds since the\n epoch, rounded down to the nearest hour.
" } }, "deletes": { "target": "com.amazonaws.appsync#Long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded\n down to the nearest hour.
" + "smithy.api#documentation": "The time after which the API key is deleted. The date is represented as seconds since\n the epoch, rounded down to the nearest hour.
" } } }, "traits": { - "smithy.api#documentation": "Describes an API key.
\nCustomers invoke AppSync GraphQL API operations with API keys as an identity mechanism.\n There are two key versions:
\n\n da1: We introduced this version at launch in November 2017. These keys\n always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid\n after February 21, 2018, and they should no longer be used.
\n\n ListApiKeys returns the expiration time in milliseconds.
\n CreateApiKey returns the expiration time in milliseconds.
\n UpdateApiKey is not available for this key version.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are\n not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a\n one-time action, we deleted these keys from the table on February 21, 2018.
\n\n da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.
\n\n ListApiKeys returns the expiration time and deletion time in seconds.
\n CreateApiKey returns the expiration time and deletion time in seconds and accepts a\n user-provided expiration time in seconds.
\n UpdateApiKey returns the expiration time and and deletion time in seconds and accepts\n a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration\n time. You can update the key expiration time as long as the key isn't deleted.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to\n authenticate will fail. However, you can reinstate the key before deletion.
\nDeletion is stored in DynamoDB as seconds. The key is deleted after deletion\n time.
\nDescribes an API key.
\nCustomers invoke AppSync GraphQL API operations with API keys as an\n identity mechanism. There are two key versions:
\n\n da1: We introduced this version at launch in November\n 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key\n expiration. These keys ceased to be valid after February 21, 2018, and they should no\n longer be used.
\n\n ListApiKeys returns the expiration time in milliseconds.
\n CreateApiKey returns the expiration time in\n milliseconds.
\n UpdateApiKey is not available for this key version.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as milliseconds. This results in a\n bug where keys are not automatically deleted because DynamoDB expects the\n TTL to be stored in seconds. As a one-time action, we deleted these keys from the\n table on February 21, 2018.
\n\n da2: We introduced this version in February 2018 when\n AppSync added support to extend key expiration.
\n\n ListApiKeys returns the expiration time and deletion time in\n seconds.
\n CreateApiKey returns the expiration time and deletion time in\n seconds and accepts a user-provided expiration time in seconds.
\n UpdateApiKey returns the expiration time and and deletion time in\n seconds and accepts a user-provided expiration time in seconds. Expired API keys are\n kept for 60 days after the expiration time. You can update the key expiration time as\n long as the key isn't deleted.
\n DeleteApiKey deletes the item from the table.
Expiration is stored in DynamoDB as seconds. After the expiration\n time, using the key to authenticate will fail. However, you can reinstate the key\n before deletion.
\nDeletion is stored in DynamoDB as seconds. The key is deleted after\n deletion time.
\nThe name of the runtime to use. Currently, the only allowed value is\n APPSYNC_JS.
The name of the runtime to use. Currently, the only allowed value is\n APPSYNC_JS.
The version of the runtime to use. Currently, the only allowed version is\n 1.0.0.
The version of the runtime to use. Currently, the only allowed version is\n 1.0.0.
Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync\n function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must\n also be specified.
" + "smithy.api#documentation": "Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note\n that if a runtime is specified, code must also be specified.
" } }, "com.amazonaws.appsync#AssociateApi": { @@ -1614,7 +1726,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an association between a Merged API and source API using the source API's identifier.
", + "smithy.api#documentation": "Creates an association between a Merged API and source API using the source API's\n identifier.
", "smithy.api#http": { "method": "POST", "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations", @@ -1628,7 +1740,7 @@ "sourceApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In\n most cases, source APIs (especially in your account) only require the API ID value or ARN\n of the source API. However, source APIs from other accounts (cross-account use cases)\n strictly require the full resource ARN of the source API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1636,7 +1748,7 @@ "mergedApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#required": {} } }, @@ -1700,7 +1812,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an association between a Merged API and source API using the Merged API's identifier.
", + "smithy.api#documentation": "Creates an association between a Merged API and source API using the Merged API's\n identifier.
", "smithy.api#http": { "method": "POST", "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations", @@ -1714,7 +1826,7 @@ "mergedApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1722,7 +1834,7 @@ "sourceApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In\n most cases, source APIs (especially in your account) only require the API ID value or ARN\n of the source API. However, source APIs from other accounts (cross-account use cases)\n strictly require the full resource ARN of the source API.
", "smithy.api#required": {} } }, @@ -1780,6 +1892,60 @@ } } }, + "com.amazonaws.appsync#AuthMode": { + "type": "structure", + "members": { + "authType": { + "target": "com.amazonaws.appsync#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authorization type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an authorization configuration. Use AuthMode to specify the\n publishing and subscription authorization configuration for an Event API.
The authorization type.
", + "smithy.api#required": {} + } + }, + "cognitoConfig": { + "target": "com.amazonaws.appsync#CognitoConfig", + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito user pool configuration.
" + } + }, + "openIDConnectConfig": { + "target": "com.amazonaws.appsync#OpenIDConnectConfig" + }, + "lambdaAuthorizerConfig": { + "target": "com.amazonaws.appsync#LambdaAuthorizerConfig" + } + }, + "traits": { + "smithy.api#documentation": "Describes an authorization provider.
" + } + }, + "com.amazonaws.appsync#AuthProviders": { + "type": "list", + "member": { + "target": "com.amazonaws.appsync#AuthProvider" + } + }, "com.amazonaws.appsync#AuthenticationType": { "type": "enum", "members": { @@ -1821,7 +1987,7 @@ "authorizationType": { "target": "com.amazonaws.appsync#AuthorizationType", "traits": { - "smithy.api#documentation": "The authorization type that the HTTP endpoint requires.
\n\n AWS_IAM: The authorization type is Signature Version 4\n (SigV4).
\nThe authorization type that the HTTP endpoint requires.
\n\n AWS_IAM: The authorization type is Signature\n Version 4 (SigV4).
\nProvides further details for the reason behind the bad request. For reason type CODE_ERROR, the\n detail will contain a list of code errors.
Provides further details for the reason behind the bad request. For reason type\n CODE_ERROR, the detail will contain a list of code errors.
The request is not well formed. For example, a value is invalid or a required field is missing. Check the\n field values, and then try again.
", + "smithy.api#documentation": "The request is not well formed. For example, a value is invalid or a required field is\n missing. Check the field values, and then try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1911,7 +2077,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides context for the cause of the bad request. The only supported value is\n CODE_ERROR.
Provides context for the cause of the bad request. The only supported value is\n CODE_ERROR.
The caching keys for a resolver that has caching activated.
\nValid values are entries from the $context.arguments, $context.source, and\n $context.identity maps.
The caching keys for a resolver that has caching activated.
\nValid values are entries from the $context.arguments,\n $context.source, and $context.identity maps.
The Api ID.
The name of the channel namespace. This name must be unique within the\n Api.
The authorization mode to use for subscribing to messages on the channel namespace. This\n configuration overrides the default Apiauthorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This\n configuration overrides the default Apiauthorization configuration.
The event handler functions that run custom business logic to process published events\n and subscribe requests.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap" + }, + "channelNamespaceArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the ChannelNamespace.
The date and time that the ChannelNamespace was created.
The date and time that the ChannelNamespace was last changed.
Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.
The type of code error.
\nExamples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.
The type of code error.
\nExamples include, but aren't limited to: LINT_ERROR,\n PARSER_ERROR.
A user presentable error.
\nExamples include, but aren't limited to: Parsing error: Unterminated string literal.
A user presentable error.
\nExamples include, but aren't limited to: Parsing error: Unterminated string\n literal.
The user pool ID.
", + "smithy.api#required": {} + } + }, + "awsRegion": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region in which the user pool was created.
", + "smithy.api#required": {} + } + }, + "appIdClientRegex": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Amazon Cognito configuration.
" + } + }, "com.amazonaws.appsync#CognitoUserPoolConfig": { "type": "structure", "members": { @@ -2089,7 +2348,7 @@ "appIdClientRegex": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" } } }, @@ -2105,7 +2364,7 @@ } }, "traits": { - "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can make your\n change.
", + "smithy.api#documentation": "Another modification is in progress at this time and it must complete before you can\n make your change.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2127,6 +2386,19 @@ } } }, + "com.amazonaws.appsync#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "A conflict with a previous successful update is detected. This typically\n occurs when the previous update did not have time to propagate before the next update was\n made. A retry (with appropriate backoff logic) is the recommended response to this\n exception.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.appsync#ConflictHandlerType": { "type": "enum", "members": { @@ -2166,6 +2438,40 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.appsync#CreateApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#CreateApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#CreateApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Api object. Use this operation to create an AppSync\n API with your preferred configuration, such as an Event API that provides real-time message\n publishing and message subscriptions over WebSockets.
Transit encryption flag when connecting to cache. You cannot update this setting after creation.
" + "smithy.api#documentation": "Transit encryption flag when connecting to cache. You cannot update this setting after\n creation.
" } }, "atRestEncryptionEnabled": { @@ -2236,7 +2542,7 @@ "apiCachingBehavior": { "target": "com.amazonaws.appsync#ApiCachingBehavior", "traits": { - "smithy.api#documentation": "Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nCaching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics\n include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the\n throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing\n bottlenecks in a cache configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis\n process. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
From the creation time, the time after which the API key expires. The date is represented as seconds since\n the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.\n For more information, see .
" + "smithy.api#documentation": "From the creation time, the time after which the API key expires. The date is\n represented as seconds since the epoch, rounded down to the nearest hour. The default value\n for this parameter is 7 days from creation time. For more information, see .
" } } }, @@ -2357,13 +2663,155 @@ "smithy.api#output": {} } }, - "com.amazonaws.appsync#CreateDataSource": { + "com.amazonaws.appsync#CreateApiRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.appsync#ApiName", + "traits": { + "smithy.api#documentation": "The name for the Api.
The owner contact information for the Api.
The Event API configuration. This includes the default authorization configuration for\n connecting, publishing, and subscribing to an Event API.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateApiResponse": { + "type": "structure", + "members": { + "api": { + "target": "com.amazonaws.appsync#Api", + "traits": { + "smithy.api#documentation": "The Api object.
Creates a ChannelNamespace for an Api.
The Api ID.
The name of the ChannelNamespace. This name must be unique within the\n Api\n
The authorization mode to use for subscribing to messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The event handler functions that run custom business logic to process published events\n and subscribe requests.
" + } + }, + "tags": { + "target": "com.amazonaws.appsync#TagMap" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#CreateChannelNamespaceResponse": { + "type": "structure", + "members": { + "channelNamespace": { + "target": "com.amazonaws.appsync#ChannelNamespace", + "traits": { + "smithy.api#documentation": "The ChannelNamespace object.
The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" + "smithy.api#documentation": "The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)\n for the data source. The system assumes this role when accessing the data source.
" } }, "dynamodbConfig": { @@ -2443,7 +2891,7 @@ "elasticsearchConfig": { "target": "com.amazonaws.appsync#ElasticsearchDataSourceConfig", "traits": { - "smithy.api#documentation": "Amazon OpenSearch Service settings.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to\n create an OpenSearch data source.
" + "smithy.api#documentation": "Amazon OpenSearch Service settings.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.
" } }, "openSearchServiceConfig": { @@ -2473,7 +2921,7 @@ "metricsConfig": { "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the\n dataSourceLevelMetricsBehavior value is set to\n PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior\n is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig\n will be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager\n (ACM) certificate or an Identity and Access Management (IAM)\n server certificate.
", "smithy.api#required": {} } }, @@ -2591,7 +3039,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
", + "smithy.api#documentation": "Creates a Function object.
A function is a reusable entity. You can use multiple functions to compose the resolver\n logic.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/functions", @@ -2633,7 +3081,7 @@ "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The version of the request mapping template. Currently, the supported value\n is 2018-05-29. Note that when using VTL and mapping templates, the\n functionVersion is required.
The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC),\n Amazon Cognito user pools, or Lambda.
", + "smithy.api#documentation": "The authentication type: API key, Identity and Access Management (IAM), OpenID\n Connect (OIDC), Amazon Cognito user pools, or Lambda.
", "smithy.api#required": {} } }, @@ -2767,14 +3215,14 @@ "additionalAuthenticationProviders": { "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", "traits": { - "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi API.
A list of additional authentication providers for the GraphqlApi\n API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
A flag indicating whether to use X-Ray tracing for the\n GraphqlApi.
Configuration for Lambda function authorization.
" } }, - "visibility": { - "target": "com.amazonaws.appsync#GraphQLApiVisibility", - "traits": { - "smithy.api#documentation": "Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The value that indicates whether the GraphQL API is a standard API\n (GRAPHQL) or merged API (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The Identity and Access Management service role ARN for a merged API. The AppSync\n service assumes this role on behalf of the Merged API to validate access to source APIs at\n runtime and to prompt the AUTO_MERGE to update the merged API endpoint with\n the source API changes automatically.
Sets the value of the GraphQL API to public (GLOBAL) or private\n (PRIVATE). If no value is provided, the visibility will be set to\n GLOBAL by default. This value cannot be changed once the API has been\n created.
Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable\n (DISABLED) introspection. If no value is provided, the introspection\n configuration will be set to ENABLED by default. This field will produce an\n error if the operation attempts to use the introspection feature while this field is\n disabled.
For more information about introspection, see GraphQL introspection.
" } }, "queryDepthLimit": { "target": "com.amazonaws.appsync#QueryDepthLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of\n nested levels allowed in the body of query. The default value is 0 (or\n unspecified), which indicates there's no depth limit. If you set a limit, it can be between\n 1 and 75 nested levels. This field will produce a limit error\n if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field\n produces an error, the error will be thrown upwards to the first nullable field\n available.
" } }, "resolverCountLimit": { "target": "com.amazonaws.appsync#ResolverCountLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The maximum number of resolvers that can be invoked in a single request. The default\n value is 0 (or unspecified), which will set the limit to 10000.\n When specified, the limit value can be between 1 and 10000. This\n field will produce a limit error if the operation falls out of bounds.
Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand, and converts the data\n source's responses into GraphQL.
", + "smithy.api#documentation": "Creates a Resolver object.
A resolver converts incoming requests into a format that a data source can understand,\n and converts the data source's responses into GraphQL.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/types/{typeName}/resolvers", @@ -2921,7 +3369,7 @@ "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "The mapping template to use for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" + "smithy.api#documentation": "The mapping template to use for requests.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data\n source. For all other data sources, VTL request and response mapping templates are\n required.
" } }, "responseMappingTemplate": { @@ -2933,7 +3381,7 @@ "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.
The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Enables or disables enhanced resolver metrics for specified resolvers. Note that\n metricsConfig won't be used unless the\n resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is\n set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will\n be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The type of the data source.
\n\n AWS_LAMBDA: The data source is an Lambda\n function.
\n\n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB\n table.
\n\n AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service\n domain.
\n\n AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.
\n\n AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge\n configuration.
\n\n NONE: There is no data source. Use this type when you want to\n invoke a GraphQL operation without connecting to a data source, such as when you're performing data\n transformation with resolvers or invoking a subscription from a mutation.
\n\n HTTP: The data source is an HTTP endpoint.
\n\n RELATIONAL_DATABASE: The data source is a relational\n database.
\nThe type of the data source.
\n\n AWS_LAMBDA: The data source is an Lambda function.
\n\n AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
\n\n AMAZON_ELASTICSEARCH: The data source is an\n Amazon OpenSearch Service domain.
\n\n AMAZON_OPENSEARCH_SERVICE: The data source is\n an Amazon OpenSearch Service domain.
\n\n AMAZON_EVENTBRIDGE: The data source is an\n Amazon EventBridge configuration.
\n\n NONE: There is no data source. Use this type\n when you want to invoke a GraphQL operation without connecting to a data source, such\n as when you're performing data transformation with resolvers or invoking a\n subscription from a mutation.
\n\n HTTP: The data source is an HTTP\n endpoint.
\n\n RELATIONAL_DATABASE: The data source is a\n relational database.
\nThe Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source.\n The system assumes this role when accessing the data source.
" + "smithy.api#documentation": "The Identity and Access Management (IAM) service role Amazon Resource Name (ARN)\n for the data source. The system assumes this role when accessing the data source.
" } }, "dynamodbConfig": { @@ -3151,7 +3599,7 @@ "metricsConfig": { "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the\n dataSourceLevelMetricsBehavior value is set to\n PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior\n is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig\n will be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The name of the model. For example, this could be the name of a single table in a database.
" + "smithy.api#documentation": "The name of the model. For example, this could be the name of a single table in a\n database.
" } }, "fields": { @@ -3177,7 +3625,7 @@ "primaryKey": { "target": "com.amazonaws.appsync#DataSourceIntrospectionModelIndex", "traits": { - "smithy.api#documentation": "The primary key stored as a DataSourceIntrospectionModelIndex object.
The primary key stored as a DataSourceIntrospectionModelIndex\n object.
Contains the output of the SDL that was generated from the introspected types. This is controlled by the\n includeModelsSDL parameter of the GetDataSourceIntrospection operation.
Contains the output of the SDL that was generated from the introspected types. This is\n controlled by the includeModelsSDL parameter of the\n GetDataSourceIntrospection operation.
Specifies the classification of data. For example, this could be set to values like Scalar or\n NonNull to indicate a fundamental property of the field.
Valid values include:
\n\n Scalar: Indicates the value is a primitive type (scalar).
\n NonNull: Indicates the field cannot be null.
\n List: Indicates the field contains a list.
Specifies the classification of data. For example, this could be set to values like\n Scalar or NonNull to indicate a fundamental property of the\n field.
Valid values include:
\n\n Scalar: Indicates the value is a primitive type\n (scalar).
\n NonNull: Indicates the field cannot be\n null.
\n List: Indicates the field contains a list.
The name of the data type that represents the field. For example, String is a valid\n name value.
The name of the data type that represents the field. For example, String is\n a valid name value.
The DataSourceIntrospectionModelFieldType object data. The type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull or List.
The type typically contains its own kind and name fields to represent\n the actual type data. For instance, type could contain a kind value of\n Scalar with a name value of String. The values Scalar\n and String will be collectively stored in the values field.
The DataSourceIntrospectionModelFieldType object data. The\n type is only present if\n DataSourceIntrospectionModelFieldType.kind is set to NonNull\n or List.
The type typically contains its own kind and name\n fields to represent the actual type data. For instance, type could contain a\n kind value of Scalar with a name value of\n String. The values Scalar and String will be\n collectively stored in the values field.
The values of the type field. This field represents the AppSync data type equivalent of the\n introspected field.
The values of the type field. This field represents the AppSync data type\n equivalent of the introspected field.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
Determines the number of types to be returned in a single response before paginating.\n This value is typically taken from nextToken value from the previous\n response.
Represents the output of a DataSourceIntrospectionResult. This is the populated result of a\n GetDataSourceIntrospection operation.
Represents the output of a DataSourceIntrospectionResult. This is the\n populated result of a GetDataSourceIntrospection operation.
Deletes an Api object
The Api ID.
Deletes a ChannelNamespace.
The ID of the Api associated with the ChannelNamespace.
The name of the ChannelNamespace.
The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
" + "smithy.api#documentation": "The number of minutes that a Delta Sync log entry is stored in the Delta Sync\n table.
" } } }, @@ -4089,7 +4667,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an association between a Merged API and source API using the source API's identifier and the\n association ID.
", + "smithy.api#documentation": "Deletes an association between a Merged API and source API using the source API's\n identifier and the association ID.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/sourceApis/{sourceApiIdentifier}/mergedApiAssociations/{associationId}", @@ -4103,7 +4681,7 @@ "sourceApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source\n APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs\n from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.
", + "smithy.api#documentation": "The identifier of the AppSync Source API. This is generated by the AppSync service. In\n most cases, source APIs (especially in your account) only require the API ID value or ARN\n of the source API. However, source APIs from other accounts (cross-account use cases)\n strictly require the full resource ARN of the source API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4161,7 +4739,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an association between a Merged API and source API using the Merged API's identifier and the\n association ID.
", + "smithy.api#documentation": "Deletes an association between a Merged API and source API using the Merged API's\n identifier and the association ID.
", "smithy.api#http": { "method": "DELETE", "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}", @@ -4175,7 +4753,7 @@ "mergedApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4235,7 +4813,7 @@ "certificateArn": { "target": "com.amazonaws.appsync#CertificateArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager\n (ACM) certificate or an Identity and Access Management (IAM)\n server certificate.
" } }, "appsyncDomainName": { @@ -4322,7 +4900,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.
" + "smithy.api#documentation": "Describes an OpenSearch data source configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data\n source.
" } }, "com.amazonaws.appsync#EnhancedMetricsConfig": { @@ -4331,27 +4909,27 @@ "resolverLevelMetricsBehavior": { "target": "com.amazonaws.appsync#ResolverLevelMetricsBehavior", "traits": { - "smithy.api#documentation": "Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at\n a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the\n request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics\n include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the\n request. Metrics will be recorded by API ID and resolver name.\n resolverLevelMetricsBehavior accepts one of these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for\n all resolvers in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers\n that have the metricsConfig value set to ENABLED.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources\n in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the\n metricsConfig value set to ENABLED.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics\n include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source\n invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in\n the request. Metrics will be recorded by API ID and data source name.\n dataSourceLevelMetricsBehavior accepts one of these values at a\n time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data\n for all data sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data\n sources that have the metricsConfig value set to\n ENABLED.
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
\nRequests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED or\n DISABLED.
Controls how operation metrics will be emitted to CloudWatch. Operation metrics\n include:
\nRequests: The number of times a specified GraphQL operation was\n called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified\n GraphQL operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to\n ENABLED or DISABLED.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling one of these\n categories:
\n resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of\n these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers\n in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricsConfig value set to ENABLED.
\n dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior\n accepts one of these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data\n sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that\n have the metricsConfig value set to ENABLED.
\n operationLevelMetricsConfig: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED\n or DISABLED.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data\n on API usage and performance such as AppSync request and error counts, latency, and cache\n hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can\n configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling\n one of these categories:
\n resolverLevelMetricsBehavior: Controls how resolver metrics will\n be emitted to CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.\n
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in\n the request. Metrics will be recorded by API ID and resolver name.\n resolverLevelMetricsBehavior accepts one of these values at a\n time:
\n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data\n for all resolvers in the request.
\n PER_RESOLVER_METRICS: Records and emits metric data for\n resolvers that have the metricsConfig value set to\n ENABLED.
\n dataSourceLevelMetricsBehavior: Controls how data source metrics\n will be emitted to CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a\n request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source\n invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources\n in the request. Metrics will be recorded by API ID and data source name.\n dataSourceLevelMetricsBehavior accepts one of these values at a\n time:
\n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric\n data for all data sources in the request.
\n PER_DATA_SOURCE_METRICS: Records and emits metric data for\n data sources that have the metricsConfig value set to\n ENABLED.
\n operationLevelMetricsConfig: Controls how operation metrics will\n be emitted to CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was\n called.
\nGraphQL errors: The number of GraphQL errors that occurred during a\n specified GraphQL operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to\n ENABLED or DISABLED.
Contains the list of errors generated. When using JavaScript, this will apply to the request or response\n function evaluation.
" + "smithy.api#documentation": "Contains the list of errors generated. When using JavaScript, this will apply to the\n request or response function evaluation.
" } }, "com.amazonaws.appsync#ErrorMessage": { @@ -4425,7 +5003,7 @@ } ], "traits": { - "smithy.api#documentation": "Evaluates the given code and returns the response. The code definition requirements depend on the specified\n runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request\n function takes the incoming request after a GraphQL operation is parsed and converts it into a request\n configuration for the selected data source operation. The response function interprets responses from the data\n source and maps it to the shape of the GraphQL field output type.
Evaluates the given code and returns the response. The code definition requirements\n depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the\n request and response functions. The request function takes the incoming request after a\n GraphQL operation is parsed and converts it into a request configuration for the selected\n data source operation. The response function interprets responses from the data source and\n maps it to the shape of the GraphQL field output type.
The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is\n supported.
The runtime to be used when evaluating the code. Currently, only the\n APPSYNC_JS runtime is supported.
The code definition to be evaluated. Note that code and runtime are both required\n for this action. The runtime value must be APPSYNC_JS.
The code definition to be evaluated. Note that code and\n runtime are both required for this action. The runtime value\n must be APPSYNC_JS.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The map that holds all of the contextual information for your resolver invocation. A\n context is required for this action.
The function within the code to be evaluated. If provided, the valid values are request and\n response.
The function within the code to be evaluated. If provided, the valid values are\n request and response.
A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
A list of logs that were generated by calls to util.log.info and\n util.log.error in the evaluated code.
Evaluates a given template and returns the response. The mapping template can be a request or response\n template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and convert it into a\n request configuration for the selected data source operation. Response templates interpret responses from the\n data source and map it to the shape of the GraphQL field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", + "smithy.api#documentation": "Evaluates a given template and returns the response. The mapping template can be a\n request or response template.
\nRequest templates take the incoming request after a GraphQL operation is parsed and\n convert it into a request configuration for the selected data source operation. Response\n templates interpret responses from the data source and map it to the shape of the GraphQL\n field output type.
\nMapping templates are written in the Apache Velocity Template Language (VTL).
", "smithy.api#http": { "method": "POST", "uri": "/v1/dataplane-evaluatetemplate", @@ -4548,14 +5126,14 @@ "template": { "target": "com.amazonaws.appsync#Template", "traits": { - "smithy.api#documentation": "The mapping template; this can be a request or response template. A template is required for\n this action.
The mapping template; this can be a request or response template. A\n template is required for this action.
The map that holds all of the contextual information for your resolver invocation. A context is\n required for this action.
The map that holds all of the contextual information for your resolver invocation. A\n context is required for this action.
A list of logs that were generated by calls to util.log.info and util.log.error in\n the evaluated code.
A list of logs that were generated by calls to util.log.info and\n util.log.error in the evaluated code.
The ARN of the event bus. For more information about event buses, see Amazon EventBridge event\n buses.
", + "smithy.api#documentation": "The ARN of the event bus. For more information about event buses, see Amazon\n EventBridge event buses.
", "smithy.api#required": {} } } @@ -4615,6 +5193,105 @@ "smithy.api#documentation": "Describes an Amazon EventBridge bus data source configuration.
" } }, + "com.amazonaws.appsync#EventConfig": { + "type": "structure", + "members": { + "authProviders": { + "target": "com.amazonaws.appsync#AuthProviders", + "traits": { + "smithy.api#documentation": "A list of authorization providers.
", + "smithy.api#required": {} + } + }, + "connectionAuthModes": { + "target": "com.amazonaws.appsync#AuthModes", + "traits": { + "smithy.api#documentation": "A list of valid authorization modes for the Event API connections.
", + "smithy.api#required": {} + } + }, + "defaultPublishAuthModes": { + "target": "com.amazonaws.appsync#AuthModes", + "traits": { + "smithy.api#documentation": "A list of valid authorization modes for the Event API publishing.
", + "smithy.api#required": {} + } + }, + "defaultSubscribeAuthModes": { + "target": "com.amazonaws.appsync#AuthModes", + "traits": { + "smithy.api#documentation": "A list of valid authorization modes for the Event API subscriptions.
", + "smithy.api#required": {} + } + }, + "logConfig": { + "target": "com.amazonaws.appsync#EventLogConfig", + "traits": { + "smithy.api#documentation": "The CloudWatch Logs configuration for the Event API.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the authorization configuration for connections, message publishing, message\n subscriptions, and logging for an Event API.
" + } + }, + "com.amazonaws.appsync#EventLogConfig": { + "type": "structure", + "members": { + "logLevel": { + "target": "com.amazonaws.appsync#EventLogLevel", + "traits": { + "smithy.api#documentation": "The type of information to log for the Event API.
", + "smithy.api#required": {} + } + }, + "cloudWatchLogsRoleArn": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The IAM service role that AppSync assumes to publish CloudWatch Logs in your account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the CloudWatch Logs configuration for the Event API.
" + } + }, + "com.amazonaws.appsync#EventLogLevel": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" + } + }, + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEBUG" + } + } + } + }, "com.amazonaws.appsync#FieldLogLevel": { "type": "enum", "members": { @@ -4745,7 +5422,7 @@ "requestMappingTemplate": { "target": "com.amazonaws.appsync#MappingTemplate", "traits": { - "smithy.api#documentation": "The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The version of the request mapping template. Currently, only the 2018-05-29 version of the template is\n supported.
" + "smithy.api#documentation": "The version of the request mapping template. Currently, only the 2018-05-29 version of\n the template is supported.
" } }, "syncConfig": { @@ -4776,12 +5453,12 @@ "code": { "target": "com.amazonaws.appsync#Code", "traits": { - "smithy.api#documentation": "The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
A function is a reusable entity. You can use multiple functions to compose the resolver logic.
" + "smithy.api#documentation": "A function is a reusable entity. You can use multiple functions to compose the resolver\n logic.
" } }, "com.amazonaws.appsync#Functions": { @@ -4796,6 +5473,40 @@ "target": "com.amazonaws.appsync#String" } }, + "com.amazonaws.appsync#GetApi": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetApiRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetApiResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves an Api object.
The Api ID.
The Api object.
Retrieves the channel namespace for a specified Api.
The Api ID.
The name of the ChannelNamespace.
The ChannelNamespace object.
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the\n instrospection will also be returned. If the retrieval fails the operation, an error message will be returned\n instead.
", + "smithy.api#documentation": "Retrieves the record of an existing introspection. If the retrieval is successful, the\n result of the instrospection will also be returned. If the retrieval fails the operation,\n an error message will be returned instead.
", "smithy.api#http": { "method": "GET", "uri": "/v1/datasources/introspections/{introspectionId}", @@ -4991,7 +5804,7 @@ "introspectionId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
", + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to\n reference the instrospection record.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5000,14 +5813,14 @@ "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A boolean flag that determines whether SDL should be generated for introspected types or not. If set to\n true, each model will contain an sdl property that contains the SDL for that type.\n The SDL only contains the type data and no additional metadata or directives.
A boolean flag that determines whether SDL should be generated for introspected types.\n If set to true, each model will contain an sdl property that\n contains the SDL for that type. The SDL only contains the type data and no additional\n metadata or directives.
Determines the number of types to be returned in a single response before paginating. This value is\n typically taken from nextToken value from the previous response.
Determines the number of types to be returned in a single response before paginating.\n This value is typically taken from nextToken value from the previous\n response.
The maximum number of introspected types that will be returned in a single response.
", + "smithy.api#documentation": "The maximum number of introspected types that will be returned in a single\n response.
", "smithy.api#httpQuery": "maxResults" } } @@ -5030,19 +5843,19 @@ "introspectionId": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to\n reference the instrospection record.
" } }, "introspectionStatus": { "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", "traits": { - "smithy.api#documentation": "The status of the introspection during retrieval. By default, when a new instrospection is being retrieved,\n the status will be set to PROCESSING. Once the operation has been completed, the status will\n change to SUCCESS or FAILED depending on how the data was parsed. A\n FAILED operation will return an error and its details as an\n introspectionStatusDetail.
The status of the introspection during retrieval. By default, when a new instrospection\n is being retrieved, the status will be set to PROCESSING. Once the operation\n has been completed, the status will change to SUCCESS or FAILED\n depending on how the data was parsed. A FAILED operation will return an error\n and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail\n will also return the exact error that was generated during the operation.
Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.
", + "smithy.api#documentation": "Retrieves the list of environmental variable key-value pairs associated with an API by\n its ID value.
", "smithy.api#http": { "method": "GET", "uri": "/v1/apis/{apiId}/environmentVariables", @@ -5311,7 +6124,7 @@ "environmentVariables": { "target": "com.amazonaws.appsync#EnvironmentVariableMap", "traits": { - "smithy.api#documentation": "The payload containing each environmental variable in the \"key\" : \"value\" format.
The payload containing each environmental variable in the \"key\" : \"value\"\n format.
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" + "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.
" } }, "details": { @@ -5604,7 +6417,7 @@ "mergedApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5840,20 +6653,20 @@ "additionalAuthenticationProviders": { "target": "com.amazonaws.appsync#AdditionalAuthenticationProviders", "traits": { - "smithy.api#documentation": "A list of additional authentication providers for the GraphqlApi API.
A list of additional authentication providers for the GraphqlApi\n API.
A flag indicating whether to use X-Ray tracing for this GraphqlApi.
A flag indicating whether to use X-Ray tracing for this\n GraphqlApi.
The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.
The ARN of the WAF access control list (ACL) associated with this\n GraphqlApi, if one exists.
Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no\n value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed\n once the API has been created.
Sets the value of the GraphQL API to public (GLOBAL) or private\n (PRIVATE). If no value is provided, the visibility will be set to\n GLOBAL by default. This value cannot be changed once the API has been\n created.
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The value that indicates whether the GraphQL API is a standard API\n (GRAPHQL) or merged API (MERGED).
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The Identity and Access Management service role ARN for a merged API. The AppSync\n service assumes this role on behalf of the Merged API to validate access to source APIs at\n runtime and to prompt the AUTO_MERGE to update the merged API endpoint with\n the source API changes automatically.
Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable\n (DISABLED) introspection. If no value is provided, the introspection\n configuration will be set to ENABLED by default. This field will produce an\n error if the operation attempts to use the introspection feature while this field is\n disabled.
For more information about introspection, see GraphQL introspection.
" } }, "queryDepthLimit": { "target": "com.amazonaws.appsync#QueryDepthLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of\n nested levels allowed in the body of query. The default value is 0 (or\n unspecified), which indicates there's no depth limit. If you set a limit, it can be between\n 1 and 75 nested levels. This field will produce a limit error\n if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field\n produces an error, the error will be thrown upwards to the first nullable field\n available.
" } }, "resolverCountLimit": { "target": "com.amazonaws.appsync#ResolverCountLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The maximum number of resolvers that can be invoked in a single request. The default\n value is 0 (or unspecified), which will set the limit to 10000.\n When specified, the limit value can be between 1 and 10000. This\n field will produce a limit error if the operation falls out of bounds.
The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL\n scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80\n for the HTTP endpoint and port 443 for HTTPS endpoints.
" + "smithy.api#documentation": "The HTTP URL endpoint. You can specify either the domain name or IP, and port\n combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port,\n AppSync uses the default port 80 for the HTTP endpoint and port 443 for\n HTTPS endpoints.
" } }, "authorizationConfig": { @@ -5975,76 +6788,241 @@ "target": "com.amazonaws.appsync#TTL", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If\n you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum\n value is one hour (3600 seconds). The Lambda function can override this by returning a\n ttlOverride key in its response.
The number of seconds a response should be cached for. The default is 0 seconds, which\n disables caching. If you don't specify a value for\n authorizerResultTtlInSeconds, the default value is used. The maximum value\n is one hour (3600 seconds). The Lambda function can override this by returning\n a ttlOverride key in its response.
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can\n be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
\n Note: This Lambda function must have the following\n resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is\n done for you. To use the Command Line Interface (CLI), run the following:
\n\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal\n appsync.amazonaws.com --action lambda:InvokeFunction\n
The Amazon Resource Name (ARN) of the Lambda function to be called for\n authorization. This can be a standard Lambda ARN, a version ARN\n (.../v3), or an alias ARN.
\n Note: This Lambda function must have the\n following resource-based policy assigned to it. When configuring Lambda\n authorizers in the console, this is done for you. To use the Command Line Interface\n (CLI), run the following:
\n\n aws lambda add-permission --function-name\n \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\"\n --principal appsync.amazonaws.com --action lambda:InvokeFunction\n
A regular expression for validation of tokens before the Lambda function is called.
" + "smithy.api#documentation": "A regular expression for validation of tokens before the Lambda function is\n called.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A LambdaAuthorizerConfig specifies how to authorize AppSync\n API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only one Lambda authorizer configured at a\n time.
The Amazon Resource Name (ARN) for the Lambda function to use as the\n Conflict Handler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The LambdaConflictHandlerConfig object when configuring LAMBDA\n as the Conflict Handler.
The Amazon Resource Name (ARN) for the Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Lambda data source configuration.
" + } + }, + "com.amazonaws.appsync#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appsync#String" + } + }, + "traits": { + "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.appsync#ListApiKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#ListApiKeysRequest" + }, + "output": { + "target": "com.amazonaws.appsync#ListApiKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may still\n be included in the response until they have actually been deleted. You can safely call\n DeleteApiKey to manually delete a key before it's automatically\n deleted.
The API ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.appsync#PaginationToken", + "traits": { + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "A LambdaAuthorizerConfig specifies how to authorize AppSync API access when\n using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API can have only\n one Lambda authorizer configured at a time.
The ApiKey objects.
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
" + "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" } } }, "traits": { - "smithy.api#documentation": "The LambdaConflictHandlerConfig object when configuring LAMBDA as the Conflict\n Handler.
Lists the APIs in your AppSync account.
\n\n ListApis returns only the high level API details. For more detailed\n information about an API, use GetApi.
The Amazon Resource Name (ARN) for the Lambda function.
", - "smithy.api#required": {} + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.appsync#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results that you want the request to return.
", + "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "Describes an Lambda data source configuration.
" + "smithy.api#input": {} } }, - "com.amazonaws.appsync#LimitExceededException": { + "com.amazonaws.appsync#ListApisResponse": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.appsync#String" + "apis": { + "target": "com.amazonaws.appsync#Apis", + "traits": { + "smithy.api#documentation": "The Api objects.
An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" + } } }, "traits": { - "smithy.api#documentation": "The request exceeded a limit. Try your request again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 + "smithy.api#output": {} } }, - "com.amazonaws.appsync#ListApiKeys": { + "com.amazonaws.appsync#ListChannelNamespaces": { "type": "operation", "input": { - "target": "com.amazonaws.appsync#ListApiKeysRequest" + "target": "com.amazonaws.appsync#ListChannelNamespacesRequest" }, "output": { - "target": "com.amazonaws.appsync#ListApiKeysResponse" + "target": "com.amazonaws.appsync#ListChannelNamespacesResponse" }, "errors": [ { @@ -6061,27 +7039,27 @@ } ], "traits": { - "smithy.api#documentation": "Lists the API keys for a given API.
\nAPI keys are deleted automatically 60 days after they expire. However, they may still be included in the\n response until they have actually been deleted. You can safely call DeleteApiKey to manually\n delete a key before it's automatically deleted.
Lists the channel namespaces for a specified Api.
\n ListChannelNamespaces returns only high level details for the channel\n namespace. To retrieve code handlers, use\n GetChannelNamespace.
The API ID.
", + "smithy.api#documentation": "The Api ID.
An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6106,19 +7084,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.appsync#ListApiKeysResponse": { + "com.amazonaws.appsync#ListChannelNamespacesResponse": { "type": "structure", "members": { - "apiKeys": { - "target": "com.amazonaws.appsync#ApiKeys", + "channelNamespaces": { + "target": "com.amazonaws.appsync#ChannelNamespaces", "traits": { - "smithy.api#documentation": "The ApiKey objects.
The ChannelNamespace objects.
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" } } }, @@ -6177,7 +7155,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6206,7 +7184,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" } } }, @@ -6254,7 +7232,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6283,7 +7261,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" } } }, @@ -6342,7 +7320,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6371,7 +7349,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" } } }, @@ -6419,7 +7397,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6434,7 +7412,7 @@ "apiType": { "target": "com.amazonaws.appsync#GraphQLApiType", "traits": { - "smithy.api#documentation": "The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API\n (MERGED).
The value that indicates whether the GraphQL API is a standard API\n (GRAPHQL) or merged API (MERGED).
An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" } } }, @@ -6566,7 +7544,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6625,7 +7603,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6654,7 +7632,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" } } }, @@ -6713,7 +7691,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6742,7 +7720,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" } } }, @@ -6903,7 +7881,7 @@ "mergedApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6927,7 +7905,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6956,7 +7934,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
" } } }, @@ -6986,7 +7964,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can use to return the\n next set of items in the list.
", + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which you can\n use to return the next set of items in the list.
", "smithy.api#httpQuery": "nextToken" } }, @@ -7015,7 +7993,7 @@ "nextToken": { "target": "com.amazonaws.appsync#PaginationToken", "traits": { - "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of items in the\n list.
" + "smithy.api#documentation": "An identifier to pass in the next request to this operation to return the next set of\n items in the list.
" } } }, @@ -7029,14 +8007,14 @@ "fieldLogLevel": { "target": "com.amazonaws.appsync#FieldLogLevel", "traits": { - "smithy.api#documentation": "The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
\n\n NONE: No field-level logs are captured.
\n\n ERROR: Logs the following information\n only for the fields that are in the error\n category:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error fields.
\n\n INFO: Logs the following information only for the fields that are in the info and error\n categories:
\nInfo-level messages.
\nThe user messages sent through $util.log.info and\n console.log.
Field-level tracing and mapping logs are not shown.
\n\n DEBUG: Logs the following information\n only for the fields that are in the debug, info,\n and error categories:
\nDebug-level messages.
\nThe user messages sent through $util.log.info,\n $util.log.debug, console.log, and\n console.debug.
Field-level tracing and mapping logs are not shown.
\n\n ALL: The following information is logged for all fields in the\n query:
\nField-level tracing information.
\nThe generated request/response functions that were resolved for each\n field.
\nThe field logging level. Values can be NONE, ERROR, or ALL.
\n\n NONE: No field-level logs are\n captured.
\n\n ERROR: Logs the following information only for\n the fields that are in error:
\nThe error section in the server response.
\nField-level errors.
\nThe generated request/response functions that got resolved for error\n fields.
\n\n ALL: The following information is logged for\n all fields in the query:
\nField-level tracing information.
\nThe generated request/response functions that got resolved for each\n field.
\nThe service role that AppSync assumes to publish to CloudWatch logs in your\n account.
", + "smithy.api#documentation": "The service role that AppSync assumes to publish to CloudWatch\n logs in your account.
", "smithy.api#required": {} } }, @@ -7044,7 +8022,7 @@ "target": "com.amazonaws.appsync#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping\n templates, regardless of logging level.
" + "smithy.api#documentation": "Set to TRUE to exclude sections that contain information such as headers, context, and\n evaluated mapping templates, regardless of logging level.
" } } }, @@ -7120,6 +8098,16 @@ } } }, + "com.amazonaws.appsync#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,48}[A-Za-z0-9])?)$" + } + }, "com.amazonaws.appsync#NotFoundException": { "type": "structure", "members": { @@ -7128,7 +8116,7 @@ } }, "traits": { - "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try again.
", + "smithy.api#documentation": "The resource specified in the request was not found. Check the resource, and then try\n again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -7139,14 +8127,14 @@ "issuer": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of\n iss in the ID token.
The issuer for the OIDC configuration. The issuer returned by discovery must exactly\n match the value of iss in the ID token.
The client identifier of the relying party at the OpenID identity provider. This identifier is typically\n obtained when the relying party is registered with the OpenID identity provider. You can specify a regular\n expression so that AppSync can validate against multiple client identifiers at a time.
" + "smithy.api#documentation": "The client identifier of the relying party at the OpenID identity provider. This\n identifier is typically obtained when the relying party is registered with the OpenID\n identity provider. You can specify a regular expression so that AppSync can\n validate against multiple client identifiers at a time.
" } }, "iatTTL": { @@ -7224,6 +8212,16 @@ } } }, + "com.amazonaws.appsync#OwnerContact": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\-\\ \\.]+$" + } + }, "com.amazonaws.appsync#Ownership": { "type": "enum", "members": { @@ -7248,7 +8246,7 @@ "min": 1, "max": 65536 }, - "smithy.api#pattern": "^[\\\\S]+$" + "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.appsync#PipelineConfig": { @@ -7294,7 +8292,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a list of environmental variables in an API by its ID value.
\nWhen creating an environmental variable, it must follow the constraints below:
\nBoth JavaScript and VTL templates support environmental variables.
\nEnvironmental variables are not evaluated before function invocation.
\nEnvironmental variables only support string values.
\nAny defined value in an environmental variable is considered a string literal and not\n expanded.
\nVariable evaluations should ideally be performed in the function code.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
Creates a list of environmental variables in an API by its ID value.
\nWhen creating an environmental variable, it must follow the constraints below:
\nBoth JavaScript and VTL templates support environmental variables.
\nEnvironmental variables are not evaluated before function invocation.
\nEnvironmental variables only support string values.
\nAny defined value in an environmental variable is considered a string literal\n and not expanded.
\nVariable evaluations should ideally be performed in the function\n code.
\nWhen creating an environmental variable key-value pair, it must follow the additional\n constraints below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character\n (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the\n environmentVariables payload as a list in the format\n {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of\n the existing environmental variable list of that API. This means the existing environmental\n variables will be lost. To avoid this, you must include all existing and new environmental\n variables in the list each time you call this action.
The list of environmental variables to add to the API.
\nWhen creating an environmental variable key-value pair, it must follow the additional constraints\n below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.
The list of environmental variables to add to the API.
\nWhen creating an environmental variable key-value pair, it must follow the additional\n constraints below:
\nKeys must begin with a letter.
\nKeys must be at least two characters long.
\nKeys can only contain letters, numbers, and the underscore character\n (_).
\nValues can be up to 512 characters long.
\nYou can configure up to 50 key-value pairs in a GraphQL API.
\nYou can create a list of environmental variables by adding it to the\n environmentVariables payload as a list in the format\n {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of\n the existing environmental variable list of that API. This means the existing environmental\n variables will be lost. To avoid this, you must include all existing and new environmental\n variables in the list each time you call this action.
The payload containing each environmental variable in the \"key\" : \"value\" format.
The payload containing each environmental variable in the \"key\" : \"value\"\n format.
The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret\n value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN,\n secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation\n data.
", + "smithy.api#documentation": "The secret's ARN that was obtained from Secrets Manager. A secret consists of secret\n information, the secret value, plus metadata about the secret. A secret value can be a\n string or binary. It typically includes the ARN, secret name and description, policies,\n tags, encryption key from the Key Management Service, and key rotation data.
", "smithy.api#required": {} } }, @@ -7437,7 +8435,7 @@ "awsSecretStoreArn": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.
" + "smithy.api#documentation": "Amazon Web Services secret store Amazon Resource Name (ARN) for database\n credentials.
" } } }, @@ -7451,7 +8449,7 @@ "relationalDatabaseSourceType": { "target": "com.amazonaws.appsync#RelationalDatabaseSourceType", "traits": { - "smithy.api#documentation": "Source type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database source type is an\n Amazon Relational Database Service (Amazon RDS) HTTP endpoint.
\nSource type for the relational database.
\n\n RDS_HTTP_ENDPOINT: The relational database\n source type is an Amazon Relational Database Service (Amazon RDS) HTTP\n endpoint.
\nThe resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.
The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Enables or disables enhanced resolver metrics for specified resolvers. Note that\n metricsConfig won't be used unless the\n resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is\n set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will\n be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The operation exceeded the service quota for this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.appsync#SourceApiAssociation": { "type": "structure", "members": { @@ -7771,12 +8782,12 @@ "lastSuccessfulMergeDate": { "target": "com.amazonaws.appsync#Date", "traits": { - "smithy.api#documentation": "The datetime value of the last successful merge of the source API association. The result will be in UTC\n format and your local time zone.
" + "smithy.api#documentation": "The datetime value of the last successful merge of the source API association. The\n result will be in UTC format and your local time zone.
" } } }, "traits": { - "smithy.api#documentation": "Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API.\n There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's\n schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular\n API.
\nSource APIs can originate from your account or from other accounts via Amazon Web Services Resource Access\n Manager. For more information about sharing resources from other accounts, see What is Amazon Web Services Resource\n Access Manager? in the Amazon Web Services Resource Access Manager guide.
" + "smithy.api#documentation": "Describes the configuration of a source API. A source API is a GraphQL API that is\n linked to a merged API. There can be multiple source APIs attached to each merged API. When\n linked to a merged API, the source API's schema, data sources, and resolvers will be\n combined with other linked source API data to form a new, singular API.
\nSource APIs can originate from your account or from other accounts via Amazon Web Services Resource Access Manager. For more information about sharing resources from other\n accounts, see What is Amazon Web Services Resource Access Manager? in the Amazon Web Services Resource Access Manager guide.
" } }, "com.amazonaws.appsync#SourceApiAssociationConfig": { @@ -7785,7 +8796,7 @@ "mergeType": { "target": "com.amazonaws.appsync#MergeType", "traits": { - "smithy.api#documentation": "The property that indicates which merging option is enabled in the source API association.
\nValid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the\n default behavior and require the user to trigger any changes from the source APIs to the merged API manually.\n Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the\n source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform\n merge operations.
The property that indicates which merging option is enabled in the source API\n association.
\nValid merge types are MANUAL_MERGE (default) and AUTO_MERGE.\n Manual merges are the default behavior and require the user to trigger any changes from the\n source APIs to the merged API manually. Auto merges subscribe the merged API to the changes\n performed on the source APIs so that any change in the source APIs are also made to the\n merged API. Auto merges use MergedApiExecutionRoleArn to perform merge\n operations.
Creates a new introspection. Returns the introspectionId of the new introspection after its\n creation.
Creates a new introspection. Returns the introspectionId of the new\n introspection after its creation.
The introspection ID. Each introspection contains a unique ID that can be used to reference the\n instrospection record.
" + "smithy.api#documentation": "The introspection ID. Each introspection contains a unique ID that can be used to\n reference the instrospection record.
" } }, "introspectionStatus": { "target": "com.amazonaws.appsync#DataSourceIntrospectionStatus", "traits": { - "smithy.api#documentation": "The status of the introspection during creation. By default, when a new instrospection has been created, the\n status will be set to PROCESSING. Once the operation has been completed, the status will change to\n SUCCESS or FAILED depending on how the data was parsed. A FAILED\n operation will return an error and its details as an introspectionStatusDetail.
The status of the introspection during creation. By default, when a new instrospection\n has been created, the status will be set to PROCESSING. Once the operation has\n been completed, the status will change to SUCCESS or FAILED\n depending on how the data was parsed. A FAILED operation will return an error\n and its details as an introspectionStatusDetail.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail will also return the\n exact error that was generated during the operation.
The error detail field. When a FAILED\n introspectionStatus is returned, the introspectionStatusDetail\n will also return the exact error that was generated during the operation.
Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to determine when it has\n completed.
", + "smithy.api#documentation": "Adds a new schema to your GraphQL API.
\nThis operation is asynchronous. Use to\n determine when it has completed.
", "smithy.api#http": { "method": "POST", "uri": "/v1/apis/{apiId}/schemacreation", @@ -8036,7 +9047,7 @@ "status": { "target": "com.amazonaws.appsync#SchemaStatus", "traits": { - "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the\n ACTIVE state, you can add data.
" + "smithy.api#documentation": "The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When\n the schema is in the ACTIVE state, you can add data.
" } } }, @@ -8070,7 +9081,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates a merge operation. Returns a status that shows the result of the merge operation.
", + "smithy.api#documentation": "Initiates a merge operation. Returns a status that shows the result of the merge\n operation.
", "smithy.api#http": { "method": "POST", "uri": "/v1/mergedApis/{mergedApiIdentifier}/sourceApiAssociations/{associationId}/merge", @@ -8092,7 +9103,7 @@ "mergedApiIdentifier": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8125,24 +9136,24 @@ "conflictHandler": { "target": "com.amazonaws.appsync#ConflictHandlerType", "traits": { - "smithy.api#documentation": "The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations\n when versions don't match the latest version at the server.
\n\n AUTOMERGE: Resolve conflicts with the Automerge conflict\n resolution strategy.
\n\n LAMBDA: Resolve conflicts with an Lambda function\n supplied in the LambdaConflictHandlerConfig.
The Conflict Resolution strategy to perform in the event of a conflict.
\n\n OPTIMISTIC_CONCURRENCY: Resolve conflicts by\n rejecting mutations when versions don't match the latest version at the\n server.
\n\n AUTOMERGE: Resolve conflicts with the\n Automerge conflict resolution strategy.
\n\n LAMBDA: Resolve conflicts with an Lambda function supplied in the\n LambdaConflictHandlerConfig.
The Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object versions for this\n resolver.
\n\n NONE: Do not detect conflicts when invoking this\n resolver.
\nThe Conflict Detection strategy to use.
\n\n VERSION: Detect conflicts based on object\n versions for this resolver.
\n\n NONE: Do not detect conflicts when invoking\n this resolver.
\nThe LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict\n Handler.
The LambdaConflictHandlerConfig when configuring LAMBDA as the\n Conflict Handler.
Describes a Sync configuration for a resolver.
\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the resolver is\n invoked.
" + "smithy.api#documentation": "Describes a Sync configuration for a resolver.
\nSpecifies which Conflict Detection strategy and Resolution strategy to use when the\n resolver is invoked.
" } }, "com.amazonaws.appsync#TTL": { @@ -8187,7 +9198,7 @@ "target": "com.amazonaws.appsync#TagValue" }, "traits": { - "smithy.api#documentation": "A map with keys of TagKey objects and values of TagValue objects.
A map with keys of TagKey objects and values of TagValue\n objects.
Updates an Api.
Caching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers that you specify are\n cached.
\nCaching behavior.
\n\n FULL_REQUEST_CACHING: All requests are fully\n cached.
\n\n PER_RESOLVER_CACHING: Individual resolvers\n that you specify are cached.
\nControls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics\n include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the\n throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing\n bottlenecks in a cache configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis\n process. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.
From the update time, the time after which the API key expires. The date is represented as seconds since the\n epoch. For more information, see .
" + "smithy.api#documentation": "From the update time, the time after which the API key expires. The date is represented\n as seconds since the epoch. For more information, see .
" } } }, @@ -8606,6 +9657,148 @@ "smithy.api#output": {} } }, + "com.amazonaws.appsync#UpdateApiRequest": { + "type": "structure", + "members": { + "apiId": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The Api ID.
The name of the Api.
", + "smithy.api#required": {} + } + }, + "ownerContact": { + "target": "com.amazonaws.appsync#String", + "traits": { + "smithy.api#documentation": "The owner contact information for the Api.
The new event configuration. This includes the default authorization configuration for\n connecting, publishing, and subscribing to an Event API.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateApiResponse": { + "type": "structure", + "members": { + "api": { + "target": "com.amazonaws.appsync#Api", + "traits": { + "smithy.api#documentation": "The Api object.
Updates a ChannelNamespace associated with an Api.
The Api ID.
The name of the ChannelNamespace.
The authorization mode to use for subscribing to messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The authorization mode to use for publishing messages on the channel namespace. This\n configuration overrides the default Api authorization configuration.
The event handler functions that run custom business logic to process published events\n and subscribe requests.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#UpdateChannelNamespaceResponse": { + "type": "structure", + "members": { + "channelNamespace": { + "target": "com.amazonaws.appsync#ChannelNamespace", + "traits": { + "smithy.api#documentation": "The ChannelNamespace object.
The new OpenSearch configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
" + "smithy.api#documentation": "The new OpenSearch configuration.
\nAs of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This\n configuration is deprecated. Instead, use UpdateDataSourceRequest$openSearchServiceConfig to update an OpenSearch data source.
" } }, "openSearchServiceConfig": { @@ -8723,7 +9916,7 @@ "metricsConfig": { "target": "com.amazonaws.appsync#DataSourceLevelMetricsConfig", "traits": { - "smithy.api#documentation": "Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the\n dataSourceLevelMetricsBehavior value is set to\n PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior\n is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig\n will be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The Function request mapping template. Functions support only the 2018-05-29 version of the\n request mapping template.
The Function request mapping template. Functions support only the\n 2018-05-29 version of the request mapping template.
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note\n that when using VTL and mapping templates, the functionVersion is required.
The version of the request mapping template. Currently, the supported value\n is 2018-05-29. Note that when using VTL and mapping templates, the\n functionVersion is required.
The function code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The function code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
The new authentication type for the GraphqlApi object.
The new authentication type for the GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi object.
The new Amazon Cognito user pool configuration for the ~GraphqlApi\n object.
A list of additional authentication providers for the GraphqlApi API.
A list of additional authentication providers for the GraphqlApi\n API.
A flag indicating whether to use X-Ray tracing for the GraphqlApi.
A flag indicating whether to use X-Ray tracing for the\n GraphqlApi.
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role\n on behalf of the Merged API to validate access to source APIs at runtime and to prompt the\n AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
The Identity and Access Management service role ARN for a merged API. The AppSync\n service assumes this role on behalf of the Merged API to validate access to source APIs at\n runtime and to prompt the AUTO_MERGE to update the merged API endpoint with\n the source API changes automatically.
Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED)\n introspection. If no value is provided, the introspection configuration will be set to ENABLED by\n default. This field will produce an error if the operation attempts to use the introspection feature while this\n field is disabled.
For more information about introspection, see GraphQL\n introspection.
" + "smithy.api#documentation": "Sets the value of the GraphQL API to enable (ENABLED) or disable\n (DISABLED) introspection. If no value is provided, the introspection\n configuration will be set to ENABLED by default. This field will produce an\n error if the operation attempts to use the introspection feature while this field is\n disabled.
For more information about introspection, see GraphQL introspection.
" } }, "queryDepthLimit": { "target": "com.amazonaws.appsync#QueryDepthLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed\n in the body of query. The default value is 0 (or unspecified), which indicates there's no depth\n limit. If you set a limit, it can be between 1 and 75 nested levels. This field will\n produce a limit error if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error,\n the error will be thrown upwards to the first nullable field available.
" + "smithy.api#documentation": "The maximum depth a query can have in a single request. Depth refers to the amount of\n nested levels allowed in the body of query. The default value is 0 (or\n unspecified), which indicates there's no depth limit. If you set a limit, it can be between\n 1 and 75 nested levels. This field will produce a limit error\n if the operation falls out of bounds.
Note that fields can still be set to nullable or non-nullable. If a non-nullable field\n produces an error, the error will be thrown upwards to the first nullable field\n available.
" } }, "resolverCountLimit": { "target": "com.amazonaws.appsync#ResolverCountLimit", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.
The maximum number of resolvers that can be invoked in a single request. The default\n value is 0 (or unspecified), which will set the limit to 10000.\n When specified, the limit value can be between 1 and 10000. This\n field will produce a limit error if the operation falls out of bounds.
The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format that a data source\n can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data source. For all other\n data sources, VTL request and response mapping templates are required.
" + "smithy.api#documentation": "The new request mapping template.
\nA resolver uses a request mapping template to convert a GraphQL expression into a format\n that a data source can understand. Mapping templates are written in Apache Velocity\n Template Language (VTL).
\nVTL request mapping templates are optional when using an Lambda data\n source. For all other data sources, VTL request and response mapping templates are\n required.
" } }, "responseMappingTemplate": { @@ -9182,7 +10374,7 @@ "kind": { "target": "com.amazonaws.appsync#ResolverKind", "traits": { - "smithy.api#documentation": "The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is the default\n resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can use a PIPELINE\n resolver to invoke a series of Function objects in a serial manner. You can use a pipeline\n resolver to run a GraphQL query against multiple data sources.
The resolver type.
\n\n UNIT: A UNIT resolver type. A UNIT resolver is\n the default resolver type. You can use a UNIT resolver to run a GraphQL query against\n a single data source.
\n\n PIPELINE: A PIPELINE resolver type. You can\n use a PIPELINE resolver to invoke a series of Function objects in a\n serial manner. You can use a pipeline resolver to run a GraphQL query against\n multiple data sources.
The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.
The resolver code that contains the request and response functions. When\n code is used, the runtime is required. The runtime value must be\n APPSYNC_JS.
Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
Enables or disables enhanced resolver metrics for specified resolvers. Note that\n metricsConfig won't be used unless the\n resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is\n set to FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will\n be ignored. However, you can still set its value.
\n metricsConfig can be ENABLED or DISABLED.
The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged\n APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs\n in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.
", + "smithy.api#documentation": "The identifier of the AppSync Merged API. This is generated by the AppSync service. In\n most cases, Merged APIs (especially in your account) only require the API ID value or ARN\n of the merged API. However, Merged APIs in other accounts (cross-account use cases)\n strictly require the full resource ARN of the merged API.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9433,14 +10625,14 @@ "defaultAction": { "target": "com.amazonaws.appsync#DefaultAction", "traits": { - "smithy.api#documentation": "The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool\n authentication doesn't match the Amazon Cognito user pool configuration.
", + "smithy.api#documentation": "The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool\n configuration.
", "smithy.api#required": {} } }, "appIdClientRegex": { "target": "com.amazonaws.appsync#String", "traits": { - "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value\n isn't set, no filtering is applied.
" + "smithy.api#documentation": "A regular expression for validating the incoming Amazon Cognito user pool app client\n ID. If this value isn't set, no filtering is applied.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index d1f25a58ddd..d43b6a499e5 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -329,8 +329,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 100 + "min": 0, + "max": 255 }, "smithy.api#sensitive": {} } @@ -447,8 +447,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 100 + "min": 0, + "max": 300 }, "smithy.api#sensitive": {} } @@ -40511,7 +40511,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about the identity of a user.
\nFor Amazon Connect instances that are created with the EXISTING_DIRECTORY\n identity management type, FirstName, LastName, and Email\n cannot be updated from within Amazon Connect because they are managed by the\n directory.
Contains information about the identity of a user.
\nFor Amazon Connect instances that are created with the EXISTING_DIRECTORY\n identity management type, FirstName, LastName, and Email\n cannot be updated from within Amazon Connect because they are managed by the\n directory.
The FirstName and LastName length constraints below apply only to\n instances using SAML for identity management. If you are using Amazon Connect for identity\n management, the length constraints are 1-255 for FirstName, and 1-256 for\n LastName.
Activates an DataSync agent that you've deployed in your storage\n environment. The activation process associates the agent with your Amazon Web Services account.
\nIf you haven't deployed an agent yet, see the following topics to learn more:
\n\n Agent requirements\n
\n\n Create an agent\n
\nIf you're transferring between Amazon Web Services storage services, you don't need a\n DataSync agent.
\nActivates an DataSync agent that you deploy in your storage environment.\n The activation process associates the agent with your Amazon Web Services account.
\nIf you haven't deployed an agent yet, see Do I need a DataSync agent?\n
" } }, "com.amazonaws.datasync#CreateAgentRequest": { @@ -452,14 +452,14 @@ "ActivationKey": { "target": "com.amazonaws.datasync#ActivationKey", "traits": { - "smithy.api#documentation": "Specifies your DataSync agent's activation key. If you don't have an\n activation key, see Activate your agent.
", + "smithy.api#documentation": "Specifies your DataSync agent's activation key. If you don't have an\n activation key, see Activating your agent.
", "smithy.api#required": {} } }, "AgentName": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "Specifies a name for your agent. You can see this name in the DataSync\n console.
" + "smithy.api#documentation": "Specifies a name for your agent. We recommend specifying a name that you can\n remember.
" } }, "Tags": { @@ -471,19 +471,19 @@ "VpcEndpointId": { "target": "com.amazonaws.datasync#VpcEndpointId", "traits": { - "smithy.api#documentation": "Specifies the ID of the VPC endpoint that you want your agent to connect to. For example,\n a VPC endpoint ID looks like vpce-01234d5aff67890e1.
The VPC endpoint you use must include the DataSync service name (for example,\n com.amazonaws.us-east-2.datasync).
Specifies the ID of the VPC service endpoint that you're using. For\n example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.
The VPC service endpoint you use must include the DataSync service name (for\n example, com.amazonaws.us-east-2.datasync).
Specifies the ARN of the subnet where you want to run your DataSync task when\n using a VPC endpoint. This is the subnet where DataSync creates and manages the\n network\n interfaces for your transfer. You can only specify one ARN.
" + "smithy.api#documentation": "Specifies the ARN of the subnet where your VPC service endpoint is located. You can only\n specify one ARN.
" } }, "SecurityGroupArns": { "target": "com.amazonaws.datasync#PLSecurityGroupArnList", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the security group that protects your task's\n network\n interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the security group that allows traffic between\n your agent and VPC service endpoint. You can only specify one ARN.
" } } }, @@ -626,20 +626,20 @@ "Subdirectory": { "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { - "smithy.api#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).\n By default, DataSync uses the root directory, but you can also include\n subdirectories.
\nYou must specify a value with forward slashes (for example,\n /path/to/folder).
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)\n on your file system.
\nBy default, DataSync uses the root directory (or access point if you provide one by using\n AccessPointArn). You can also include subdirectories using forward slashes (for\n example, /path/to/folder).
Specifies the ARN for the Amazon EFS file system.
", + "smithy.api#documentation": "Specifies the ARN for your Amazon EFS file system.
", "smithy.api#required": {} } }, "Ec2Config": { "target": "com.amazonaws.datasync#Ec2Config", "traits": { - "smithy.api#documentation": "Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
", + "smithy.api#documentation": "Specifies the subnet and security groups DataSync uses to connect to one of\n your Amazon EFS file system's mount targets.
", "smithy.api#required": {} } }, @@ -652,19 +652,19 @@ "AccessPointArn": { "target": "com.amazonaws.datasync#EfsAccessPointArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to access the Amazon EFS file system.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses\n to mount your Amazon EFS file system.
\nFor more information, see Accessing restricted file systems.
" } }, "FileSystemAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that DataSync\n assumes when mounting the Amazon EFS file system.
" + "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
\nFor information on creating this role, see Creating a DataSync IAM role for file system access.
" } }, "InTransitEncryption": { "target": "com.amazonaws.datasync#EfsInTransitEncryption", "traits": { - "smithy.api#documentation": "Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2\n encryption when it copies data to or from the Amazon EFS file system.
\nIf you specify an access point using AccessPointArn or an IAM\n role using FileSystemAccessRoleArn, you must set this parameter to\n TLS1_2.
Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2\n encryption when it transfers data to or from your Amazon EFS file system.
\nIf you specify an access point using AccessPointArn or an IAM\n role using FileSystemAccessRoleArn, you must set this parameter to\n TLS1_2.
Specifies the ARNs of the security groups that provide access to your file system's\n preferred subnet.
\nIf you choose a security group that doesn't allow connections from within itself, do one\n of the following:
\nConfigure the security group to allow it to communicate within itself.
\nChoose a different security group that can communicate with the mount target's\n security group.
\nSpecifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.
\nThe security groups that you specify must be able to communicate with your file system's\n security groups. For information about configuring security groups for file system access, see\n the \n Amazon FSx for Windows File Server User Guide\n .
\nIf you choose a security group that doesn't allow connections from within itself, do one\n of the following:
\nConfigure the security group to allow it to communicate within itself.
\nChoose a different security group that can communicate with the mount target's\n security group.
\nThe Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS\n cluster.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
", "smithy.api#required": {} } }, @@ -1108,7 +1108,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The ARN of the source HDFS cluster location that's created.
" + "smithy.api#documentation": "The ARN of the source HDFS cluster location that you create.
" } } }, @@ -1156,7 +1156,7 @@ "OnPremConfig": { "target": "com.amazonaws.datasync#OnPremConfig", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to\n connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple\n agents for transfers.
", + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that can\n connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple DataSync\n agents.
", "smithy.api#required": {} } }, @@ -1263,7 +1263,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can\n securely connect with your location.
", + "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can\n connect with your object storage system.
", "smithy.api#required": {} } }, @@ -1441,7 +1441,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "Specifies the DataSync agent (or agents) which you want to connect to your SMB\n file server. You specify an agent by using its Amazon Resource Name (ARN).
", + "smithy.api#documentation": "Specifies the DataSync agent (or agents) that can connect to your SMB file\n server. You specify an agent by using its Amazon Resource Name (ARN).
", "smithy.api#required": {} } }, @@ -1518,7 +1518,7 @@ "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
\nFor Enhanced mode tasks, you don't need to specify anything. DataSync\n automatically sends logs to a CloudWatch log group named /aws/datasync.
Specifies include filters define the files, objects, and folders in your source location\n that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" + "smithy.api#documentation": "Specifies include filters that define the files, objects, and folders in your source\n location that you want DataSync to transfer. For more information and examples, see\n Specifying what\n DataSync transfers by using filters.
" } }, "ManifestConfig": { @@ -1568,6 +1568,12 @@ "traits": { "smithy.api#documentation": "Specifies how you want to configure a task report, which provides detailed information\n about your DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.
\nWhen 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.
Specifies one of the following task modes for your data transfer:
\n\n ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
To create an Enhanced mode task, the IAM role that you use to call\n the CreateTask operation must have the\n iam:CreateServiceLinkedRole permission.
\n BASIC (default) - Transfer files or objects between Amazon Web Services\n storage and on-premises, edge, or other cloud storage. DataSync\n quotas apply.
For more information, see Understanding task mode differences.
" + } } }, "traits": { @@ -2064,19 +2070,19 @@ "AccessPointArn": { "target": "com.amazonaws.datasync#EfsAccessPointArn", "traits": { - "smithy.api#documentation": "The ARN of the access point that DataSync uses to access the Amazon EFS\n file system.
" + "smithy.api#documentation": "The ARN of the access point that DataSync uses to access the Amazon EFS\n file system.
\nFor more information, see Accessing restricted file systems.
" } }, "FileSystemAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "The Identity and Access Management (IAM) role that DataSync assumes when\n mounting the Amazon EFS file system.
" + "smithy.api#documentation": "The Identity and Access Management (IAM) role that allows DataSync to\n access your Amazon EFS file system.
\nFor more information, see Creating a DataSync IAM role for file system access.
" } }, "InTransitEncryption": { "target": "com.amazonaws.datasync#EfsInTransitEncryption", "traits": { - "smithy.api#documentation": "Describes whether DataSync uses Transport Layer Security (TLS) encryption when\n copying data to or from the Amazon EFS file system.
" + "smithy.api#documentation": "Indicates whether DataSync uses Transport Layer Security (TLS) encryption when\n transferring data to or from the Amazon EFS file system.
" } } }, @@ -2360,7 +2366,7 @@ "SecurityGroupArns": { "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "The ARNs of the security groups that are configured for the FSx for Windows File Server file\n system.
" + "smithy.api#documentation": "The ARNs of the Amazon EC2 security groups that provide access to your file\n system's preferred subnet.
\nFor information about configuring security groups for file system access, see the \n Amazon FSx for Windows File Server User Guide\n .
" } }, "CreationTime": { @@ -3170,7 +3176,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing transfer or check the results of\n the transfer.
" + "smithy.api#documentation": "Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing data transfer or check the\n results of the transfer.
\nSome DescribeTaskExecution response elements are only relevant to a\n specific task mode. For information, see Understanding task mode differences and Understanding data\n transfer performance metrics.
The expected number of files, objects, and directories that DataSync will\n transfer over the network. This value is calculated during the task execution's\n PREPARING phase before the TRANSFERRING phase. The calculation is\n based on comparing the content of the source and destination locations and finding the\n difference that needs to be transferred.
The number of files, objects, and directories that DataSync expects to\n transfer over the network. This value is calculated during the task execution's\n PREPARING\n step before the TRANSFERRING step.
How this gets calculated depends primarily on your task’s transfer\n mode configuration:
\nIf TranserMode is set to CHANGED - The calculation is based\n on comparing the content of the source and destination locations and determining the\n difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
\nAnything that's in both locations and modified at the destination after an initial\n transfer (unless OverwriteMode is set to NEVER).
\n (Basic task mode only) The number of items that\n DataSync expects to delete (if PreserveDeletedFiles is set to\n REMOVE).
If TranserMode is set to ALL - The calculation is based only\n on the items that DataSync finds at the source location.
The estimated physical number of bytes that will transfer over the network.
" + "smithy.api#documentation": "The number of logical bytes that DataSync expects to write to the destination\n location.
" } }, "FilesTransferred": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The actual number of files, objects, and directories that DataSync\n transferred over the network. This value is updated periodically during the task execution's\n TRANSFERRING phase when something is read from the source and sent over the\n network.
If DataSync fails to transfer something, this value can be less than\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an exact indication of what transferred or to monitor your task execution.
The number of files, objects, and directories that DataSync actually\n transfers over the network. This value is updated periodically during the task execution's\n TRANSFERRING\n 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\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an exact indication of what's transferring or to monitor\n your task execution.
The number of logical bytes written to the destination location.
" + "smithy.api#documentation": "The number of logical bytes that DataSync actually writes to the destination\n location.
" } }, "BytesTransferred": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The total number of bytes that are involved in the transfer. For the number of bytes\n sent over the network, see BytesCompressed.
The number of bytes that DataSync sends to the network before compression (if\n compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
" } }, "BytesCompressed": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The physical number of bytes transferred over the network after compression was applied.\n In most cases, this number is less than BytesTransferred unless the data isn't\n compressible.
The number of physical bytes that DataSync transfers over the network after\n compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
\nNot currently supported with Enhanced mode\n tasks.
\nThe number of files, objects, and directories that DataSync deleted in your\n destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.
The number of files, objects, and directories that DataSync actually deletes in\n your destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.
The number of files, objects, and directories that DataSync skipped during your\n transfer.
" + "smithy.api#documentation": "The number of files, objects, and directories that DataSync skips during your\n transfer.
" } }, "FilesVerified": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of files, objects, and directories that DataSync verified during your\n transfer.
\nWhen you configure your task to verify only the\n data that's transferred, DataSync doesn't verify directories in some\n situations or files that fail to transfer.
\nThe number of files, objects, and directories that DataSync verifies during your\n transfer.
\nWhen you configure your task to verify only the\n data that's transferred, DataSync doesn't verify directories in some\n situations or files that fail to transfer.
\nThe expected number of files, objects, and directories that DataSync will delete\n in your destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.
The number of files, objects, and directories that DataSync expects to delete in\n your destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + } + }, + "FilesPrepared": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of objects that DataSync will attempt to transfer after comparing\n your source and destination locations.
\nApplies only to Enhanced mode\n tasks.
\nThis 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": { + "target": "com.amazonaws.datasync#TaskExecutionFilesListedDetail", + "traits": { + "smithy.api#documentation": "The number of\n objects\n that DataSync\n finds\n at your locations.
\nApplies only to Enhanced mode\n tasks.
\nThe number of objects that DataSync fails to prepare, transfer, verify, and\n delete during your task execution.
\nApplies only to Enhanced mode\n tasks.
\nThe Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your\n task.
\nFor more information, see Monitoring DataSync with\n Amazon CloudWatch.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your\n task.
\nFor more information, see Monitoring data transfers with\n CloudWatch Logs.
" } }, "SourceNetworkInterfaceArns": { @@ -3457,6 +3488,12 @@ "traits": { "smithy.api#documentation": "The details about your task schedule.
" } + }, + "TaskMode": { + "target": "com.amazonaws.datasync#TaskMode", + "traits": { + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + } } }, "traits": { @@ -3699,7 +3736,7 @@ } }, "traits": { - "smithy.api#documentation": "The subnet and security groups that DataSync uses to access your Amazon EFS file system.
" + "smithy.api#documentation": "The subnet and security groups that DataSync uses to connect to one of your\n Amazon EFS file system's mount targets.
" } }, "com.amazonaws.datasync#Ec2SecurityGroupArn": { @@ -6902,13 +6939,13 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the agents connecting to a transfer\n location.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.
\nYou can specify more than one agent. For more information, see Using multiple DataSync\n agents.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The DataSync agents that are connecting to a Network File System (NFS)\n location.
" + "smithy.api#documentation": "The DataSync agents that can connect to your Network File System (NFS)\n file server.
" } }, "com.amazonaws.datasync#Operator": { @@ -6982,7 +7019,7 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "Specifies how and when DataSync checks the integrity of your data during a\n transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred files and metadata at the source location. At the end of the\n transfer, DataSync then compares this checksum to the checksum calculated on\n those files at the destination.
We recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer,\n DataSync scans the entire source and destination to verify that both locations\n are fully synchronized.
If you use a manifest, DataSync only scans and\n verifies what's listed in the manifest.
\nYou can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync doesn't run additional verification at the\n end of the transfer. All data transmissions are still integrity-checked with checksum\n verification during the transfer.
Specifies if and how DataSync checks the integrity of your data at the end of\n your transfer.
\n\n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred data (including metadata) at the source location. At the end\n of the transfer, DataSync then compares this checksum to the checksum calculated\n on that data at the destination.
This is the default option for Enhanced mode\n tasks.
\nWe recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n POINT_IN_TIME_CONSISTENT - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are\n fully synchronized.
The is the default option for Basic mode tasks and\n isn't currently supported with Enhanced mode tasks.
\nIf you use a manifest, DataSync only scans and\n verifies what's listed in the manifest.
\nYou can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.
\n\n NONE - DataSync performs data integrity checks only during\n your transfer. Unlike other options, there's no additional verification at the end of your\n transfer.
Specifies whether to preserve metadata indicating the last time a file was read or\n written to.
\nThe behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.
\n BEST_EFFORT (default) - DataSync attempts to preserve the\n original Atime attribute on all source files (that is, the version before the\n PREPARING phase of the task execution). This option is\n recommended.
\n NONE - Ignores Atime.
If Atime is set to BEST_EFFORT, Mtime must be set\n to PRESERVE.
If Atime is set to NONE, Mtime must also be\n NONE.
Specifies whether to preserve metadata indicating the last time a file was read or\n written to.
\nThe behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.
\n BEST_EFFORT (default) - DataSync attempts to preserve the\n original Atime attribute on all source files (that is, the version before the\n PREPARING steps of the task execution). This option is\n recommended.
\n NONE - Ignores Atime.
If Atime is set to BEST_EFFORT, Mtime must be set\n to PRESERVE.
If Atime is set to NONE, Mtime must also be\n NONE.
Specifies whether to preserve metadata indicating the last time that a file was written\n to before the PREPARING phase of your task execution. This option is required\n when you need to run the a task more than once.
\n PRESERVE (default) - Preserves original Mtime, which is\n recommended.
\n NONE - Ignores Mtime.
If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.
If Mtime is set to NONE, Atime must also be set\n to NONE.
Specifies whether to preserve metadata indicating the last time that a file was written\n to before the PREPARING step of your task execution. This option is required when\n you need to run the a task more than once.
\n PRESERVE (default) - Preserves original Mtime, which is\n recommended.
\n NONE - Ignores Mtime.
If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.
If Mtime is set to NONE, Atime must also be set\n to NONE.
Specifies the POSIX group ID (GID) of the file's owners.
\n\n INT_VALUE (default) - Preserves the integer value of user ID (UID) and\n GID, which is recommended.
\n NONE - Ignores UID and GID.
For more information, see Metadata copied by DataSync.
" + "smithy.api#documentation": "Specifies the POSIX group ID (GID) of the file's owners.
\n\n INT_VALUE (default) - Preserves the integer value of user ID (UID) and\n GID, which is recommended.
\n NONE - Ignores UID and GID.
For more information, see Understanding how DataSync handles file and object metadata.
" } }, "PreserveDeletedFiles": { @@ -7030,13 +7067,13 @@ "PosixPermissions": { "target": "com.amazonaws.datasync#PosixPermissions", "traits": { - "smithy.api#documentation": "Specifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.
\nFor more information, see Metadata copied by DataSync.
\n\n PRESERVE (default) - Preserves POSIX-style permissions, which is\n recommended.
\n NONE - Ignores POSIX-style permissions.
DataSync can preserve extant permissions of a source location.
\nSpecifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.
\nFor more information, see Understanding how DataSync handles file and object metadata.
\n\n PRESERVE (default) - Preserves POSIX-style permissions, which is\n recommended.
\n NONE - Ignores POSIX-style permissions.
DataSync can preserve extant permissions of a source location.
\nLimits the bandwidth used by a DataSync task. For example, if you want\n DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).
Limits the bandwidth used by a DataSync task. For example, if you want\n DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).
Not applicable to Enhanced mode\n tasks.
\nDetermines whether DataSync transfers only the data and metadata that differ\n between the source and the destination location or transfers all the content from the source\n (without comparing what's in the destination).
\n\n CHANGED (default) - DataSync copies only data or metadata that\n is new or different content from the source location to the destination location.
\n ALL - DataSync copies everything in the source to the\n destination without comparing differences between the locations.
Specifies whether DataSync transfers only the data (including metadata) that\n differs between locations following an initial copy or transfers all data every time you run\n the task. If you're planning on recurring transfers, you might only want to transfer what's\n changed since your previous task execution.
\n\n CHANGED (default) - After your initial full transfer, DataSync\n copies only the data and metadata that differs between the source and destination\n location.
\n ALL - DataSync copies everything in the source to the\n destination without comparing differences between the locations.
Specifies which components of the SMB security descriptor are copied from source to\n destination objects.
\nThis value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.
\n\n OWNER_DACL (default) - For each copied object, DataSync copies\n the following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nDataSync won't copy NTFS system access control lists (SACLs) with this\n option.
\n\n OWNER_DACL_SACL - For each copied object, DataSync copies the\n following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nSACLs, which are used by administrators to log attempts to access a secured\n object.
\nCopying SACLs requires granting additional permissions to the Windows user that\n DataSync uses to access your SMB location. For information about choosing\n a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending\n on the type of location in your transfer).
\n\n NONE - None of the SMB security descriptor components are copied.\n Destination objects are owned by the user that was provided for accessing the destination\n location. DACLs and SACLs are set based on the destination server’s configuration.
Specifies which components of the SMB security descriptor are copied from source to\n destination objects.
\nThis value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see Understanding how DataSync handles file and object metadata.
\n\n OWNER_DACL (default) - For each copied object, DataSync copies\n the following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nDataSync won't copy NTFS system access control lists (SACLs) with this\n option.
\n\n OWNER_DACL_SACL - For each copied object, DataSync copies the\n following metadata:
The object owner.
\nNTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.
\nSACLs, which are used by administrators to log attempts to access a secured\n object.
\nCopying SACLs requires granting additional permissions to the Windows user that\n DataSync uses to access your SMB location. For information about choosing\n a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending\n on the type of location in your transfer).
\n\n NONE - None of the SMB security descriptor components are copied.\n Destination objects are owned by the user that was provided for accessing the destination\n location. DACLs and SACLs are set based on the destination server’s configuration.
Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that\n your agent connects to.
" + "smithy.api#documentation": "Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that\n your agent connects to.
" } }, "SubnetArns": { @@ -7696,9 +7733,9 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 156 + "max": 268 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$" + "smithy.api#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}$" } }, "com.amazonaws.datasync#S3Config": { @@ -8122,7 +8159,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an DataSync transfer task. For each task, you can only run one task\n execution at a time.
\nThere are several phases to a task execution. For more information, see Task execution statuses.
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nStarts an DataSync transfer task. For each task, you can only run one task\n execution at a time.
\nThere are several steps to a task execution. For more information, see Task execution statuses.
\nIf you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.
\nThe number of objects that DataSync fails to prepare during your task\n execution.
" + } + }, + "Transfer": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of objects that DataSync fails to transfer during your task\n execution.
" + } + }, + "Verify": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of objects that DataSync fails to verify during your task\n execution.
" + } + }, + "Delete": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of objects that DataSync fails to delete during your task\n execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The number of objects that DataSync fails to prepare, transfer, verify, and\n delete during your task execution.
\nApplies only to Enhanced mode\n tasks.
\nThe number of objects that DataSync finds at your source location.
\nWith a manifest, DataSync\n lists only what's in your manifest (and not everything at your source location).
\nWith an include filter, DataSync lists only what\n matches the filter at your source location.
\nWith an exclude filter, DataSync lists everything at your source location before applying\n the filter.
\nThe 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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The number of objects that DataSync finds at your locations.
\nApplies only to Enhanced mode\n tasks.
\nThe status of a task execution. For more information, see Task execution statuses.
" } + }, + "TaskMode": { + "target": "com.amazonaws.datasync#TaskMode", + "traits": { + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + } } }, "traits": { @@ -8468,60 +8569,60 @@ "PrepareDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "The total time in milliseconds that DataSync spent in the PREPARING\n phase.
" + "smithy.api#documentation": "The time in milliseconds that your task execution was in the PREPARING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync prepares your data transfer.
The status of the PREPARING phase.
" + "smithy.api#documentation": "The status of the PREPARING step for your task execution. For more\n information, see Task\n execution statuses.
The total time in milliseconds that DataSync took to transfer the file from\n the source to the destination location.
" + "smithy.api#documentation": "The time in milliseconds that your task execution ran.
" } }, "TransferDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "The total time in milliseconds that DataSync spent in the TRANSFERRING\n phase.
" + "smithy.api#documentation": "The time in milliseconds that your task execution was in the TRANSFERRING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync transfers your data.
The status of the TRANSFERRING phase.
" + "smithy.api#documentation": "The status of the TRANSFERRING step for your task execution. For more\n information, see Task\n execution statuses.
The total time in milliseconds that DataSync spent in the VERIFYING\n phase.
" + "smithy.api#documentation": "The time in milliseconds that your task execution was in the VERIFYING\n step. For more information, see Task\n execution statuses.
For Enhanced mode tasks, the value is always 0. For more information, see\n How DataSync verifies your data's integrity.
The status of the VERIFYING phase.
" + "smithy.api#documentation": "The status of the VERIFYING step for your task execution. For more\n information, see Task\n execution statuses.
Errors that DataSync encountered during execution of the task. You can\n use this error code to help troubleshoot issues.
" + "smithy.api#documentation": "An error that DataSync encountered during your task execution. You can use\n this information to help troubleshoot\n issues.
" } }, "ErrorDetail": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" + "smithy.api#documentation": "The detailed description of an error that DataSync encountered during your\n task execution. You can use this information to help troubleshoot\n issues.
" } } }, "traits": { - "smithy.api#documentation": "Describes the detailed result of a TaskExecution operation. This result\n includes the time in milliseconds spent in each phase, the status of the task execution, and\n the errors encountered.
Provides detailed information about the result of your DataSync task\n execution.
" } }, "com.amazonaws.datasync#TaskExecutionStatus": { @@ -8655,12 +8756,35 @@ "traits": { "smithy.api#documentation": "The name of the task.
" } + }, + "TaskMode": { + "target": "com.amazonaws.datasync#TaskMode", + "traits": { + "smithy.api#documentation": "The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
" + } } }, "traits": { "smithy.api#documentation": "Represents a single entry in a list of tasks. TaskListEntry returns an\n array that contains a list of tasks when the ListTasks operation is called. A\n task includes the source and destination file systems to sync and the options to use for the\n tasks.
Specifies your task schedule by using a cron expression in UTC time. For information about\n cron expression syntax, see the \n Amazon EventBridge User\n Guide\n .
", + "smithy.api#documentation": "Specifies your task schedule by using a cron or rate expression.
\nUse cron expressions for task schedules that run on a specific time and day. For example,\n the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday\n of every month:
\n\n cron(0 8 * * 3#1)\n
Use rate expressions for task schedules that run on a regular interval. For example, the\n following rate expression creates a task schedule that runs every 12 hours:
\n\n rate(12 hours)\n
For information about cron and rate expression syntax, see the \n Amazon EventBridge User Guide\n .
", "smithy.api#required": {} } }, @@ -9210,7 +9334,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The ARNs of the agents that are used to connect to the HDFS cluster.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
" } } }, @@ -9342,7 +9466,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can\n securely connect with your location.
" + "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can\n connect with your object storage system.
" } }, "ServerCertificate": { @@ -9420,7 +9544,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#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).
" + "smithy.api#documentation": "Specifies the DataSync agent (or agents) that can connect to your SMB file\n server. You specify an agent by using its Amazon Resource Name (ARN).
" } }, "MountOptions": { @@ -9615,7 +9739,7 @@ "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
" + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for\n monitoring your task.
\nFor Enhanced mode tasks, you must use /aws/datasync as your log group\n name. For example:
\n arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*\n
For more information, see Monitoring data transfers with\n CloudWatch Logs.
" } }, "Includes": { diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index f3c18ebb06c..8c6c006cb04 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -2282,6 +2282,9 @@ { "target": "com.amazonaws.ec2#AssociateRouteTable" }, + { + "target": "com.amazonaws.ec2#AssociateSecurityGroupVpc" + }, { "target": "com.amazonaws.ec2#AssociateSubnetCidrBlock" }, @@ -3185,6 +3188,9 @@ { "target": "com.amazonaws.ec2#DescribeSecurityGroups" }, + { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociations" + }, { "target": "com.amazonaws.ec2#DescribeSnapshotAttribute" }, @@ -3431,6 +3437,9 @@ { "target": "com.amazonaws.ec2#DisassociateRouteTable" }, + { + "target": "com.amazonaws.ec2#DisassociateSecurityGroupVpc" + }, { "target": "com.amazonaws.ec2#DisassociateSubnetCidrBlock" }, @@ -7091,6 +7100,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#AssociateSecurityGroupVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateSecurityGroupVpcRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateSecurityGroupVpcResult" + }, + "traits": { + "smithy.api#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.
\nThe VPC you want to associate the security group with must be in the same Region.
\nYou can associate the security group with another VPC if your account owns the VPC or if the VPC was shared with you.
\nYou must own the security group and the VPC that it was created in.
\nYou cannot use this feature with default security groups.
\nYou cannot use this feature with the default VPC.
\nA security group ID.
", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A VPC ID.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The state of the association.
", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#AssociateSubnetCidrBlock": { "type": "operation", "input": { @@ -18091,7 +18158,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "The type of network interface. The default is interface.
The only supported values are interface, efa, and trunk.
The type of network interface. The default is interface.
If you specify efa-only, do not assign any IP addresses to the network \n interface. EFA-only network interfaces do not support IP addresses.
The only supported values are interface, efa, efa-only, and trunk.
The tags assigned to the security group.
", "smithy.api#xmlName": "tagSet" } + }, + "SecurityGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupArn", + "smithy.api#documentation": "The security group ARN.
", + "smithy.api#xmlName": "securityGroupArn" + } } }, "traits": { @@ -19753,7 +19828,7 @@ "target": "com.amazonaws.ec2#CreateTrafficMirrorSessionResult" }, "traits": { - "smithy.api#documentation": "Creates a Traffic Mirror session.
\nA Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it\n to the session to define a subset of the traffic to mirror, for example all TCP\n traffic.
\nThe 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.
\nBy default, no traffic is mirrored. Use CreateTrafficMirrorFilter to\n create filter rules that specify the traffic to mirror.
" + "smithy.api#documentation": "Creates a Traffic Mirror session.
\nA Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it\n to the session to define a subset of the traffic to mirror, for example all TCP\n traffic.
\nThe 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.
\nBy default, no traffic is mirrored. Use CreateTrafficMirrorFilter to\n create filter rules that specify the traffic to mirror.
" } }, "com.amazonaws.ec2#CreateTrafficMirrorSessionRequest": { @@ -25245,7 +25320,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance or network interface or is\n\t\t\t referenced by another security group in the same VPC, the operation fails with\n\t\t\t\tDependencyViolation.
Deletes a security group.
\nIf you attempt to delete a security group that is associated with an instance or network interface, is\n\t\t\t referenced by another security group in the same VPC, or has a VPC association, the operation fails with\n\t\t\t\tDependencyViolation.
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether Amazon CloudWatch action\n based recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type\n (true | false).
\n burstable-performance-supported - Indicates whether the instance type is a\n burstable performance T instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported |\n unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported\n (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance\n storage disk, in GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-support - Indicates whether data is\n encrypted at rest (required | supported |\n unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported\n | unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage\n available from all local instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private\n IPv4 addresses per network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private\n IPv6 addresses per network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports\n IPv6 (true | false).
\n network-info.maximum-network-cards - The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces - The maximum number of network\n interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n nitro-enclaves-support - Indicates whether Nitro Enclaves is supported\n (supported | unsupported).
\n nitro-tpm-support - Indicates whether NitroTPM is supported\n (supported | unsupported).
\n nitro-tpm-info.supported-versions - The supported NitroTPM version\n (2.0).
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in\n GHz.
\n processor-info.supported-features - The supported CPU features\n (amd-sev-snp).
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand |\n spot).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance\n type.
\n vcpu-info.default-threads-per-core - The default number of threads per core\n for the instance type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance\n type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the\n instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether Amazon CloudWatch action\n based recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type\n (true | false).
\n burstable-performance-supported - Indicates whether the instance type is a\n burstable performance T instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported |\n unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported\n (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance\n storage disk, in GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-support - Indicates whether data is\n encrypted at rest (required | supported |\n unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported\n | unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage\n available from all local instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private\n IPv4 addresses per network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private\n IPv6 addresses per network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports\n IPv6 (true | false).
\n network-info.maximum-network-cards - The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces - The maximum number of network\n interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n nitro-enclaves-support - Indicates whether Nitro Enclaves is supported\n (supported | unsupported).
\n nitro-tpm-support - Indicates whether NitroTPM is supported\n (supported | unsupported).
\n nitro-tpm-info.supported-versions - The supported NitroTPM version\n (2.0).
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in\n GHz.
\n processor-info.supported-features - The supported CPU features\n (amd-sev-snp).
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand | spot | \n capacity-block).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance\n type.
\n vcpu-info.default-threads-per-core - The default number of threads per core\n for the instance type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance\n type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the\n instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".
One or more filters.
\n\n association.allocation-id - The allocation ID returned when you\n\t\t allocated the Elastic IP address (IPv4) for your network interface.
\n association.association-id - The association ID returned when the\n\t\t network interface was associated with an IPv4 address.
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n\t\t the network interface was associated with the Elastic IP address\n\t\t (IPv4).
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.private-ip-address - The private IPv4 addresses\n\t\t associated with the network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | \n\t\t ec2_instance_connect_endpoint | efa | efs | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | \n\t\t global_accelerator_managed | \n\t\t interface | iot_rules_managed | \n\t\t lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | \n\t\t quicksight | \n\t\t transit_gateway | trunk | \n\t\t vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services \n\t\t service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network interface.
One or more filters.
\n\n association.allocation-id - The allocation ID returned when you\n\t\t allocated the Elastic IP address (IPv4) for your network interface.
\n association.association-id - The association ID returned when the\n\t\t network interface was associated with an IPv4 address.
\n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
\n addresses.association.public-ip - The association ID returned when\n\t\t the network interface was associated with the Elastic IP address\n\t\t (IPv4).
\n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.
\n addresses.private-ip-address - The private IPv4 addresses\n\t\t associated with the network interface.
\n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.
\n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.
\n association.public-dns-name - The public DNS name for the network\n interface (IPv4).
\n attachment.attach-time - The time that the network interface was attached to an instance.
\n attachment.attachment-id - The ID of the interface attachment.
\n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
\n attachment.device-index - The device index to which the network interface is attached.
\n attachment.instance-id - The ID of the instance to which the network interface is attached.
\n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
\n attachment.status - The status of the attachment (attaching | attached | detaching | detached).
\n availability-zone - The Availability Zone of the network interface.
\n description - The description of the network interface.
\n group-id - The ID of a security group associated with the network interface.
\n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.
\n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | \n\t\t efa | efa-only | efs | gateway_load_balancer | \n\t\t gateway_load_balancer_endpoint | global_accelerator_managed | interface | \n\t\t iot_rules_managed | lambda | load_balancer | nat_gateway | \n\t\t network_load_balancer | quicksight | transit_gateway | trunk | \n\t\t vpc_endpoint).
\n mac-address - The MAC address of the network interface.
\n network-interface-id - The ID of the network interface.
\n owner-id - The Amazon Web Services account ID of the network interface owner.
\n private-dns-name - The private DNS name of the network interface (IPv4).
\n private-ip-address - The private IPv4 address or addresses of the\n network interface.
\n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
\n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services \n\t\t service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
\n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.
\n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
\n subnet-id - The ID of the subnet for the network interface.
\n tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
\n vpc-id - The ID of the VPC for the network interface.
Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
", + "smithy.api#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.
", "smithy.api#examples": [ { "title": "To describe security group references", @@ -37738,6 +37813,90 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsResult" + }, + "traits": { + "smithy.api#documentation": "Describes security group VPC associations made with AssociateSecurityGroupVpc.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityGroupVpcAssociations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "Security group VPC association filters.
\n\n group-id: The security group ID.
\n vpc-id: The ID of the associated VPC.
\n vpc-owner-id: The account ID of the VPC owner.
\n state: The state of the association.
\n tag:: The key/value combination of a tag assigned to the resource. Use\n the tag key in the filter name and the tag value as the filter value. For\n example, to find all resources that have a tag with the key Owner\n and the value TeamA, specify tag:Owner for the filter\n name and TeamA for the filter value.
\n tag-key: The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSecurityGroupVpcAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The security group VPC associations.
", + "smithy.api#xmlName": "securityGroupVpcAssociationSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#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.
The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.
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.
Describes the stale security group rules for security groups in a specified VPC. \n 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 \n been deleted.
", + "smithy.api#documentation": "Describes the stale security group rules for security groups referenced across a VPC\n peering connection, transit gateway connection, or with a security group VPC\n association. Rules are stale when they reference a deleted security group. Rules can\n also be stale if they reference a security group in a peer VPC for which the VPC peering\n connection has been deleted, across a transit gateway where the transit gateway has been\n deleted (or the transit\n gateway security group referencing feature has been disabled), or if a\n security group VPC association has been disassociated.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -39157,7 +39316,7 @@ "NextToken": { "target": "com.amazonaws.ec2#DescribeStaleSecurityGroupsNextToken", "traits": { - "smithy.api#documentation": "The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.
" + "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } }, "VpcId": { @@ -39180,7 +39339,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to include in another request to get the next page of items. \n If there are no additional items to return, the string is empty.
", + "smithy.api#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.
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.\n \n Note that the disassociation is asynchronous and you can check the status of the request with DescribeSecurityGroupVpcAssociations.
" + } + }, + "com.amazonaws.ec2#DisassociateSecurityGroupVpcRequest": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#DisassociateSecurityGroupVpcSecurityGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A security group ID.
", + "smithy.api#required": {} + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A VPC ID.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The state of the disassociation.
", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DisassociateSecurityGroupVpcSecurityGroupId": { + "type": "string" + }, "com.amazonaws.ec2#DisassociateSubnetCidrBlock": { "type": "operation", "input": { @@ -61205,7 +61425,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InterfaceType", - "smithy.api#documentation": "The type of network interface.
\nValid values: interface | efa | trunk\n
The type of network interface.
\nValid values: interface | efa | efa-only | trunk\n
The type of network interface.
\nValid values: interface | efa\n
The type of network interface.
\nIf you specify efa-only, do not assign any IP addresses to the network \n\t interface. EFA-only network interfaces do not support IP addresses.
Valid values: interface | efa | efa-only\n
Indicates whether the instance type is offered for spot or On-Demand.
", + "smithy.api#documentation": "Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.
", "smithy.api#xmlName": "supportedUsageClasses" } }, @@ -73207,7 +73427,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa. For more information, see Elastic Fabric Adapter in the\n Amazon EC2 User Guide.
If you are not creating an EFA, specify interface or omit this\n parameter.
Valid values: interface | efa\n
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify\n efa or efa. For more information, see Elastic Fabric Adapter in the\n Amazon EC2 User Guide.
If you are not creating an EFA, specify interface or omit this\n parameter.
If you specify efa-only, do not assign any IP addresses to the network \n interface. EFA-only network interfaces do not support IP addresses.
Valid values: interface | efa | efa-only\n
The outbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.
Details about the revoked security group rules.
", + "smithy.api#xmlName": "revokedSecurityGroupRuleSet" + } } }, "traits": { @@ -93667,12 +93895,125 @@ "smithy.api#documentation": "The inbound rules that were unknown to the service. In some cases,\n unknownIpPermissionSet might be in a different format from the request\n parameter.
Details about the revoked security group rules.
", + "smithy.api#xmlName": "revokedSecurityGroupRuleSet" + } } }, "traits": { "smithy.api#output": {} } }, + "com.amazonaws.ec2#RevokedSecurityGroupRule": { + "type": "structure", + "members": { + "SecurityGroupRuleId": { + "target": "com.amazonaws.ec2#SecurityGroupRuleId", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleId", + "smithy.api#documentation": "A security group rule ID.
", + "smithy.api#xmlName": "securityGroupRuleId" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "A security group ID.
", + "smithy.api#xmlName": "groupId" + } + }, + "IsEgress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsEgress", + "smithy.api#documentation": "Defines if a security group rule is an outbound rule.
", + "smithy.api#xmlName": "isEgress" + } + }, + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "The security group rule's protocol.
", + "smithy.api#xmlName": "ipProtocol" + } + }, + "FromPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "FromPort", + "smithy.api#documentation": "The 'from' port number of the security group rule.
", + "smithy.api#xmlName": "fromPort" + } + }, + "ToPort": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "The 'to' port number of the security group rule.
", + "smithy.api#xmlName": "toPort" + } + }, + "CidrIpv4": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv4", + "smithy.api#documentation": "The IPv4 CIDR of the traffic source.
", + "smithy.api#xmlName": "cidrIpv4" + } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "The IPv6 CIDR of the traffic source.
", + "smithy.api#xmlName": "cidrIpv6" + } + }, + "PrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", + "traits": { + "aws.protocols#ec2QueryName": "PrefixListId", + "smithy.api#documentation": "The ID of a prefix list that's the traffic source.
", + "smithy.api#xmlName": "prefixListId" + } + }, + "ReferencedGroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "ReferencedGroupId", + "smithy.api#documentation": "The ID of a referenced security group.
", + "smithy.api#xmlName": "referencedGroupId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "A description of the revoked security group rule.
", + "smithy.api#xmlName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress.
" + } + }, + "com.amazonaws.ec2#RevokedSecurityGroupRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#RevokedSecurityGroupRule", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#RoleId": { "type": "string" }, @@ -95764,6 +96105,14 @@ "smithy.api#xmlName": "vpcId" } }, + "SecurityGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupArn", + "smithy.api#documentation": "The ARN of the security group.
", + "smithy.api#xmlName": "securityGroupArn" + } + }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -96119,6 +96468,14 @@ "smithy.api#documentation": "The tags applied to the security group rule.
", "smithy.api#xmlName": "tagSet" } + }, + "SecurityGroupRuleArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupRuleArn", + "smithy.api#documentation": "The ARN of the security group rule.
", + "smithy.api#xmlName": "securityGroupRuleArn" + } } }, "traits": { @@ -96271,6 +96628,104 @@ } } }, + "com.amazonaws.ec2#SecurityGroupVpcAssociation": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.ec2#SecurityGroupId", + "traits": { + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "The association's security group ID.
", + "smithy.api#xmlName": "groupId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "The association's VPC ID.
", + "smithy.api#xmlName": "vpcId" + } + }, + "VpcOwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcOwnerId", + "smithy.api#documentation": "The Amazon Web Services account ID of the owner of the VPC.
", + "smithy.api#xmlName": "vpcOwnerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The association's state.
", + "smithy.api#xmlName": "state" + } + }, + "StateReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateReason", + "smithy.api#documentation": "The association's state reason.
", + "smithy.api#xmlName": "stateReason" + } + } + }, + "traits": { + "smithy.api#documentation": "A security group association with a VPC that you made with AssociateSecurityGroupVpc.
" + } + }, + "com.amazonaws.ec2#SecurityGroupVpcAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#SecurityGroupVpcAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#SecurityGroupVpcAssociationState": { + "type": "enum", + "members": { + "associating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associating" + } + }, + "associated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "associated" + } + }, + "association_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "association-failed" + } + }, + "disassociating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociating" + } + }, + "disassociated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociated" + } + }, + "disassociation_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disassociation-failed" + } + } + } + }, "com.amazonaws.ec2#SelfServicePortal": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/ecs.json b/codegen/sdk-codegen/aws-models/ecs.json index 8166172c491..d2c2b09a385 100644 --- a/codegen/sdk-codegen/aws-models/ecs.json +++ b/codegen/sdk-codegen/aws-models/ecs.json @@ -137,6 +137,12 @@ { "target": "com.amazonaws.ecs#DescribeContainerInstances" }, + { + "target": "com.amazonaws.ecs#DescribeServiceDeployments" + }, + { + "target": "com.amazonaws.ecs#DescribeServiceRevisions" + }, { "target": "com.amazonaws.ecs#DescribeServices" }, @@ -170,6 +176,9 @@ { "target": "com.amazonaws.ecs#ListContainerInstances" }, + { + "target": "com.amazonaws.ecs#ListServiceDeployments" + }, { "target": "com.amazonaws.ecs#ListServices" }, @@ -1762,7 +1771,7 @@ } }, "traits": { - "smithy.api#documentation": "These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:
\nLinux platform version 1.3.0 or later.
Windows platform version 1.0.0 or later.
For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.
" } }, + "com.amazonaws.ecs#ContainerImage": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, + "imageDigest": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container image digest.
" + } + }, + "image": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The container image.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details about the container image a service revision uses.
\nTo ensure that all tasks in a service use the same container image, Amazon ECS resolves\n\t\t\tcontainer image names and any image tags specified in the task definition to container\n\t\t\timage digests.
\nAfter the container image digest has been established, Amazon ECS uses the digest to start\n\t\t\tany other desired tasks, and for any future service and service revision updates. This\n\t\t\tleads to all tasks in a service always running identical container images, resulting in\n\t\t\tversion consistency for your software. For more information, see Container image resolution in the Amazon ECS Developer Guide.
" + } + }, + "com.amazonaws.ecs#ContainerImages": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ContainerImage" + } + }, "com.amazonaws.ecs#ContainerInstance": { "type": "structure", "members": { @@ -3011,7 +3052,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the user that\n\t\t\t\tmakes the call doesn't have permissions to create the service-linked role, it isn't\n\t\t\t\tcreated. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nCreates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the user that\n\t\t\t\tmakes the call doesn't have permissions to create the service-linked role, it isn't\n\t\t\t\tcreated. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
\nRuns and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, 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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nYou can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice 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\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault 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\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired 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\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n
", + "smithy.api#documentation": "Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, 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.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nIn addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
\nYou can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice 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\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
\n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault 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\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.
If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired 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\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n
", "smithy.api#examples": [ { "title": "To create a new service", @@ -3319,7 +3360,7 @@ "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the\n\t\t\tfailure detection methods.
" } }, "placementConstraints": { @@ -3343,7 +3384,7 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in\n\t\t\tthe task definition health check parameters. For more information, see Health\n\t\t\t\tcheck.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" + "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.
If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in\n\t\t\tthe task definition health check parameters. For more information, see Health\n\t\t\t\tcheck.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can\n\t\t\tspecify a health check grace period of up to 2,147,483,647 seconds (about 69 years).\n\t\t\tDuring that time, the Amazon ECS service scheduler ignores health check status. This grace\n\t\t\tperiod can prevent the service scheduler from marking tasks as unhealthy and stopping\n\t\t\tthem before they have time to come up.
" } }, "schedulingStrategy": { @@ -3565,6 +3606,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.ecs#CreatedAt": { + "type": "structure", + "members": { + "before": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "Include service deployments in the result that were created before this time. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "after": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "Include service deployments in the result that were created after this time. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The optional filter to narrow the ListServiceDeployment results.
If you do not specify a value, service deployments that were created before the current\n\t\t\ttime are included in the result.
" + } + }, "com.amazonaws.ecs#DeleteAccountSetting": { "type": "operation", "input": { @@ -4224,19 +4285,19 @@ "smithy.api#required": {} } }, - "enable": { + "rollback": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to use the CloudWatch alarm option in the service deployment\n\t\t\tprocess.
", + "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is used, when a service deployment fails, the service is rolled back\n\t\t\tto the last deployment that completed successfully.
", "smithy.api#required": {} } }, - "rollback": { + "enable": { "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Determines whether to configure Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is used, when a service deployment fails, the service is rolled back\n\t\t\tto the last deployment that completed successfully.
", + "smithy.api#documentation": "Determines whether to use the CloudWatch alarm option in the service deployment\n\t\t\tprocess.
", "smithy.api#required": {} } } @@ -4298,7 +4359,7 @@ } }, "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during a deployment and\n\t\t\tthe ordering of stopping and starting tasks.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the\n\t\t\tfailure detection methods.
" } }, "com.amazonaws.ecs#DeploymentController": { @@ -4345,7 +4406,7 @@ "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify an Key Management Service key ID to encrypt the ephemeral storage for\n\t\t\tdeployment.
" + "smithy.api#documentation": "Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for\n\t\t\tdeployment.
" } } }, @@ -4835,6 +4896,146 @@ "smithy.api#output": {} } }, + "com.amazonaws.ecs#DescribeServiceDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#DescribeServiceDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.ecs#DescribeServiceDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#ClusterNotFoundException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "Describes one or more of your service deployments.
\nA service deployment happens when you release a software update for the service. For more information, see Amazon ECS service deployments.
" + } + }, + "com.amazonaws.ecs#DescribeServiceDeploymentsRequest": { + "type": "structure", + "members": { + "serviceDeploymentArns": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The ARN of the service deployment.
\nYou can specify a maximum of 20 ARNs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DescribeServiceDeploymentsResponse": { + "type": "structure", + "members": { + "serviceDeployments": { + "target": "com.amazonaws.ecs#ServiceDeployments", + "traits": { + "smithy.api#documentation": "The list of service deployments described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
\nIf you decsribe a deployment with a service revision created before October 25, 2024, the\n\t\t\tcall fails. The failure includes the service revision ARN and the reason set to\n\t\t\t\tMISSING.
Describes one or more service revisions.
\nA service revision is a version of the service that includes the values for the Amazon ECS\n\t\t\tresources (for example, task definition) and the environment resources (for example,\n\t\t\tload balancers, subnets, and security groups). For more information, see Amazon ECS service revisions.
\nYou can't describe a service revision that was created before October 25, 2024.
" + } + }, + "com.amazonaws.ecs#DescribeServiceRevisionsRequest": { + "type": "structure", + "members": { + "serviceRevisionArns": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The ARN of the service revision.
\nYou can specify a maximum of 20 ARNs.
\nYou can call ListServiceDeployments to\n\t\t\tget the ARNs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ecs#DescribeServiceRevisionsResponse": { + "type": "structure", + "members": { + "serviceRevisions": { + "target": "com.amazonaws.ecs#ServiceRevisions", + "traits": { + "smithy.api#documentation": "The list of service revisions described.
" + } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ecs#DescribeServices": { "type": "operation", "input": { @@ -7135,6 +7336,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.ecs#ListServiceDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#ListServiceDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.ecs#ListServiceDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ecs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ecs#ClientException" + }, + { + "target": "com.amazonaws.ecs#InvalidParameterException" + }, + { + "target": "com.amazonaws.ecs#ServerException" + }, + { + "target": "com.amazonaws.ecs#ServiceNotFoundException" + }, + { + "target": "com.amazonaws.ecs#UnsupportedFeatureException" + } + ], + "traits": { + "smithy.api#documentation": "This operation lists all the service deployments that meet the specified filter criteria.
\nA service deployment happens when you release a softwre update for the service. You\n\t\t\troute traffic from the running service revisions to the new service revison and control\n\t\t\tthe number of running tasks.
\nThis API returns the values that you use for the request parameters in DescribeServiceRevisions.
" + } + }, + "com.amazonaws.ecs#ListServiceDeploymentsRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN or name of the service
", + "smithy.api#required": {} + } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#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\n\t\t\tspecify a cluster, deault is used.
An optional filter you can use to narrow the results. If you do not specify a status, then\n\t\t\tall status values are included in the result.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#CreatedAt", + "traits": { + "smithy.api#documentation": "An optional filter you can use to narrow the results by the service creation date. If you do\n\t\t\tnot specify a value, the result includes all services created before the current\n\t\t\ttime. The\n\t\t\tformat is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#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.
The maximum number of service deployment results that ListServiceDeployments\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\t\tListServiceDeployments only returns maxResults results in\n\t\t\ta single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListServiceDeployments request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this parameter isn't used, then\n\t\t\t\tListServiceDeployments returns up to 20 results and a\n\t\t\t\tnextToken value if applicable.
An overview of the service deployment, including the following\n\t\t\tproperties:
\nThe ARN of the service deployment.
\nThe ARN of the service being deployed.
\nThe ARN of the cluster that hosts the service in the service deployment.
\nThe time that the service deployment started.
\nThe time that the service deployment completed.
\nThe service deployment status.
\nInformation about why the service deployment is in the current state.
\nThe ARN of the service revision that is being deployed.
\nThe 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.
The name of the load balancer to associate with the Amazon ECS service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be\n\t\t\tomitted.
" + "smithy.api#documentation": "The name of the load balancer to associate with the service or task set.
\nIf you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be\n\t\t\tomitted.
" } }, "containerName": { @@ -8016,7 +8314,7 @@ "minimumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.
\nIf you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.
" + "smithy.api#documentation": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. If this parameter is omitted, the default\n\t\t\tvalue of 1 is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.
\nIf you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.
" } }, "maximumScalingStepSize": { @@ -8086,7 +8384,7 @@ "kmsKeyId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specify a Key Management Service key ID to encrypt the managed storage.
" + "smithy.api#documentation": "Specify a Amazon Web Services Key Management Service key ID to encrypt the managed storage.
" } }, "fargateEphemeralStorageKmsKeyId": { @@ -8556,7 +8854,7 @@ "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.
\nIf you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort.
If you use containers in a task with the bridge network mode and you\n\t\t\tspecify a container port and not a host port, your container automatically receives a\n\t\t\thost port in the ephemeral port range. For more information, see hostPort.\n\t\t\tPort mappings that are automatically assigned in this way do not count toward the 100\n\t\t\treserved ports limit of a container instance.
The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.
\nFor tasks that use the Fargate launch type or EC2 tasks that use the\n\t\t\t\tawsvpc network mode, you use containerPort to specify the\n\t\t\texposed ports.
For Windows containers on Fargate, you can't use port 3150 for the\n\t\t\t\tcontainerPort. This is because it's reserved.
Suppose that you're using containers in a task with the EC2 launch type\n\t\t\tand you specify a container port and not a host port. Then, your container automatically\n\t\t\treceives a host port in the ephemeral port range. For more information, see\n\t\t\t\thostPort. Port mappings that are automatically assigned in this way\n\t\t\tdon't count toward the 100 reserved ports quota of a container instance.
Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.
\nIf you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort. The\n\t\t\t\thostPort can be left blank or it must be the same value as the\n\t\t\t\tcontainerPort.
Most fields of this parameter (containerPort, hostPort,\n\t\t\tprotocol) maps to PortBindings in the docker container create command and the\n\t\t\t\t--publish option to docker\n\t\t\t\t\trun. If the network mode of a task definition is set to\n\t\t\t\thost, host ports must either be undefined or match the container port\n\t\t\tin the port mapping.
You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.
\nAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\tDescribeTasks API responses.
Port mappings expose your container's network ports to the outside world. this allows\n\t\t\tclients to access your application. It's also used for inter-container communication\n\t\t\twithin the same task.
\nFor task definitions (both the Fargate and EC2 launch type) that use the\n\t\t\t\tawsvpc network mode, only specify the containerPort. The\n\t\t\t\thostPort is always ignored, and the container port is automatically\n\t\t\tmapped to a random high-numbered port on the host.
Most fields of this parameter (containerPort, hostPort,\n\t\t\tprotocol) maps to PortBindings in the docker container create command and the\n\t\t\t\t--publish option to docker\n\t\t\t\t\trun. If the network mode of a task definition is set to\n\t\t\t\thost, host ports must either be undefined or match the container port\n\t\t\tin the port mapping.
You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.
\nAfter a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\tDescribeTasks API responses.
The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
For more information, see Network\n settings in the Docker run reference.
" } }, "containerDefinitions": { @@ -9264,13 +9562,13 @@ "pidMode": { "target": "com.amazonaws.ecs#PidMode", "traits": { - "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container. For more information,\n see PID settings in the Docker run\n reference.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure. For more information, see\n Docker security.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n 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\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe value for the specified resource type.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
The value for the specified resource type.
\nWhen the type is GPU, the value is the number of physical GPUs the\n\t\t\tAmazon ECS container agent reserves for the container. The number of GPUs that's reserved for\n\t\t\tall containers in a task can't exceed the number of available GPUs on the container\n\t\t\tinstance that the task is launched on.
When the type is InferenceAccelerator, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a task definition.
The reason the rollback happened. For example, the circuit breaker initiated the rollback operation.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "Time time that the rollback started. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "serviceRevisionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision deployed as part of the rollback.
\nWhen the type is GPU, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.
When the type is InferenceAccelerator, the value matches the\n\t\t\t\tdeviceName for an InferenceAccelerator specified in a task definition.
Information about the service deployment rollback.
" + } + }, + "com.amazonaws.ecs#RunTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.ecs#RunTaskRequest" + }, "output": { "target": "com.amazonaws.ecs#RunTaskResponse" }, @@ -9709,13 +10033,13 @@ "cpuArchitecture": { "target": "com.amazonaws.ecs#CPUArchitecture", "traits": { - "smithy.api#documentation": "The CPU architecture.
\nYou can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.
The CPU architecture.
\nYou can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is available for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.
The default is X86_64.
The operating system.
" + "smithy.api#documentation": "The operating system.
\nThe default is Linux.
The capacity provider strategy the service uses. When using the DescribeServices API,\n\t\t\tthis field is omitted if the service was created using a launch type.
" + "smithy.api#documentation": "The capacity provider strategy the service uses. When using DescribeServices,\n\t\t\tthis field is omitted if the service was created using a launch type.
The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define bot the key and\n\t\t\tvalue.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the service to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value. You define both the key and value.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The key that encrypts and decrypts your resources for Service Connect TLS.
" } }, + "com.amazonaws.ecs#ServiceDeployment": { + "type": "structure", + "members": { + "serviceDeploymentArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service deployment.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service for this service deployment.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment was created. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment statred. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "finishedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment finished. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
" + } + }, + "stoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time the service deployment stopped. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.
\nThe service deployment stops when any of the following actions happen:
\nA user manually stops the deployment
\nThe rollback option is not in use for the failure detection mechanism (the\n\t\t\t\t\tcircuit breaker or alarm-based) and the service fails.
\nThe time that the service deployment was last updated. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "sourceServiceRevisions": { + "target": "com.amazonaws.ecs#ServiceRevisionsSummaryList", + "traits": { + "smithy.api#documentation": "The currently deployed workload configuration.
" + } + }, + "targetServiceRevision": { + "target": "com.amazonaws.ecs#ServiceRevisionSummary", + "traits": { + "smithy.api#documentation": "The workload configuration being deployed.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentStatus", + "traits": { + "smithy.api#documentation": "The service deployment state.
" + } + }, + "statusReason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Information about why the service deployment is in the current status. For example, the circuit breaker detected a failure.
" + } + }, + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration" + }, + "rollback": { + "target": "com.amazonaws.ecs#Rollback", + "traits": { + "smithy.api#documentation": "The rollback options the service deployment uses when the deployment fails.
" + } + }, + "deploymentCircuitBreaker": { + "target": "com.amazonaws.ecs#ServiceDeploymentCircuitBreaker", + "traits": { + "smithy.api#documentation": "The circuit breaker configuration that determines a service deployment failed.
" + } + }, + "alarms": { + "target": "com.amazonaws.ecs#ServiceDeploymentAlarms", + "traits": { + "smithy.api#documentation": "The CloudWatch alarms that determine when a service deployment fails.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the service deployment.
\nService deployments provide a comprehensive view of your deployments. For information\n\t\t\tabout service deployments, see View service history using Amazon ECS service deployments\n\t\t\tin the \n Amazon Elastic Container Service Developer Guide\n .
" + } + }, + "com.amazonaws.ecs#ServiceDeploymentAlarms": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus", + "traits": { + "smithy.api#documentation": "The status of the alarms check. Amazon ECS is not using alarms for service deployment failures when the status is DISABLED.
The name of the CloudWatch alarms that determine when a service deployment failed. A \",\" separates the alarms.
" + } + }, + "triggeredAlarmNames": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "One or more CloudWatch alarm names that have been triggered during the service deployment. A \",\"\n\t\t\tseparates the alarm names.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The CloudWatch alarms used to determine a service deployment failed.
\nAmazon 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.
The ARN of the service deployment.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service for this service deployment.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" + } + }, + "startedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service deployment statred. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service deployment was created. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "finishedAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service deployment completed. The format is yyyy-MM-dd\n\t\t\tHH:mm:ss.SSSSSS.
" + } + }, + "targetServiceRevisionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision being deplyed.
" + } + }, + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of the service deployment
" + } + }, + "statusReason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "Information about why the service deployment is in the current status. For example, the circuit breaker detected a deployment failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The service deployment properties that are retured when you call ListServiceDeployments.
This provides a high-level overview of the service deployment.
" + } + }, + "com.amazonaws.ecs#ServiceDeploymentCircuitBreaker": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus", + "traits": { + "smithy.api#documentation": "The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.
The number of times the circuit breaker detected a service deploymeny failure.
" + } + }, + "threshold": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The threshhold which determines that the service deployment failed.
\nThe deployment circuit breaker calculates the threshold value, and then uses the value to\n\t\t\tdetermine when to move the deployment to a FAILED state. The deployment circuit breaker\n\t\t\thas a minimum threshold of 3 and a maximum threshold of 200. and uses the values in the\n\t\t\tfollowing formula to determine the deployment failure.
\n\n 0.5 * desired task count\n
Information about the circuit breaker used to determine when a service deployment has\n\t\t\tfailed.
\nThe deployment circuit breaker is the rolling update mechanism that determines if the\n\t\t\ttasks reach a steady state. The deployment circuit breaker has an option that will\n\t\t\tautomatically roll back a failed deployment to the last cpompleted service\n\t\t\trevision. For more information, see How the Amazon ECS\n\t\t\tdeployment circuit breaker detects failures in the Amazon ECS Developer\n\t\t\t\tGuide.
" + } + }, + "com.amazonaws.ecs#ServiceDeploymentRollbackMonitorsStatus": { + "type": "enum", + "members": { + "TRIGGERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIGGERED" + } + }, + "MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONITORING" + } + }, + "MONITORING_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONITORING_COMPLETE" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.ecs#ServiceDeploymentStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "STOP_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_REQUESTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, + "ROLLBACK_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_SUCCESSFUL" + } + }, + "ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_FAILED" + } + } + } + }, + "com.amazonaws.ecs#ServiceDeploymentStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceDeploymentStatus" + } + }, + "com.amazonaws.ecs#ServiceDeployments": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceDeployment" + } + }, + "com.amazonaws.ecs#ServiceDeploymentsBrief": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceDeploymentBrief" + } + }, "com.amazonaws.ecs#ServiceEvent": { "type": "structure", "members": { @@ -10399,6 +11040,155 @@ "smithy.api#documentation": "The details for the service registry.
\nEach service may be associated with one service registry. Multiple service registries\n\t\t\tfor each service are not supported.
\nWhen you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.
" } }, + "com.amazonaws.ecs#ServiceRevision": { + "type": "structure", + "members": { + "serviceRevisionArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision.
" + } + }, + "serviceArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service for the service revision.
" + } + }, + "clusterArn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the cluster that hosts the service.
" + } + }, + "taskDefinition": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The task definition the service revision uses.
" + } + }, + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "traits": { + "smithy.api#documentation": "The capacity provider strategy the service revision uses.
" + } + }, + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", + "traits": { + "smithy.api#documentation": "The launch type the service revision uses.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "For the Fargate launch type, the platform version the service revision uses.
" + } + }, + "platformFamily": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The platform family the service revision uses.
" + } + }, + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", + "traits": { + "smithy.api#documentation": "The load balancers the service revision uses.
" + } + }, + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", + "traits": { + "smithy.api#documentation": "The service registries (for Service Discovery) the service revision uses.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration" + }, + "containerImages": { + "target": "com.amazonaws.ecs#ContainerImages", + "traits": { + "smithy.api#documentation": "The container images the service revision uses.
" + } + }, + "guardDutyEnabled": { + "target": "com.amazonaws.ecs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether Runtime Monitoring is turned on.
" + } + }, + "serviceConnectConfiguration": { + "target": "com.amazonaws.ecs#ServiceConnectConfiguration" + }, + "volumeConfigurations": { + "target": "com.amazonaws.ecs#ServiceVolumeConfigurations", + "traits": { + "smithy.api#documentation": "The volumes that are configured at deployment that the service revision uses.
" + } + }, + "fargateEphemeralStorage": { + "target": "com.amazonaws.ecs#DeploymentEphemeralStorage" + }, + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the service revision was created. The format is yyyy-mm-dd HH:mm:ss.SSSSS.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the service revision.
\nA 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\n\t\t\tabout service revisions, see Amazon ECS service revisions\n\t\t\tin the \n Amazon Elastic Container Service Developer Guide\n .
" + } + }, + "com.amazonaws.ecs#ServiceRevisionSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The ARN of the service revision.
" + } + }, + "requestedTaskCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of requested tasks for the service revision.
" + } + }, + "runningTaskCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of running tasks for the service revision.
" + } + }, + "pendingTaskCount": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of pending tasks for the service revision.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The information about the number of requested, pending, and running tasks for a service revision.
" + } + }, + "com.amazonaws.ecs#ServiceRevisions": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceRevision" + } + }, + "com.amazonaws.ecs#ServiceRevisionsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#ServiceRevisionSummary" + } + }, "com.amazonaws.ecs#ServiceVolumeConfiguration": { "type": "structure", "members": { @@ -11565,7 +12355,7 @@ "networkMode": { "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
The Docker networking mode to use for the containers in the task. The valid values are\n none, bridge, awsvpc, and host.\n If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required. \n For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network\n mode is set to none, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host and awsvpc network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge mode.
With the host and awsvpc network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host\n network mode) or the attached elastic network interface port (for the\n awsvpc network mode), so you cannot take advantage of dynamic host port\n mappings.
When using the host network mode, you should not run\n containers using the root user (UID 0). It is considered best practice\n to use a non-root user.
If the network mode is awsvpc, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
If the network mode is host, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
For more information, see Network\n settings in the Docker run reference.
" } }, "revision": { @@ -11638,13 +12428,13 @@ "pidMode": { "target": "com.amazonaws.ecs#PidMode", "traits": { - "smithy.api#documentation": "The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The process namespace to use for the containers in the task. The valid\n values are host or task. On Fargate for\n Linux containers, the only valid value is task. For\n example, monitoring sidecars might need pidMode to access\n information about other containers running in the same task.
If host is specified, all containers within the tasks\n that specified the host PID mode on the same container\n instance share the same process namespace with the host Amazon EC2\n instance.
If task is specified, all containers within the specified\n task share the same process namespace.
If no value is specified, the\n default is a private namespace for each container. For more information,\n see PID settings in the Docker run\n reference.
\nIf the host PID mode is used, there's a heightened risk\n of undesired process namespace exposure. For more information, see\n Docker security.
This parameter is not supported for Windows containers.
\nThis parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.
The IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n 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\n undesired IPC namespace expose.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none. If host is\n specified, then all containers within the tasks that specified the host IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task is specified, all containers within the specified task\n share the same IPC resources. If none is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host IPC mode, IPC namespace related\n systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related\n systemControls will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nSpecify an Key Management Service key ID to encrypt the ephemeral storage for the\n\t\t\ttask.
" + "smithy.api#documentation": "Specify an Amazon Web Services Key Management Service key ID to encrypt the ephemeral storage for the\n\t\t\ttask.
" } } }, @@ -13105,7 +13895,7 @@ "deploymentConfiguration": { "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment and the\n\t\t\tfailure detection methods.
" } }, "networkConfiguration": { diff --git a/codegen/sdk-codegen/aws-models/geo-maps.json b/codegen/sdk-codegen/aws-models/geo-maps.json new file mode 100644 index 00000000000..c49621e5bd0 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/geo-maps.json @@ -0,0 +1,2181 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.geomaps#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.geomaps#ApiKey": { + "type": "string", + "traits": { + "smithy.api#externalDocumentation": { + "Implementation Guide": "https://github.com/paseto-standard/paseto-spec/blob/master/docs/02-Implementation-Guide/03-Algorithm-Lucidity.md" + }, + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geomaps#ColorScheme": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LIGHT", + "value": "Light" + }, + { + "name": "DARK", + "value": "Dark" + } + ] + } + }, + "com.amazonaws.geomaps#CompactOverlay": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7000 + } + } + }, + "com.amazonaws.geomaps#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + }, + "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$" + } + }, + "com.amazonaws.geomaps#DistanceMeters": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.geomaps#GeoJsonOverlay": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7000 + } + } + }, + "com.amazonaws.geomaps#GetGlyphs": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetGlyphsRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetGlyphsResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the map's glyphs.
", + "smithy.api#http": { + "uri": "/glyphs/{FontStack}/{FontUnicodeRange}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetGlyphsSuccess", + "params": { + "FontStack": "Amazon Ember Regular", + "FontUnicodeRange": "0-255.pbf" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetGlyphsRequest": { + "type": "structure", + "members": { + "FontStack": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the FontStack to retrieve.
Example: Amazon Ember Bold,Noto Sans Bold.
The supported font stacks are as follows:
\nAmazon Ember Bold
\nAmazon Ember Bold Italic
\nAmazon Ember Bold,Noto Sans Bold
\nAmazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
\nAmazon Ember Condensed RC BdItalic
\nAmazon Ember Condensed RC Bold
\nAmazon Ember Condensed RC Bold Italic
\nAmazon Ember Condensed RC Bold,Noto Sans Bold
\nAmazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic Condensed Bold
\nAmazon Ember Condensed RC Light
\nAmazon Ember Condensed RC Light Italic
\nAmazon Ember Condensed RC LtItalic
\nAmazon Ember Condensed RC Regular
\nAmazon Ember Condensed RC Regular Italic
\nAmazon Ember Condensed RC Regular,Noto Sans Regular
\nAmazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic Condensed Regular
\nAmazon Ember Condensed RC RgItalic
\nAmazon Ember Condensed RC ThItalic
\nAmazon Ember Condensed RC Thin
\nAmazon Ember Condensed RC Thin Italic
\nAmazon Ember Heavy
\nAmazon Ember Heavy Italic
\nAmazon Ember Light
\nAmazon Ember Light Italic
\nAmazon Ember Medium
\nAmazon Ember Medium Italic
\nAmazon Ember Medium,Noto Sans Medium
\nAmazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
\nAmazon Ember Regular
\nAmazon Ember Regular Italic
\nAmazon Ember Regular Italic,Noto Sans Italic
\nAmazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic Regular
\nAmazon Ember Regular,Noto Sans Regular
\nAmazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
\nAmazon Ember Thin
\nAmazon Ember Thin Italic
\nAmazonEmberCdRC_Bd
\nAmazonEmberCdRC_BdIt
\nAmazonEmberCdRC_Lt
\nAmazonEmberCdRC_LtIt
\nAmazonEmberCdRC_Rg
\nAmazonEmberCdRC_RgIt
\nAmazonEmberCdRC_Th
\nAmazonEmberCdRC_ThIt
\nAmazonEmber_Bd
\nAmazonEmber_BdIt
\nAmazonEmber_He
\nAmazonEmber_HeIt
\nAmazonEmber_Lt
\nAmazonEmber_LtIt
\nAmazonEmber_Md
\nAmazonEmber_MdIt
\nAmazonEmber_Rg
\nAmazonEmber_RgIt
\nAmazonEmber_Th
\nAmazonEmber_ThIt
\nNoto Sans Black
\nNoto Sans Black Italic
\nNoto Sans Bold
\nNoto Sans Bold Italic
\nNoto Sans Extra Bold
\nNoto Sans Extra Bold Italic
\nNoto Sans Extra Light
\nNoto Sans Extra Light Italic
\nNoto Sans Italic
\nNoto Sans Light
\nNoto Sans Light Italic
\nNoto Sans Medium
\nNoto Sans Medium Italic
\nNoto Sans Regular
\nNoto Sans Semi Bold
\nNoto Sans Semi Bold Italic
\nNoto Sans Thin
\nNoto Sans Thin Italic
\nNotoSans-Bold
\nNotoSans-Italic
\nNotoSans-Medium
\nNotoSans-Regular
\nOpen Sans Regular,Arial Unicode MS Regular
\nA Unicode range of characters to download glyphs for. This must be aligned to multiples\n of 256.
\nExample: 0-255.pdf\n
The Glyph, as a binary blob.
", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The glyph's Etag.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetSprites": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetSpritesRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetSpritesResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the map's sprites.
", + "smithy.api#http": { + "uri": "/styles/{Style}/{ColorScheme}/{Variant}/sprites/{FileName}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetSpritesSuccess", + "params": { + "Style": "Standard", + "ColorScheme": "Light", + "Variant": "Default", + "FileName": "sprites.json" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetSpritesRequest": { + "type": "structure", + "members": { + "FileName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "\n Sprites API: The name of the sprite file to retrieve, following pattern\n sprites(@2x)?\\.(png|json).
Example: sprites.png\n
Style specifies the desired map style for the Sprites APIs.
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.
\nExample: Light\n
Default value: Light\n
Valid values for ColorScheme are case sensitive.
\nOptimizes map styles for specific use case or industry. You can choose allowed variant only with Standard map style.
\nExample: Default\n
Valid values for Variant are case sensitive.
\nThe body of the sprite sheet or JSON offset file (image/png or application/json,\n depending on input).
", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The sprite's Etag.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetStaticMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetStaticMapRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetStaticMapResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geomaps#AccessDeniedException" + }, + { + "target": "com.amazonaws.geomaps#InternalServerException" + }, + { + "target": "com.amazonaws.geomaps#ThrottlingException" + }, + { + "target": "com.amazonaws.geomaps#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#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.
", + "smithy.api#http": { + "uri": "/static/{FileName}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetStaticMapSuccess", + "params": { + "FileName": "map", + "Width": 800, + "Height": 900, + "Center": "-123.144847,49.303609", + "Style": "Satellite", + "Zoom": 10.0 + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetStaticMapRequest": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.geomaps#PositionListString", + "traits": { + "smithy.api#documentation": "Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and\n north-easterly edges of the image. The underlying area becomes the view of the image.
\nExample: -123.17075,49.26959,-123.08125,49.31429
", + "smithy.api#httpQuery": "bounding-box" + } + }, + "BoundedPositions": { + "target": "com.amazonaws.geomaps#PositionListString", + "traits": { + "smithy.api#documentation": "Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by\n a comma. The API will generate an image to encompass all of the provided coordinates.
\nCannot be used with Zoom and or Radius\n
Example: 97.170451,78.039098,99.045536,27.176178
", + "smithy.api#httpQuery": "bounded-positions" + } + }, + "Center": { + "target": "com.amazonaws.geomaps#PositionString", + "traits": { + "smithy.api#documentation": "Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image.\n This parameter requires that either zoom or radius is set.
\nCannot be used with Zoom and or Radius\n
Example: 49.295,-123.108
", + "smithy.api#httpQuery": "center" + } + }, + "CompactOverlay": { + "target": "com.amazonaws.geomaps#CompactOverlay", + "traits": { + "smithy.api#documentation": "Takes in a string to draw geometries on the image. The input is a comma separated format as follows format:\n [Lon, Lat]\n
Example:\n 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\n
Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.
\nTakes in a string to draw geometries on the image. The input is a valid GeoJSON\n collection object.
\nExample:\n {\"type\":\"FeatureCollection\",\"features\": [{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPoint\",\"coordinates\": [[-90.076345,51.504107],[-0.074451,51.506892]]},\"properties\": {\"color\":\"#00DD00\"}}]}\n
Specifies the height of the map image.
", + "smithy.api#httpQuery": "height", + "smithy.api#range": { + "min": 64, + "max": 1400 + }, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.geomaps#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "Padding": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Applies additional space (in pixels) around overlay feature to prevent them from being\n cut or obscured.
\nValue for max and min is determined by:
\nMin: 1\n
Max: min(height, width)/4\n
Example: 100\n
Used with center parameter, it specifies the zoom of the image where you can control it\n on a granular level. Takes in any value >= 1.
Example: 1500\n
Cannot be used with Zoom.
\n Unit: Meters\n
The map scaling parameter to size the image, icons, and labels. It follows the pattern\n of ^map(@2x)?$.
Example: map, map@2x\n
Displays a scale on the bottom right of the map image with the unit specified in the\n input.
\nExample: KilometersMiles, Miles, Kilometers, MilesKilometers\n
Style specifies the desired map style for the Style APIs.
Specifies the width of the map image.
", + "smithy.api#httpQuery": "width", + "smithy.api#range": { + "min": 64, + "max": 1400 + }, + "smithy.api#required": {} + } + }, + "Zoom": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Specifies the zoom level of the map image.
\nCannot be used with Radius.
The blob represents a map image as a jpeg for\n the GetStaticMap API.
Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The static map's Etag.
", + "smithy.api#httpHeader": "ETag" + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the request is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetStyleDescriptor": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetStyleDescriptorRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetStyleDescriptorResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about the style.
", + "smithy.api#http": { + "uri": "/styles/{Style}/descriptor", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetStyleDescriptorSuccess", + "params": { + "Style": "Standard" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetStyleDescriptorRequest": { + "type": "structure", + "members": { + "Style": { + "target": "com.amazonaws.geomaps#MapStyle", + "traits": { + "smithy.api#documentation": "Style specifies the desired map style.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ColorScheme": { + "target": "com.amazonaws.geomaps#ColorScheme", + "traits": { + "smithy.api#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.
\nExample: Light\n
Default value: Light\n
Valid values for ColorScheme are case sensitive.
\nSpecifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
\nThe following political views are currently supported:
\n\n ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands
\n EGY: Egypt's view on Bir Tawil
\n IND: India's view on Gilgit-Baltistan
\n KEN: Kenya's view on the Ilemi Triangle
\n MAR: Morocco's view on Western Sahara
\n PAK: Pakistan's view on Jammu and Kashmir and the Junagadh Area
\n RUS: Russia's view on Crimea
\n SDN: Sudan's view on the Halaib Triangle
\n SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands
\n SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters
\n SYR: Syria's view on the Golan Heights
\n TUR: Turkey's view on Cyprus and Northern Cyprus
\n TZA: Tanzania's view on Lake Malawi
\n URY: Uruguay's view on Rincon de Artigas
\n VNM: Vietnam's view on the Paracel Islands and Spratly Islands
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geomaps#GetStyleDescriptorResponse": { + "type": "structure", + "members": { + "Blob": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "This Blob contains the body of the style descriptor which is in application/json format.
", + "smithy.api#httpPayload": {} + } + }, + "ContentType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The style descriptor's Etag.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#GetTile": { + "type": "operation", + "input": { + "target": "com.amazonaws.geomaps#GetTileRequest" + }, + "output": { + "target": "com.amazonaws.geomaps#GetTileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geomaps#AccessDeniedException" + }, + { + "target": "com.amazonaws.geomaps#InternalServerException" + }, + { + "target": "com.amazonaws.geomaps#ThrottlingException" + }, + { + "target": "com.amazonaws.geomaps#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#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.
", + "smithy.api#http": { + "uri": "/tiles/{Tileset}/{Z}/{X}/{Y}", + "method": "GET" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetTileSuccess", + "params": { + "Tileset": "vector.basemap", + "X": "5190", + "Y": "11218", + "Z": "15" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geomaps#GetTileRequest": { + "type": "structure", + "members": { + "Tileset": { + "target": "com.amazonaws.geomaps#Tileset", + "traits": { + "smithy.api#documentation": "Specifies the desired tile set.
\nValid Values: raster.satellite | vector.basemap\n
The zoom value for the map tile.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "\\d+", + "smithy.api#required": {} + } + }, + "X": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The X axis value for the map tile. Must be between 0 and 19.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "\\d+", + "smithy.api#required": {} + } + }, + "Y": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Y axis value for the map tile.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "\\d+", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.geomaps#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geomaps#GetTileResponse": { + "type": "structure", + "members": { + "Blob": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "The blob represents a vector tile in mvt format for the\n GetTile API.
Header that represents the format of the response. The response returns the following as the HTTP body.
", + "smithy.api#httpHeader": "Content-Type" + } + }, + "CacheControl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Header that instructs caching configuration for the client.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ETag": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the request is charged at.
", + "smithy.api#httpHeader": "ETag" + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the request is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geomaps#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.geomaps#MapStyle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STANDARD", + "value": "Standard" + }, + { + "name": "MONOCHROME", + "value": "Monochrome" + }, + { + "name": "HYBRID", + "value": "Hybrid" + }, + { + "name": "SATELLITE", + "value": "Satellite" + } + ] + } + }, + "com.amazonaws.geomaps#MapsService": { + "type": "service", + "version": "2020-11-19", + "resources": [ + { + "target": "com.amazonaws.geomaps#ProviderResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Geo Maps", + "arnNamespace": "geo-maps", + "cloudTrailEventSource": "geo-maps.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "geo-maps" + }, + "aws.endpoints#standardRegionalEndpoints": { + "partitionSpecialCases": { + "aws": [ + { + "endpoint": "https://maps.geo.{region}.{dnsSuffix}/v2" + }, + { + "endpoint": "https://maps.geo-fips.{region}.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://maps.geo-fips.{region}.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://maps.geo.{region}.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ], + "aws-us-gov": [ + { + "endpoint": "https://maps.geo.{region}.us-gov.{dnsSuffix}/v2" + }, + { + "endpoint": "https://maps.geo-fips.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://maps.geo-fips.{region}.us-gov.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://maps.geo.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ] + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "x-amz-content-sha256", + "x-amz-user-agent", + "content-type" + ], + "additionalExposedHeaders": [ + "age", + "date", + "x-amz-apigw-id", + "x-amz-cf-id", + "x-amz-cf-pop", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-cache" + ] + }, + "smithy.api#documentation": "\n Integrate high-quality base map data into your applications using \n MapLibre. Capabilities include:\n
\nAccess to comprehensive base map data, allowing you to tailor the map display to your specific needs.
\nMultiple pre-designed map styles suited for various application types, such as navigation, logistics, or data visualization.
\nGeneration of static map images for scenarios where interactive maps aren't suitable, such as:
\nEmbedding in emails or documents
\nDisplaying in low-bandwidth environments
\nCreating printable maps
\nEnhancing application performance by reducing client-side rendering
\nThe request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.geomaps#Tileset": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[-.\\w]+$" + } + }, + "com.amazonaws.geomaps#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.geomaps#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The field where thebb invalid entry was detected.
", + "smithy.api#jsonName": "reason", + "smithy.api#required": {} + } + }, + "FieldList": { + "target": "com.amazonaws.geomaps#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A message with the reason for the validation exception error.
", + "smithy.api#jsonName": "fieldList", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.geomaps#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the Amazon Location service.
" + } + }, + "com.amazonaws.geomaps#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.geomaps#ValidationExceptionField" + } + }, + "com.amazonaws.geomaps#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "UNKNOWN_OPERATION", + "value": "UnknownOperation", + "documentation": "No such operation is supported." + }, + { + "name": "MISSING", + "value": "Missing", + "documentation": "The required input is missing." + }, + { + "name": "CANNOT_PARSE", + "value": "CannotParse", + "documentation": " The input cannot be parsed. For example a required JSON document, ARN identifier,\n date value, or numeric field cannot be parsed.\n" + }, + { + "name": "FIELD_VALIDATION_FAILED", + "value": "FieldValidationFailed", + "documentation": " The input is present and parsable, but it is otherwise invalid. For example, a\n required numeric argument is outside the allowed range.\n" + }, + { + "name": "OTHER", + "value": "Other", + "documentation": "The input is invalid but no more specific reason is applicable." + }, + { + "name": "UNKNOWN_FIELD", + "value": "UnknownField", + "documentation": "No such field is supported." + } + ] + } + }, + "com.amazonaws.geomaps#Variant": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DEFAULT", + "value": "Default" + } + ] + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/geo-places.json b/codegen/sdk-codegen/aws-models/geo-places.json new file mode 100644 index 00000000000..a14d4b57e97 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/geo-places.json @@ -0,0 +1,5840 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.geoplaces#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.geoplaces#AccessPoint": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Position of the access point represented by longitude and latitude for a vehicle.
" + } + }, + "com.amazonaws.geoplaces#AccessPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#AccessPoint" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#AccessRestriction": { + "type": "structure", + "members": { + "Restricted": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The restriction.
" + } + }, + "Categories": { + "target": "com.amazonaws.geoplaces#CategoryList", + "traits": { + "smithy.api#documentation": "Categories of results that results must belong too.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates if the access location is restricted. Index correlates to that of an access\n point and indicates if access through this point has some form of restriction.
" + } + }, + "com.amazonaws.geoplaces#AccessRestrictionList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#AccessRestriction" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#Address": { + "type": "structure", + "members": { + "Label": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Assembled address value built out of the address components, according to the regional\n postal rules. This is the correctly formatted address.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "Country": { + "target": "com.amazonaws.geoplaces#Country", + "traits": { + "smithy.api#documentation": "The country component of the address.
" + } + }, + "Region": { + "target": "com.amazonaws.geoplaces#Region", + "traits": { + "smithy.api#documentation": "The region or state results should be present in.
\nExample: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" + } + }, + "Locality": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The locality or city of the address.
\nExample: Vancouver.
The district or division of a locality associated with this address.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "SubDistrict": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A subdivision of a district.
\nExample: Minden-Lübbecke.
An alphanumeric string included in a postal address to facilitate mail sorting, such as\n post code, postcode, or ZIP code, for which the result should posses.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "Block": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the block.
\nExample: Sunny Mansion 203 block: 2 Chome\n
Name of sub-block.
\nExample: Sunny Mansion 203 sub-block: 4\n
Name of the streets in the intersection.
\nExample: [\"Friedrichstraße\",\"Unter den Linden\"]\n
The name of the street results should be present in.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "StreetComponents": { + "target": "com.amazonaws.geoplaces#StreetComponentsList", + "traits": { + "smithy.api#documentation": "Components of the street.
\nExample: Younge from the \"Younge street\".
" + } + }, + "AddressNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The number that identifies an address within a street.
", + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "Building": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the building at the address.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The place address.
" + } + }, + "com.amazonaws.geoplaces#AddressComponentMatchScores": { + "type": "structure", + "members": { + "Country": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
" + } + }, + "Region": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The region or state results should be to be present in.
\nExample: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" + } + }, + "Locality": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The city or locality results should be present in.
\nExample: Vancouver.
The district or division of a city the results should be present in.
" + } + }, + "SubDistrict": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "A subdivision of a district.
\nExample: Minden-Lübbecke\n
An alphanumeric string included in a postal address to facilitate mail sorting, such as\n post code, postcode, or ZIP code, for which the result should posses.
" + } + }, + "Block": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Name of the block.
\nExample: Sunny Mansion 203 block: 2 Chome\n
Name of sub-block.
\nExample: Sunny Mansion 203 sub-block: 4\n
Name of the streets in the intersection.
\nExample: [\"Friedrichstraße\",\"Unter den Linden\"]\n
The house number or address results should have.
" + } + }, + "Building": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The name of the building at the address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates how well the entire input matches the returned. It is equal to 1 if all input\n tokens are recognized and matched.
" + } + }, + "com.amazonaws.geoplaces#AddressComponentPhonemes": { + "type": "structure", + "members": { + "Country": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
" + } + }, + "Region": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the region or state results should be to be present in.
" + } + }, + "SubRegion": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the sub-region or county for which results should be present in.
" + } + }, + "Locality": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the city or locality results should be present in.
\nExample: Vancouver.
How to pronounce the district or division of a city results should be present in.
" + } + }, + "SubDistrict": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the sub-district or division of a city results should be present\n in.
" + } + }, + "Block": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the name of the block.
" + } + }, + "SubBlock": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the name of the sub-block.
" + } + }, + "Street": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "How to pronounce the name of the street results should be present in.
" + } + } + }, + "traits": { + "smithy.api#documentation": "How to pronounce the various components of the address or place.
" + } + }, + "com.amazonaws.geoplaces#ApiKey": { + "type": "string", + "traits": { + "smithy.api#externalDocumentation": { + "Implementation Guide": "https://github.com/paseto-standard/paseto-spec/blob/master/docs/02-Implementation-Guide/03-Algorithm-Lucidity.md" + }, + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geoplaces#Autocomplete": { + "type": "operation", + "input": { + "target": "com.amazonaws.geoplaces#AutocompleteRequest" + }, + "output": { + "target": "com.amazonaws.geoplaces#AutocompleteResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geoplaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.geoplaces#InternalServerException" + }, + { + "target": "com.amazonaws.geoplaces#ThrottlingException" + }, + { + "target": "com.amazonaws.geoplaces#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#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
", + "smithy.api#http": { + "uri": "/autocomplete", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "AutocompleteSuccess", + "params": { + "QueryText": "Star" + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geoplaces#AutocompleteAdditionalFeature": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CORE", + "value": "Core" + } + ] + } + }, + "com.amazonaws.geoplaces#AutocompleteAdditionalFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#AutocompleteAdditionalFeature" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.geoplaces#AutocompleteAddressHighlights": { + "type": "structure", + "members": { + "Label": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending indexes for result items where they are identified to match the input query.\n This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
" + } + }, + "Country": { + "target": "com.amazonaws.geoplaces#CountryHighlights", + "traits": { + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
" + } + }, + "Region": { + "target": "com.amazonaws.geoplaces#RegionHighlights", + "traits": { + "smithy.api#documentation": "The region or state results should be to be present in.
\nExample: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
" + } + }, + "Locality": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "The city or locality results should be present in.
\nExample: Vancouver.
The district or division of a city the results should be present in.
" + } + }, + "SubDistrict": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the title in the text query that match the found title.
" + } + }, + "Street": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "The name of the street results should be present in.
" + } + }, + "Block": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Name of the block. Example: Sunny Mansion 203\nblock: 2 Chome
" + } + }, + "SubBlock": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Name of sub-block. Example Sunny Mansion 203 sub-block: 4
" + } + }, + "Intersection": { + "target": "com.amazonaws.geoplaces#IntersectionHighlightsList", + "traits": { + "smithy.api#documentation": "Name of the streets in the intersection. For example: e.g. [\"Friedrichstraße\",\"Unter den Linden\"]
" + } + }, + "PostalCode": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "The house number or address results should have.
" + } + }, + "Building": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "The name of the building at the address.
" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.geoplaces#AutocompleteFilter": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" + } + }, + "IncludePlaceTypes": { + "target": "com.amazonaws.geoplaces#AutocompleteFilterPlaceTypeList", + "traits": { + "smithy.api#documentation": "The included place types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Autocomplete structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "com.amazonaws.geoplaces#AutocompleteFilterPlaceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LOCALITY", + "value": "Locality" + }, + { + "name": "POSTAL_CODE", + "value": "PostalCode" + } + ] + } + }, + "com.amazonaws.geoplaces#AutocompleteFilterPlaceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#AutocompleteFilterPlaceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.geoplaces#AutocompleteHighlights": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates where the title field in the result matches the input query.
" + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#AutocompleteAddressHighlights", + "traits": { + "smithy.api#documentation": "Describes how part of the result address match the input query.
" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.geoplaces#AutocompleteIntendedUse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SINGLE_USE", + "value": "SingleUse", + "documentation": "Indicates that results of the operation are for single use, e.g., displaying results on a map or presenting options to users." + } + ] + } + }, + "com.amazonaws.geoplaces#AutocompleteRequest": { + "type": "structure", + "members": { + "QueryText": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#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.
", + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "An optional limit for the number of results returned in a single call.
", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "BiasPosition": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position in longitude and latitude that the results should be close to. Typically,\n place results returned are ranked higher the closer they are to this position. Stored in\n [lng, lat] and in the WSG84 format.
The fields BiasPosition, FilterBoundingBox, and\n FilterCircle are mutually exclusive.
A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "PostalCodeMode": { + "target": "com.amazonaws.geoplaces#PostalCodeMode", + "traits": { + "smithy.api#documentation": "The PostalCodeMode affects how postal code results are returned. If a\n postal code spans multiple localities and this value is empty, \n 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\n postal code are returned.
A list of optional additional parameters that can be requested for\n each result.
" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#AutocompleteIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left\n empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#AutocompleteResponse": { + "type": "structure", + "members": { + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "ResultItems": { + "target": "com.amazonaws.geoplaces#AutocompleteResultItemList", + "traits": { + "smithy.api#documentation": "List of places or results returned for a query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geoplaces#AutocompleteResultItem": { + "type": "structure", + "members": { + "PlaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PlaceId of the place associated with this result. This can be used to look up additional details about the result via GetPlace.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "PlaceType": { + "target": "com.amazonaws.geoplaces#PlaceType", + "traits": { + "smithy.api#documentation": "PlaceType describes the type of result entry returned.
", + "smithy.api#required": {} + } + }, + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A formatted string for display when presenting this result to an end user.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#Address", + "traits": { + "smithy.api#documentation": "The address associated with this result.
" + } + }, + "Distance": { + "target": "com.amazonaws.geoplaces#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#AutocompleteHighlights", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the place in the text query that match the found title.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A result matching the input query text.
" + } + }, + "com.amazonaws.geoplaces#AutocompleteResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#AutocompleteResultItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.geoplaces#BoundingBox": { + "type": "list", + "member": { + "target": "smithy.api#Double" + }, + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-5" + }, + "smithy.api#length": { + "min": 4, + "max": 4 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geoplaces#BusinessChain": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The business chain name.
", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Business Chain Id.
", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "A businesschain is a chain of businesses that belong to the same brand. For example 7-11.
The category ID.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The category name.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "LocalizedName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Localized name of the category type.
", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "Primary": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean which indicates if this category is the primary offered by the place.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Category of the Place returned.
Indicates the starting and ending index of the title in the text query that match the found title.
" + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#AddressComponentMatchScores", + "traits": { + "smithy.api#documentation": "The place's address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates how well the input matches the returned element.\n It is equal to 1 if all input tokens are recognized and matched to the title in the result.
" + } + }, + "com.amazonaws.geoplaces#ContactDetails": { + "type": "structure", + "members": { + "Label": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The contact's label.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The contact's value.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "Categories": { + "target": "com.amazonaws.geoplaces#CategoryList", + "traits": { + "smithy.api#documentation": "Categories of results that results must belong too.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to contacts.
" + } + }, + "com.amazonaws.geoplaces#ContactDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#ContactDetails" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#Contacts": { + "type": "structure", + "members": { + "Phones": { + "target": "com.amazonaws.geoplaces#ContactDetailsList", + "traits": { + "smithy.api#documentation": "List of phone numbers for the results contact.
" + } + }, + "Faxes": { + "target": "com.amazonaws.geoplaces#ContactDetailsList", + "traits": { + "smithy.api#documentation": "List of fax addresses for the result contact.
" + } + }, + "Websites": { + "target": "com.amazonaws.geoplaces#ContactDetailsList", + "traits": { + "smithy.api#documentation": "List of website URLs that belong to the result.
" + } + }, + "Emails": { + "target": "com.amazonaws.geoplaces#ContactDetailsList", + "traits": { + "smithy.api#documentation": "List of emails for contacts of the result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of potential contact methods for the result/place.
" + } + }, + "com.amazonaws.geoplaces#Country": { + "type": "structure", + "members": { + "Code2": { + "target": "com.amazonaws.geoplaces#CountryCode2", + "traits": { + "smithy.api#documentation": "Country, represented by its alpha 2-character code.
" + } + }, + "Code3": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#documentation": "Country, represented by its alpha t-character code.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the country.
", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
" + } + }, + "com.amazonaws.geoplaces#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + }, + "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$" + } + }, + "com.amazonaws.geoplaces#CountryCode2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, + "com.amazonaws.geoplaces#CountryCode3": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + }, + "smithy.api#pattern": "^[A-Z]{3}$" + } + }, + "com.amazonaws.geoplaces#CountryCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#CountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.geoplaces#CountryHighlights": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the country code in the text query that match the found title.
" + } + }, + "Name": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the country code in the text query that match the found title.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the country in the text query that match the found title.
" + } + }, + "com.amazonaws.geoplaces#DistanceMeters": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.geoplaces#DurationSeconds": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.geoplaces#FilterBusinessChainList": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.geoplaces#FilterCategoryList": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.geoplaces#FilterCircle": { + "type": "structure", + "members": { + "Center": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The center position, in longitude and latitude, of the FilterCircle.
The radius, in meters, of the FilterCircle.
The Circle that all results must be in.
Localized name of the food type.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Food Type Id.
", + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "Primary": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean which indicates if this food type is the primary offered by the place. For\n example, if a location serves fast food, but also dessert, he primary would likely be fast\n food.
" + } + } + }, + "traits": { + "smithy.api#documentation": "List of Food types offered by this result.
The Geocode action allows you to obtain coordinates, addresses, and other\n information about places.
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" + } + }, + "IncludePlaceTypes": { + "target": "com.amazonaws.geoplaces#GeocodeFilterPlaceTypeList", + "traits": { + "smithy.api#documentation": "The included place types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Geocode structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "com.amazonaws.geoplaces#GeocodeFilterPlaceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LOCALITY", + "value": "Locality" + }, + { + "name": "POSTAL_CODE", + "value": "PostalCode" + }, + { + "name": "INTERSECTION", + "value": "Intersection" + }, + { + "name": "STREET", + "value": "Street" + }, + { + "name": "POINT_ADDRESS", + "value": "PointAddress" + }, + { + "name": "INTERPOLATED_ADDRESS", + "value": "InterpolatedAddress" + } + ] + } + }, + "com.amazonaws.geoplaces#GeocodeFilterPlaceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#GeocodeFilterPlaceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.geoplaces#GeocodeIntendedUse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SINGLE_USE", + "value": "SingleUse", + "documentation": "Indicates that results of the operation are for single use, e.g., displaying results on a map or presenting options to users." + }, + { + "name": "STORAGE", + "value": "Storage", + "documentation": "Indicates that results of the operation may be stored locally." + } + ] + } + }, + "com.amazonaws.geoplaces#GeocodeQueryComponents": { + "type": "structure", + "members": { + "Country": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the country that the results will be present in.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[^;]+$" + } + }, + "Region": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#documentation": "The region or state results should be to be present in.
\nExample: North Rhine-Westphalia.
The sub-region or county for which results should be present in.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[^;]+$" + } + }, + "Locality": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#documentation": "City or locality results should be present in.
\nExample: Vancouver.
The district or division of a city the results should be present in.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[^;]+$" + } + }, + "Street": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#documentation": "The name of the street results should be present in.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[^;]+$" + } + }, + "AddressNumber": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#documentation": "The house number or address results should have.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[^;]+$" + } + }, + "PostalCode": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#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.
", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[^;]+$" + } + } + }, + "traits": { + "smithy.api#documentation": "A structured free text query allows you to search for places by the name or text representation of specific properties of the place.
" + } + }, + "com.amazonaws.geoplaces#GeocodeRequest": { + "type": "structure", + "members": { + "QueryText": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#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.
", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "QueryComponents": { + "target": "com.amazonaws.geoplaces#GeocodeQueryComponents" + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "An optional limit for the number of results returned in a single call.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "BiasPosition": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude, that the results should be close to. Typically,\n place results returned are ranked higher the closer they are to this position. Stored in\n [lng, lat] and in the WSG84 format.
The fields BiasPosition, FilterBoundingBox, and\n FilterCircle are mutually exclusive.
A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "AdditionalFeatures": { + "target": "com.amazonaws.geoplaces#GeocodeAdditionalFeatureList", + "traits": { + "smithy.api#documentation": "A list of optional additional parameters, such as time zone, that can be requested for\n each result.
" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the political view of a country. \n 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": { + "target": "com.amazonaws.geoplaces#GeocodeIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left\n empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#GeocodeResponse": { + "type": "structure", + "members": { + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "ResultItems": { + "target": "com.amazonaws.geoplaces#GeocodeResultItemList", + "traits": { + "smithy.api#documentation": "List of places or results returned for a query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geoplaces#GeocodeResultItem": { + "type": "structure", + "members": { + "PlaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The place's address.
" + } + }, + "AddressNumberCorrected": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean indicating if the address provided has been corrected.
" + } + }, + "PostalCodeDetails": { + "target": "com.amazonaws.geoplaces#PostalCodeDetailsList", + "traits": { + "smithy.api#documentation": "Contains details about the postal code of the place/result.
" + } + }, + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position in longitude and latitude.
" + } + }, + "Distance": { + "target": "com.amazonaws.geoplaces#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The distance in meters from the QueryPosition.
" + } + }, + "MapView": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
Categories of results that results must belong to.
" + } + }, + "FoodTypes": { + "target": "com.amazonaws.geoplaces#FoodTypeList", + "traits": { + "smithy.api#documentation": "List of food types offered by this result.
" + } + }, + "AccessPoints": { + "target": "com.amazonaws.geoplaces#AccessPointList", + "traits": { + "smithy.api#documentation": "Position of the access point represent by longitude and latitude.
" + } + }, + "TimeZone": { + "target": "com.amazonaws.geoplaces#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#MatchScoreDetails", + "traits": { + "smithy.api#documentation": "Indicates how well the entire input matches the returned. It is equal to 1 if all input\n tokens are recognized and matched.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Geocoded result.
" + } + }, + "com.amazonaws.geoplaces#GeocodeResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#GeocodeResultItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#GetPlace": { + "type": "operation", + "input": { + "target": "com.amazonaws.geoplaces#GetPlaceRequest" + }, + "output": { + "target": "com.amazonaws.geoplaces#GetPlaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geoplaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.geoplaces#InternalServerException" + }, + { + "target": "com.amazonaws.geoplaces#ThrottlingException" + }, + { + "target": "com.amazonaws.geoplaces#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Finds a place by its unique ID. A PlaceId is returned by other place\n operations.
The PlaceId of the place you wish to receive the information for.
A list of optional additional parameters such as time zone that can be requested for\n each result.
", + "smithy.api#httpQuery": "additional-features" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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.
", + "smithy.api#httpQuery": "language" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#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.
", + "smithy.api#httpQuery": "political-view" + } + }, + "IntendedUse": { + "target": "com.amazonaws.geoplaces#GetPlaceIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#GetPlaceResponse": { + "type": "structure", + "members": { + "PlaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#Address", + "traits": { + "smithy.api#documentation": "The place's address.
" + } + }, + "AddressNumberCorrected": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean indicating if the address provided has been corrected.
" + } + }, + "PostalCodeDetails": { + "target": "com.amazonaws.geoplaces#PostalCodeDetailsList", + "traits": { + "smithy.api#documentation": "Contains details about the postal code of the place/result.
" + } + }, + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude.
" + } + }, + "MapView": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set of four coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
Categories of results that results must belong to.
" + } + }, + "FoodTypes": { + "target": "com.amazonaws.geoplaces#FoodTypeList", + "traits": { + "smithy.api#documentation": "List of food types offered by this result.
" + } + }, + "BusinessChains": { + "target": "com.amazonaws.geoplaces#BusinessChainList", + "traits": { + "smithy.api#documentation": "The Business Chains associated with the place.
" + } + }, + "Contacts": { + "target": "com.amazonaws.geoplaces#Contacts", + "traits": { + "smithy.api#documentation": "List of potential contact methods for the result/place.
" + } + }, + "OpeningHours": { + "target": "com.amazonaws.geoplaces#OpeningHoursList", + "traits": { + "smithy.api#documentation": "List of opening hours objects.
" + } + }, + "AccessPoints": { + "target": "com.amazonaws.geoplaces#AccessPointList", + "traits": { + "smithy.api#documentation": "Position of the access point in (lng,lat).
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": { + "target": "com.amazonaws.geoplaces#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#PhonemeDetails", + "traits": { + "smithy.api#documentation": "How the various components of the result's address are pronounced in various\n languages.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geoplaces#Highlight": { + "type": "structure", + "members": { + "StartIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Start index of the highlight.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "EndIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "End index of the highlight.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The highlight's value.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Describes how parts of the result response match the input query.
" + } + }, + "com.amazonaws.geoplaces#HighlightList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#Highlight" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.geoplaces#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.geoplaces#IntersectionHighlightsList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#HighlightList" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#IntersectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#IntersectionStreet" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#IntersectionStreet": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.geoplaces#LanguageTag": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 35 + } + } + }, + "com.amazonaws.geoplaces#MatchScore": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.geoplaces#MatchScoreDetails": { + "type": "structure", + "members": { + "Overall": { + "target": "com.amazonaws.geoplaces#MatchScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
" + } + }, + "Components": { + "target": "com.amazonaws.geoplaces#ComponentMatchScores", + "traits": { + "smithy.api#documentation": "Indicates how well the component input matches the returned. It is equal to 1 if all\n input tokens are recognized and matched.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the match score.
" + } + }, + "com.amazonaws.geoplaces#MatchScoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#MatchScore" + } + }, + "com.amazonaws.geoplaces#OpeningHours": { + "type": "structure", + "members": { + "Display": { + "target": "com.amazonaws.geoplaces#OpeningHoursDisplayList", + "traits": { + "smithy.api#documentation": "List of opening hours in the format they are displayed in. This can vary by result and\n in most cases represents how the result uniquely formats their opening hours.
" + } + }, + "OpenNow": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean which indicates if the result/place is currently open.
" + } + }, + "Components": { + "target": "com.amazonaws.geoplaces#OpeningHoursComponentsList", + "traits": { + "smithy.api#documentation": "Components of the opening hours object.
" + } + }, + "Categories": { + "target": "com.amazonaws.geoplaces#CategoryList", + "traits": { + "smithy.api#documentation": "Categories of results that results must belong too.
" + } + } + }, + "traits": { + "smithy.api#documentation": "List of opening hours objects.
" + } + }, + "com.amazonaws.geoplaces#OpeningHoursComponents": { + "type": "structure", + "members": { + "OpenTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "String which represents the opening hours, such as \"T070000\".
String which represents the duration of the opening period, such as\n \"PT12H00M\".
Days or periods when the provided opening hours are in affect.
\nExample: FREQ:DAILY;BYDAY:MO,TU,WE,TH,SU\n
Components of the opening hours object.
" + } + }, + "com.amazonaws.geoplaces#OpeningHoursComponentsList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#OpeningHoursComponents" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#OpeningHoursDisplay": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.geoplaces#OpeningHoursDisplayList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#OpeningHoursDisplay" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#OpeningHoursList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#OpeningHours" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#PhonemeDetails": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.geoplaces#PhonemeTranscriptionList", + "traits": { + "smithy.api#documentation": "List of PhonemeTranscription. See PhonemeTranscription for\n fields.
How to pronounce the address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The phoneme details.
" + } + }, + "com.amazonaws.geoplaces#PhonemeTranscription": { + "type": "structure", + "members": { + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Value which indicates how to pronounce the value.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean which indicates if it the preferred pronunciation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "How to pronounce the various components of the address or place.
" + } + }, + "com.amazonaws.geoplaces#PhonemeTranscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#PhonemeTranscription" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#PlaceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "COUNTRY", + "value": "Country" + }, + { + "name": "REGION", + "value": "Region" + }, + { + "name": "SUB_REGION", + "value": "SubRegion" + }, + { + "name": "LOCALITY", + "value": "Locality" + }, + { + "name": "DISTRICT", + "value": "District" + }, + { + "name": "SUB_DISTRICT", + "value": "SubDistrict" + }, + { + "name": "POSTAL_CODE", + "value": "PostalCode" + }, + { + "name": "BLOCK", + "value": "Block" + }, + { + "name": "SUB_BLOCK", + "value": "SubBlock" + }, + { + "name": "INTERSECTION", + "value": "Intersection" + }, + { + "name": "STREET", + "value": "Street" + }, + { + "name": "POINT_OF_INTEREST", + "value": "PointOfInterest" + }, + { + "name": "POINT_ADDRESS", + "value": "PointAddress" + }, + { + "name": "INTERPOLATED_ADDRESS", + "value": "InterpolatedAddress" + } + ] + } + }, + "com.amazonaws.geoplaces#PlacesService": { + "type": "service", + "version": "2020-11-19", + "resources": [ + { + "target": "com.amazonaws.geoplaces#ProviderResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Geo Places", + "arnNamespace": "geo-places", + "cloudTrailEventSource": "geo-places.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "geo-places" + }, + "aws.endpoints#standardRegionalEndpoints": { + "partitionSpecialCases": { + "aws": [ + { + "endpoint": "https://places.geo.{region}.{dnsSuffix}/v2" + }, + { + "endpoint": "https://places.geo-fips.{region}.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://places.geo-fips.{region}.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://places.geo.{region}.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ], + "aws-us-gov": [ + { + "endpoint": "https://places.geo.{region}.us-gov.{dnsSuffix}/v2" + }, + { + "endpoint": "https://places.geo-fips.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://places.geo-fips.{region}.us-gov.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://places.geo.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ] + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "x-amz-content-sha256", + "x-amz-user-agent", + "content-type" + ] + }, + "smithy.api#documentation": "\n The Places API enables powerful location search and geocoding capabilities for your applications, offering global coverage with rich, detailed information. Key features include:\n
\nForward and reverse geocoding for addresses and coordinates
\nComprehensive place searches with detailed information, including:
\nBusiness names and addresses
\nContact information
\nHours of operation
\nPOI (Points of Interest) categories
\nFood types for restaurants
\nChain affiliation for relevant businesses
\nGlobal data coverage with a wide range of POI categories
\nRegular data updates to ensure accuracy and relevance
\nAn 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.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "PostalAuthority": { + "target": "com.amazonaws.geoplaces#PostalAuthority", + "traits": { + "smithy.api#documentation": "The postal authority or entity. This could be a governmental authority, a regulatory authority, or a designated postal operator.
" + } + }, + "PostalCodeType": { + "target": "com.amazonaws.geoplaces#PostalCodeType", + "traits": { + "smithy.api#documentation": "The postal code type.
" + } + }, + "UspsZip": { + "target": "com.amazonaws.geoplaces#UspsZip", + "traits": { + "smithy.api#documentation": "The ZIP Classification Code, or in other words what type of postal code is it.
" + } + }, + "UspsZipPlus4": { + "target": "com.amazonaws.geoplaces#UspsZipPlus4", + "traits": { + "smithy.api#documentation": "The USPS ZIP+4 Record Type Code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the postal code of the place or result.
" + } + }, + "com.amazonaws.geoplaces#PostalCodeDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#PostalCodeDetails" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#PostalCodeMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MERGE_ALL_SPANNED_LOCALITIES", + "value": "MergeAllSpannedLocalities" + }, + { + "name": "ENUMERATE_SPANNED_LOCALITIES", + "value": "EnumerateSpannedLocalities" + } + ] + } + }, + "com.amazonaws.geoplaces#PostalCodeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "USPS_ZIP", + "value": "UspsZip" + }, + { + "name": "USPS_ZIP_PLUS_4", + "value": "UspsZipPlus4" + } + ] + } + }, + "com.amazonaws.geoplaces#ProviderResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.geoplaces#Autocomplete" + }, + { + "target": "com.amazonaws.geoplaces#Geocode" + }, + { + "target": "com.amazonaws.geoplaces#GetPlace" + }, + { + "target": "com.amazonaws.geoplaces#ReverseGeocode" + }, + { + "target": "com.amazonaws.geoplaces#SearchNearby" + }, + { + "target": "com.amazonaws.geoplaces#SearchText" + }, + { + "target": "com.amazonaws.geoplaces#Suggest" + } + ] + }, + "com.amazonaws.geoplaces#QueryRefinement": { + "type": "structure", + "members": { + "RefinedTerm": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The term that will be suggested to the user.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "OriginalTerm": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The sub-string of the original query that is replaced by this query term.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "StartIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Start index of the parsed component.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "EndIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "End index of the parsed query.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Suggestions for refining individual query terms. Suggestions are returned as objects\n which note the term, suggested replacement, and its index in the query.
" + } + }, + "com.amazonaws.geoplaces#QueryRefinementList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#QueryRefinement" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.geoplaces#QueryType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CATEGORY", + "value": "Category" + }, + { + "name": "BUSINESS_CHAIN", + "value": "BusinessChain" + } + ] + } + }, + "com.amazonaws.geoplaces#RecordTypeCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "FIRM", + "value": "Firm" + }, + { + "name": "GENERAL", + "value": "General" + }, + { + "name": "HIGH_RISE", + "value": "HighRise" + }, + { + "name": "POST_OFFICE_BOX", + "value": "PostOfficeBox" + }, + { + "name": "RURAL", + "value": "Rural" + }, + { + "name": "STREET", + "value": "Street" + } + ] + } + }, + "com.amazonaws.geoplaces#Region": { + "type": "structure", + "members": { + "Code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Abbreviated code for a the state, province or region of the country.
\nExample: BC.
Name for a the state, province, or region of the country.
\nExample: British Columbia.
The region or state results should be to be present in.
\nExample: North Rhine-Westphalia.
Indicates the starting and ending index of the region in the text query that match the found title.
" + } + }, + "Name": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the region name in the text query that match the found title.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the region in the text query that match the found title.
" + } + }, + "com.amazonaws.geoplaces#ReverseGeocode": { + "type": "operation", + "input": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeRequest" + }, + "output": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geoplaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.geoplaces#InternalServerException" + }, + { + "target": "com.amazonaws.geoplaces#ThrottlingException" + }, + { + "target": "com.amazonaws.geoplaces#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": " The ReverseGeocode operation allows you to retrieve addresses and place\n information from coordinates.
The included place types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The included place types.
" + } + }, + "com.amazonaws.geoplaces#ReverseGeocodeFilterPlaceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LOCALITY", + "value": "Locality" + }, + { + "name": "INTERSECTION", + "value": "Intersection" + }, + { + "name": "STREET", + "value": "Street" + }, + { + "name": "POINT_ADDRESS", + "value": "PointAddress" + }, + { + "name": "INTERPOLATED_ADDRESS", + "value": "InterpolatedAddress" + } + ] + } + }, + "com.amazonaws.geoplaces#ReverseGeocodeFilterPlaceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeFilterPlaceType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.geoplaces#ReverseGeocodeIntendedUse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SINGLE_USE", + "value": "SingleUse", + "documentation": "Indicates that results of the operation are for single use, e.g., displaying results on a map or presenting options to users." + }, + { + "name": "STORAGE", + "value": "Storage", + "documentation": "Indicates that results of the operation may be stored locally." + } + ] + } + }, + "com.amazonaws.geoplaces#ReverseGeocodeRequest": { + "type": "structure", + "members": { + "QueryPosition": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#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
The maximum distance in meters from the QueryPosition from which a result will be returned.
", + "smithy.api#range": { + "min": 1, + "max": 21000000 + } + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "An optional limit for the number of results returned in a single call.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "Filter": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeFilter", + "traits": { + "smithy.api#documentation": "A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "AdditionalFeatures": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeAdditionalFeatureList", + "traits": { + "smithy.api#documentation": "A list of optional additional parameters, such as time zone that can be requested for\n each result.
" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#ReverseGeocodeResponse": { + "type": "structure", + "members": { + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "ResultItems": { + "target": "com.amazonaws.geoplaces#ReverseGeocodeResultItemList", + "traits": { + "smithy.api#documentation": "List of places or results returned for a query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geoplaces#ReverseGeocodeResultItem": { + "type": "structure", + "members": { + "PlaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The localized display name of this result item based on request parameter language.
The place's address.
" + } + }, + "AddressNumberCorrected": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean indicating if the address provided has been corrected.
" + } + }, + "PostalCodeDetails": { + "target": "com.amazonaws.geoplaces#PostalCodeDetailsList", + "traits": { + "smithy.api#documentation": "Contains details about the postal code of the place/result.
" + } + }, + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position in longitude and latitude.
" + } + }, + "Distance": { + "target": "com.amazonaws.geoplaces#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The distance in meters from the QueryPosition.
" + } + }, + "MapView": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
Categories of results that results must belong to.
" + } + }, + "FoodTypes": { + "target": "com.amazonaws.geoplaces#FoodTypeList", + "traits": { + "smithy.api#documentation": "List of food types offered by this result.
" + } + }, + "AccessPoints": { + "target": "com.amazonaws.geoplaces#AccessPointList", + "traits": { + "smithy.api#documentation": "Position of the access point represent by longitude and latitude.
" + } + }, + "TimeZone": { + "target": "com.amazonaws.geoplaces#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The returned location from the Reverse Geocode action.
Search nearby a specified location.
", + "smithy.api#http": { + "uri": "/search-nearby", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "SearchNearbySuccess", + "params": { + "QueryPosition": [ + 2.2945, + 48.85824 + ] + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.geoplaces#SearchNearbyAdditionalFeature": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "TIME_ZONE", + "value": "TimeZone" + }, + { + "name": "PHONEMES", + "value": "Phonemes" + }, + { + "name": "ACCESS", + "value": "Access" + }, + { + "name": "CONTACT", + "value": "Contact" + } + ] + } + }, + "com.amazonaws.geoplaces#SearchNearbyAdditionalFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#SearchNearbyAdditionalFeature" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.geoplaces#SearchNearbyFilter": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" + } + }, + "IncludeCategories": { + "target": "com.amazonaws.geoplaces#FilterCategoryList", + "traits": { + "smithy.api#documentation": "Categories of results that results must belong too.
" + } + }, + "ExcludeCategories": { + "target": "com.amazonaws.geoplaces#FilterCategoryList", + "traits": { + "smithy.api#documentation": "Categories of results that results are excluded from.
" + } + }, + "IncludeBusinessChains": { + "target": "com.amazonaws.geoplaces#FilterBusinessChainList", + "traits": { + "smithy.api#documentation": "The Business Chains associated with the place.
" + } + }, + "ExcludeBusinessChains": { + "target": "com.amazonaws.geoplaces#FilterBusinessChainList", + "traits": { + "smithy.api#documentation": "The Business Chains associated with the place.
" + } + }, + "IncludeFoodTypes": { + "target": "com.amazonaws.geoplaces#FilterFoodTypeList", + "traits": { + "smithy.api#documentation": "Food types that results are included from.
" + } + }, + "ExcludeFoodTypes": { + "target": "com.amazonaws.geoplaces#FilterFoodTypeList", + "traits": { + "smithy.api#documentation": "Food types that results are excluded from.
" + } + } + }, + "traits": { + "smithy.api#documentation": "SearchNearby structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "com.amazonaws.geoplaces#SearchNearbyIntendedUse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SINGLE_USE", + "value": "SingleUse", + "documentation": "Indicates that results of the operation are for single use, e.g., displaying results on a map or presenting options to users." + }, + { + "name": "STORAGE", + "value": "Storage", + "documentation": "Indicates that results of the operation may be stored locally." + } + ] + } + }, + "com.amazonaws.geoplaces#SearchNearbyRequest": { + "type": "structure", + "members": { + "QueryPosition": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#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
The maximum distance in meters from the QueryPosition from which a result will be returned.
", + "smithy.api#range": { + "min": 1, + "max": 21000000 + } + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "An optional limit for the number of results returned in a single call.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "Filter": { + "target": "com.amazonaws.geoplaces#SearchNearbyFilter", + "traits": { + "smithy.api#documentation": "A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "AdditionalFeatures": { + "target": "com.amazonaws.geoplaces#SearchNearbyAdditionalFeatureList", + "traits": { + "smithy.api#documentation": "A list of optional additional parameters, such as time zone, that can be requested for\n each result.
" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#SearchNearbyIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
If nextToken is returned, \n there are more results available. The value of nextToken is a unique pagination token for each page.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#SearchNearbyResponse": { + "type": "structure", + "members": { + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "ResultItems": { + "target": "com.amazonaws.geoplaces#SearchNearbyResultItemList", + "traits": { + "smithy.api#documentation": "List of places or results returned for a query.
" + } + }, + "NextToken": { + "target": "com.amazonaws.geoplaces#Token", + "traits": { + "smithy.api#documentation": "If nextToken is returned, \n there are more results available. The value of nextToken is a unique pagination token for each page.
The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The item's title.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#Address", + "traits": { + "smithy.api#documentation": "The place's address.
" + } + }, + "AddressNumberCorrected": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean indicating if the address provided has been corrected.
" + } + }, + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position in longitude and latitude.
" + } + }, + "Distance": { + "target": "com.amazonaws.geoplaces#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The distance in meters from the QueryPosition.
" + } + }, + "MapView": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
Categories of results that results must belong to.
" + } + }, + "FoodTypes": { + "target": "com.amazonaws.geoplaces#FoodTypeList", + "traits": { + "smithy.api#documentation": "List of food types offered by this result.
" + } + }, + "BusinessChains": { + "target": "com.amazonaws.geoplaces#BusinessChainList", + "traits": { + "smithy.api#documentation": "The Business Chains associated with the place.
" + } + }, + "Contacts": { + "target": "com.amazonaws.geoplaces#Contacts", + "traits": { + "smithy.api#documentation": "List of potential contact methods for the result/place.
" + } + }, + "OpeningHours": { + "target": "com.amazonaws.geoplaces#OpeningHoursList", + "traits": { + "smithy.api#documentation": "List of opening hours objects.
" + } + }, + "AccessPoints": { + "target": "com.amazonaws.geoplaces#AccessPointList", + "traits": { + "smithy.api#documentation": "Position of the access point represent by longitude and latitude.
" + } + }, + "AccessRestrictions": { + "target": "com.amazonaws.geoplaces#AccessRestrictionList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#PhonemeDetails", + "traits": { + "smithy.api#documentation": "How the various components of the result's address are pronounced in various\n languages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The search results of nearby places.
" + } + }, + "com.amazonaws.geoplaces#SearchNearbyResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#SearchNearbyResultItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#SearchText": { + "type": "operation", + "input": { + "target": "com.amazonaws.geoplaces#SearchTextRequest" + }, + "output": { + "target": "com.amazonaws.geoplaces#SearchTextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geoplaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.geoplaces#InternalServerException" + }, + { + "target": "com.amazonaws.geoplaces#ThrottlingException" + }, + { + "target": "com.amazonaws.geoplaces#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Use the SearchText operation to search for geocode and place information.\n You can then complete a follow-up query suggested from the Suggest API via a\n query id.
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "SearchText structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "com.amazonaws.geoplaces#SearchTextIntendedUse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SINGLE_USE", + "value": "SingleUse", + "documentation": "Indicates that results of the operation are for single use, e.g., displaying results on a map or presenting options to users." + }, + { + "name": "STORAGE", + "value": "Storage", + "documentation": "Indicates that results of the operation may be stored locally." + } + ] + } + }, + "com.amazonaws.geoplaces#SearchTextRequest": { + "type": "structure", + "members": { + "QueryText": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#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.
", + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "QueryId": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#documentation": "The query Id.
", + "smithy.api#length": { + "min": 1, + "max": 400 + } + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "An optional limit for the number of results returned in a single call.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "BiasPosition": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude, that the results should be close to. Typically,\n place results returned are ranked higher the closer they are to this position. Stored in\n [lng, lat] and in the WSG84 format.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "AdditionalFeatures": { + "target": "com.amazonaws.geoplaces#SearchTextAdditionalFeatureList", + "traits": { + "smithy.api#documentation": "A list of optional additional parameters, such as time zone, that can be requested for\n each result.
" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#SearchTextIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
If nextToken is returned, \n there are more results available. The value of nextToken is a unique pagination token for each page.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#SearchTextResponse": { + "type": "structure", + "members": { + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "ResultItems": { + "target": "com.amazonaws.geoplaces#SearchTextResultItemList", + "traits": { + "smithy.api#documentation": "List of places or results returned for a query.
" + } + }, + "NextToken": { + "target": "com.amazonaws.geoplaces#Token", + "traits": { + "smithy.api#documentation": "If nextToken is returned, \n there are more results available. The value of nextToken is a unique pagination token for each page.
The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The item's title.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#Address", + "traits": { + "smithy.api#documentation": "The place's address.
" + } + }, + "AddressNumberCorrected": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Boolean indicating if the address provided has been corrected.
" + } + }, + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude.
" + } + }, + "Distance": { + "target": "com.amazonaws.geoplaces#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The distance in meters from the QueryPosition.
" + } + }, + "MapView": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
Categories of results that results must belong to.
" + } + }, + "FoodTypes": { + "target": "com.amazonaws.geoplaces#FoodTypeList", + "traits": { + "smithy.api#documentation": "List of food types offered by this result.
" + } + }, + "BusinessChains": { + "target": "com.amazonaws.geoplaces#BusinessChainList", + "traits": { + "smithy.api#documentation": "The Business Chains associated with the place.
" + } + }, + "Contacts": { + "target": "com.amazonaws.geoplaces#Contacts", + "traits": { + "smithy.api#documentation": "List of potential contact methods for the result/place.
" + } + }, + "OpeningHours": { + "target": "com.amazonaws.geoplaces#OpeningHoursList", + "traits": { + "smithy.api#documentation": "List of opening hours objects.
" + } + }, + "AccessPoints": { + "target": "com.amazonaws.geoplaces#AccessPointList", + "traits": { + "smithy.api#documentation": "Position of the access point represent by longitude and latitude.
" + } + }, + "AccessRestrictions": { + "target": "com.amazonaws.geoplaces#AccessRestrictionList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#PhonemeDetails", + "traits": { + "smithy.api#documentation": "How the various components of the result's address are pronounced in various\n languages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The text search result.
" + } + }, + "com.amazonaws.geoplaces#SearchTextResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#SearchTextResultItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.geoplaces#StreetComponents": { + "type": "structure", + "members": { + "BaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Base name part of the street name.
\nExample: Younge from the “Younge street\".
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Street type part of the street name.
\nExample: “avenue\".
Defines if the street type is before or after the base name.
" + } + }, + "TypeSeparator": { + "target": "com.amazonaws.geoplaces#TypeSeparator", + "traits": { + "smithy.api#documentation": "What character(s) separates the string from its type.
" + } + }, + "Prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A prefix is a directional identifier that precedes, but is not included in, the base\n name of a road.
\nExample: E for East.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "Suffix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A suffix is a directional identifier that follows, but is not included in, the base name\n of a road.
\nExample W for West.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "Direction": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Indicates the official directional identifiers assigned to highways.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Components of a street.
" + } + }, + "com.amazonaws.geoplaces#StreetComponentsList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#StreetComponents" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#SubRegion": { + "type": "structure", + "members": { + "Code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Abbreviated code for the county or sub-region.
", + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name for the county or sub-region.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The sub-region.
" + } + }, + "com.amazonaws.geoplaces#SubRegionHighlights": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the sub-region in the text query that match\n the found title.
" + } + }, + "Name": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the name in the text query that match the found title.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the sub-region in the text query that match\n the found title.
" + } + }, + "com.amazonaws.geoplaces#Suggest": { + "type": "operation", + "input": { + "target": "com.amazonaws.geoplaces#SuggestRequest" + }, + "output": { + "target": "com.amazonaws.geoplaces#SuggestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.geoplaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.geoplaces#InternalServerException" + }, + { + "target": "com.amazonaws.geoplaces#ThrottlingException" + }, + { + "target": "com.amazonaws.geoplaces#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "The Suggest operation finds addresses or place candidates based on\n incomplete or misspelled queries. You then select the best query to submit based on the\n returned results.
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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.
" + } + }, + "com.amazonaws.geoplaces#SuggestFilter": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "SuggestFilter structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "com.amazonaws.geoplaces#SuggestHighlights": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.geoplaces#HighlightList", + "traits": { + "smithy.api#documentation": "Indicates the starting and ending index of the title in the text query that match the found title.
" + } + }, + "Address": { + "target": "com.amazonaws.geoplaces#SuggestAddressHighlights", + "traits": { + "smithy.api#documentation": "The place's address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes how the parts of the textQuery matched the input query by returning the sections of the response which matched to textQuery terms.
" + } + }, + "com.amazonaws.geoplaces#SuggestIntendedUse": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SINGLE_USE", + "value": "SingleUse", + "documentation": "Indicates that results of the operation are for single use, e.g., displaying results on a map or presenting options to users." + } + ] + } + }, + "com.amazonaws.geoplaces#SuggestPlaceResult": { + "type": "structure", + "members": { + "PlaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The PlaceId of the place you wish to receive the information for.
A PlaceType is a category that the result place must belong to.
The place's address.
" + } + }, + "Position": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude.
" + } + }, + "Distance": { + "target": "com.amazonaws.geoplaces#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The distance in meters from the QueryPosition.
" + } + }, + "MapView": { + "target": "com.amazonaws.geoplaces#BoundingBox", + "traits": { + "smithy.api#documentation": "The bounding box enclosing the geometric shape (area or line) that an individual result covers.
\nThe bounding box formed is defined as a set 4 coordinates: [{westward lng},\n {southern lat}, {eastward lng}, {northern lat}]\n
Categories of results that results must belong to.
" + } + }, + "FoodTypes": { + "target": "com.amazonaws.geoplaces#FoodTypeList", + "traits": { + "smithy.api#documentation": "List of food types offered by this result.
" + } + }, + "BusinessChains": { + "target": "com.amazonaws.geoplaces#BusinessChainList", + "traits": { + "smithy.api#documentation": "The Business Chains associated with the place.
" + } + }, + "AccessPoints": { + "target": "com.amazonaws.geoplaces#AccessPointList", + "traits": { + "smithy.api#documentation": "Position of the access point represent by longitude and latitude.
" + } + }, + "AccessRestrictions": { + "target": "com.amazonaws.geoplaces#AccessRestrictionList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#TimeZone", + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "PoliticalView": { + "target": "com.amazonaws.geoplaces#CountryCode3", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#PhonemeDetails", + "traits": { + "smithy.api#documentation": "How the various components of the result's address are pronounced in various\n languages.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The suggested place results.
" + } + }, + "com.amazonaws.geoplaces#SuggestQueryResult": { + "type": "structure", + "members": { + "QueryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#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.
", + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "QueryType": { + "target": "com.amazonaws.geoplaces#QueryType", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The suggested query results.
" + } + }, + "com.amazonaws.geoplaces#SuggestRequest": { + "type": "structure", + "members": { + "QueryText": { + "target": "com.amazonaws.geoplaces#SensitiveString", + "traits": { + "smithy.api#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.
", + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "An optional limit for the number of results returned in a single call.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "MaxQueryRefinements": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum number of query terms to be returned for use with a search text query.
", + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "BiasPosition": { + "target": "com.amazonaws.geoplaces#Position", + "traits": { + "smithy.api#documentation": "The position, in longitude and latitude, that the results should be close to. Typically,\n place results returned are ranked higher the closer they are to this position. Stored in\n [lng, lat] and in the WSG84 format.
The fields BiasPosition, FilterBoundingBox, and FilterCircle are mutually exclusive.
A structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.
" + } + }, + "AdditionalFeatures": { + "target": "com.amazonaws.geoplaces#SuggestAdditionalFeatureList", + "traits": { + "smithy.api#documentation": "A list of optional additional parameters, such as time zone, that can be requested for\n each result.
" + } + }, + "Language": { + "target": "com.amazonaws.geoplaces#LanguageTag", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#CountryCode", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.geoplaces#SuggestIntendedUse", + "traits": { + "smithy.api#documentation": "Indicates if the results will be stored. Defaults to SingleUse, if left empty.
Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.geoplaces#SuggestResponse": { + "type": "structure", + "members": { + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
\nFor more inforamtion on pricing, please visit Amazon Location Service Pricing.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "ResultItems": { + "target": "com.amazonaws.geoplaces#SuggestResultItemList", + "traits": { + "smithy.api#documentation": "List of places or results returned for a query.
" + } + }, + "QueryRefinements": { + "target": "com.amazonaws.geoplaces#QueryRefinementList", + "traits": { + "smithy.api#documentation": "Maximum number of query terms to be returned for use with a search text query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.geoplaces#SuggestResultItem": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The display title that should be used when presenting this option to the end user.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "SuggestResultItemType": { + "target": "com.amazonaws.geoplaces#SuggestResultItemType", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + }, + "Place": { + "target": "com.amazonaws.geoplaces#SuggestPlaceResult", + "traits": { + "smithy.api#documentation": "The suggested place by its unique ID.
" + } + }, + "Query": { + "target": "com.amazonaws.geoplaces#SuggestQueryResult" + }, + "Highlights": { + "target": "com.amazonaws.geoplaces#SuggestHighlights", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resulting item from the suggested query.
" + } + }, + "com.amazonaws.geoplaces#SuggestResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#SuggestResultItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.geoplaces#SuggestResultItemType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "PLACE", + "value": "Place" + }, + { + "name": "QUERY", + "value": "Query" + } + ] + } + }, + "com.amazonaws.geoplaces#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.geoplaces#TimeZone": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The time zone name.
", + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#required": {} + } + }, + "Offset": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Time zone offset of the timezone from UTC.
", + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "OffsetSeconds": { + "target": "com.amazonaws.geoplaces#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The offset of the time zone from UTC, in seconds.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The time zone in which the place is located.
" + } + }, + "com.amazonaws.geoplaces#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.geoplaces#TypePlacement": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "BEFORE_BASE_NAME", + "value": "BeforeBaseName" + }, + { + "name": "AFTER_BASE_NAME", + "value": "AfterBaseName" + } + ] + } + }, + "com.amazonaws.geoplaces#TypeSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + }, + "smithy.api#pattern": "^$|^ $" + } + }, + "com.amazonaws.geoplaces#UspsZip": { + "type": "structure", + "members": { + "ZipClassificationCode": { + "target": "com.amazonaws.geoplaces#ZipClassificationCode", + "traits": { + "smithy.api#documentation": "The ZIP Classification Code, or in other words what type of postal code is it.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The USPS zip code.
" + } + }, + "com.amazonaws.geoplaces#UspsZipPlus4": { + "type": "structure", + "members": { + "RecordTypeCode": { + "target": "com.amazonaws.geoplaces#RecordTypeCode", + "traits": { + "smithy.api#documentation": "The USPS ZIP+4 Record Type Code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The USPS zip+4 code.
" + } + }, + "com.amazonaws.geoplaces#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.geoplaces#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Test stub for reason
", + "smithy.api#jsonName": "reason", + "smithy.api#required": {} + } + }, + "FieldList": { + "target": "com.amazonaws.geoplaces#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "Test stub for FieldList.
", + "smithy.api#jsonName": "fieldList", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.geoplaces#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the Amazon Location service.
" + } + }, + "com.amazonaws.geoplaces#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.geoplaces#ValidationExceptionField" + } + }, + "com.amazonaws.geoplaces#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "UNKNOWN_OPERATION", + "value": "UnknownOperation", + "documentation": "No such operation is supported." + }, + { + "name": "MISSING", + "value": "Missing", + "documentation": "The required input is missing." + }, + { + "name": "CANNOT_PARSE", + "value": "CannotParse", + "documentation": " The input cannot be parsed. For example a required JSON document, ARN identifier,\n date value, or numeric field cannot be parsed.\n" + }, + { + "name": "FIELD_VALIDATION_FAILED", + "value": "FieldValidationFailed", + "documentation": " The input is present and parsable, but it is otherwise invalid. For example, a\n required numeric argument is outside the allowed range.\n" + }, + { + "name": "OTHER", + "value": "Other", + "documentation": "The input is invalid but no more specific reason is applicable." + }, + { + "name": "UNKNOWN_FIELD", + "value": "UnknownField", + "documentation": "No such field is supported." + } + ] + } + }, + "com.amazonaws.geoplaces#ZipClassificationCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MILITARY", + "value": "Military" + }, + { + "name": "POST_OFFICE_BOXES", + "value": "PostOfficeBoxes" + }, + { + "name": "UNIQUE", + "value": "Unique" + } + ] + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/geo-routes.json b/codegen/sdk-codegen/aws-models/geo-routes.json new file mode 100644 index 00000000000..aa9c2cf304e --- /dev/null +++ b/codegen/sdk-codegen/aws-models/geo-routes.json @@ -0,0 +1,11353 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.georoutes#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.georoutes#ApiKey": { + "type": "string", + "traits": { + "smithy.api#externalDocumentation": { + "Implementation Guide": "https://github.com/paseto-standard/paseto-spec/blob/master/docs/02-Implementation-Guide/03-Algorithm-Lucidity.md" + }, + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#BeforeWaypointsList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointIndex" + } + }, + "com.amazonaws.georoutes#BoundingBox": { + "type": "list", + "member": { + "target": "smithy.api#Double" + }, + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-5" + }, + "smithy.api#length": { + "min": 4, + "max": 4 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#CalculateIsolines": { + "type": "operation", + "input": { + "target": "com.amazonaws.georoutes#CalculateIsolinesRequest" + }, + "output": { + "target": "com.amazonaws.georoutes#CalculateIsolinesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.georoutes#AccessDeniedException" + }, + { + "target": "com.amazonaws.georoutes#InternalServerException" + }, + { + "target": "com.amazonaws.georoutes#ThrottlingException" + }, + { + "target": "com.amazonaws.georoutes#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Use the CalculateIsolines action to find service areas that can be reached\n in a given threshold of time, distance.
Features that are allowed while calculating. a route
" + } + }, + "ArrivalTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Time of arrival at the destination.
\nTime format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an\n avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.
" + } + }, + "DepartNow": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Uses the current time as the time of departure.
" + } + }, + "DepartureTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Time of departure from thr origin.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
Destination related options.
" + } + }, + "IsolineGeometryFormat": { + "target": "com.amazonaws.georoutes#GeometryFormat", + "traits": { + "smithy.api#documentation": "The format of the returned IsolineGeometry.
\nDefault Value:FlexiblePolyline\n
Defines the granularity of the returned Isoline
" + } + }, + "Key": { + "target": "com.amazonaws.georoutes#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "OptimizeIsolineFor": { + "target": "com.amazonaws.georoutes#IsolineOptimizationObjective", + "traits": { + "smithy.api#documentation": "Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. \nFastCalculation 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. \n
\nDefault Value: BalancedCalculation\n
Specifies the optimization criteria for calculating a route.
\nDefault Value: FastestRoute\n
The start position for the route.
" + } + }, + "OriginOptions": { + "target": "com.amazonaws.georoutes#IsolineOriginOptions", + "traits": { + "smithy.api#documentation": "Origin related options.
" + } + }, + "Thresholds": { + "target": "com.amazonaws.georoutes#IsolineThresholds", + "traits": { + "smithy.api#documentation": "Threshold to be used for the isoline calculation. Up to \n 3 thresholds per provided type can be requested.
", + "smithy.api#required": {} + } + }, + "Traffic": { + "target": "com.amazonaws.georoutes#IsolineTrafficOptions", + "traits": { + "smithy.api#documentation": "Traffic related options.
" + } + }, + "TravelMode": { + "target": "com.amazonaws.georoutes#IsolineTravelMode", + "traits": { + "smithy.api#documentation": "Specifies the mode of transport when calculating a route. \n Used in estimating the speed of travel and road compatibility.
\n The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.
Default Value: Car\n
Travel mode related options for the provided travel mode.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.georoutes#CalculateIsolinesResponse": { + "type": "structure", + "members": { + "ArrivalTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Time of arrival at the destination. This parameter is returned only if the Destination parameters was provided in the request.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
Time of departure from thr origin.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
The format of the returned IsolineGeometry.
\nDefault Value:FlexiblePolyline\n
Calculated isolines and associated properties.
", + "smithy.api#required": {} + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "SnappedDestination": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Snapped destination that was used for the Isoline calculation.
" + } + }, + "SnappedOrigin": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Snapped origin that was used for the Isoline calculation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.georoutes#CalculateRouteMatrix": { + "type": "operation", + "input": { + "target": "com.amazonaws.georoutes#CalculateRouteMatrixRequest" + }, + "output": { + "target": "com.amazonaws.georoutes#CalculateRouteMatrixResponse" + }, + "errors": [ + { + "target": "com.amazonaws.georoutes#AccessDeniedException" + }, + { + "target": "com.amazonaws.georoutes#InternalServerException" + }, + { + "target": "com.amazonaws.georoutes#ThrottlingException" + }, + { + "target": "com.amazonaws.georoutes#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Calculates route matrix containing the results for all pairs of \n Origins to Destinations. Each row corresponds to one entry in Origins. \n Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.
", + "smithy.api#http": { + "uri": "/route-matrix", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "CalculateRouteMatrixSuccess", + "params": { + "Origins": [ + { + "Position": [ + -123.11679, + 49.28147 + ] + } + ], + "Destinations": [ + { + "Position": [ + -123.11231, + 49.28897192166 + ] + } + ], + "RoutingBoundary": { + "Unbounded": true + } + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.georoutes#CalculateRouteMatrixRequest": { + "type": "structure", + "members": { + "Allow": { + "target": "com.amazonaws.georoutes#RouteMatrixAllowOptions", + "traits": { + "smithy.api#documentation": "Features that are allowed while calculating. a route
" + } + }, + "Avoid": { + "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceOptions", + "traits": { + "smithy.api#documentation": "Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an\n avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.
" + } + }, + "DepartNow": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Uses the current time as the time of departure.
" + } + }, + "DepartureTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Time of departure from thr origin.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
List of destinations for the route.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "Exclude": { + "target": "com.amazonaws.georoutes#RouteMatrixExclusionOptions", + "traits": { + "smithy.api#documentation": "Features to be strictly excluded while calculating the route.
" + } + }, + "Key": { + "target": "com.amazonaws.georoutes#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "OptimizeRoutingFor": { + "target": "com.amazonaws.georoutes#RoutingObjective", + "traits": { + "smithy.api#documentation": "Specifies the optimization criteria for calculating a route.
\nDefault Value: FastestRoute\n
The position in longitude and latitude for the origin.
", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "RoutingBoundary": { + "target": "com.amazonaws.georoutes#RouteMatrixBoundary", + "traits": { + "smithy.api#documentation": "Boundary within which the matrix is to be calculated. \n All data, origins and destinations outside the boundary are considered invalid.
\nWhen request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
\nTraffic related options.
" + } + }, + "TravelMode": { + "target": "com.amazonaws.georoutes#RouteMatrixTravelMode", + "traits": { + "smithy.api#documentation": "Specifies the mode of transport when calculating a route. \n Used in estimating the speed of travel and road compatibility.
\nDefault Value: Car\n
Travel mode related options for the provided travel mode.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.georoutes#CalculateRouteMatrixResponse": { + "type": "structure", + "members": { + "ErrorCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "RouteMatrix": { + "target": "com.amazonaws.georoutes#RouteMatrix", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + }, + "RoutingBoundary": { + "target": "com.amazonaws.georoutes#RouteMatrixBoundary", + "traits": { + "smithy.api#documentation": "Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
\nWhen request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.
\nCalculates a route given the following required parameters: \n Origin and Destination.
Features that are allowed while calculating. a route
" + } + }, + "ArrivalTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Time of arrival at the destination.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an\n avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.
" + } + }, + "DepartNow": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Uses the current time as the time of departure.
" + } + }, + "DepartureTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Time of departure from thr origin.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].
Destination related options.
" + } + }, + "Driver": { + "target": "com.amazonaws.georoutes#RouteDriverOptions", + "traits": { + "smithy.api#documentation": "Driver related options.
" + } + }, + "Exclude": { + "target": "com.amazonaws.georoutes#RouteExclusionOptions", + "traits": { + "smithy.api#documentation": "Features to be strictly excluded while calculating the route.
" + } + }, + "InstructionsMeasurementSystem": { + "target": "com.amazonaws.georoutes#MeasurementSystem", + "traits": { + "smithy.api#documentation": "Measurement system to be used for instructions within steps in the response.
" + } + }, + "Key": { + "target": "com.amazonaws.georoutes#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "Languages": { + "target": "com.amazonaws.georoutes#LanguageTagList", + "traits": { + "smithy.api#documentation": "List of languages for instructions within steps in the response.
\nInstructions in the requested language are returned only if they are available.
\nA list of optional additional parameters such as timezone that can be requested for each result.
\n\n Elevation: Retrieves the elevation information for each location.
\n Incidents: Provides information on traffic incidents along the route.
\n PassThroughWaypoints: Indicates waypoints that are passed through without stopping.
\n Summary: Returns a summary of the route, including distance and duration.
\n Tolls: Supplies toll cost information along the route.
\n TravelStepInstructions: Provides step-by-step instructions for travel along the route.
\n TruckRoadTypes: Returns information about road types suitable for trucks.
\n TypicalDuration: Gives typical travel duration based on historical data.
\n Zones: Specifies the time zone information for each waypoint.
Specifies the format of the geometry returned for each leg of the route. You can \n choose between two different geometry encoding formats.
\n\n FlexiblePolyline: A compact and precise encoding format for the \n leg geometry. For more information on the format, see the GitHub repository for \n FlexiblePolyline\n .
\n Simple: A less compact encoding,\n which is easier to decode but may be less precise and result in larger payloads.
Maximum number of alternative routes to be provided in the response, if available.
", + "smithy.api#range": { + "min": 0, + "max": 5 + } + } + }, + "OptimizeRoutingFor": { + "target": "com.amazonaws.georoutes#RoutingObjective", + "traits": { + "smithy.api#documentation": "Specifies the optimization criteria for calculating a route.
\nDefault Value: FastestRoute\n
The start position for the route.
", + "smithy.api#required": {} + } + }, + "OriginOptions": { + "target": "com.amazonaws.georoutes#RouteOriginOptions", + "traits": { + "smithy.api#documentation": "Origin related options.
" + } + }, + "SpanAdditionalFeatures": { + "target": "com.amazonaws.georoutes#RouteSpanAdditionalFeatureList", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.georoutes#RouteTollOptions", + "traits": { + "smithy.api#documentation": "Toll related options.
" + } + }, + "Traffic": { + "target": "com.amazonaws.georoutes#RouteTrafficOptions", + "traits": { + "smithy.api#documentation": "Traffic related options.
" + } + }, + "TravelMode": { + "target": "com.amazonaws.georoutes#RouteTravelMode", + "traits": { + "smithy.api#documentation": "Specifies the mode of transport when calculating a route. \n Used in estimating the speed of travel and road compatibility.
\nDefault Value: Car\n
Travel mode related options for the provided travel mode.
" + } + }, + "TravelStepType": { + "target": "com.amazonaws.georoutes#RouteTravelStepType", + "traits": { + "smithy.api#documentation": "Type of step returned by the response.\nDefault provides basic steps intended for web based applications.\nTurnByTurn provides detailed instructions with more granularity intended for a turn based naviagtion system.
" + } + }, + "Waypoints": { + "target": "com.amazonaws.georoutes#RouteWaypointList", + "traits": { + "smithy.api#documentation": "List of waypoints between the Origin and Destination.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.georoutes#CalculateRoutesResponse": { + "type": "structure", + "members": { + "LegGeometryFormat": { + "target": "com.amazonaws.georoutes#GeometryFormat", + "traits": { + "smithy.api#documentation": "Specifies the format of the geometry returned for each leg of the route.
", + "smithy.api#required": {} + } + }, + "Notices": { + "target": "com.amazonaws.georoutes#RouteResponseNoticeList", + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
", + "smithy.api#required": {} + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "Routes": { + "target": "com.amazonaws.georoutes#RouteList", + "traits": { + "smithy.api#documentation": "The path from the origin to the destination.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.georoutes#Circle": { + "type": "structure", + "members": { + "Center": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Center of the Circle defined in longitude and latitude coordinates.
\nExample: [-123.1174, 49.2847] represents the position with longitude -123.1174 and latitude 49.2847.
Radius of the Circle.
\n\n Unit: meters\n
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.
An ordered list of positions used to plot a route on a map.
\nLineString and Polyline are mutually exclusive properties.
\nRadius that defines the width of the corridor.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + }, + "smithy.api#pattern": "^([A-Z]{2}|[A-Z]{3})$" + } + }, + "com.amazonaws.georoutes#CountryCode3": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + }, + "smithy.api#pattern": "^[A-Z]{3}$" + } + }, + "com.amazonaws.georoutes#CountryCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#CountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#CurrencyCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + }, + "smithy.api#pattern": "^[A-Z]{3}$" + } + }, + "com.amazonaws.georoutes#DayOfWeek": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MONDAY", + "value": "Monday" + }, + { + "name": "TUESDAY", + "value": "Tuesday" + }, + { + "name": "WEDNESDAY", + "value": "Wednesday" + }, + { + "name": "THURSDAY", + "value": "Thursday" + }, + { + "name": "FRIDAY", + "value": "Friday" + }, + { + "name": "SATURDAY", + "value": "Saturday" + }, + { + "name": "SUNDAY", + "value": "Sunday" + } + ] + } + }, + "com.amazonaws.georoutes#DimensionCentimeters": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.georoutes#DistanceMeters": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.georoutes#DistanceThresholdList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 300000 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.georoutes#DurationSeconds": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.georoutes#GeometryFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "FLEXIBLE_POLYLINE", + "value": "FlexiblePolyline" + }, + { + "name": "SIMPLE", + "value": "Simple" + } + ] + } + }, + "com.amazonaws.georoutes#Heading": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0.0, + "max": 360.0 + } + } + }, + "com.amazonaws.georoutes#IndexList": { + "type": "list", + "member": { + "target": "smithy.api#Integer" + } + }, + "com.amazonaws.georoutes#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.georoutes#Isoline": { + "type": "structure", + "members": { + "Connections": { + "target": "com.amazonaws.georoutes#IsolineConnectionList", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + }, + "DistanceThreshold": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance threshold corresponding to the calculated Isoline.
" + } + }, + "Geometries": { + "target": "com.amazonaws.georoutes#IsolineShapeGeometryList", + "traits": { + "smithy.api#documentation": "Geometries for the Calculated isolines.
", + "smithy.api#required": {} + } + }, + "TimeThreshold": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Time threshold corresponding to the calculated isoline.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Calculated isolines and associated properties.
" + } + }, + "com.amazonaws.georoutes#IsolineAllowOptions": { + "type": "structure", + "members": { + "Hot": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allow Hot (High Occupancy Toll) lanes while calculating the route.
" + } + }, + "Hov": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allow Hov (High Occupancy vehicle) lanes while calculating the route.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Features that are allowed while calculating. a route
" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceArea": { + "type": "structure", + "members": { + "Except": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceAreaGeometryList", + "traits": { + "smithy.api#documentation": "Exceptions to the provided avoidance geometry, to be included while calculating the route.
" + } + }, + "Geometry": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceAreaGeometry", + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The area to be avoided.
" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceAreaGeometry": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.georoutes#BoundingBox", + "traits": { + "smithy.api#documentation": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.
" + } + }, + "Corridor": { + "target": "com.amazonaws.georoutes#Corridor", + "traits": { + "smithy.api#documentation": "Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
" + } + }, + "Polygon": { + "target": "com.amazonaws.georoutes#LinearRings", + "traits": { + "smithy.api#documentation": "A list of Polygon will be excluded for calculating isolines, the list can only contain 1 polygon.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "PolylineCorridor": { + "target": "com.amazonaws.georoutes#PolylineCorridor", + "traits": { + "smithy.api#documentation": "Geometry defined as an encoded corridor – a polyline with a radius that defines the width of the corridor. For more information on polyline \nencoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
" + } + }, + "PolylinePolygon": { + "target": "com.amazonaws.georoutes#PolylineRingList", + "traits": { + "smithy.api#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. \n
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The avoidance geometry, to be included while calculating the route.
" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceAreaGeometryList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceAreaGeometry" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceAreaList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceArea" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceOptions": { + "type": "structure", + "members": { + "Areas": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceAreaList", + "traits": { + "smithy.api#documentation": "Areas to be avoided.
" + } + }, + "CarShuttleTrains": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid car-shuttle-trains while calculating the route.
" + } + }, + "ControlledAccessHighways": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid controlled access highways while calculating the route.
" + } + }, + "DirtRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid dirt roads while calculating the route.
" + } + }, + "Ferries": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid ferries while calculating the route.
" + } + }, + "SeasonalClosure": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid roads that have seasonal closure while calculating the route.
" + } + }, + "TollRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "TollTransponders": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "TruckRoadTypes": { + "target": "com.amazonaws.georoutes#TruckRoadTypeList", + "traits": { + "smithy.api#documentation": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. \nA2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
\nAvoid tunnels while calculating the route.
" + } + }, + "UTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + }, + "ZoneCategories": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceZoneCategoryList", + "traits": { + "smithy.api#documentation": "Zone categories to be avoided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an\n avoidance can't be satisfied for a particular case, it violates the avoidance and the\n returned response produces a notice for the violation.
" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceZoneCategory": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.georoutes#IsolineZoneCategory", + "traits": { + "smithy.api#documentation": "Zone category to be avoided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Zone category to be avoided.
" + } + }, + "com.amazonaws.georoutes#IsolineAvoidanceZoneCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#IsolineAvoidanceZoneCategory" + }, + "traits": { + "smithy.api#length": { + "max": 3 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#IsolineCarOptions": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.georoutes#IsolineEngineType", + "traits": { + "smithy.api#documentation": "Engine type of the vehicle.
" + } + }, + "LicensePlate": { + "target": "com.amazonaws.georoutes#IsolineVehicleLicensePlate", + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed.
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Options for vehicles.
" + } + }, + "com.amazonaws.georoutes#IsolineConnection": { + "type": "structure", + "members": { + "FromPolygonIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Index of the polygon corresponding to the \"from\" component of the connection. The polygon is available from Isoline[].Geometries.
The isoline geometry.
", + "smithy.api#required": {} + } + }, + "ToPolygonIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Index of the polygon corresponding to the \"to\" component of the connection. The polygon is available from Isoline[].Geometries.
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.
" + } + }, + "com.amazonaws.georoutes#IsolineConnectionGeometry": { + "type": "structure", + "members": { + "LineString": { + "target": "com.amazonaws.georoutes#LineString", + "traits": { + "smithy.api#documentation": "An ordered list of positions used to plot a route on a map.
\nLineString and Polyline are mutually exclusive properties.
\nAn ordered list of positions used to plot a route on a map in a lossy compression format.
\nLineString and Polyline are mutually exclusive properties.
\nGeometry of the connection between different Isoline components.
" + } + }, + "com.amazonaws.georoutes#IsolineConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#IsolineConnection" + } + }, + "com.amazonaws.georoutes#IsolineDestinationOptions": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#IsolineMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "SideOfStreet": { + "target": "com.amazonaws.georoutes#IsolineSideOfStreetOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Destination related options.
" + } + }, + "com.amazonaws.georoutes#IsolineEngineType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ELECTRIC", + "value": "Electric" + }, + { + "name": "INTERNAL_COMBUSTION", + "value": "InternalCombustion" + }, + { + "name": "PLUGIN_HYBRID", + "value": "PluginHybrid" + } + ] + } + }, + "com.amazonaws.georoutes#IsolineGranularityOptions": { + "type": "structure", + "members": { + "MaxPoints": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum number of points of returned Isoline.
", + "smithy.api#range": { + "min": 31 + } + } + }, + "MaxResolution": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Maximum resolution of the returned isoline.
\n\n Unit: centimeters\n
Isoline granularity related options.
" + } + }, + "com.amazonaws.georoutes#IsolineHazardousCargoType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "COMBUSTIBLE", + "value": "Combustible" + }, + { + "name": "CORROSIVE", + "value": "Corrosive" + }, + { + "name": "EXPLOSIVE", + "value": "Explosive" + }, + { + "name": "FLAMMABLE", + "value": "Flammable" + }, + { + "name": "GAS", + "value": "Gas" + }, + { + "name": "HARMFUL_TO_WATER", + "value": "HarmfulToWater" + }, + { + "name": "ORGANIC", + "value": "Organic" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "POISON", + "value": "Poison" + }, + { + "name": "POISONOUS_INHALATION", + "value": "PoisonousInhalation" + }, + { + "name": "RADIOACTIVE", + "value": "Radioactive" + } + ] + } + }, + "com.amazonaws.georoutes#IsolineHazardousCargoTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#IsolineHazardousCargoType" + }, + "traits": { + "smithy.api#length": { + "max": 11 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#IsolineList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#Isoline" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.georoutes#IsolineMatchingOptions": { + "type": "structure", + "members": { + "NameHint": { + "target": "com.amazonaws.georoutes#SensitiveString", + "traits": { + "smithy.api#documentation": "Attempts to match the provided position to a road similar to the provided name.
" + } + }, + "OnRoadThreshold": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
\n\n Unit: meters\n
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
\n\n Unit: Meters\n
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Isoline matching related options.
" + } + }, + "com.amazonaws.georoutes#IsolineOptimizationObjective": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCURATE_CALCULATION", + "value": "AccurateCalculation" + }, + { + "name": "BALANCED_CALCULATION", + "value": "BalancedCalculation" + }, + { + "name": "FAST_CALCULATION", + "value": "FastCalculation" + } + ] + } + }, + "com.amazonaws.georoutes#IsolineOriginOptions": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#IsolineMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "SideOfStreet": { + "target": "com.amazonaws.georoutes#IsolineSideOfStreetOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options for the property.
" + } + }, + "com.amazonaws.georoutes#IsolineScooterOptions": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.georoutes#IsolineEngineType", + "traits": { + "smithy.api#documentation": "Engine type of the vehicle.
" + } + }, + "LicensePlate": { + "target": "com.amazonaws.georoutes#IsolineVehicleLicensePlate", + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed specified.
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Options for the property.
" + } + }, + "com.amazonaws.georoutes#IsolineShapeGeometry": { + "type": "structure", + "members": { + "Polygon": { + "target": "com.amazonaws.georoutes#LinearRings", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.georoutes#PolylineRingList", + "traits": { + "smithy.api#documentation": "A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon \n of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). \n For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Geometry of the connection between different Isoline components.
" + } + }, + "com.amazonaws.georoutes#IsolineShapeGeometryList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#IsolineShapeGeometry" + } + }, + "com.amazonaws.georoutes#IsolineSideOfStreetOptions": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
\nDefault Value: DividedStreetOnly\n
Options to configure matching the provided position to a side of the street.
" + } + }, + "com.amazonaws.georoutes#IsolineThresholds": { + "type": "structure", + "members": { + "Distance": { + "target": "com.amazonaws.georoutes#DistanceThresholdList", + "traits": { + "smithy.api#documentation": "Distance to be used for the isoline calculation.
" + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimeThresholdList", + "traits": { + "smithy.api#documentation": "Time to be used for the isoline calculation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type\n can be requested.
" + } + }, + "com.amazonaws.georoutes#IsolineTrafficOptions": { + "type": "structure", + "members": { + "FlowEventThresholdOverride": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.
\n\n Unit: seconds\n
Determines if traffic should be used or ignored while calculating the route.
\nDefault Value: UseTrafficData\n
Options related to traffic.
" + } + }, + "com.amazonaws.georoutes#IsolineTrailerOptions": { + "type": "structure", + "members": { + "AxleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Total number of axles of the vehicle.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "TrailerCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Number of trailers attached to the vehicle.
\nDefault Value: 0\n
Trailer options corresponding to the vehicle.
" + } + }, + "com.amazonaws.georoutes#IsolineTravelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAR", + "value": "Car" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "SCOOTER", + "value": "Scooter" + }, + { + "name": "TRUCK", + "value": "Truck" + } + ] + } + }, + "com.amazonaws.georoutes#IsolineTravelModeOptions": { + "type": "structure", + "members": { + "Car": { + "target": "com.amazonaws.georoutes#IsolineCarOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Car\"
" + } + }, + "Scooter": { + "target": "com.amazonaws.georoutes#IsolineScooterOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Scooter\"
" + } + }, + "Truck": { + "target": "com.amazonaws.georoutes#IsolineTruckOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Truck\"
" + } + } + }, + "traits": { + "smithy.api#documentation": "Travel mode related options for the provided travel mode.
" + } + }, + "com.amazonaws.georoutes#IsolineTruckOptions": { + "type": "structure", + "members": { + "AxleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Total number of axles of the vehicle.
", + "smithy.api#range": { + "min": 2, + "max": 255 + } + } + }, + "EngineType": { + "target": "com.amazonaws.georoutes#IsolineEngineType", + "traits": { + "smithy.api#documentation": "Engine type of the vehicle.
" + } + }, + "GrossWeight": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Gross weight of the vehicle including trailers, and goods at capacity.
\n\n Unit: Kilograms\n
List of Hazardous cargo contained in the vehicle.
" + } + }, + "Height": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Height of the vehicle.
\n\n Unit: centimeters\n
Height of the vehicle above its first axle.
\n\n Unit: centimeters\n
Kingpin to rear axle length of the vehicle.
\n\n Unit: centimeters\n
Length of the vehicle.
\n\n Unit: centimeters\n
The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed specified.
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Payload capacity of the vehicle and trailers attached.
\n\n Unit: kilograms\n
Number of tires on the vehicle.
", + "smithy.api#range": { + "min": 1, + "max": 255 + } + } + }, + "Trailer": { + "target": "com.amazonaws.georoutes#IsolineTrailerOptions", + "traits": { + "smithy.api#documentation": "Trailer options corresponding to the vehicle.
" + } + }, + "TruckType": { + "target": "com.amazonaws.georoutes#IsolineTruckType", + "traits": { + "smithy.api#documentation": "Type of the truck.
" + } + }, + "TunnelRestrictionCode": { + "target": "com.amazonaws.georoutes#TunnelRestrictionCode", + "traits": { + "smithy.api#documentation": "The tunnel restriction code.
\nTunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. \n They relate to the types of dangerous goods that can be transported through them.
\n\n Tunnel Category B\n
\n\n Risk Level: Limited risk
\n\n Restrictions: Few restrictions
\n\n Tunnel Category C\n
\n\n Risk Level: Medium risk
\n\n Restrictions: Some restrictions
\n\n Tunnel Category D\n
\n\n Risk Level: High risk
\n\n Restrictions: Many restrictions occur
\n\n Tunnel Category E\n
\n\n Risk Level: Very high risk
\n\n Restrictions: Restricted tunnel
\nHeaviest 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.
\n\n Unit: Kilograms\n
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
\n\n Unit: Kilograms\n
Width of the vehicle.
\n\n Unit: centimeters\n
Travel mode options when the provided travel mode is \"Truck\"
" + } + }, + "com.amazonaws.georoutes#IsolineTruckType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LIGHT_TRUCK", + "value": "LightTruck" + }, + { + "name": "STRAIGHT_TRUCK", + "value": "StraightTruck" + }, + { + "name": "TRACTOR", + "value": "Tractor" + } + ] + } + }, + "com.amazonaws.georoutes#IsolineVehicleLicensePlate": { + "type": "structure", + "members": { + "LastCharacter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The last character of the License Plate.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The vehicle license plate.
" + } + }, + "com.amazonaws.georoutes#IsolineZoneCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CONGESTION_PRICING", + "value": "CongestionPricing" + }, + { + "name": "ENVIRONMENTAL", + "value": "Environmental" + }, + { + "name": "VIGNETTE", + "value": "Vignette" + } + ] + } + }, + "com.amazonaws.georoutes#LanguageTag": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 35 + } + } + }, + "com.amazonaws.georoutes#LanguageTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#LanguageTag" + } + }, + "com.amazonaws.georoutes#LineString": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#Position" + }, + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-3.1.4" + }, + "smithy.api#length": { + "min": 2 + } + } + }, + "com.amazonaws.georoutes#LinearRing": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#Position" + }, + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-3.1.6" + }, + "smithy.api#length": { + "min": 4 + } + } + }, + "com.amazonaws.georoutes#LinearRings": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#LinearRing" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.georoutes#LocalizedString": { + "type": "structure", + "members": { + "Language": { + "target": "com.amazonaws.georoutes#LanguageTag", + "traits": { + "smithy.api#documentation": "A list of BCP 47 compliant language codes for the results to be rendered in. The request\n uses the regional default as the fallback if the requested language can't be\n provided.
" + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the localized string.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The localized string.
" + } + }, + "com.amazonaws.georoutes#LocalizedStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#LocalizedString" + } + }, + "com.amazonaws.georoutes#MatchingStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MATCH_ANY", + "value": "MatchAny" + }, + { + "name": "MATCH_MOST_SIGNIFICANT_ROAD", + "value": "MatchMostSignificantRoad" + } + ] + } + }, + "com.amazonaws.georoutes#MeasurementSystem": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "METRIC", + "value": "Metric" + }, + { + "name": "IMPERIAL", + "value": "Imperial" + } + ] + } + }, + "com.amazonaws.georoutes#OptimizeWaypoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.georoutes#OptimizeWaypointsRequest" + }, + "output": { + "target": "com.amazonaws.georoutes#OptimizeWaypointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.georoutes#AccessDeniedException" + }, + { + "target": "com.amazonaws.georoutes#InternalServerException" + }, + { + "target": "com.amazonaws.georoutes#ThrottlingException" + }, + { + "target": "com.amazonaws.georoutes#ValidationException" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "smithy.api#documentation": "Calculates the optimal order to travel between a set of waypoints to minimize either the\n travel time or the distance travelled during the journey, based on road network\n restrictions and the traffic pattern data.
", + "smithy.api#http": { + "uri": "/optimize-waypoints", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "OptimizeWaypointsSuccess", + "params": { + "Origin": [ + -123.253374, + 49.351673 + ], + "Destination": [ + -123.930756, + 49.1314 + ] + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.georoutes#OptimizeWaypointsRequest": { + "type": "structure", + "members": { + "Avoid": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAvoidanceOptions", + "traits": { + "smithy.api#documentation": "Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an\n avoidance can't be satisfied for a particular case, this setting is ignored.
" + } + }, + "DepartureTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Departure time from the waypoint.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
The final position for the route in the World Geodetic System (WGS 84) format:\n [longitude, latitude].
Destination related options.
" + } + }, + "Driver": { + "target": "com.amazonaws.georoutes#WaypointOptimizationDriverOptions", + "traits": { + "smithy.api#documentation": "Driver related options.
" + } + }, + "Exclude": { + "target": "com.amazonaws.georoutes#WaypointOptimizationExclusionOptions", + "traits": { + "smithy.api#documentation": "Features to be strictly excluded while calculating the route.
" + } + }, + "Key": { + "target": "com.amazonaws.georoutes#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "OptimizeSequencingFor": { + "target": "com.amazonaws.georoutes#WaypointOptimizationSequencingObjective", + "traits": { + "smithy.api#documentation": "Specifies the optimization criteria for the calculated sequence.
\nDefault Value: FastestRoute.
The start position for the route.
", + "smithy.api#required": {} + } + }, + "OriginOptions": { + "target": "com.amazonaws.georoutes#WaypointOptimizationOriginOptions", + "traits": { + "smithy.api#documentation": "Origin related options.
" + } + }, + "Traffic": { + "target": "com.amazonaws.georoutes#WaypointOptimizationTrafficOptions", + "traits": { + "smithy.api#documentation": "Traffic-related options.
" + } + }, + "TravelMode": { + "target": "com.amazonaws.georoutes#WaypointOptimizationTravelMode", + "traits": { + "smithy.api#documentation": "Specifies the mode of transport when calculating a route. \n Used in estimating the speed of travel and road compatibility.
\nDefault Value: Car\n
Travel mode related options for the provided travel mode.
" + } + }, + "Waypoints": { + "target": "com.amazonaws.georoutes#WaypointOptimizationWaypointList", + "traits": { + "smithy.api#documentation": "List of waypoints between the Origin and Destination.
Details about the connection from one waypoint to the next, within the optimized sequence.
", + "smithy.api#required": {} + } + }, + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Overall distance to travel the whole sequence.
", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Overall duration to travel the whole sequence.
\n\n Unit: seconds\n
Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.
", + "smithy.api#required": {} + } + }, + "OptimizedWaypoints": { + "target": "com.amazonaws.georoutes#WaypointOptimizationOptimizedWaypointList", + "traits": { + "smithy.api#documentation": "Waypoints in the order of the optimized sequence.
", + "smithy.api#required": {} + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "TimeBreakdown": { + "target": "com.amazonaws.georoutes#WaypointOptimizationTimeBreakdown", + "traits": { + "smithy.api#documentation": "Time breakdown for the sequence.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.georoutes#Polyline": { + "type": "string", + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://developers.google.com/maps/documentation/utilities/polylinealgorithm" + }, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#PolylineCorridor": { + "type": "structure", + "members": { + "Polyline": { + "target": "com.amazonaws.georoutes#Polyline", + "traits": { + "smithy.api#documentation": "An ordered list of positions used to plot a route on a map in a lossy compression format.
\nLineString and Polyline are mutually exclusive properties.
\nConsiders all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
\n\n Unit: Meters\n
Geometry defined as an encoded corridor - an encoded polyline with a radius that defines\n the width of the corridor.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#PolylineRing": { + "type": "string", + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-3.1.6" + }, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#PolylineRingList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#PolylineRing" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.georoutes#Position": { + "type": "list", + "member": { + "target": "smithy.api#Double" + }, + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-3.1.1" + }, + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#Position23": { + "type": "list", + "member": { + "target": "smithy.api#Double" + }, + "traits": { + "smithy.api#externalDocumentation": { + "Documentation": "https://tools.ietf.org/html/rfc7946#section-3.1.1" + }, + "smithy.api#length": { + "min": 2, + "max": 3 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.georoutes#ProviderResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.georoutes#CalculateIsolines" + }, + { + "target": "com.amazonaws.georoutes#CalculateRouteMatrix" + }, + { + "target": "com.amazonaws.georoutes#CalculateRoutes" + }, + { + "target": "com.amazonaws.georoutes#OptimizeWaypoints" + }, + { + "target": "com.amazonaws.georoutes#SnapToRoads" + } + ] + }, + "com.amazonaws.georoutes#RoadSnapHazardousCargoType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "COMBUSTIBLE", + "value": "Combustible" + }, + { + "name": "CORROSIVE", + "value": "Corrosive" + }, + { + "name": "EXPLOSIVE", + "value": "Explosive" + }, + { + "name": "FLAMMABLE", + "value": "Flammable" + }, + { + "name": "GAS", + "value": "Gas" + }, + { + "name": "HARMFUL_TO_WATER", + "value": "HarmfulToWater" + }, + { + "name": "ORGANIC", + "value": "Organic" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "POISON", + "value": "Poison" + }, + { + "name": "POISONOUS_INHALATION", + "value": "PoisonousInhalation" + }, + { + "name": "RADIOACTIVE", + "value": "Radioactive" + } + ] + } + }, + "com.amazonaws.georoutes#RoadSnapHazardousCargoTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoadSnapHazardousCargoType" + }, + "traits": { + "smithy.api#length": { + "max": 11 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RoadSnapNotice": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.georoutes#RoadSnapNoticeCode", + "traits": { + "smithy.api#documentation": "Code corresponding to the issue.
", + "smithy.api#required": {} + } + }, + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The notice title.
", + "smithy.api#required": {} + } + }, + "TracePointIndexes": { + "target": "com.amazonaws.georoutes#RoadSnapTracePointIndexList", + "traits": { + "smithy.api#documentation": "TracePoint indices for which the provided notice code corresponds to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Notices provide information around factors that may have influenced snapping in a manner atypical to the standard use cases.
" + } + }, + "com.amazonaws.georoutes#RoadSnapNoticeCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "TRACE_POINTS_HEADING_IGNORED", + "value": "TracePointsHeadingIgnored" + }, + { + "name": "TRACE_POINTS_IGNORED", + "value": "TracePointsIgnored" + }, + { + "name": "TRACE_POINTS_MOVED_BY_LARGE_DISTANCE", + "value": "TracePointsMovedByLargeDistance" + }, + { + "name": "TRACE_POINTS_NOT_MATCHED", + "value": "TracePointsNotMatched" + }, + { + "name": "TRACE_POINTS_OUT_OF_SEQUENCE", + "value": "TracePointsOutOfSequence" + }, + { + "name": "TRACE_POINTS_SPEED_ESTIMATED", + "value": "TracePointsSpeedEstimated" + }, + { + "name": "TRACE_POINTS_SPEED_IGNORED", + "value": "TracePointsSpeedIgnored" + } + ] + } + }, + "com.amazonaws.georoutes#RoadSnapNoticeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoadSnapNotice" + } + }, + "com.amazonaws.georoutes#RoadSnapSnappedGeometry": { + "type": "structure", + "members": { + "LineString": { + "target": "com.amazonaws.georoutes#LineString", + "traits": { + "smithy.api#documentation": "An ordered list of positions used to plot a route on a map.
\nLineString and Polyline are mutually exclusive properties.
\nAn ordered list of positions used to plot a route on a map in a lossy compression format.
\nLineString and Polyline are mutually exclusive properties.
\nInterpolated geometry for the snapped route that is overlay-able onto a map.
" + } + }, + "com.amazonaws.georoutes#RoadSnapSnappedTracePoint": { + "type": "structure", + "members": { + "Confidence": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Confidence value for the correctness of this point match.
", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "OriginalPosition": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position of the TracePoint provided within the request, at the same index.
", + "smithy.api#required": {} + } + }, + "SnappedPosition": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Snapped position of the TracePoint provided within the request, at the same index.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "TracePoints snapped onto the road network.
" + } + }, + "com.amazonaws.georoutes#RoadSnapSnappedTracePointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoadSnapSnappedTracePoint" + } + }, + "com.amazonaws.georoutes#RoadSnapTracePoint": { + "type": "structure", + "members": { + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Speed at the specified trace point .
\n\n Unit: KilometersPerHour\n
Timestamp of the event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "TracePoint indices for which the provided notice code corresponds to.
" + } + }, + "com.amazonaws.georoutes#RoadSnapTracePointIndexList": { + "type": "list", + "member": { + "target": "smithy.api#Integer" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.georoutes#RoadSnapTracePointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoadSnapTracePoint" + } + }, + "com.amazonaws.georoutes#RoadSnapTrailerOptions": { + "type": "structure", + "members": { + "TrailerCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of trailers attached to the vehicle.
\nDefault Value: 0\n
Trailer options corresponding to the vehicle.
" + } + }, + "com.amazonaws.georoutes#RoadSnapTravelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAR", + "value": "Car" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "SCOOTER", + "value": "Scooter" + }, + { + "name": "TRUCK", + "value": "Truck" + } + ] + } + }, + "com.amazonaws.georoutes#RoadSnapTravelModeOptions": { + "type": "structure", + "members": { + "Truck": { + "target": "com.amazonaws.georoutes#RoadSnapTruckOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Truck\".
" + } + } + }, + "traits": { + "smithy.api#documentation": "Travel mode related options for the provided travel mode.
" + } + }, + "com.amazonaws.georoutes#RoadSnapTruckOptions": { + "type": "structure", + "members": { + "GrossWeight": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Gross weight of the vehicle including trailers, and goods at capacity.
\n\n Unit: Kilograms\n
List of Hazardous cargos contained in the vehicle.
" + } + }, + "Height": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Height of the vehicle.
\n\n Unit: centimeters\n
Length of the vehicle.
\n\n Unit: centimeters\n
Trailer options corresponding to the vehicle.
" + } + }, + "TunnelRestrictionCode": { + "target": "com.amazonaws.georoutes#TunnelRestrictionCode", + "traits": { + "smithy.api#documentation": "The tunnel restriction code.
\nTunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. \n They relate to the types of dangerous goods that can be transported through them.
\n\n Tunnel Category B\n
\n\n Risk Level: Limited risk
\n\n Restrictions: Few restrictions
\n\n Tunnel Category C\n
\n\n Risk Level: Medium risk
\n\n Restrictions: Some restrictions
\n\n Tunnel Category D\n
\n\n Risk Level: High risk
\n\n Restrictions: Many restrictions occur
\n\n Tunnel Category E\n
\n\n Risk Level: Very high risk
\n\n Restrictions: Restricted tunnel
\nWidth of the vehicle in centimenters.
", + "smithy.api#range": { + "min": 0, + "max": 5000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Truck\".
" + } + }, + "com.amazonaws.georoutes#RoundaboutAngle": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": -360, + "max": 360 + } + } + }, + "com.amazonaws.georoutes#Route": { + "type": "structure", + "members": { + "Legs": { + "target": "com.amazonaws.georoutes#RouteLegList", + "traits": { + "smithy.api#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.\nLegs 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.
", + "smithy.api#required": {} + } + }, + "MajorRoadLabels": { + "target": "com.amazonaws.georoutes#RouteMajorRoadLabelList", + "traits": { + "smithy.api#documentation": "Important labels including names and route numbers that differentiate the current route from the alternatives presented.
", + "smithy.api#length": { + "min": 0, + "max": 2 + }, + "smithy.api#required": {} + } + }, + "Summary": { + "target": "com.amazonaws.georoutes#RouteSummary", + "traits": { + "smithy.api#documentation": "Summarized details of the leg.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The route.
" + } + }, + "com.amazonaws.georoutes#RouteAllowOptions": { + "type": "structure", + "members": { + "Hot": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allow Hot (High Occupancy Toll) lanes while calculating the route.
" + } + }, + "Hov": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allow Hov (High Occupancy vehicle) lanes while calculating the route.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Features that are allowed while calculating. a route
" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceArea": { + "type": "structure", + "members": { + "Except": { + "target": "com.amazonaws.georoutes#RouteAvoidanceAreaGeometryList", + "traits": { + "smithy.api#documentation": "Exceptions to the provided avoidance geometry, to be included while calculating the route.
" + } + }, + "Geometry": { + "target": "com.amazonaws.georoutes#RouteAvoidanceAreaGeometry", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Areas to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceAreaGeometry": { + "type": "structure", + "members": { + "Corridor": { + "target": "com.amazonaws.georoutes#Corridor", + "traits": { + "smithy.api#documentation": "Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
" + } + }, + "BoundingBox": { + "target": "com.amazonaws.georoutes#BoundingBox", + "traits": { + "smithy.api#documentation": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.
" + } + }, + "Polygon": { + "target": "com.amazonaws.georoutes#LinearRings", + "traits": { + "smithy.api#documentation": "Geometry defined as a polygon with only one linear ring.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "PolylineCorridor": { + "target": "com.amazonaws.georoutes#PolylineCorridor", + "traits": { + "smithy.api#documentation": "Geometry defined as an encoded corridor - an encoded polyline with a radius that defines\n the width of the corridor.
" + } + }, + "PolylinePolygon": { + "target": "com.amazonaws.georoutes#PolylineRingList", + "traits": { + "smithy.api#documentation": "A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon \n of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). \n For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceAreaGeometryList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteAvoidanceAreaGeometry" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceAreaList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteAvoidanceArea" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceOptions": { + "type": "structure", + "members": { + "Areas": { + "target": "com.amazonaws.georoutes#RouteAvoidanceAreaList", + "traits": { + "smithy.api#documentation": "Areas to be avoided.
" + } + }, + "CarShuttleTrains": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid car-shuttle-trains while calculating the route.
" + } + }, + "ControlledAccessHighways": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid controlled access highways while calculating the route.
" + } + }, + "DirtRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid dirt roads while calculating the route.
" + } + }, + "Ferries": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid ferries while calculating the route.
" + } + }, + "SeasonalClosure": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid roads that have seasonal closure while calculating the route.
" + } + }, + "TollRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "TollTransponders": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "TruckRoadTypes": { + "target": "com.amazonaws.georoutes#TruckRoadTypeList", + "traits": { + "smithy.api#documentation": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. \n A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
\nAvoid tunnels while calculating the route.
" + } + }, + "UTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + }, + "ZoneCategories": { + "target": "com.amazonaws.georoutes#RouteAvoidanceZoneCategoryList", + "traits": { + "smithy.api#documentation": "Zone categories to be avoided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to areas to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceZoneCategory": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.georoutes#RouteZoneCategory", + "traits": { + "smithy.api#documentation": "Zone category to be avoided.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Zone categories to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteAvoidanceZoneCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteAvoidanceZoneCategory" + }, + "traits": { + "smithy.api#length": { + "max": 3 + } + } + }, + "com.amazonaws.georoutes#RouteCarOptions": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.georoutes#RouteEngineType", + "traits": { + "smithy.api#documentation": "Engine type of the vehicle.
" + } + }, + "LicensePlate": { + "target": "com.amazonaws.georoutes#RouteVehicleLicensePlate", + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed specified.
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Travel mode options when the provided travel mode is \"Car\"
" + } + }, + "com.amazonaws.georoutes#RouteContinueHighwayStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the continue highway step.
" + } + }, + "com.amazonaws.georoutes#RouteContinueStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the continue step.
" + } + }, + "com.amazonaws.georoutes#RouteDestinationOptions": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.
", + "smithy.api#range": { + "max": 2000 + } + } + }, + "AvoidUTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#RouteMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "SideOfStreet": { + "target": "com.amazonaws.georoutes#RouteSideOfStreetOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to a side of the street.
" + } + }, + "StopDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the stop.
\n\n Unit: seconds\n
Options related to the destination.
" + } + }, + "com.amazonaws.georoutes#RouteDirection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EAST", + "value": "East" + }, + { + "name": "NORTH", + "value": "North" + }, + { + "name": "SOUTH", + "value": "South" + }, + { + "name": "WEST", + "value": "West" + } + ] + } + }, + "com.amazonaws.georoutes#RouteDriverOptions": { + "type": "structure", + "members": { + "Schedule": { + "target": "com.amazonaws.georoutes#RouteDriverScheduleIntervalList", + "traits": { + "smithy.api#documentation": "Driver work-rest schedule. Stops are added to fulfil the provided rest schedule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Driver related options.
" + } + }, + "com.amazonaws.georoutes#RouteDriverScheduleInterval": { + "type": "structure", + "members": { + "DriveDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Maximum allowed driving time before stopping to rest.
\n\n Unit: seconds\n
Resting time before the driver can continue driving.
\n\n Unit: seconds\n
Interval of the driver work-rest schedule. \n Stops are added to fulfil the provided rest schedule.
" + } + }, + "com.amazonaws.georoutes#RouteDriverScheduleIntervalList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteDriverScheduleInterval" + } + }, + "com.amazonaws.georoutes#RouteEmissionType": { + "type": "structure", + "members": { + "Co2EmissionClass": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The CO 2 emission classes.
" + } + }, + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the emission.
\n\n Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev\n
Type of the emission.
\n\n Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev\n
Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the enter highway step.
" + } + }, + "com.amazonaws.georoutes#RouteExclusionOptions": { + "type": "structure", + "members": { + "Countries": { + "target": "com.amazonaws.georoutes#CountryCodeList", + "traits": { + "smithy.api#documentation": "List of countries to be avoided defined by two-letter or three-letter country codes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exclusion options for the route.
" + } + }, + "com.amazonaws.georoutes#RouteExitStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "RelativeExit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Exit to be taken.
", + "smithy.api#range": { + "min": 1, + "max": 12 + } + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the exit step.
" + } + }, + "com.amazonaws.georoutes#RouteFerryAfterTravelStep": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Brief description of the step in the requested language.
\nOnly available when the TravelStepType is Default.
\nType of the step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed after the travel portion of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteFerryAfterTravelStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteFerryAfterTravelStep" + } + }, + "com.amazonaws.georoutes#RouteFerryAfterTravelStepType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DEBOARD", + "value": "Deboard" + } + ] + } + }, + "com.amazonaws.georoutes#RouteFerryArrival": { + "type": "structure", + "members": { + "Place": { + "target": "com.amazonaws.georoutes#RouteFerryPlace", + "traits": { + "smithy.api#documentation": "The place details.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "The time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details corresponding to the arrival for the leg.
" + } + }, + "com.amazonaws.georoutes#RouteFerryBeforeTravelStep": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Brief description of the step in the requested language.
\nOnly available when the TravelStepType is Default.
\nType of the step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed before the travel portion of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteFerryBeforeTravelStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteFerryBeforeTravelStep" + } + }, + "com.amazonaws.georoutes#RouteFerryBeforeTravelStepType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "BOARD", + "value": "Board" + } + ] + } + }, + "com.amazonaws.georoutes#RouteFerryDeparture": { + "type": "structure", + "members": { + "Place": { + "target": "com.amazonaws.georoutes#RouteFerryPlace", + "traits": { + "smithy.api#documentation": "The place details.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "The time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details corresponding to the departure for the leg.
" + } + }, + "com.amazonaws.georoutes#RouteFerryLegDetails": { + "type": "structure", + "members": { + "AfterTravelSteps": { + "target": "com.amazonaws.georoutes#RouteFerryAfterTravelStepList", + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed after the travel portion of the leg.
", + "smithy.api#required": {} + } + }, + "Arrival": { + "target": "com.amazonaws.georoutes#RouteFerryArrival", + "traits": { + "smithy.api#documentation": "Details corresponding to the arrival for the leg.
", + "smithy.api#required": {} + } + }, + "BeforeTravelSteps": { + "target": "com.amazonaws.georoutes#RouteFerryBeforeTravelStepList", + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed before the travel portion of the leg.
", + "smithy.api#required": {} + } + }, + "Departure": { + "target": "com.amazonaws.georoutes#RouteFerryDeparture", + "traits": { + "smithy.api#documentation": "Details corresponding to the departure for the leg.
", + "smithy.api#required": {} + } + }, + "Notices": { + "target": "com.amazonaws.georoutes#RouteFerryNoticeList", + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
", + "smithy.api#required": {} + } + }, + "PassThroughWaypoints": { + "target": "com.amazonaws.georoutes#RoutePassThroughWaypointList", + "traits": { + "smithy.api#documentation": "Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
", + "smithy.api#required": {} + } + }, + "RouteName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Route name of the ferry line.
" + } + }, + "Spans": { + "target": "com.amazonaws.georoutes#RouteFerrySpanList", + "traits": { + "smithy.api#documentation": "Spans that were computed for the requested SpanAdditionalFeatures.
", + "smithy.api#required": {} + } + }, + "Summary": { + "target": "com.amazonaws.georoutes#RouteFerrySummary", + "traits": { + "smithy.api#documentation": "Summarized details of the leg.
" + } + }, + "TravelSteps": { + "target": "com.amazonaws.georoutes#RouteFerryTravelStepList", + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed before the travel portion of the leg.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "FerryLegDetails is populated when the Leg type is Ferry, and provides additional\n information that is specific
" + } + }, + "com.amazonaws.georoutes#RouteFerryNotice": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.georoutes#RouteFerryNoticeCode", + "traits": { + "smithy.api#documentation": "Code corresponding to the issue.
", + "smithy.api#required": {} + } + }, + "Impact": { + "target": "com.amazonaws.georoutes#RouteNoticeImpact", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
" + } + }, + "com.amazonaws.georoutes#RouteFerryNoticeCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCURATE_POLYLINE_UNAVAILABLE", + "value": "AccuratePolylineUnavailable" + }, + { + "name": "NO_SCHEDULE", + "value": "NoSchedule" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "VIOLATED_AVOID_FERRY", + "value": "ViolatedAvoidFerry" + }, + { + "name": "VIOLATED_AVOID_RAIL_FERRY", + "value": "ViolatedAvoidRailFerry" + } + ] + } + }, + "com.amazonaws.georoutes#RouteFerryNoticeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteFerryNotice" + } + }, + "com.amazonaws.georoutes#RouteFerryOverviewSummary": { + "type": "structure", + "members": { + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance of the step.
", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Summarized details of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteFerryPlace": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the place.
" + } + }, + "OriginalPosition": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position provided in the request.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Index of the waypoint in the request.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Position provided in the request.
" + } + }, + "com.amazonaws.georoutes#RouteFerrySpan": { + "type": "structure", + "members": { + "Country": { + "target": "com.amazonaws.georoutes#CountryCode3", + "traits": { + "smithy.api#documentation": "3 letter Country code corresponding to the Span.
" + } + }, + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
\n\n Unit: seconds\n
Offset in the leg geometry corresponding to the start of this span.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Names": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Provides an array of names of the ferry span in available languages.
" + } + }, + "Region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "2-3 letter Region code corresponding to the Span. This is either a province or a state.
", + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Span computed for the requested SpanAdditionalFeatures.
" + } + }, + "com.amazonaws.georoutes#RouteFerrySpanList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteFerrySpan" + } + }, + "com.amazonaws.georoutes#RouteFerrySummary": { + "type": "structure", + "members": { + "Overview": { + "target": "com.amazonaws.georoutes#RouteFerryOverviewSummary", + "traits": { + "smithy.api#documentation": "Summarized details for the leg including before travel, travel and after travel steps.
" + } + }, + "TravelOnly": { + "target": "com.amazonaws.georoutes#RouteFerryTravelOnlySummary", + "traits": { + "smithy.api#documentation": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.georoutes#RouteFerryTravelOnlySummary": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
\n\n Unit: seconds\n
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.
" + } + }, + "com.amazonaws.georoutes#RouteFerryTravelStep": { + "type": "structure", + "members": { + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance of the step.
" + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Offset in the leg geometry corresponding to the start of this step.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Instruction": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Brief description of the step in the requested language.
\nOnly available when the TravelStepType is Default.
\nType of the step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed during the travel portion of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteFerryTravelStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteFerryTravelStep" + } + }, + "com.amazonaws.georoutes#RouteFerryTravelStepType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DEPART", + "value": "Depart" + }, + { + "name": "CONTINUE", + "value": "Continue" + }, + { + "name": "ARRIVE", + "value": "Arrive" + } + ] + } + }, + "com.amazonaws.georoutes#RouteHazardousCargoType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "COMBUSTIBLE", + "value": "Combustible" + }, + { + "name": "CORROSIVE", + "value": "Corrosive" + }, + { + "name": "EXPLOSIVE", + "value": "Explosive" + }, + { + "name": "FLAMMABLE", + "value": "Flammable" + }, + { + "name": "GAS", + "value": "Gas" + }, + { + "name": "HARMFUL_TO_WATER", + "value": "HarmfulToWater" + }, + { + "name": "ORGANIC", + "value": "Organic" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "POISON", + "value": "Poison" + }, + { + "name": "POISONOUS_INHALATION", + "value": "PoisonousInhalation" + }, + { + "name": "RADIOACTIVE", + "value": "Radioactive" + } + ] + } + }, + "com.amazonaws.georoutes#RouteHazardousCargoTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteHazardousCargoType" + }, + "traits": { + "smithy.api#length": { + "max": 11 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteKeepStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details that are specific to a Keep step.
" + } + }, + "com.amazonaws.georoutes#RouteLeg": { + "type": "structure", + "members": { + "FerryLegDetails": { + "target": "com.amazonaws.georoutes#RouteFerryLegDetails", + "traits": { + "smithy.api#documentation": "FerryLegDetails is populated when the Leg type is Ferry, and provides additional\n information that is specific
" + } + }, + "Geometry": { + "target": "com.amazonaws.georoutes#RouteLegGeometry", + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
", + "smithy.api#required": {} + } + }, + "Language": { + "target": "com.amazonaws.georoutes#LanguageTag", + "traits": { + "smithy.api#documentation": "List of languages for instructions within steps in the response.
" + } + }, + "PedestrianLegDetails": { + "target": "com.amazonaws.georoutes#RoutePedestrianLegDetails", + "traits": { + "smithy.api#documentation": "Details related to the pedestrian leg.
" + } + }, + "TravelMode": { + "target": "com.amazonaws.georoutes#RouteLegTravelMode", + "traits": { + "smithy.api#documentation": "Specifies the mode of transport when calculating a route. \n Used in estimating the speed of travel and road compatibility.
\nDefault Value: Car\n
Type of the leg.
", + "smithy.api#required": {} + } + }, + "VehicleLegDetails": { + "target": "com.amazonaws.georoutes#RouteVehicleLegDetails", + "traits": { + "smithy.api#documentation": "Details related to the vehicle leg.
" + } + } + }, + "traits": { + "smithy.api#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.\nLegs 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.
" + } + }, + "com.amazonaws.georoutes#RouteLegAdditionalFeature": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ELEVATION", + "value": "Elevation" + }, + { + "name": "INCIDENTS", + "value": "Incidents" + }, + { + "name": "PASS_THROUGH_WAYPOINTS", + "value": "PassThroughWaypoints" + }, + { + "name": "SUMMARY", + "value": "Summary" + }, + { + "name": "TOLLS", + "value": "Tolls" + }, + { + "name": "TRAVEL_STEP_INSTRUCTIONS", + "value": "TravelStepInstructions" + }, + { + "name": "TRUCK_ROAD_TYPES", + "value": "TruckRoadTypes" + }, + { + "name": "TYPICAL_DURATION", + "value": "TypicalDuration" + }, + { + "name": "ZONES", + "value": "Zones" + } + ] + } + }, + "com.amazonaws.georoutes#RouteLegAdditionalFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteLegAdditionalFeature" + }, + "traits": { + "smithy.api#length": { + "max": 9 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteLegGeometry": { + "type": "structure", + "members": { + "LineString": { + "target": "com.amazonaws.georoutes#LineString", + "traits": { + "smithy.api#documentation": "An ordered list of positions used to plot a route on a map.
\nLineString and Polyline are mutually exclusive properties.
\nAn ordered list of positions used to plot a route on a map in a lossy compression format.
\nLineString and Polyline are mutually exclusive properties.
\nThe returned Route leg geometry.
" + } + }, + "com.amazonaws.georoutes#RouteLegList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteLeg" + } + }, + "com.amazonaws.georoutes#RouteLegTravelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAR", + "value": "Car" + }, + { + "name": "FERRY", + "value": "Ferry" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "SCOOTER", + "value": "Scooter" + }, + { + "name": "TRUCK", + "value": "Truck" + } + ] + } + }, + "com.amazonaws.georoutes#RouteLegType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "FERRY", + "value": "Ferry" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "VEHICLE", + "value": "Vehicle" + } + ] + } + }, + "com.amazonaws.georoutes#RouteList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#Route" + } + }, + "com.amazonaws.georoutes#RouteMajorRoadLabel": { + "type": "structure", + "members": { + "RoadName": { + "target": "com.amazonaws.georoutes#LocalizedString", + "traits": { + "smithy.api#documentation": "Name of the road (localized).
" + } + }, + "RouteNumber": { + "target": "com.amazonaws.georoutes#RouteNumber", + "traits": { + "smithy.api#documentation": "Route number of the road.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Important labels including names and route numbers that differentiate the current route from the alternatives presented.
" + } + }, + "com.amazonaws.georoutes#RouteMajorRoadLabelList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMajorRoadLabel" + } + }, + "com.amazonaws.georoutes#RouteMatchingOptions": { + "type": "structure", + "members": { + "NameHint": { + "target": "com.amazonaws.georoutes#SensitiveString", + "traits": { + "smithy.api#documentation": "Attempts to match the provided position to a road similar to the provided name.
", + "smithy.api#length": { + "max": 100 + } + } + }, + "OnRoadThreshold": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
\n\n Unit: meters\n
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
\n\n Unit: Meters\n
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to route matching.
" + } + }, + "com.amazonaws.georoutes#RouteMatrix": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixRow" + } + }, + "com.amazonaws.georoutes#RouteMatrixAllowOptions": { + "type": "structure", + "members": { + "Hot": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allow Hot (High Occupancy Toll) lanes while calculating the route.
" + } + }, + "Hov": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Allow Hov (High Occupancy vehicle) lanes while calculating the route.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Allow Options related to the route matrix.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixAutoCircle": { + "type": "structure", + "members": { + "Margin": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The margin provided for the calculation.
", + "smithy.api#range": { + "min": 0, + "max": 200000 + } + } + }, + "MaxRadius": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum size of the radius provided for the calculation.
", + "smithy.api#range": { + "min": 0, + "max": 200000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Provides the circle that was used while calculating the route.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixAvoidanceArea": { + "type": "structure", + "members": { + "Geometry": { + "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceAreaGeometry", + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Area to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixAvoidanceAreaGeometry": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.georoutes#BoundingBox", + "traits": { + "smithy.api#documentation": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.
" + } + }, + "Polygon": { + "target": "com.amazonaws.georoutes#LinearRings", + "traits": { + "smithy.api#documentation": "Geometry defined as a polygon with only one linear ring.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "PolylinePolygon": { + "target": "com.amazonaws.georoutes#PolylineRingList", + "traits": { + "smithy.api#documentation": "A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains\n PolylinePolygon of the first linear ring (the outer ring) and from second item to the last\n item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixAvoidanceAreaList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceArea" + } + }, + "com.amazonaws.georoutes#RouteMatrixAvoidanceOptions": { + "type": "structure", + "members": { + "Areas": { + "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceAreaList", + "traits": { + "smithy.api#documentation": "Areas to be avoided.
", + "smithy.api#length": { + "max": 250 + } + } + }, + "CarShuttleTrains": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid car-shuttle-trains while calculating the route.
" + } + }, + "ControlledAccessHighways": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid controlled access highways while calculating the route.
" + } + }, + "DirtRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid dirt roads while calculating the route.
" + } + }, + "Ferries": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid ferries while calculating the route.
" + } + }, + "TollRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "TollTransponders": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "TruckRoadTypes": { + "target": "com.amazonaws.georoutes#TruckRoadTypeList", + "traits": { + "smithy.api#documentation": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. \n A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
\nAvoid tunnels while calculating the route.
" + } + }, + "UTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + }, + "ZoneCategories": { + "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceZoneCategoryList", + "traits": { + "smithy.api#documentation": "Zone categories to be avoided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to the route matrix.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixAvoidanceZoneCategory": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.georoutes#RouteMatrixZoneCategory", + "traits": { + "smithy.api#documentation": "Zone category to be avoided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Zone categories to be avoided.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixAvoidanceZoneCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixAvoidanceZoneCategory" + }, + "traits": { + "smithy.api#length": { + "max": 3 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteMatrixBoundary": { + "type": "structure", + "members": { + "Geometry": { + "target": "com.amazonaws.georoutes#RouteMatrixBoundaryGeometry", + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
" + } + }, + "Unbounded": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "No restrictions in terms of a routing boundary, and is typically used for longer routes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixBoundaryGeometry": { + "type": "structure", + "members": { + "AutoCircle": { + "target": "com.amazonaws.georoutes#RouteMatrixAutoCircle", + "traits": { + "smithy.api#documentation": "Provides the circle that was used while calculating the route.
" + } + }, + "Circle": { + "target": "com.amazonaws.georoutes#Circle", + "traits": { + "smithy.api#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.
Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.
" + } + }, + "Polygon": { + "target": "com.amazonaws.georoutes#LinearRings", + "traits": { + "smithy.api#documentation": "Geometry defined as a polygon with only one linear ring.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Geometry of the routing boundary.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixCarOptions": { + "type": "structure", + "members": { + "LicensePlate": { + "target": "com.amazonaws.georoutes#RouteMatrixVehicleLicensePlate", + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Options related to the car.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixDestination": { + "type": "structure", + "members": { + "Options": { + "target": "com.amazonaws.georoutes#RouteMatrixDestinationOptions", + "traits": { + "smithy.api#documentation": "Destination related options.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
The route destination.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixDestinationList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixDestination" + } + }, + "com.amazonaws.georoutes#RouteMatrixDestinationOptions": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#RouteMatrixMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "SideOfStreet": { + "target": "com.amazonaws.georoutes#RouteMatrixSideOfStreetOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to the destination.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixEntry": { + "type": "structure", + "members": { + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The total distance of travel for the route.
", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The expected duration of travel for the route.
\n\n Unit: seconds\n
Error code that occurred during calculation of the route.
" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "NO_MATCH", + "value": "NoMatch" + }, + { + "name": "NO_MATCH_DESTINATION", + "value": "NoMatchDestination" + }, + { + "name": "NO_MATCH_ORIGIN", + "value": "NoMatchOrigin" + }, + { + "name": "NO_ROUTE", + "value": "NoRoute" + }, + { + "name": "OUT_OF_BOUNDS", + "value": "OutOfBounds" + }, + { + "name": "OUT_OF_BOUNDS_DESTINATION", + "value": "OutOfBoundsDestination" + }, + { + "name": "OUT_OF_BOUNDS_ORIGIN", + "value": "OutOfBoundsOrigin" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "VIOLATION", + "value": "Violation" + } + ] + } + }, + "com.amazonaws.georoutes#RouteMatrixExclusionOptions": { + "type": "structure", + "members": { + "Countries": { + "target": "com.amazonaws.georoutes#CountryCodeList", + "traits": { + "smithy.api#documentation": "List of countries to be avoided defined by two-letter or three-letter country codes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exclusion options.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixHazardousCargoType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "COMBUSTIBLE", + "value": "Combustible" + }, + { + "name": "CORROSIVE", + "value": "Corrosive" + }, + { + "name": "EXPLOSIVE", + "value": "Explosive" + }, + { + "name": "FLAMMABLE", + "value": "Flammable" + }, + { + "name": "GAS", + "value": "Gas" + }, + { + "name": "HARMFUL_TO_WATER", + "value": "HarmfulToWater" + }, + { + "name": "ORGANIC", + "value": "Organic" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "POISON", + "value": "Poison" + }, + { + "name": "POISONOUS_INHALATION", + "value": "PoisonousInhalation" + }, + { + "name": "RADIOACTIVE", + "value": "Radioactive" + } + ] + } + }, + "com.amazonaws.georoutes#RouteMatrixHazardousCargoTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixHazardousCargoType" + }, + "traits": { + "smithy.api#length": { + "max": 11 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteMatrixMatchingOptions": { + "type": "structure", + "members": { + "NameHint": { + "target": "com.amazonaws.georoutes#SensitiveString", + "traits": { + "smithy.api#documentation": "Attempts to match the provided position to a road similar to the provided name.
" + } + }, + "OnRoadThreshold": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.
\n\n Unit: meters\n
Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.
\n\n Unit: Meters\n
Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Matching options.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixOrigin": { + "type": "structure", + "members": { + "Options": { + "target": "com.amazonaws.georoutes#RouteMatrixOriginOptions", + "traits": { + "smithy.api#documentation": "Origin related options.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
The start position for the route.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixOriginList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixOrigin" + } + }, + "com.amazonaws.georoutes#RouteMatrixOriginOptions": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#RouteMatrixMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "SideOfStreet": { + "target": "com.amazonaws.georoutes#RouteMatrixSideOfStreetOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Origin related options.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixRow": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteMatrixEntry" + } + }, + "com.amazonaws.georoutes#RouteMatrixScooterOptions": { + "type": "structure", + "members": { + "LicensePlate": { + "target": "com.amazonaws.georoutes#RouteMatrixVehicleLicensePlate", + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed.
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Travel mode options when the provided travel mode is \"Scooter\"
" + } + }, + "com.amazonaws.georoutes#RouteMatrixSideOfStreetOptions": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
\nDefault Value: DividedStreetOnly\n
Options to configure matching the provided position to a side of the street.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixTrafficOptions": { + "type": "structure", + "members": { + "FlowEventThresholdOverride": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration for which flow traffic is considered valid. \n For this period, the flow traffic is used over historical traffic data. \n Flow traffic refers to congestion, which changes very quickly. \n Duration in seconds for which flow traffic event would be considered valid. \n While flow traffic event is valid it will be used over the historical traffic data.
" + } + }, + "Usage": { + "target": "com.amazonaws.georoutes#TrafficUsage", + "traits": { + "smithy.api#documentation": "Determines if traffic should be used or ignored while calculating the route.
\nDefault Value: UseTrafficData\n
Traffic related options.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixTrailerOptions": { + "type": "structure", + "members": { + "TrailerCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of trailers attached to the vehicle.
\nDefault Value: 0\n
Trailer options corresponding to the vehicle.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixTravelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAR", + "value": "Car" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "SCOOTER", + "value": "Scooter" + }, + { + "name": "TRUCK", + "value": "Truck" + } + ] + } + }, + "com.amazonaws.georoutes#RouteMatrixTravelModeOptions": { + "type": "structure", + "members": { + "Car": { + "target": "com.amazonaws.georoutes#RouteMatrixCarOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Car\"
" + } + }, + "Scooter": { + "target": "com.amazonaws.georoutes#RouteMatrixScooterOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Scooter\"
" + } + }, + "Truck": { + "target": "com.amazonaws.georoutes#RouteMatrixTruckOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Truck\"
" + } + } + }, + "traits": { + "smithy.api#documentation": "Travel mode related options for the provided travel mode.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixTruckOptions": { + "type": "structure", + "members": { + "AxleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Total number of axles of the vehicle.
", + "smithy.api#range": { + "min": 2, + "max": 255 + } + } + }, + "GrossWeight": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Gross weight of the vehicle including trailers, and goods at capacity.
\n\n Unit: Kilograms\n
List of Hazardous cargo contained in the vehicle.
" + } + }, + "Height": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Height of the vehicle.
\n\n Unit: centimeters\n
Kingpin to rear axle length of the vehicle
\n\n Unit: centimeters\n
Length of the vehicle.
\n\n Unit: centimeters\n
The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Payload capacity of the vehicle and trailers attached.
\n\n Unit: kilograms\n
Trailer options corresponding to the vehicle.
" + } + }, + "TruckType": { + "target": "com.amazonaws.georoutes#RouteMatrixTruckType", + "traits": { + "smithy.api#documentation": "Type of the truck.
" + } + }, + "TunnelRestrictionCode": { + "target": "com.amazonaws.georoutes#TunnelRestrictionCode", + "traits": { + "smithy.api#documentation": "The tunnel restriction code.
\nTunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. \n They relate to the types of dangerous goods that can be transported through them.
\n\n Tunnel Category B\n
\n\n Risk Level: Limited risk
\n\n Restrictions: Few restrictions
\n\n Tunnel Category C\n
\n\n Risk Level: Medium risk
\n\n Restrictions: Some restrictions
\n\n Tunnel Category D\n
\n\n Risk Level: High risk
\n\n Restrictions: Many restrictions occur
\n\n Tunnel Category E\n
\n\n Risk Level: Very high risk
\n\n Restrictions: Restricted tunnel
\nHeaviest 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.
\n\n Unit: Kilograms\n
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": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Width of the vehicle.
\n\n Unit: centimeters\n
Travel mode options when the provided travel mode is \"Truck\"
" + } + }, + "com.amazonaws.georoutes#RouteMatrixTruckType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LIGHT_TRUCK", + "value": "LightTruck" + }, + { + "name": "STRAIGHT_TRUCK", + "value": "StraightTruck" + }, + { + "name": "TRACTOR", + "value": "Tractor" + } + ] + } + }, + "com.amazonaws.georoutes#RouteMatrixVehicleLicensePlate": { + "type": "structure", + "members": { + "LastCharacter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The last character of the License Plate.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "com.amazonaws.georoutes#RouteMatrixZoneCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CONGESTION_PRICING", + "value": "CongestionPricing" + }, + { + "name": "ENVIRONMENTAL", + "value": "Environmental" + }, + { + "name": "VIGNETTE", + "value": "Vignette" + } + ] + } + }, + "com.amazonaws.georoutes#RouteNoticeDetailRange": { + "type": "structure", + "members": { + "Min": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Minimum value for the range.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Max": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum value for the range.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Notice Detail that is a range.
" + } + }, + "com.amazonaws.georoutes#RouteNoticeImpact": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "HIGH", + "value": "High" + }, + { + "name": "LOW", + "value": "Low" + } + ] + } + }, + "com.amazonaws.georoutes#RouteNumber": { + "type": "structure", + "members": { + "Direction": { + "target": "com.amazonaws.georoutes#RouteDirection", + "traits": { + "smithy.api#documentation": "Directional identifier of the route.
" + } + }, + "Language": { + "target": "com.amazonaws.georoutes#LanguageTag", + "traits": { + "smithy.api#documentation": "List of languages for instructions corresponding to the route number.
" + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The route number.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The route number.
" + } + }, + "com.amazonaws.georoutes#RouteNumberList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteNumber" + } + }, + "com.amazonaws.georoutes#RouteOriginOptions": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.
", + "smithy.api#range": { + "max": 2000 + } + } + }, + "AvoidUTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#RouteMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "SideOfStreet": { + "target": "com.amazonaws.georoutes#RouteSideOfStreetOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Origin related options.
" + } + }, + "com.amazonaws.georoutes#RoutePassThroughPlace": { + "type": "structure", + "members": { + "OriginalPosition": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position provided in the request.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Index of the waypoint in the request.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The place where the waypoint is passed through and not treated as a stop.
" + } + }, + "com.amazonaws.georoutes#RoutePassThroughWaypoint": { + "type": "structure", + "members": { + "GeometryOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Offset in the leg geometry corresponding to the start of this step.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Place": { + "target": "com.amazonaws.georoutes#RoutePassThroughPlace", + "traits": { + "smithy.api#documentation": "The place details.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "If the waypoint should be treated as a stop. If yes, the route is split up into different legs around the stop.
" + } + }, + "com.amazonaws.georoutes#RoutePassThroughWaypointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoutePassThroughWaypoint" + } + }, + "com.amazonaws.georoutes#RoutePedestrianArrival": { + "type": "structure", + "members": { + "Place": { + "target": "com.amazonaws.georoutes#RoutePedestrianPlace", + "traits": { + "smithy.api#documentation": "The place details.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "The time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details corresponding to the arrival for a leg.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
The place details.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "The time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details corresponding to the departure for a leg.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
Details corresponding to the arrival for the leg.
", + "smithy.api#required": {} + } + }, + "Departure": { + "target": "com.amazonaws.georoutes#RoutePedestrianDeparture", + "traits": { + "smithy.api#documentation": "Details corresponding to the departure for the leg.
", + "smithy.api#required": {} + } + }, + "Notices": { + "target": "com.amazonaws.georoutes#RoutePedestrianNoticeList", + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
", + "smithy.api#required": {} + } + }, + "PassThroughWaypoints": { + "target": "com.amazonaws.georoutes#RoutePassThroughWaypointList", + "traits": { + "smithy.api#documentation": "Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
", + "smithy.api#required": {} + } + }, + "Spans": { + "target": "com.amazonaws.georoutes#RoutePedestrianSpanList", + "traits": { + "smithy.api#documentation": "Spans that were computed for the requested SpanAdditionalFeatures.
", + "smithy.api#required": {} + } + }, + "Summary": { + "target": "com.amazonaws.georoutes#RoutePedestrianSummary", + "traits": { + "smithy.api#documentation": "Summarized details of the leg.
" + } + }, + "TravelSteps": { + "target": "com.amazonaws.georoutes#RoutePedestrianTravelStepList", + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed before the travel portion of the leg.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details that are specific to a pedestrian leg.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianNotice": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.georoutes#RoutePedestrianNoticeCode", + "traits": { + "smithy.api#documentation": "Code corresponding to the issue.
", + "smithy.api#required": {} + } + }, + "Impact": { + "target": "com.amazonaws.georoutes#RouteNoticeImpact", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianNoticeCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCURATE_POLYLINE_UNAVAILABLE", + "value": "AccuratePolylineUnavailable" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "VIOLATED_AVOID_DIRT_ROAD", + "value": "ViolatedAvoidDirtRoad" + }, + { + "name": "VIOLATED_AVOID_TUNNEL", + "value": "ViolatedAvoidTunnel" + }, + { + "name": "VIOLATED_PEDESTRIAN_OPTION", + "value": "ViolatedPedestrianOption" + } + ] + } + }, + "com.amazonaws.georoutes#RoutePedestrianNoticeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoutePedestrianNotice" + } + }, + "com.amazonaws.georoutes#RoutePedestrianOptions": { + "type": "structure", + "members": { + "Speed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Walking speed in Kilometers per hour.
", + "smithy.api#range": { + "min": 1.8, + "max": 7.2 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to the pedestrian.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianOverviewSummary": { + "type": "structure", + "members": { + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance of the step.
", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a summary of a pedestrian route step.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianPlace": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the place.
" + } + }, + "OriginalPosition": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position provided in the request.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Options to configure matching the provided position to a side of the street.
" + } + }, + "WaypointIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Index of the waypoint in the request.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Place details corresponding to the arrival or departure.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianSpan": { + "type": "structure", + "members": { + "BestCaseDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the computed span without traffic congestion.
\n\n Unit: seconds\n
3 letter Country code corresponding to the Span.
" + } + }, + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
\n\n Unit: seconds\n
Dynamic speed details corresponding to the span.
\n\n Unit: KilometersPerHour\n
Functional classification of the road segment corresponding to the span.
", + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "GeometryOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Offset in the leg geometry corresponding to the start of this span.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Incidents": { + "target": "com.amazonaws.georoutes#IndexList", + "traits": { + "smithy.api#documentation": "Incidents corresponding to the span. These index into the Incidents in the parent Leg.
" + } + }, + "Names": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Provides an array of names of the pedestrian span in available languages.
" + } + }, + "PedestrianAccess": { + "target": "com.amazonaws.georoutes#RouteSpanPedestrianAccessAttributeList", + "traits": { + "smithy.api#documentation": "Access attributes for a pedestrian corresponding to the span.
" + } + }, + "Region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "2-3 letter Region code corresponding to the Span. This is either a province or a state.
", + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "RoadAttributes": { + "target": "com.amazonaws.georoutes#RouteSpanRoadAttributeList", + "traits": { + "smithy.api#documentation": "Attributes for the road segment corresponding to the span.
" + } + }, + "RouteNumbers": { + "target": "com.amazonaws.georoutes#RouteNumberList", + "traits": { + "smithy.api#documentation": "Designated route name or number corresponding to the span.
" + } + }, + "SpeedLimit": { + "target": "com.amazonaws.georoutes#RouteSpanSpeedLimitDetails", + "traits": { + "smithy.api#documentation": "Speed limit details corresponding to the span.
\n\n Unit: KilometersPerHour\n
Duration of the computed span under typical traffic congestion.
\n\n Unit: seconds\n
Span computed for the requested SpanAdditionalFeatures.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianSpanList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoutePedestrianSpan" + } + }, + "com.amazonaws.georoutes#RoutePedestrianSummary": { + "type": "structure", + "members": { + "Overview": { + "target": "com.amazonaws.georoutes#RoutePedestrianOverviewSummary", + "traits": { + "smithy.api#documentation": "Summarized details for the leg including before travel, travel and after travel steps.
" + } + }, + "TravelOnly": { + "target": "com.amazonaws.georoutes#RoutePedestrianTravelOnlySummary", + "traits": { + "smithy.api#documentation": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarized details for the leg including before travel, travel and after travel steps.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianTravelOnlySummary": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Summarized details for the leg including travel steps.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianTravelStep": { + "type": "structure", + "members": { + "ContinueStepDetails": { + "target": "com.amazonaws.georoutes#RouteContinueStepDetails", + "traits": { + "smithy.api#documentation": "Details related to the continue step.
" + } + }, + "CurrentRoad": { + "target": "com.amazonaws.georoutes#RouteRoad", + "traits": { + "smithy.api#documentation": "Details of the current road. See RouteRoad for details of sub-attributes.
" + } + }, + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance of the step.
" + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Exit number of the road exit, if applicable.
" + } + }, + "GeometryOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Offset in the leg geometry corresponding to the start of this step.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Instruction": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Brief description of the step in the requested language.
\nOnly available when the TravelStepType is Default.
\nDetails that are specific to a Keep step.
" + } + }, + "NextRoad": { + "target": "com.amazonaws.georoutes#RouteRoad", + "traits": { + "smithy.api#documentation": "Details of the next road. See RouteRoad for details of sub-attributes.
" + } + }, + "RoundaboutEnterStepDetails": { + "target": "com.amazonaws.georoutes#RouteRoundaboutEnterStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Enter step.
" + } + }, + "RoundaboutExitStepDetails": { + "target": "com.amazonaws.georoutes#RouteRoundaboutExitStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Exit step.
" + } + }, + "RoundaboutPassStepDetails": { + "target": "com.amazonaws.georoutes#RouteRoundaboutPassStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Pass step.
" + } + }, + "Signpost": { + "target": "com.amazonaws.georoutes#RouteSignpost", + "traits": { + "smithy.api#documentation": "Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" + } + }, + "TurnStepDetails": { + "target": "com.amazonaws.georoutes#RouteTurnStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a turn step.
" + } + }, + "Type": { + "target": "com.amazonaws.georoutes#RoutePedestrianTravelStepType", + "traits": { + "smithy.api#documentation": "Type of the step.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed during the travel portion of the leg.
" + } + }, + "com.amazonaws.georoutes#RoutePedestrianTravelStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RoutePedestrianTravelStep" + } + }, + "com.amazonaws.georoutes#RoutePedestrianTravelStepType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ARRIVE", + "value": "Arrive" + }, + { + "name": "CONTINUE", + "value": "Continue" + }, + { + "name": "DEPART", + "value": "Depart" + }, + { + "name": "KEEP", + "value": "Keep" + }, + { + "name": "ROUNDABOUT_ENTER", + "value": "RoundaboutEnter" + }, + { + "name": "ROUNDABOUT_EXIT", + "value": "RoundaboutExit" + }, + { + "name": "ROUNDABOUT_PASS", + "value": "RoundaboutPass" + }, + { + "name": "TURN", + "value": "Turn" + }, + { + "name": "EXIT", + "value": "Exit" + }, + { + "name": "RAMP", + "value": "Ramp" + }, + { + "name": "U_TURN", + "value": "UTurn" + } + ] + } + }, + "com.amazonaws.georoutes#RouteRampStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details that are specific to a ramp step.
" + } + }, + "com.amazonaws.georoutes#RouteResponseNotice": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.georoutes#RouteResponseNoticeCode", + "traits": { + "smithy.api#documentation": "Code corresponding to the issue.
", + "smithy.api#required": {} + } + }, + "Impact": { + "target": "com.amazonaws.georoutes#RouteNoticeImpact", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
" + } + }, + "com.amazonaws.georoutes#RouteResponseNoticeCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MAIN_LANGUAGE_NOT_FOUND", + "value": "MainLanguageNotFound" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "TRAVEL_TIME_EXCEEDS_DRIVER_WORK_HOURS", + "value": "TravelTimeExceedsDriverWorkHours" + } + ] + } + }, + "com.amazonaws.georoutes#RouteResponseNoticeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteResponseNotice" + } + }, + "com.amazonaws.georoutes#RouteRoad": { + "type": "structure", + "members": { + "RoadName": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the road (localized).
", + "smithy.api#required": {} + } + }, + "RouteNumber": { + "target": "com.amazonaws.georoutes#RouteNumberList", + "traits": { + "smithy.api#documentation": "Route number of the road.
", + "smithy.api#required": {} + } + }, + "Towards": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Names of destinations that can be reached when traveling on the road.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.georoutes#RouteRoadType", + "traits": { + "smithy.api#documentation": "The type of road.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The road on the route.
" + } + }, + "com.amazonaws.georoutes#RouteRoadType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "HIGHWAY", + "value": "Highway" + }, + { + "name": "RURAL", + "value": "Rural" + }, + { + "name": "URBAN", + "value": "Urban" + } + ] + } + }, + "com.amazonaws.georoutes#RouteRoundaboutEnterStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the roundabout leg.
" + } + }, + "com.amazonaws.georoutes#RouteRoundaboutExitStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "RelativeExit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Exit to be taken.
", + "smithy.api#range": { + "min": 1, + "max": 12 + } + } + }, + "RoundaboutAngle": { + "target": "com.amazonaws.georoutes#RoundaboutAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the roundabout.
" + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the roundabout step.
" + } + }, + "com.amazonaws.georoutes#RouteRoundaboutPassStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the step.
" + } + }, + "com.amazonaws.georoutes#RouteScooterOptions": { + "type": "structure", + "members": { + "EngineType": { + "target": "com.amazonaws.georoutes#RouteEngineType", + "traits": { + "smithy.api#documentation": "Engine type of the vehicle.
" + } + }, + "LicensePlate": { + "target": "com.amazonaws.georoutes#RouteVehicleLicensePlate", + "traits": { + "smithy.api#documentation": "The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Travel mode options when the provided travel mode is \"Scooter\"
" + } + }, + "com.amazonaws.georoutes#RouteSideOfStreet": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LEFT", + "value": "Left" + }, + { + "name": "RIGHT", + "value": "Right" + } + ] + } + }, + "com.amazonaws.georoutes#RouteSideOfStreetOptions": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used.
\nDefault Value: DividedStreetOnly\n
Options to configure matching the provided position to a side of the street.
" + } + }, + "com.amazonaws.georoutes#RouteSignpost": { + "type": "structure", + "members": { + "Labels": { + "target": "com.amazonaws.georoutes#RouteSignpostLabelList", + "traits": { + "smithy.api#documentation": "Labels present on the sign post.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" + } + }, + "com.amazonaws.georoutes#RouteSignpostLabel": { + "type": "structure", + "members": { + "RouteNumber": { + "target": "com.amazonaws.georoutes#RouteNumber", + "traits": { + "smithy.api#documentation": "Route number of the road.
" + } + }, + "Text": { + "target": "com.amazonaws.georoutes#LocalizedString", + "traits": { + "smithy.api#documentation": "The Signpost text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Labels presented on the sign post.
" + } + }, + "com.amazonaws.georoutes#RouteSignpostLabelList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteSignpostLabel" + } + }, + "com.amazonaws.georoutes#RouteSpanAdditionalFeature": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "BEST_CASE_DURATION", + "value": "BestCaseDuration" + }, + { + "name": "CAR_ACCESS", + "value": "CarAccess" + }, + { + "name": "COUNTRY", + "value": "Country" + }, + { + "name": "DISTANCE", + "value": "Distance" + }, + { + "name": "DURATION", + "value": "Duration" + }, + { + "name": "DYNAMIC_SPEED", + "value": "DynamicSpeed" + }, + { + "name": "FUNCTIONAL_CLASSIFICATION", + "value": "FunctionalClassification" + }, + { + "name": "GATES", + "value": "Gates" + }, + { + "name": "INCIDENTS", + "value": "Incidents" + }, + { + "name": "NAMES", + "value": "Names" + }, + { + "name": "NOTICES", + "value": "Notices" + }, + { + "name": "PEDESTRIAN_ACCESS", + "value": "PedestrianAccess" + }, + { + "name": "RAILWAY_CROSSINGS", + "value": "RailwayCrossings" + }, + { + "name": "REGION", + "value": "Region" + }, + { + "name": "ROAD_ATTRIBUTES", + "value": "RoadAttributes" + }, + { + "name": "ROUTE_NUMBERS", + "value": "RouteNumbers" + }, + { + "name": "SCOOTER_ACCESS", + "value": "ScooterAccess" + }, + { + "name": "SPEED_LIMIT", + "value": "SpeedLimit" + }, + { + "name": "TOLL_SYSTEMS", + "value": "TollSystems" + }, + { + "name": "TRUCK_ACCESS", + "value": "TruckAccess" + }, + { + "name": "TRUCK_ROAD_TYPES", + "value": "TruckRoadTypes" + }, + { + "name": "TYPICAL_DURATION", + "value": "TypicalDuration" + }, + { + "name": "ZONES", + "value": "Zones" + }, + { + "name": "CONSUMPTION", + "value": "Consumption" + } + ] + } + }, + "com.amazonaws.georoutes#RouteSpanAdditionalFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteSpanAdditionalFeature" + }, + "traits": { + "smithy.api#length": { + "max": 24 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteSpanCarAccessAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ALLOWED", + "value": "Allowed" + }, + { + "name": "NO_THROUGH_TRAFFIC", + "value": "NoThroughTraffic" + }, + { + "name": "TOLL_ROAD", + "value": "TollRoad" + } + ] + } + }, + "com.amazonaws.georoutes#RouteSpanCarAccessAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteSpanCarAccessAttribute" + }, + "traits": { + "smithy.api#length": { + "max": 3 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteSpanDynamicSpeedDetails": { + "type": "structure", + "members": { + "BestCaseSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Estimated speed while traversing the span without traffic congestion.
\n\n Unit: KilometersPerHour\n
Estimated time to turn from this span into the next.
\n\n Unit: seconds\n
Estimated speed while traversing the span under typical traffic congestion.
\n\n Unit: KilometersPerHour\n
Details about the dynamic speed.
\n\n Unit: KilometersPerHour\n
Maximum speed.
\n\n Unit: KilometersPerHour\n
If the span doesn't have a speed limit like the Autobahn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the speed limit corresponding to the span.
\n\n Unit: KilometersPerHour\n
Distance of the route.
" + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the route.
\n\n Unit: seconds\n
Toll summary for the complete route.
" + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.georoutes#RouteToll": { + "type": "structure", + "members": { + "Country": { + "target": "com.amazonaws.georoutes#CountryCode3", + "traits": { + "smithy.api#documentation": "The alpha-2 or alpha-3 character code for the country.
" + } + }, + "PaymentSites": { + "target": "com.amazonaws.georoutes#RouteTollPaymentSiteList", + "traits": { + "smithy.api#documentation": "Locations or sites where the toll fare is collected.
", + "smithy.api#required": {} + } + }, + "Rates": { + "target": "com.amazonaws.georoutes#RouteTollRateList", + "traits": { + "smithy.api#documentation": "Toll rates that need to be paid to travel this leg of the route.
", + "smithy.api#required": {} + } + }, + "Systems": { + "target": "com.amazonaws.georoutes#IndexList", + "traits": { + "smithy.api#documentation": "Toll systems are authorities that collect payments for the toll.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#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.
" + } + }, + "com.amazonaws.georoutes#RouteTollList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteToll" + } + }, + "com.amazonaws.georoutes#RouteTollOptions": { + "type": "structure", + "members": { + "AllTransponders": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies if the user has valid transponder with access to all toll systems. This\n impacts toll calculation, and if true the price with transponders is used.
" + } + }, + "AllVignettes": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.georoutes#CurrencyCode", + "traits": { + "smithy.api#documentation": "Currency code corresponding to the price. This is the same as Currency specified in the request.
" + } + }, + "EmissionType": { + "target": "com.amazonaws.georoutes#RouteEmissionType", + "traits": { + "smithy.api#documentation": "Emission type of the vehicle for toll cost calculation.
\n\n Valid values: Euro1, Euro2, Euro3, Euro4, Euro5, Euro6, EuroEev\n
Vehicle category for toll cost calculation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to Tolls on a route.
" + } + }, + "com.amazonaws.georoutes#RouteTollPass": { + "type": "structure", + "members": { + "IncludesReturnTrip": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "If the pass includes the rate for the return leg of the trip.
" + } + }, + "SeniorPass": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "If the pass is only valid for senior persons.
" + } + }, + "TransferCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "If the toll pass can be transferred, and how many times.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "TripCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of trips the pass is valid for.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "ValidityPeriod": { + "target": "com.amazonaws.georoutes#RouteTollPassValidityPeriod", + "traits": { + "smithy.api#documentation": "Period for which the pass is valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details if the toll rate can be a pass that supports multiple trips.
" + } + }, + "com.amazonaws.georoutes#RouteTollPassValidityPeriod": { + "type": "structure", + "members": { + "Period": { + "target": "com.amazonaws.georoutes#RouteTollPassValidityPeriodType", + "traits": { + "smithy.api#documentation": "Validity period.
", + "smithy.api#required": {} + } + }, + "PeriodCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Counts for the validity period.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Period for which the pass is valid.
" + } + }, + "com.amazonaws.georoutes#RouteTollPassValidityPeriodType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ANNUAL", + "value": "Annual" + }, + { + "name": "DAYS", + "value": "Days" + }, + { + "name": "EXTENDED_ANNUAL", + "value": "ExtendedAnnual" + }, + { + "name": "MINUTES", + "value": "Minutes" + }, + { + "name": "MONTHS", + "value": "Months" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTollPaymentMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "BANK_CARD", + "value": "BankCard" + }, + { + "name": "CASH", + "value": "Cash" + }, + { + "name": "CASH_EXACT", + "value": "CashExact" + }, + { + "name": "CREDIT_CARD", + "value": "CreditCard" + }, + { + "name": "PASS_SUBSCRIPTION", + "value": "PassSubscription" + }, + { + "name": "TRAVEL_CARD", + "value": "TravelCard" + }, + { + "name": "TRANSPONDER", + "value": "Transponder" + }, + { + "name": "VIDEO_TOLL", + "value": "VideoToll" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTollPaymentMethodList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteTollPaymentMethod" + }, + "traits": { + "smithy.api#length": { + "max": 8 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#RouteTollPaymentSite": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of the payment site.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Locations or sites where the toll fare is collected.
" + } + }, + "com.amazonaws.georoutes#RouteTollPaymentSiteList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteTollPaymentSite" + } + }, + "com.amazonaws.georoutes#RouteTollPrice": { + "type": "structure", + "members": { + "Currency": { + "target": "com.amazonaws.georoutes#CurrencyCode", + "traits": { + "smithy.api#documentation": "Currency code corresponding to the price. This is the same as Currency specified in the request.
", + "smithy.api#required": {} + } + }, + "Estimate": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "If the price is an estimate or an exact value.
", + "smithy.api#required": {} + } + }, + "PerDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration for which the price corresponds to.
\n\n Unit: seconds\n
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.
", + "smithy.api#required": {} + } + }, + "RangeValue": { + "target": "com.amazonaws.georoutes#RouteTollPriceValueRange", + "traits": { + "smithy.api#documentation": "Price range with a minimum and maximum value, if a range.
" + } + }, + "Value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Exact price, if not a range.
", + "smithy.api#range": { + "min": 0.0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The toll price.
" + } + }, + "com.amazonaws.georoutes#RouteTollPriceSummary": { + "type": "structure", + "members": { + "Currency": { + "target": "com.amazonaws.georoutes#CurrencyCode", + "traits": { + "smithy.api#documentation": "Currency code corresponding to the price. This is the same as Currency specified in the request.
", + "smithy.api#required": {} + } + }, + "Estimate": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "If the price is an estimate or an exact value.
", + "smithy.api#required": {} + } + }, + "Range": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#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.
", + "smithy.api#required": {} + } + }, + "RangeValue": { + "target": "com.amazonaws.georoutes#RouteTollPriceValueRange", + "traits": { + "smithy.api#documentation": "Price range with a minimum and maximum value, if a range.
" + } + }, + "Value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Exact price, if not a range.
", + "smithy.api#range": { + "min": 0.0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of the route and toll price.
" + } + }, + "com.amazonaws.georoutes#RouteTollPriceValueRange": { + "type": "structure", + "members": { + "Min": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Minimum price.
", + "smithy.api#range": { + "min": 0.0 + }, + "smithy.api#required": {} + } + }, + "Max": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Maximum price.
", + "smithy.api#range": { + "min": 0.0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Price range with a minimum and maximum value, if a range.
" + } + }, + "com.amazonaws.georoutes#RouteTollRate": { + "type": "structure", + "members": { + "ApplicableTimes": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Time when the rate is valid.
" + } + }, + "ConvertedPrice": { + "target": "com.amazonaws.georoutes#RouteTollPrice", + "traits": { + "smithy.api#documentation": "Price in the converted currency as specified in the request.
" + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Toll rate Id.
", + "smithy.api#required": {} + } + }, + "LocalPrice": { + "target": "com.amazonaws.georoutes#RouteTollPrice", + "traits": { + "smithy.api#documentation": "Price in the local regional currency.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the toll.
", + "smithy.api#required": {} + } + }, + "Pass": { + "target": "com.amazonaws.georoutes#RouteTollPass", + "traits": { + "smithy.api#documentation": "Details if the toll rate can be a pass that supports multiple trips.
" + } + }, + "PaymentMethods": { + "target": "com.amazonaws.georoutes#RouteTollPaymentMethodList", + "traits": { + "smithy.api#documentation": "Accepted payment methods at the toll.
", + "smithy.api#required": {} + } + }, + "Transponders": { + "target": "com.amazonaws.georoutes#RouteTransponderList", + "traits": { + "smithy.api#documentation": "Transponders for which this toll can be applied.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The toll rate.
" + } + }, + "com.amazonaws.georoutes#RouteTollRateList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteTollRate" + } + }, + "com.amazonaws.georoutes#RouteTollSummary": { + "type": "structure", + "members": { + "Total": { + "target": "com.amazonaws.georoutes#RouteTollPriceSummary", + "traits": { + "smithy.api#documentation": "Total toll summary for the complete route. Total is the only summary available\n today.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The toll summary for the complete route.
" + } + }, + "com.amazonaws.georoutes#RouteTollSystem": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The toll system name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Toll systems are authorities that collect payments for the toll.
" + } + }, + "com.amazonaws.georoutes#RouteTollSystemList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteTollSystem" + } + }, + "com.amazonaws.georoutes#RouteTollVehicleCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "MINIBUS", + "value": "Minibus" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTrafficOptions": { + "type": "structure", + "members": { + "FlowEventThresholdOverride": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration for which flow \n traffic is considered valid. \n For this period, the flow traffic is used over historical traffic data. \n Flow traffic refers to congestion, which changes very quickly. \n Duration in seconds for which flow traffic event would be considered valid. \n While flow traffic event is valid it will be used over the historical traffic data.
" + } + }, + "Usage": { + "target": "com.amazonaws.georoutes#TrafficUsage", + "traits": { + "smithy.api#documentation": "Determines if traffic should be used or ignored while calculating the route.
\nDefault Value: UseTrafficData\n
Traffic options for the route.
" + } + }, + "com.amazonaws.georoutes#RouteTrailerOptions": { + "type": "structure", + "members": { + "AxleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Total number of axles of the vehicle.
", + "smithy.api#range": { + "min": 1 + } + } + }, + "TrailerCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Number of trailers attached to the vehicle.
\nDefault Value: 0\n
Trailer options corresponding to the vehicle.
" + } + }, + "com.amazonaws.georoutes#RouteTransponder": { + "type": "structure", + "members": { + "SystemName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Names of the toll system collecting the toll.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Transponders for which this toll can be applied.
" + } + }, + "com.amazonaws.georoutes#RouteTransponderList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteTransponder" + } + }, + "com.amazonaws.georoutes#RouteTravelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAR", + "value": "Car" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "SCOOTER", + "value": "Scooter" + }, + { + "name": "TRUCK", + "value": "Truck" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTravelModeOptions": { + "type": "structure", + "members": { + "Car": { + "target": "com.amazonaws.georoutes#RouteCarOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Car\"
" + } + }, + "Pedestrian": { + "target": "com.amazonaws.georoutes#RoutePedestrianOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Pedestrian\"
" + } + }, + "Scooter": { + "target": "com.amazonaws.georoutes#RouteScooterOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Scooter\"
" + } + }, + "Truck": { + "target": "com.amazonaws.georoutes#RouteTruckOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Truck\"
" + } + } + }, + "traits": { + "smithy.api#documentation": "Travel mode related options for the provided travel mode.
" + } + }, + "com.amazonaws.georoutes#RouteTravelStepType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DEFAULT", + "value": "Default" + }, + { + "name": "TURN_BY_TURN", + "value": "TurnByTurn" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTruckOptions": { + "type": "structure", + "members": { + "AxleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Total number of axles of the vehicle.
", + "smithy.api#range": { + "min": 2, + "max": 255 + } + } + }, + "EngineType": { + "target": "com.amazonaws.georoutes#RouteEngineType", + "traits": { + "smithy.api#documentation": "Engine type of the vehicle.
" + } + }, + "GrossWeight": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Gross weight of the vehicle including trailers, and goods at capacity.
\n\n Unit: Kilograms\n
List of Hazardous cargo contained in the vehicle.
" + } + }, + "Height": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Height of the vehicle.
\n\n Unit: centimeters\n
Height of the vehicle above its first axle.
\n\n Unit: centimeters\n
Kingpin to rear axle length of the vehicle.
\n\n Unit: centimeters\n
Length of the vehicle.
\n\n Unit: c\n
The vehicle License Plate.
" + } + }, + "MaxSpeed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Maximum speed
\n\n Unit: KilometersPerHour\n
The number of occupants in the vehicle.
\nDefault Value: 1\n
Payload capacity of the vehicle and trailers attached.
\n\n Unit: kilograms\n
Number of tires on the vehicle.
", + "smithy.api#range": { + "min": 1, + "max": 255 + } + } + }, + "Trailer": { + "target": "com.amazonaws.georoutes#RouteTrailerOptions", + "traits": { + "smithy.api#documentation": "Trailer options corresponding to the vehicle.
" + } + }, + "TruckType": { + "target": "com.amazonaws.georoutes#RouteTruckType", + "traits": { + "smithy.api#documentation": "Type of the truck.
" + } + }, + "TunnelRestrictionCode": { + "target": "com.amazonaws.georoutes#TunnelRestrictionCode", + "traits": { + "smithy.api#documentation": "The tunnel restriction code.
\nTunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. \n They relate to the types of dangerous goods that can be transported through them.
\n\n Tunnel Category B\n
\n\n Risk Level: Limited risk
\n\n Restrictions: Few restrictions
\n\n Tunnel Category C\n
\n\n Risk Level: Medium risk
\n\n Restrictions: Some restrictions
\n\n Tunnel Category D\n
\n\n Risk Level: High risk
\n\n Restrictions: Many restrictions occur
\n\n Tunnel Category E\n
\n\n Risk Level: Very high risk
\n\n Restrictions: Restricted tunnel
\nHeaviest 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.
\n\n Unit: Kilograms\n
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
\n\n Unit: Kilograms\n
Width of the vehicle.
\n\n Unit: centimeters\n
Travel mode options when the provided travel mode is \"Truck\"
" + } + }, + "com.amazonaws.georoutes#RouteTruckType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LIGHT_TRUCK", + "value": "LightTruck" + }, + { + "name": "STRAIGHT_TRUCK", + "value": "StraightTruck" + }, + { + "name": "TRACTOR", + "value": "Tractor" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTurnIntensity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SHARP", + "value": "Sharp" + }, + { + "name": "SLIGHT", + "value": "Slight" + }, + { + "name": "TYPICAL", + "value": "Typical" + } + ] + } + }, + "com.amazonaws.georoutes#RouteTurnStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the turn step.
" + } + }, + "com.amazonaws.georoutes#RouteUTurnStepDetails": { + "type": "structure", + "members": { + "Intersection": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Name of the intersection, if applicable to the step.
", + "smithy.api#required": {} + } + }, + "SteeringDirection": { + "target": "com.amazonaws.georoutes#RouteSteeringDirection", + "traits": { + "smithy.api#documentation": "Steering direction for the step.
" + } + }, + "TurnAngle": { + "target": "com.amazonaws.georoutes#TurnAngle", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Angle of the turn.
" + } + }, + "TurnIntensity": { + "target": "com.amazonaws.georoutes#RouteTurnIntensity", + "traits": { + "smithy.api#documentation": "Intensity of the turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details related to the U-turn step.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleArrival": { + "type": "structure", + "members": { + "Place": { + "target": "com.amazonaws.georoutes#RouteVehiclePlace", + "traits": { + "smithy.api#documentation": "The place details.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "The time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details corresponding to the arrival for a leg.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleDeparture": { + "type": "structure", + "members": { + "Place": { + "target": "com.amazonaws.georoutes#RouteVehiclePlace", + "traits": { + "smithy.api#documentation": "The place details.
", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "The departure time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details corresponding to the departure for the leg.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleIncident": { + "type": "structure", + "members": { + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Brief readable description of the incident.
" + } + }, + "EndTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "End timestamp of the incident.
" + } + }, + "Severity": { + "target": "com.amazonaws.georoutes#RouteVehicleIncidentSeverity", + "traits": { + "smithy.api#documentation": "Severity of the incident\nCritical - The part of the route the incident affects is unusable.\nMajor- Major impact on the leg duration, for example stop and go\nMinor- Minor impact on the leg duration, for example traffic jam\nLow - Low on duration, for example slightly increased traffic
" + } + }, + "StartTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Start time of the incident.
" + } + }, + "Type": { + "target": "com.amazonaws.georoutes#RouteVehicleIncidentType", + "traits": { + "smithy.api#documentation": "Type of the incident.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Incidents corresponding to this leg of the route.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleIncidentList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteVehicleIncident" + } + }, + "com.amazonaws.georoutes#RouteVehicleIncidentSeverity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CRITICAL", + "value": "Critical" + }, + { + "name": "HIGH", + "value": "High" + }, + { + "name": "MEDIUM", + "value": "Medium" + }, + { + "name": "LOW", + "value": "Low" + } + ] + } + }, + "com.amazonaws.georoutes#RouteVehicleIncidentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCIDENT", + "value": "Accident" + }, + { + "name": "CONGESTION", + "value": "Congestion" + }, + { + "name": "CONSTRUCTION", + "value": "Construction" + }, + { + "name": "DISABLED_VEHICLE", + "value": "DisabledVehicle" + }, + { + "name": "LANE_RESTRICTION", + "value": "LaneRestriction" + }, + { + "name": "MASS_TRANSIT", + "value": "MassTransit" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "PLANNED_EVENT", + "value": "PlannedEvent" + }, + { + "name": "ROAD_CLOSURE", + "value": "RoadClosure" + }, + { + "name": "ROAD_HAZARD", + "value": "RoadHazard" + }, + { + "name": "WEATHER", + "value": "Weather" + } + ] + } + }, + "com.amazonaws.georoutes#RouteVehicleLegDetails": { + "type": "structure", + "members": { + "Arrival": { + "target": "com.amazonaws.georoutes#RouteVehicleArrival", + "traits": { + "smithy.api#documentation": "Details corresponding to the arrival for the leg.
", + "smithy.api#required": {} + } + }, + "Departure": { + "target": "com.amazonaws.georoutes#RouteVehicleDeparture", + "traits": { + "smithy.api#documentation": "Details corresponding to the departure for the leg.
", + "smithy.api#required": {} + } + }, + "Incidents": { + "target": "com.amazonaws.georoutes#RouteVehicleIncidentList", + "traits": { + "smithy.api#documentation": "Incidents corresponding to this leg of the route.
", + "smithy.api#required": {} + } + }, + "Notices": { + "target": "com.amazonaws.georoutes#RouteVehicleNoticeList", + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
", + "smithy.api#required": {} + } + }, + "PassThroughWaypoints": { + "target": "com.amazonaws.georoutes#RoutePassThroughWaypointList", + "traits": { + "smithy.api#documentation": "Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
", + "smithy.api#required": {} + } + }, + "Spans": { + "target": "com.amazonaws.georoutes#RouteVehicleSpanList", + "traits": { + "smithy.api#documentation": "Spans that were computed for the requested SpanAdditionalFeatures.
", + "smithy.api#required": {} + } + }, + "Summary": { + "target": "com.amazonaws.georoutes#RouteVehicleSummary", + "traits": { + "smithy.api#documentation": "Summarized details of the leg.
" + } + }, + "Tolls": { + "target": "com.amazonaws.georoutes#RouteTollList", + "traits": { + "smithy.api#documentation": "Toll related options.
", + "smithy.api#required": {} + } + }, + "TollSystems": { + "target": "com.amazonaws.georoutes#RouteTollSystemList", + "traits": { + "smithy.api#documentation": "Toll systems are authorities that collect payments for the toll.
", + "smithy.api#required": {} + } + }, + "TravelSteps": { + "target": "com.amazonaws.georoutes#RouteVehicleTravelStepList", + "traits": { + "smithy.api#documentation": "Steps of a leg that must be performed before the travel portion of the leg.
", + "smithy.api#required": {} + } + }, + "TruckRoadTypes": { + "target": "com.amazonaws.georoutes#TruckRoadTypeList", + "traits": { + "smithy.api#documentation": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. \n A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
\nZones corresponding to this leg of the route.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Steps of a leg that correspond to the travel portion of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleLicensePlate": { + "type": "structure", + "members": { + "LastCharacter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The last character of the License Plate.
", + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + } + }, + "traits": { + "smithy.api#documentation": "License plate information of the vehicle. Currently, only the last character is used\n where license plate based controlled access is enforced.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleNotice": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.georoutes#RouteVehicleNoticeCode", + "traits": { + "smithy.api#documentation": "Code corresponding to the issue.
", + "smithy.api#required": {} + } + }, + "Details": { + "target": "com.amazonaws.georoutes#RouteVehicleNoticeDetailList", + "traits": { + "smithy.api#documentation": "Additional details of the notice.
", + "smithy.api#required": {} + } + }, + "Impact": { + "target": "com.amazonaws.georoutes#RouteNoticeImpact", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleNoticeCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCURATE_POLYLINE_UNAVAILABLE", + "value": "AccuratePolylineUnavailable" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "POTENTIAL_VIOLATED_AVOID_TOLL_ROAD_USAGE", + "value": "PotentialViolatedAvoidTollRoadUsage" + }, + { + "name": "POTENTIAL_VIOLATED_CARPOOL_USAGE", + "value": "PotentialViolatedCarpoolUsage" + }, + { + "name": "POTENTIAL_VIOLATED_TURN_RESTRICTION_USAGE", + "value": "PotentialViolatedTurnRestrictionUsage" + }, + { + "name": "POTENTIAL_VIOLATED_VEHICLE_RESTRICTION_USAGE", + "value": "PotentialViolatedVehicleRestrictionUsage" + }, + { + "name": "POTENTIAL_VIOLATED_ZONE_RESTRICTION_USAGE", + "value": "PotentialViolatedZoneRestrictionUsage" + }, + { + "name": "SEASONAL_CLOSURE", + "value": "SeasonalClosure" + }, + { + "name": "TOLLS_DATA_TEMPORARILY_UNAVAILABLE", + "value": "TollsDataTemporarilyUnavailable" + }, + { + "name": "TOLLS_DATA_UNAVAILABLE", + "value": "TollsDataUnavailable" + }, + { + "name": "TOLL_TRANSPONDER", + "value": "TollTransponder" + }, + { + "name": "VIOLATED_AVOID_CONTROLLED_ACCESS_HIGHWAY", + "value": "ViolatedAvoidControlledAccessHighway" + }, + { + "name": "VIOLATED_AVOID_DIFFICULT_TURNS", + "value": "ViolatedAvoidDifficultTurns" + }, + { + "name": "VIOLATED_AVOID_DIRT_ROAD", + "value": "ViolatedAvoidDirtRoad" + }, + { + "name": "VIOLATED_AVOID_SEASONAL_CLOSURE", + "value": "ViolatedAvoidSeasonalClosure" + }, + { + "name": "VIOLATED_AVOID_TOLL_ROAD", + "value": "ViolatedAvoidTollRoad" + }, + { + "name": "VIOLATED_AVOID_TOLL_TRANSPONDER", + "value": "ViolatedAvoidTollTransponder" + }, + { + "name": "VIOLATED_AVOID_TRUCK_ROAD_TYPE", + "value": "ViolatedAvoidTruckRoadType" + }, + { + "name": "VIOLATED_AVOID_TUNNEL", + "value": "ViolatedAvoidTunnel" + }, + { + "name": "VIOLATED_AVOID_U_TURNS", + "value": "ViolatedAvoidUTurns" + }, + { + "name": "VIOLATED_BLOCKED_ROAD", + "value": "ViolatedBlockedRoad" + }, + { + "name": "VIOLATED_CARPOOL", + "value": "ViolatedCarpool" + }, + { + "name": "VIOLATED_EMERGENCY_GATE", + "value": "ViolatedEmergencyGate" + }, + { + "name": "VIOLATED_START_DIRECTION", + "value": "ViolatedStartDirection" + }, + { + "name": "VIOLATED_TURN_RESTRICTION", + "value": "ViolatedTurnRestriction" + }, + { + "name": "VIOLATED_VEHICLE_RESTRICTION", + "value": "ViolatedVehicleRestriction" + }, + { + "name": "VIOLATED_ZONE_RESTRICTION", + "value": "ViolatedZoneRestriction" + } + ] + } + }, + "com.amazonaws.georoutes#RouteVehicleNoticeDetail": { + "type": "structure", + "members": { + "Title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The notice title.
" + } + }, + "ViolatedConstraints": { + "target": "com.amazonaws.georoutes#RouteViolatedConstraints", + "traits": { + "smithy.api#documentation": "Any violated constraints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional details of the notice.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleNoticeDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteVehicleNoticeDetail" + } + }, + "com.amazonaws.georoutes#RouteVehicleNoticeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteVehicleNotice" + } + }, + "com.amazonaws.georoutes#RouteVehicleOverviewSummary": { + "type": "structure", + "members": { + "BestCaseDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
\n\n Unit: seconds\n
Distance of the step.
", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Duration of the computed span under typical traffic congestion.
\n\n Unit: seconds\n
Summarized details of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteVehiclePlace": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the place.
" + } + }, + "OriginalPosition": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position provided in the request.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position23", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Options to configure matching the provided position to a side of the street.
" + } + }, + "WaypointIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Index of the waypoint in the request.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Place details corresponding to the arrival or departure.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleSpan": { + "type": "structure", + "members": { + "BestCaseDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the computed span without traffic congestion.
\n\n Unit: seconds\n
Access attributes for a car corresponding to the span.
" + } + }, + "Country": { + "target": "com.amazonaws.georoutes#CountryCode3", + "traits": { + "smithy.api#documentation": "3 letter Country code corresponding to the Span.
" + } + }, + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
\n\n Unit: seconds\n
Dynamic speed details corresponding to the span.
\n\n Unit: KilometersPerHour\n
Functional classification of the road segment corresponding to the span.
", + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "Gate": { + "target": "com.amazonaws.georoutes#RouteSpanGateAttribute", + "traits": { + "smithy.api#documentation": "Attributes corresponding to a gate. The gate is present at the end of the returned span.
" + } + }, + "GeometryOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Offset in the leg geometry corresponding to the start of this span.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Incidents": { + "target": "com.amazonaws.georoutes#IndexList", + "traits": { + "smithy.api#documentation": "Incidents corresponding to the span. These index into the Incidents in the parent Leg.
" + } + }, + "Names": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Provides an array of names of the vehicle span in available languages.
" + } + }, + "Notices": { + "target": "com.amazonaws.georoutes#IndexList", + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
" + } + }, + "RailwayCrossing": { + "target": "com.amazonaws.georoutes#RouteSpanRailwayCrossingAttribute", + "traits": { + "smithy.api#documentation": "Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
" + } + }, + "Region": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "2-3 letter Region code corresponding to the Span. This is either a province or a state.
", + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "RoadAttributes": { + "target": "com.amazonaws.georoutes#RouteSpanRoadAttributeList", + "traits": { + "smithy.api#documentation": "Attributes for the road segment corresponding to the span.
" + } + }, + "RouteNumbers": { + "target": "com.amazonaws.georoutes#RouteNumberList", + "traits": { + "smithy.api#documentation": "Designated route name or number corresponding to the span.
" + } + }, + "ScooterAccess": { + "target": "com.amazonaws.georoutes#RouteSpanScooterAccessAttributeList", + "traits": { + "smithy.api#documentation": "Access attributes for a scooter corresponding to the span.
" + } + }, + "SpeedLimit": { + "target": "com.amazonaws.georoutes#RouteSpanSpeedLimitDetails", + "traits": { + "smithy.api#documentation": "Speed limit details corresponding to the span.
\n\n Unit: KilometersPerHour\n
Toll systems are authorities that collect payments for the toll.
" + } + }, + "TruckAccess": { + "target": "com.amazonaws.georoutes#RouteSpanTruckAccessAttributeList", + "traits": { + "smithy.api#documentation": "Access attributes for a truck corresponding to the span.
" + } + }, + "TruckRoadTypes": { + "target": "com.amazonaws.georoutes#IndexList", + "traits": { + "smithy.api#documentation": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. \n A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
\nDuration of the computed span under typical traffic congestion.
\n\n Unit: seconds\n
Zones corresponding to this leg of the route.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Span computed for the requested SpanAdditionalFeatures.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleSpanList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteVehicleSpan" + } + }, + "com.amazonaws.georoutes#RouteVehicleSummary": { + "type": "structure", + "members": { + "Overview": { + "target": "com.amazonaws.georoutes#RouteVehicleOverviewSummary", + "traits": { + "smithy.api#documentation": "Summarized details for the leg including before travel, travel and after travel steps.
" + } + }, + "TravelOnly": { + "target": "com.amazonaws.georoutes#RouteVehicleTravelOnlySummary", + "traits": { + "smithy.api#documentation": "Summarized details for the leg including travel steps only. The Distance for the travel only portion of the journey is in meters
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarized details of the route.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleTravelOnlySummary": { + "type": "structure", + "members": { + "BestCaseDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Total duration in free flowing traffic, which is the best case or shortest duration possible to cover the leg.
\n\n Unit: seconds\n
Duration of the step.
\n\n Unit: seconds\n
Duration of the computed span under typical traffic congestion.
\n\n Unit: seconds\n
Summarized details of the route.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleTravelStep": { + "type": "structure", + "members": { + "ContinueHighwayStepDetails": { + "target": "com.amazonaws.georoutes#RouteContinueHighwayStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Continue Highway step.
" + } + }, + "ContinueStepDetails": { + "target": "com.amazonaws.georoutes#RouteContinueStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Continue step.
" + } + }, + "CurrentRoad": { + "target": "com.amazonaws.georoutes#RouteRoad", + "traits": { + "smithy.api#documentation": "Details of the current road.
" + } + }, + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance of the step.
" + } + }, + "Duration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the step.
\n\n Unit: seconds\n
Details that are specific to a Enter Highway step.
" + } + }, + "ExitNumber": { + "target": "com.amazonaws.georoutes#LocalizedStringList", + "traits": { + "smithy.api#documentation": "Exit number of the road exit, if applicable.
" + } + }, + "ExitStepDetails": { + "target": "com.amazonaws.georoutes#RouteExitStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Exit step.
" + } + }, + "GeometryOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Offset in the leg geometry corresponding to the start of this step.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "Instruction": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Brief description of the step in the requested language.
\nOnly available when the TravelStepType is Default.
\nDetails that are specific to a Keep step.
" + } + }, + "NextRoad": { + "target": "com.amazonaws.georoutes#RouteRoad", + "traits": { + "smithy.api#documentation": "Details of the next road. See RouteRoad for details of sub-attributes.
" + } + }, + "RampStepDetails": { + "target": "com.amazonaws.georoutes#RouteRampStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Ramp step.
" + } + }, + "RoundaboutEnterStepDetails": { + "target": "com.amazonaws.georoutes#RouteRoundaboutEnterStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Enter step.
" + } + }, + "RoundaboutExitStepDetails": { + "target": "com.amazonaws.georoutes#RouteRoundaboutExitStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Exit step.
" + } + }, + "RoundaboutPassStepDetails": { + "target": "com.amazonaws.georoutes#RouteRoundaboutPassStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Roundabout Pass step.
" + } + }, + "Signpost": { + "target": "com.amazonaws.georoutes#RouteSignpost", + "traits": { + "smithy.api#documentation": "Sign post information of the action, applicable only for TurnByTurn steps. See RouteSignpost for details of sub-attributes.
" + } + }, + "TurnStepDetails": { + "target": "com.amazonaws.georoutes#RouteTurnStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Turn step.
" + } + }, + "Type": { + "target": "com.amazonaws.georoutes#RouteVehicleTravelStepType", + "traits": { + "smithy.api#documentation": "Type of the step.
", + "smithy.api#required": {} + } + }, + "UTurnStepDetails": { + "target": "com.amazonaws.georoutes#RouteUTurnStepDetails", + "traits": { + "smithy.api#documentation": "Details that are specific to a Turn step.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Steps of a leg that correspond to the travel portion of the leg.
" + } + }, + "com.amazonaws.georoutes#RouteVehicleTravelStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteVehicleTravelStep" + } + }, + "com.amazonaws.georoutes#RouteVehicleTravelStepType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ARRIVE", + "value": "Arrive" + }, + { + "name": "CONTINUE", + "value": "Continue" + }, + { + "name": "CONTINUE_HIGHWAY", + "value": "ContinueHighway" + }, + { + "name": "DEPART", + "value": "Depart" + }, + { + "name": "ENTER_HIGHWAY", + "value": "EnterHighway" + }, + { + "name": "EXIT", + "value": "Exit" + }, + { + "name": "KEEP", + "value": "Keep" + }, + { + "name": "RAMP", + "value": "Ramp" + }, + { + "name": "ROUNDABOUT_ENTER", + "value": "RoundaboutEnter" + }, + { + "name": "ROUNDABOUT_EXIT", + "value": "RoundaboutExit" + }, + { + "name": "ROUNDABOUT_PASS", + "value": "RoundaboutPass" + }, + { + "name": "TURN", + "value": "Turn" + }, + { + "name": "U_TURN", + "value": "UTurn" + } + ] + } + }, + "com.amazonaws.georoutes#RouteViolatedConstraints": { + "type": "structure", + "members": { + "AllHazardsRestricted": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "This restriction applies to truck cargo, where the resulting route excludes roads on which hazardous materials are prohibited from being transported.
" + } + }, + "AxleCount": { + "target": "com.amazonaws.georoutes#RouteNoticeDetailRange", + "traits": { + "smithy.api#documentation": "Total number of axles of the vehicle.
" + } + }, + "HazardousCargos": { + "target": "com.amazonaws.georoutes#RouteHazardousCargoTypeList", + "traits": { + "smithy.api#documentation": "List of Hazardous cargo contained in the vehicle.
", + "smithy.api#required": {} + } + }, + "MaxHeight": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum height of the vehicle.
" + } + }, + "MaxKpraLength": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum Kpra length of the vehicle.
\n\n Unit: centimeters\n
The maximum length of the vehicle.
" + } + }, + "MaxPayloadCapacity": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum load capacity of the vehicle.
\n\n Unit: kilograms\n
The maximum weight of the route.
\n\n Unit: Kilograms\n
The maximum weight per axle of the vehicle.
\n\n Unit: Kilograms\n
The maximum weight per axle group of the vehicle.
\n\n Unit: Kilograms\n
The maximum width of the vehicle.
" + } + }, + "Occupancy": { + "target": "com.amazonaws.georoutes#RouteNoticeDetailRange", + "traits": { + "smithy.api#documentation": "The number of occupants in the vehicle.
\nDefault Value: 1\n
Access radius restrictions based on time.
" + } + }, + "TimeDependent": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The time dependent constraint.
" + } + }, + "TrailerCount": { + "target": "com.amazonaws.georoutes#RouteNoticeDetailRange", + "traits": { + "smithy.api#documentation": "Number of trailers attached to the vehicle.
\nDefault Value: 0\n
Travel mode corresponding to the leg.
" + } + }, + "TruckRoadType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Truck road type identifiers. BK1 through BK4 apply only to Sweden. \n A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.
There are currently no other supported values as of 26th April 2024.
\nType of the truck.
" + } + }, + "TunnelRestrictionCode": { + "target": "com.amazonaws.georoutes#TunnelRestrictionCode", + "traits": { + "smithy.api#documentation": "The tunnel restriction code.
\nTunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. \n They relate to the types of dangerous goods that can be transported through them.
\n\n Tunnel Category B\n
\n\n Risk Level: Limited risk
\n\n Restrictions: Few restrictions
\n\n Tunnel Category C\n
\n\n Risk Level: Medium risk
\n\n Restrictions: Some restrictions
\n\n Tunnel Category D\n
\n\n Risk Level: High risk
\n\n Restrictions: Many restrictions occur
\n\n Tunnel Category E\n
\n\n Risk Level: Very high risk
\n\n Restrictions: Restricted tunnel
\nThis property contains a \n summary of violated constraints.
" + } + }, + "com.amazonaws.georoutes#RouteWaypoint": { + "type": "structure", + "members": { + "AvoidActionsForDistance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#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.
", + "smithy.api#range": { + "max": 2000 + } + } + }, + "AvoidUTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Matching": { + "target": "com.amazonaws.georoutes#RouteMatchingOptions", + "traits": { + "smithy.api#documentation": "Options to configure matching the provided position to the road network.
" + } + }, + "PassThrough": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Options to configure matching the provided position to a side of the street.
" + } + }, + "StopDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Duration of the stop.
\n\n Unit: seconds\n
Waypoint between the Origin and Destination.
" + } + }, + "com.amazonaws.georoutes#RouteWaypointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteWaypoint" + } + }, + "com.amazonaws.georoutes#RouteWeightConstraint": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.georoutes#RouteWeightConstraintType", + "traits": { + "smithy.api#documentation": "The type of constraint.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The constraint value.
\n\n Unit: Kilograms\n
The weight constraint for the route.
\n\n Unit: Kilograms\n
The zone category.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The zone.
" + } + }, + "com.amazonaws.georoutes#RouteZoneCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CONGESTION_PRICING", + "value": "CongestionPricing" + }, + { + "name": "ENVIRONMENTAL", + "value": "Environmental" + }, + { + "name": "VIGNETTE", + "value": "Vignette" + } + ] + } + }, + "com.amazonaws.georoutes#RouteZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#RouteZone" + } + }, + "com.amazonaws.georoutes#RoutesService": { + "type": "service", + "version": "2020-11-19", + "resources": [ + { + "target": "com.amazonaws.georoutes#ProviderResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Geo Routes", + "arnNamespace": "geo-routes", + "cloudTrailEventSource": "geo-routes.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "geo-routes" + }, + "aws.endpoints#standardRegionalEndpoints": { + "partitionSpecialCases": { + "aws": [ + { + "endpoint": "https://routes.geo.{region}.{dnsSuffix}/v2" + }, + { + "endpoint": "https://routes.geo-fips.{region}.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://routes.geo-fips.{region}.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://routes.geo.{region}.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ], + "aws-us-gov": [ + { + "endpoint": "https://routes.geo.{region}.us-gov.{dnsSuffix}/v2" + }, + { + "endpoint": "https://routes.geo-fips.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": true, + "dualStack": true + }, + { + "endpoint": "https://routes.geo-fips.{region}.us-gov.{dnsSuffix}/v2", + "fips": true, + "dualStack": false + }, + { + "endpoint": "https://routes.geo.{region}.us-gov.{dualStackDnsSuffix}/v2", + "fips": false, + "dualStack": true + } + ] + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "x-amz-content-sha256", + "x-amz-user-agent", + "content-type" + ] + }, + "smithy.api#documentation": "With the Amazon Location Routes API you can calculate\n routes and estimate travel time based on up-to-date road network and live \n traffic information.
\nCalculate optimal travel routes and estimate travel times using up-to-date road network and traffic data. Key features include:
\nPoint-to-point routing with estimated travel time, distance, and turn-by-turn directions
\nMulti-point route optimization to minimize travel time or distance
\nRoute matrices for efficient multi-destination planning
\nIsoline calculations to determine reachable areas within specified time or distance thresholds
\nMap-matching to align GPS traces with the road network
\nThe SnapToRoads action matches GPS trace to roads most likely traveled on.
", + "smithy.api#http": { + "uri": "/snap-to-roads", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "SnapToRoadsSuccess", + "params": { + "TracePoints": [ + { + "Position": [ + 8.53404, + 50.16364 + ] + }, + { + "Position": [ + 8.53379056, + 50.16352417 + ] + } + ] + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.georoutes#SnapToRoadsRequest": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.georoutes#ApiKey", + "traits": { + "smithy.api#documentation": "Optional: The API key to be used for authorization. Either an API key or valid SigV4\n signature must be provided when making a request.
", + "smithy.api#httpQuery": "key" + } + }, + "SnappedGeometryFormat": { + "target": "com.amazonaws.georoutes#GeometryFormat", + "traits": { + "smithy.api#documentation": "Chooses what the returned SnappedGeometry format should be.
\nDefault Value: FlexiblePolyline\n
The radius around the provided tracepoint that is considered for snapping.
\n\n Unit: meters\n
Default value: 300\n
List of trace points to be snapped onto the road network.
", + "smithy.api#length": { + "min": 2, + "max": 5000 + }, + "smithy.api#required": {} + } + }, + "TravelMode": { + "target": "com.amazonaws.georoutes#RoadSnapTravelMode", + "traits": { + "smithy.api#documentation": "Specifies the mode of transport when calculating a route. \n Used in estimating the speed of travel and road compatibility.
\nDefault Value: Car\n
Travel mode related options for the provided travel mode.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.georoutes#SnapToRoadsResponse": { + "type": "structure", + "members": { + "Notices": { + "target": "com.amazonaws.georoutes#RoadSnapNoticeList", + "traits": { + "smithy.api#documentation": "Notices are additional information returned that indicate issues that occurred during route calculation.
", + "smithy.api#required": {} + } + }, + "PricingBucket": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pricing bucket for which the query is charged at.
", + "smithy.api#httpHeader": "x-amz-geo-pricing-bucket", + "smithy.api#required": {} + } + }, + "SnappedGeometry": { + "target": "com.amazonaws.georoutes#RoadSnapSnappedGeometry", + "traits": { + "smithy.api#documentation": "The interpolated geometry for the snapped route onto the road network.
" + } + }, + "SnappedGeometryFormat": { + "target": "com.amazonaws.georoutes#GeometryFormat", + "traits": { + "smithy.api#documentation": "Specifies the format of the geometry returned for each leg of the route.
", + "smithy.api#required": {} + } + }, + "SnappedTracePoints": { + "target": "com.amazonaws.georoutes#RoadSnapSnappedTracePointList", + "traits": { + "smithy.api#documentation": "The trace points snapped onto the road network.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.georoutes#SpeedKilometersPerHour": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0.0 + } + } + }, + "com.amazonaws.georoutes#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.georoutes#TimeOfDay": { + "type": "string", + "traits": { + "smithy.api#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])$" + } + }, + "com.amazonaws.georoutes#TimeThresholdList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10800 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.georoutes#TimestampWithTimezoneOffset": { + "type": "string", + "traits": { + "smithy.api#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])$" + } + }, + "com.amazonaws.georoutes#TrafficUsage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "IGNORE_TRAFFIC_DATA", + "value": "IgnoreTrafficData" + }, + { + "name": "USE_TRAFFIC_DATA", + "value": "UseTrafficData" + } + ] + } + }, + "com.amazonaws.georoutes#TruckRoadType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.georoutes#TruckRoadTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#TruckRoadType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 12 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#TunnelRestrictionCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.georoutes#TurnAngle": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": -180, + "max": 180 + } + } + }, + "com.amazonaws.georoutes#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.georoutes#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "A message with the reason for the validation exception error.
", + "smithy.api#jsonName": "reason", + "smithy.api#required": {} + } + }, + "FieldList": { + "target": "com.amazonaws.georoutes#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field where the invalid entry was detected.
", + "smithy.api#jsonName": "fieldList", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.georoutes#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the Validation Exception Field.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by the Amazon Location service.
" + } + }, + "com.amazonaws.georoutes#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#ValidationExceptionField" + } + }, + "com.amazonaws.georoutes#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "UNKNOWN_OPERATION", + "value": "UnknownOperation", + "documentation": "No such operation is supported." + }, + { + "name": "MISSING", + "value": "Missing", + "documentation": "The required input is missing." + }, + { + "name": "CANNOT_PARSE", + "value": "CannotParse", + "documentation": " The input cannot be parsed. For example a required JSON document, ARN identifier,\n date value, or numeric field cannot be parsed.\n" + }, + { + "name": "FIELD_VALIDATION_FAILED", + "value": "FieldValidationFailed", + "documentation": " The input is present and parsable, but it is otherwise invalid. For example, a\n required numeric argument is outside the allowed range.\n" + }, + { + "name": "OTHER", + "value": "Other", + "documentation": "The input is invalid but no more specific reason is applicable." + }, + { + "name": "UNKNOWN_FIELD", + "value": "UnknownField", + "documentation": "No such field is supported." + } + ] + } + }, + "com.amazonaws.georoutes#WaypointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.georoutes#WaypointIndex": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.georoutes#WaypointOptimizationAccessHours": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAccessHoursEntry", + "traits": { + "smithy.api#documentation": "Contains the ID of the starting waypoint in this connection.
", + "smithy.api#required": {} + } + }, + "To": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAccessHoursEntry", + "traits": { + "smithy.api#documentation": "Contains the ID of the ending waypoint in this connection.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Access hours corresponding to when a destination can be visited.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationAccessHoursEntry": { + "type": "structure", + "members": { + "DayOfWeek": { + "target": "com.amazonaws.georoutes#DayOfWeek", + "traits": { + "smithy.api#documentation": "Day of the week.
", + "smithy.api#required": {} + } + }, + "TimeOfDay": { + "target": "com.amazonaws.georoutes#TimeOfDay", + "traits": { + "smithy.api#documentation": "Time of the day.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Hours of entry.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationAvoidanceArea": { + "type": "structure", + "members": { + "Geometry": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAvoidanceAreaGeometry", + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The area to be avoided.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationAvoidanceAreaGeometry": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.georoutes#BoundingBox", + "traits": { + "smithy.api#documentation": "Geometry defined as a bounding box. The first pair represents the X and Y coordinates\n (longitude and latitude,) of the southwest corner of the bounding box; the second pair\n represents the X and Y coordinates (longitude and latitude) of the northeast corner.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Geometry of the area to be avoided.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationAvoidanceAreaList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAvoidanceArea" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationAvoidanceOptions": { + "type": "structure", + "members": { + "Areas": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAvoidanceAreaList", + "traits": { + "smithy.api#documentation": "Areas to be avoided.
", + "smithy.api#length": { + "max": 20 + } + } + }, + "CarShuttleTrains": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoidance options for cars-shuttles-trains.
" + } + }, + "ControlledAccessHighways": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid controlled access highways while calculating the route.
" + } + }, + "DirtRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid dirt roads while calculating the route.
" + } + }, + "Ferries": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoidance options for ferries.
" + } + }, + "TollRoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoids roads where the specified toll transponders are the only mode of payment.
" + } + }, + "Tunnels": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid tunnels while calculating the route.
" + } + }, + "UTurns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Avoid U-turns for calculation on highways and motorways.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options for WaypointOptimizationAvoidance.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationConnection": { + "type": "structure", + "members": { + "Distance": { + "target": "com.amazonaws.georoutes#DistanceMeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Distance of the step.
", + "smithy.api#required": {} + } + }, + "From": { + "target": "com.amazonaws.georoutes#WaypointId", + "traits": { + "smithy.api#documentation": "contains the ID of the starting waypoint in this connection.
", + "smithy.api#required": {} + } + }, + "RestDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Resting time before the driver can continue driving.
", + "smithy.api#required": {} + } + }, + "To": { + "target": "com.amazonaws.georoutes#WaypointId", + "traits": { + "smithy.api#documentation": "Contains the ID of the ending waypoint in this connection.
", + "smithy.api#required": {} + } + }, + "TravelDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Total duration.
\n\n Unit: seconds\n
Duration of a wait step.
\n\n Unit: seconds\n
This contains information such as distance and duration from one waypoint to the next waypoint in the sequence.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationConnectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationConnection" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationConstraint": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCESS_HOURS", + "value": "AccessHours" + }, + { + "name": "APPOINTMENT_TIME", + "value": "AppointmentTime" + }, + { + "name": "BEFORE", + "value": "Before" + }, + { + "name": "HEADING", + "value": "Heading" + }, + { + "name": "SERVICE_DURATION", + "value": "ServiceDuration" + }, + { + "name": "SIDE_OF_STREET", + "value": "SideOfStreet" + } + ] + } + }, + "com.amazonaws.georoutes#WaypointOptimizationDestinationOptions": { + "type": "structure", + "members": { + "AccessHours": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAccessHours", + "traits": { + "smithy.api#documentation": "Access hours corresponding to when a waypoint can be visited.
" + } + }, + "AppointmentTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Appointment time at the destination.
" + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Id": { + "target": "com.amazonaws.georoutes#WaypointId", + "traits": { + "smithy.api#documentation": "The waypoint Id.
" + } + }, + "ServiceDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Service time spent at the destination. At an appointment, the service time should be the appointment duration.
\n\n Unit: seconds\n
Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Destination related options.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationDriverOptions": { + "type": "structure", + "members": { + "RestCycles": { + "target": "com.amazonaws.georoutes#WaypointOptimizationRestCycles", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.georoutes#WaypointOptimizationRestProfile", + "traits": { + "smithy.api#documentation": "Pre defined rest profiles for a driver schedule. The only currently supported profile is\n EU.
" + } + }, + "TreatServiceTimeAs": { + "target": "com.amazonaws.georoutes#WaypointOptimizationServiceTimeTreatment", + "traits": { + "smithy.api#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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Driver related options.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationExclusionOptions": { + "type": "structure", + "members": { + "Countries": { + "target": "com.amazonaws.georoutes#CountryCodeList", + "traits": { + "smithy.api#documentation": "List of countries to be avoided defined by two-letter or three-letter country codes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Exclusion options.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationFailedConstraint": { + "type": "structure", + "members": { + "Constraint": { + "target": "com.amazonaws.georoutes#WaypointOptimizationConstraint", + "traits": { + "smithy.api#documentation": "The failed constraint.
" + } + }, + "Reason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Reason for the failed constraint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The failed constraint.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationFailedConstraintList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationFailedConstraint" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationHazardousCargoType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "COMBUSTIBLE", + "value": "Combustible" + }, + { + "name": "CORROSIVE", + "value": "Corrosive" + }, + { + "name": "EXPLOSIVE", + "value": "Explosive" + }, + { + "name": "FLAMMABLE", + "value": "Flammable" + }, + { + "name": "GAS", + "value": "Gas" + }, + { + "name": "HARMFUL_TO_WATER", + "value": "HarmfulToWater" + }, + { + "name": "ORGANIC", + "value": "Organic" + }, + { + "name": "OTHER", + "value": "Other" + }, + { + "name": "POISON", + "value": "Poison" + }, + { + "name": "POISONOUS_INHALATION", + "value": "PoisonousInhalation" + }, + { + "name": "RADIOACTIVE", + "value": "Radioactive" + } + ] + } + }, + "com.amazonaws.georoutes#WaypointOptimizationHazardousCargoTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationHazardousCargoType" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.georoutes#WaypointOptimizationImpedingWaypoint": { + "type": "structure", + "members": { + "FailedConstraints": { + "target": "com.amazonaws.georoutes#WaypointOptimizationFailedConstraintList", + "traits": { + "smithy.api#documentation": "Failed constraints for an impeding waypoint.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.georoutes#WaypointId", + "traits": { + "smithy.api#documentation": "The waypoint Id.
", + "smithy.api#required": {} + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
The impeding waypoint.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationImpedingWaypointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationImpedingWaypoint" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationOptimizedWaypoint": { + "type": "structure", + "members": { + "ArrivalTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Estimated time of arrival at the destination.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
Estimated time of departure from thr origin.
\nTime format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm\n
Examples:
\n\n 2020-04-22T17:57:24Z\n
\n 2020-04-22T17:57:24+02:00\n
The waypoint Id.
", + "smithy.api#required": {} + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
The optimized waypoint.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationOptimizedWaypointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationOptimizedWaypoint" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationOriginOptions": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.georoutes#WaypointId", + "traits": { + "smithy.api#documentation": "The Origin Id.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options related to the origin.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationPedestrianOptions": { + "type": "structure", + "members": { + "Speed": { + "target": "com.amazonaws.georoutes#SpeedKilometersPerHour", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Walking speed.
\n\n Unit: KilometersPerHour\n
Options related to a pedestrian.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationRestCycleDurations": { + "type": "structure", + "members": { + "RestDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Resting phase of the cycle.
\n\n Unit: seconds\n
Working phase of the cycle.
\n\n Unit: seconds\n
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.
\n\n Unit: seconds\n
Long cycle for a driver work-rest schedule.
", + "smithy.api#required": {} + } + }, + "ShortCycle": { + "target": "com.amazonaws.georoutes#WaypointOptimizationRestCycleDurations", + "traits": { + "smithy.api#documentation": "Short cycle for a driver work-rest schedule
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Resting phase of the cycle.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationRestProfile": { + "type": "structure", + "members": { + "Profile": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Pre defined rest profiles for a driver schedule. The only currently supported profile is\n EU.
", + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Pre defined rest profiles for a driver schedule. The only currently supported profile is\n EU.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationSequencingObjective": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "FASTEST_ROUTE", + "value": "FastestRoute" + }, + { + "name": "SHORTEST_ROUTE", + "value": "ShortestRoute" + } + ] + } + }, + "com.amazonaws.georoutes#WaypointOptimizationServiceTimeTreatment": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "REST", + "value": "Rest" + }, + { + "name": "WORK", + "value": "Work" + } + ] + } + }, + "com.amazonaws.georoutes#WaypointOptimizationSideOfStreetOptions": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Strategy that defines when the side of street position should be used. AnyStreet will always use the provided position.
\nDefault Value: DividedStreetOnly\n
Options to configure matching the provided position to a side of the street.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTimeBreakdown": { + "type": "structure", + "members": { + "RestDuration": { + "target": "com.amazonaws.georoutes#DurationSeconds", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Resting phase of the cycle.
\n\n Unit: seconds\n
Service time spent at the destination. At an appointment, the service time should be the appointment duration.
\n\n Unit: seconds\n
Traveling phase of the cycle.
\n\n Unit: seconds\n
Waiting phase of the cycle.
\n\n Unit: seconds\n
Time breakdown for the sequence.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTrafficOptions": { + "type": "structure", + "members": { + "Usage": { + "target": "com.amazonaws.georoutes#TrafficUsage", + "traits": { + "smithy.api#documentation": "Determines if traffic should be used or ignored while calculating the route.
\nDefault Value: UseTrafficData\n
Options related to traffic.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTrailerOptions": { + "type": "structure", + "members": { + "TrailerCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of trailers attached to the vehicle.
\nDefault Value: 0\n
Trailer options corresponding to the vehicle.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTravelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CAR", + "value": "Car" + }, + { + "name": "PEDESTRIAN", + "value": "Pedestrian" + }, + { + "name": "SCOOTER", + "value": "Scooter" + }, + { + "name": "TRUCK", + "value": "Truck" + } + ] + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTravelModeOptions": { + "type": "structure", + "members": { + "Pedestrian": { + "target": "com.amazonaws.georoutes#WaypointOptimizationPedestrianOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Pedestrian\"
" + } + }, + "Truck": { + "target": "com.amazonaws.georoutes#WaypointOptimizationTruckOptions", + "traits": { + "smithy.api#documentation": "Travel mode options when the provided travel mode is \"Truck\"
" + } + } + }, + "traits": { + "smithy.api#documentation": "Travel mode related options for the provided travel mode.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTruckOptions": { + "type": "structure", + "members": { + "GrossWeight": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Gross weight of the vehicle including trailers, and goods at capacity.
\n\n Unit: Kilograms\n
List of Hazardous cargo contained in the vehicle.
" + } + }, + "Height": { + "target": "com.amazonaws.georoutes#DimensionCentimeters", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Height of the vehicle.
\n\n Unit: centimeters\n
Length of the vehicle.
\n\n Unit: centimeters\n
Trailer options corresponding to the vehicle.
" + } + }, + "TruckType": { + "target": "com.amazonaws.georoutes#WaypointOptimizationTruckType", + "traits": { + "smithy.api#documentation": "Type of the truck.
" + } + }, + "TunnelRestrictionCode": { + "target": "com.amazonaws.georoutes#TunnelRestrictionCode", + "traits": { + "smithy.api#documentation": "The tunnel restriction code.
\nTunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. \n They relate to the types of dangerous goods that can be transported through them.
\n\n Tunnel Category B\n
\n\n Risk Level: Limited risk
\n\n Restrictions: Few restrictions
\n\n Tunnel Category C\n
\n\n Risk Level: Medium risk
\n\n Restrictions: Some restrictions
\n\n Tunnel Category D\n
\n\n Risk Level: High risk
\n\n Restrictions: Many restrictions occur
\n\n Tunnel Category E\n
\n\n Risk Level: Very high risk
\n\n Restrictions: Restricted tunnel
\nHeaviest 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.
\n\n Unit: Kilograms\n
Width of the vehicle.
\n\n Unit: centimeters\n
Travel mode options when the provided travel mode is \"Truck\"
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationTruckType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "STRAIGHT_TRUCK", + "value": "StraightTruck" + }, + { + "name": "TRACTOR", + "value": "Tractor" + } + ] + } + }, + "com.amazonaws.georoutes#WaypointOptimizationWaypoint": { + "type": "structure", + "members": { + "AccessHours": { + "target": "com.amazonaws.georoutes#WaypointOptimizationAccessHours", + "traits": { + "smithy.api#documentation": "Access hours corresponding to when a waypoint can be visited.
" + } + }, + "AppointmentTime": { + "target": "com.amazonaws.georoutes#TimestampWithTimezoneOffset", + "traits": { + "smithy.api#documentation": "Appointment time at the waypoint.
" + } + }, + "Before": { + "target": "com.amazonaws.georoutes#BeforeWaypointsList", + "traits": { + "smithy.api#documentation": "Constraint defining what waypoints are to be visited after this waypoint.
" + } + }, + "Heading": { + "target": "com.amazonaws.georoutes#Heading", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "GPS Heading at the position.
" + } + }, + "Id": { + "target": "com.amazonaws.georoutes#WaypointId", + "traits": { + "smithy.api#documentation": "The waypoint Id.
" + } + }, + "Position": { + "target": "com.amazonaws.georoutes#Position", + "traits": { + "smithy.api#documentation": "Position defined as [longitude, latitude].
Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.
\n\n Unit: seconds\n
Options to configure matching the provided position to a side of the street.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Waypoint between the Origin and Destination.
" + } + }, + "com.amazonaws.georoutes#WaypointOptimizationWaypointList": { + "type": "list", + "member": { + "target": "com.amazonaws.georoutes#WaypointOptimizationWaypoint" + } + }, + "com.amazonaws.georoutes#WeightKilograms": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 4294967295 + } + } + }, + "com.amazonaws.georoutes#WeightPerAxleGroup": { + "type": "structure", + "members": { + "Single": { + "target": "com.amazonaws.georoutes#WeightKilograms", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Weight for single axle group.
\n\n Unit: Kilograms\n
Weight for tandem axle group.
\n\n Unit: Kilograms\n
Weight for triple axle group.
\n\n Unit: Kilograms\n
Weight for quad axle group.
\n\n Unit: Kilograms\n
Weight for quad quint group.
\n\n Unit: Kilograms\n
Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.
\n\n Unit: Kilograms\n
The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names\n must be unique within each Region.
\n CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace \n by using the GetKeyspace operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer\n Guide.
" + "smithy.api#documentation": "The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names\n must be unique within each Region.
\n CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace \n by using the GetKeyspace operation.
For more information, see Create a keyspace in the Amazon Keyspaces Developer\n Guide.
" } }, "com.amazonaws.keyspaces#CreateKeyspaceRequest": { @@ -388,7 +388,7 @@ } ], "traits": { - "smithy.api#documentation": "The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names\n must be unique.
\n CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING.\n You can monitor the creation status of the new table by using the GetTable \n 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\n Guide.
" + "smithy.api#documentation": "The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names\n must be unique.
\n CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING.\n You can monitor the creation status of the new table by using the GetTable \n 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\n Guide.
" } }, "com.amazonaws.keyspaces#CreateTableRequest": { @@ -489,6 +489,89 @@ } } }, + "com.amazonaws.keyspaces#CreateType": { + "type": "operation", + "input": { + "target": "com.amazonaws.keyspaces#CreateTypeRequest" + }, + "output": { + "target": "com.amazonaws.keyspaces#CreateTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.keyspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.keyspaces#ConflictException" + }, + { + "target": "com.amazonaws.keyspaces#InternalServerException" + }, + { + "target": "com.amazonaws.keyspaces#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.keyspaces#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.keyspaces#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n The CreateType operation creates a new user-defined type in the specified keyspace.\n
For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer\n Guide.
" + } + }, + "com.amazonaws.keyspaces#CreateTypeRequest": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "\n The name of the keyspace.\n
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.keyspaces#TypeName", + "traits": { + "smithy.api#documentation": "\n The name of the user-defined type.\n
\nUDT names must contain 48 characters or less, must begin with an alphabetic character, and \n can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically\n into lower case characters.
\nAlternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes,\n Amazon Keyspaces preserves upper casing and allows special characters.
\nYou can also use double quotes as part of the \n name when you create the UDT, but you must escape each double quote character with an additional \n double quote character.
", + "smithy.api#required": {} + } + }, + "fieldDefinitions": { + "target": "com.amazonaws.keyspaces#FieldList", + "traits": { + "smithy.api#documentation": "\n The field definitions, consisting of names and types, that define this type. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.keyspaces#CreateTypeResponse": { + "type": "structure", + "members": { + "keyspaceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN). \n
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.keyspaces#TypeName", + "traits": { + "smithy.api#documentation": "\n The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for\n other operations, for example GetType.\n
\n The DeleteType operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table\n or another UDT.\n
\n The name of the keyspace of the to be deleted type.\n
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.keyspaces#TypeName", + "traits": { + "smithy.api#documentation": "\n The name of the type to be deleted.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.keyspaces#DeleteTypeResponse": { + "type": "structure", + "members": { + "keyspaceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN).\n
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.keyspaces#TypeName", + "traits": { + "smithy.api#documentation": "\n The name of the type that was deleted.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.keyspaces#Depth": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.keyspaces#DoubleObject": { "type": "double", "traits": { @@ -643,6 +808,43 @@ ] } }, + "com.amazonaws.keyspaces#FieldDefinition": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "\n The identifier.\n
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.keyspaces#GenericString", + "traits": { + "smithy.api#documentation": "\n Any supported Cassandra data type, including collections and other user-defined types that are \n contained in the same keyspace.\n
\nFor more information, see Cassandra data type support in the Amazon Keyspaces Developer\n Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n A field definition consists out of a name and a type.\n
" + } + }, + "com.amazonaws.keyspaces#FieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.keyspaces#FieldDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.keyspaces#GenericString": { "type": "string" }, @@ -745,7 +947,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about the table, including the table's name and current status, the keyspace name, \n configuration settings, and metadata.
\nTo read table metadata using GetTable, Select action \n permissions for the table and system tables are required to complete the operation.
Returns information about the table, including the table's name and current status, the keyspace name, \n configuration settings, and metadata.
\nTo read table metadata using GetTable, the \n IAM principal needs Select action \n permissions for the table and the system keyspace.
\n The GetType operation returns information about the type, for example the field definitions, the timestamp when the type\n was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.\n
To read keyspace metadata using GetType, the \n IAM principal needs Select action \n permissions for the system keyspace.
\n The name of the keyspace that contains this type.\n
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.keyspaces#TypeName", + "traits": { + "smithy.api#documentation": "The formatted name of the type. For example, if the name of the type was created\n without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was\n created in double quotes, you must use double quotes to specify the type name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.keyspaces#GetTypeResponse": { + "type": "structure", + "members": { + "keyspaceName": { + "target": "com.amazonaws.keyspaces#KeyspaceName", + "traits": { + "smithy.api#documentation": "\n The name of the keyspace that contains this type.\n
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "com.amazonaws.keyspaces#TypeName", + "traits": { + "smithy.api#documentation": "\n The name of the type.\n
", + "smithy.api#required": {} + } + }, + "fieldDefinitions": { + "target": "com.amazonaws.keyspaces#FieldList", + "traits": { + "smithy.api#documentation": "\n The names and types that define this type.\n
" + } + }, + "lastModifiedTimestamp": { + "target": "com.amazonaws.keyspaces#Timestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp that shows when this type was last modified.\n
" + } + }, + "status": { + "target": "com.amazonaws.keyspaces#TypeStatus", + "traits": { + "smithy.api#documentation": "\n The status of this type.\n
" + } + }, + "directReferringTables": { + "target": "com.amazonaws.keyspaces#TableNameList", + "traits": { + "smithy.api#documentation": "\n The tables that use this type.\n
" + } + }, + "directParentTypes": { + "target": "com.amazonaws.keyspaces#TypeNameList", + "traits": { + "smithy.api#documentation": "\n The types that use this type.\n
" + } + }, + "maxNestingDepth": { + "target": "com.amazonaws.keyspaces#Depth", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The level of nesting implemented for this type.\n
" + } + }, + "keyspaceArn": { + "target": "com.amazonaws.keyspaces#ARN", + "traits": { + "smithy.api#documentation": "\n The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN).\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.keyspaces#IntegerObject": { "type": "integer", "traits": { @@ -1038,12 +1357,18 @@ { "target": "com.amazonaws.keyspaces#CreateTable" }, + { + "target": "com.amazonaws.keyspaces#CreateType" + }, { "target": "com.amazonaws.keyspaces#DeleteKeyspace" }, { "target": "com.amazonaws.keyspaces#DeleteTable" }, + { + "target": "com.amazonaws.keyspaces#DeleteType" + }, { "target": "com.amazonaws.keyspaces#GetKeyspace" }, @@ -1053,6 +1378,9 @@ { "target": "com.amazonaws.keyspaces#GetTableAutoScalingSettings" }, + { + "target": "com.amazonaws.keyspaces#GetType" + }, { "target": "com.amazonaws.keyspaces#ListKeyspaces" }, @@ -1062,6 +1390,9 @@ { "target": "com.amazonaws.keyspaces#ListTagsForResource" }, + { + "target": "com.amazonaws.keyspaces#ListTypes" + }, { "target": "com.amazonaws.keyspaces#RestoreTable" }, @@ -2030,7 +2361,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of keyspaces.
", + "smithy.api#documentation": "The ListKeyspaces operation returns a list of keyspaces.
Returns a list of tables for a specified keyspace.
", + "smithy.api#documentation": "The ListTables operation returns a list of tables for a specified keyspace.
To read keyspace metadata using ListTables, the \n IAM principal needs Select action \n permissions for the system keyspace.
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
", + "smithy.api#documentation": "Returns a list of all tags associated with the specified Amazon Keyspaces resource.
\nTo read keyspace metadata using ListTagsForResource, the \n IAM principal needs Select action \n permissions for the specified resource and the system keyspace.
\n The ListTypes operation returns a list of types for a specified keyspace.\n
To read keyspace metadata using ListTypes, the \n IAM principal needs Select action \n permissions for the system keyspace.
\n The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.\n
\n The total number of types to return in the output. If the total number of types available is more than the value specified,\n a NextToken is provided in the output. To resume pagination, provide the NextToken value as an \n argument of a subsequent API invocation.\n
\n The name of the keyspace that contains the listed types.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.keyspaces#ListTypesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.keyspaces#NextToken", + "traits": { + "smithy.api#documentation": "\n The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.\n
\n The list of types contained in the specified keyspace.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.keyspaces#MaxResults": { "type": "integer", "traits": { @@ -2469,7 +2883,7 @@ "resourceArn": { "target": "com.amazonaws.keyspaces#ARN", "traits": { - "smithy.api#documentation": "The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.
" + "smithy.api#documentation": "The unique identifier in the format of Amazon Resource Name (ARN) for the resource could't be found.
" } } }, @@ -2478,7 +2892,7 @@ "code": "ResourceNotFoundException", "httpResponseCode": 404 }, - "smithy.api#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.
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, \n or its status might not be ACTIVE.
The number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle.\n 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. \n Clients or targets can use TCP keepalive packets to reset the idle timeout.\n
\nYou can define the TcpIdleTimeoutSeconds value to be between 60 and 6000 seconds. If no value is provided, it defaults to 350 seconds.\n
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. \n Existing connections and flows are not impacted when you update this value. Only new connections after you update this value are impacted.\n
" + } + }, "com.amazonaws.networkfirewall#GeneratedRulesType": { "type": "enum", "members": { @@ -3360,7 +3374,7 @@ "name": "network-firewall" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "This is the API Reference for Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors.
\nThe REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
\nTo access Network Firewall using the REST API endpoint:\n https://network-firewall.\n
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n Amazon Web Services SDKs.
\nFor descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the Network Firewall Developer\n Guide.
\nNetwork Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source network analysis and threat detection engine.\n Network Firewall supports Suricata version 6.0.9. For information about Suricata,\n see the Suricata website.
\nYou can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples:
\nAllow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and\n block all other forms of traffic.
\nUse custom lists of known bad domains to limit the types of domain names that your\n applications can access.
\nPerform deep packet inspection on traffic entering or leaving your VPC.
\nUse stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.
\nTo enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
\nTo start using Network Firewall, do the following:
\n(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC.
\nIn Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall.
\nIn Network Firewall, create stateless and stateful rule groups,\n to define the components of the network traffic filtering behavior that you want your firewall to have.
\nIn Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.
\nIn Network Firewall, create a firewall and specify your new firewall policy and\n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.
\nIn Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.
\nThis is the API Reference for Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors.
\nThe REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
\nTo access Network Firewall using the REST API endpoint:\n https://network-firewall.\n
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n Amazon Web Services SDKs.
\nFor descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the Network Firewall Developer\n Guide.
\nNetwork Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source network analysis and threat detection engine.
\nYou can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples:
\nAllow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and\n block all other forms of traffic.
\nUse custom lists of known bad domains to limit the types of domain names that your\n applications can access.
\nPerform deep packet inspection on traffic entering or leaving your VPC.
\nUse stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.
\nTo enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
\nTo start using Network Firewall, do the following:
\n(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC.
\nIn Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall.
\nIn Network Firewall, create stateless and stateful rule groups,\n to define the components of the network traffic filtering behavior that you want your firewall to have.
\nIn Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.
\nIn Network Firewall, create a firewall and specify your new firewall policy and\n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.
\nIn Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.
\nConfigures 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.
\n\n DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
\n CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
\n REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
Configures the amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle.\n
" + } } }, "traits": { @@ -6073,6 +6093,9 @@ "target": "com.amazonaws.networkfirewall#TargetType" } }, + "com.amazonaws.networkfirewall#TcpIdleTimeoutRangeBound": { + "type": "integer" + }, "com.amazonaws.networkfirewall#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index 7996aef72ae..68a2361902f 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -118,6 +118,17 @@ "smithy.api#documentation": "Information about an Amazon OpenSearch Service domain.
" } }, + "com.amazonaws.opensearch#AWSServicePrincipal": { + "type": "enum", + "members": { + "application_opensearchservice_amazonaws_com": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "application.opensearchservice.amazonaws.com" + } + } + } + }, "com.amazonaws.opensearch#AcceptInboundConnection": { "type": "operation", "input": { @@ -644,6 +655,9 @@ { "target": "com.amazonaws.opensearch#CancelServiceSoftwareUpdate" }, + { + "target": "com.amazonaws.opensearch#CreateApplication" + }, { "target": "com.amazonaws.opensearch#CreateDomain" }, @@ -656,6 +670,9 @@ { "target": "com.amazonaws.opensearch#CreateVpcEndpoint" }, + { + "target": "com.amazonaws.opensearch#DeleteApplication" + }, { "target": "com.amazonaws.opensearch#DeleteDataSource" }, @@ -722,6 +739,9 @@ { "target": "com.amazonaws.opensearch#DissociatePackage" }, + { + "target": "com.amazonaws.opensearch#GetApplication" + }, { "target": "com.amazonaws.opensearch#GetCompatibleVersions" }, @@ -740,6 +760,9 @@ { "target": "com.amazonaws.opensearch#GetUpgradeStatus" }, + { + "target": "com.amazonaws.opensearch#ListApplications" + }, { "target": "com.amazonaws.opensearch#ListDataSources" }, @@ -794,6 +817,9 @@ { "target": "com.amazonaws.opensearch#StartServiceSoftwareUpdate" }, + { + "target": "com.amazonaws.opensearch#UpdateApplication" + }, { "target": "com.amazonaws.opensearch#UpdateDataSource" }, @@ -1899,6 +1925,168 @@ } } }, + "com.amazonaws.opensearch#AppConfig": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.opensearch#AppConfigType", + "traits": { + "smithy.api#documentation": "Specify the item to configure, such as admin role for the OpenSearch Application.
" + } + }, + "value": { + "target": "com.amazonaws.opensearch#AppConfigValue", + "traits": { + "smithy.api#documentation": "Specifies the value to configure for the key, such as an IAM user ARN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configurations of the OpenSearch Application.
" + } + }, + "com.amazonaws.opensearch#AppConfigType": { + "type": "enum", + "members": { + "OpensearchDashboardAdminUsers": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opensearchDashboards.dashboardAdmin.users" + } + }, + "OpensearchDashboardAdminGroups": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opensearchDashboards.dashboardAdmin.groups" + } + } + } + }, + "com.amazonaws.opensearch#AppConfigValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.opensearch#AppConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#AppConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.opensearch#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 30 + }, + "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" + } + }, + "com.amazonaws.opensearch#ApplicationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.opensearch#ApplicationStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#ApplicationStatus" + } + }, + "com.amazonaws.opensearch#ApplicationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#ApplicationSummary" + } + }, + "com.amazonaws.opensearch#ApplicationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearch#Id", + "traits": { + "smithy.api#documentation": "Unique identifier for an OpenSearch application.
" + } + }, + "arn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "name": { + "target": "com.amazonaws.opensearch#ApplicationName", + "traits": { + "smithy.api#documentation": "Name of an OpenSearch Application.
" + } + }, + "endpoint": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "Endpoint URL of an OpenSearch Application.
" + } + }, + "status": { + "target": "com.amazonaws.opensearch#ApplicationStatus", + "traits": { + "smithy.api#documentation": "Status of an OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
Timestamp at which an OpenSearch Application was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.opensearch#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp at which an OpenSearch Application was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Basic information of the OpenSearch Application.
" + } + }, "com.amazonaws.opensearch#AssociatePackage": { "type": "operation", "input": { @@ -2027,8 +2215,13 @@ "Account": { "target": "com.amazonaws.opensearch#AWSAccount", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID to grant access to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Web Services account ID to grant access to.
" + } + }, + "Service": { + "target": "com.amazonaws.opensearch#AWSServicePrincipal", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service SP to grant access to.
" } } }, @@ -3212,6 +3405,136 @@ "com.amazonaws.opensearch#ConnectionStatusMessage": { "type": "string" }, + "com.amazonaws.opensearch#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#AccessDeniedException" + }, + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#ConflictException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an OpenSearch Application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/opensearch/application", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#CreateApplicationRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.opensearch#ClientToken", + "traits": { + "smithy.api#documentation": "A unique client idempotency token. It will be auto generated if not provided.
", + "smithy.api#idempotencyToken": {} + } + }, + "name": { + "target": "com.amazonaws.opensearch#ApplicationName", + "traits": { + "smithy.api#documentation": "Name of the OpenSearch Appication to create. Application names are unique across the applications\n owned by an account within an Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "dataSources": { + "target": "com.amazonaws.opensearch#DataSources", + "traits": { + "smithy.api#documentation": "Data sources to be associated with the OpenSearch Application.
" + } + }, + "iamIdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IamIdentityCenterOptionsInput", + "traits": { + "smithy.api#documentation": "Settings of IAM Identity Center for the OpenSearch Application.
" + } + }, + "appConfigs": { + "target": "com.amazonaws.opensearch#AppConfigs", + "traits": { + "smithy.api#documentation": "Configurations of the OpenSearch Application, inlcuding admin configuration.
" + } + }, + "tagList": { + "target": "com.amazonaws.opensearch#TagList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#CreateApplicationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearch#Id", + "traits": { + "smithy.api#documentation": "Unique identifier for the created OpenSearch Application.
" + } + }, + "name": { + "target": "com.amazonaws.opensearch#ApplicationName", + "traits": { + "smithy.api#documentation": "Name of the created OpenSearch Application.
" + } + }, + "arn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "dataSources": { + "target": "com.amazonaws.opensearch#DataSources", + "traits": { + "smithy.api#documentation": "Data sources associated with the created OpenSearch Application.
" + } + }, + "iamIdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", + "traits": { + "smithy.api#documentation": "Settings of IAM Identity Center for the created OpenSearch Application.
" + } + }, + "appConfigs": { + "target": "com.amazonaws.opensearch#AppConfigs", + "traits": { + "smithy.api#documentation": "Configurations of the OpenSearch Application, inlcuding admin configuration.
" + } + }, + "tagList": { + "target": "com.amazonaws.opensearch#TagList" + }, + "createdAt": { + "target": "com.amazonaws.opensearch#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp when the OpenSearch Application was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#CreateDomain": { "type": "operation", "input": { @@ -3346,6 +3669,12 @@ "smithy.api#documentation": "Options for fine-grained access control.
" } }, + "IdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IdentityCenterOptionsInput", + "traits": { + "smithy.api#documentation": "Options for IAM Identity Center Option control for the domain.
" + } + }, "TagList": { "target": "com.amazonaws.opensearch#TagList", "traits": { @@ -3708,6 +4037,23 @@ "smithy.api#documentation": "Cross-cluster search specific connection properties.
" } }, + "com.amazonaws.opensearch#DataSource": { + "type": "structure", + "members": { + "dataSourceArn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "dataSourceDescription": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "Detailed description of a data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Data sources that are associated with an OpenSearch Application.
" + } + }, "com.amazonaws.opensearch#DataSourceDescription": { "type": "string", "traits": { @@ -3797,20 +4143,29 @@ "smithy.api#documentation": "The type of data source.
" } }, - "com.amazonaws.opensearch#DeleteDataSource": { + "com.amazonaws.opensearch#DataSources": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#DataSource" + } + }, + "com.amazonaws.opensearch#DeleteApplication": { "type": "operation", "input": { - "target": "com.amazonaws.opensearch#DeleteDataSourceRequest" + "target": "com.amazonaws.opensearch#DeleteApplicationRequest" }, "output": { - "target": "com.amazonaws.opensearch#DeleteDataSourceResponse" + "target": "com.amazonaws.opensearch#DeleteApplicationResponse" }, "errors": [ + { + "target": "com.amazonaws.opensearch#AccessDeniedException" + }, { "target": "com.amazonaws.opensearch#BaseException" }, { - "target": "com.amazonaws.opensearch#DependencyFailureException" + "target": "com.amazonaws.opensearch#ConflictException" }, { "target": "com.amazonaws.opensearch#DisabledOperationException" @@ -3826,25 +4181,85 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
", + "smithy.api#documentation": "Deletes an existing OpenSearch Application.
", "smithy.api#http": { "method": "DELETE", - "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "uri": "/2021-01-01/opensearch/application/{id}", "code": 200 } } }, - "com.amazonaws.opensearch#DeleteDataSourceRequest": { + "com.amazonaws.opensearch#DeleteApplicationRequest": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.opensearch#DomainName", + "id": { + "target": "com.amazonaws.opensearch#Id", "traits": { - "smithy.api#documentation": "The name of the domain.
", + "smithy.api#documentation": "Unique identifier for the OpenSearch Application that you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#DeleteApplicationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.opensearch#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Name": { "target": "com.amazonaws.opensearch#DataSourceName", "traits": { @@ -5738,6 +6153,12 @@ "smithy.api#documentation": "Container for fine-grained access control settings for the domain.
" } }, + "IdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IdentityCenterOptionsStatus", + "traits": { + "smithy.api#documentation": "Container for IAM Identity Center Option control for the domain.
" + } + }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptionsStatus", "traits": { @@ -6414,6 +6835,12 @@ "smithy.api#documentation": "Settings for fine-grained access control.
" } }, + "IdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IdentityCenterOptions", + "traits": { + "smithy.api#documentation": "Container for IAM Identity Center Option control for the domain.
" + } + }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptionsOutput", "traits": { @@ -6813,6 +7240,124 @@ "target": "com.amazonaws.opensearch#GUID" } }, + "com.amazonaws.opensearch#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#AccessDeniedException" + }, + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Check the configuration and status of an existing OpenSearch Application.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/application/{id}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#GetApplicationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearch#Id", + "traits": { + "smithy.api#documentation": "Unique identifier of the checked OpenSearch Application.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#GetApplicationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearch#Id", + "traits": { + "smithy.api#documentation": "Unique identifier of the checked OpenSearch Application.
" + } + }, + "arn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "name": { + "target": "com.amazonaws.opensearch#ApplicationName", + "traits": { + "smithy.api#documentation": "Name of the checked OpenSearch Application.
" + } + }, + "endpoint": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "Endpoint URL of the checked OpenSearch Application.
" + } + }, + "status": { + "target": "com.amazonaws.opensearch#ApplicationStatus", + "traits": { + "smithy.api#documentation": "Current status of the checked OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
IAM Identity Center settings for the checked OpenSearch Application.
" + } + }, + "dataSources": { + "target": "com.amazonaws.opensearch#DataSources", + "traits": { + "smithy.api#documentation": "Associated data sources to the checked OpenSearch Application.
" + } + }, + "appConfigs": { + "target": "com.amazonaws.opensearch#AppConfigs", + "traits": { + "smithy.api#documentation": "App configurations of the checked OpenSearch Application.
" + } + }, + "createdAt": { + "target": "com.amazonaws.opensearch#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp at which the checked OpenSearch Application was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.opensearch#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp at which the checked OpenSearch Application was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#GetCompatibleVersions": { "type": "operation", "input": { @@ -7301,89 +7846,262 @@ } } }, - "com.amazonaws.opensearch#GetUpgradeStatusRequest": { + "com.amazonaws.opensearch#GetUpgradeStatusRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The domain of the domain to get upgrade status information for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the request parameters to the GetUpgradeStatus operation.
One of three steps that an upgrade or upgrade eligibility check goes through.
" + } + }, + "StepStatus": { + "target": "com.amazonaws.opensearch#UpgradeStatus", + "traits": { + "smithy.api#documentation": "The status of the current step that an upgrade is on.
" + } + }, + "UpgradeName": { + "target": "com.amazonaws.opensearch#UpgradeName", + "traits": { + "smithy.api#documentation": "A string that describes the update.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the response returned by the GetUpgradeStatus operation.
The IP address options for the domain.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.opensearch#OptionStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The IP address type status for the domain.
" + } + }, + "com.amazonaws.opensearch#IamIdentityCenterOptions": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "IAM Identity Center is enabled for the OpenSearch Application.
" + } + }, + "iamIdentityCenterInstanceArn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "iamRoleForIdentityCenterApplicationArn": { + "target": "com.amazonaws.opensearch#RoleArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name of the IAM Identity Center's Application created for the OpenSearch Application after enabling IAM Identity Center.
" + } + }, + "iamIdentityCenterApplicationArn": { + "target": "com.amazonaws.opensearch#ARN" + } + }, + "traits": { + "smithy.api#documentation": "Settings for IAM Identity Center for an OpenSearch Application.
" + } + }, + "com.amazonaws.opensearch#IamIdentityCenterOptionsInput": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "Enable/disable settings for IAM Identity Center.
" + } + }, + "iamIdentityCenterInstanceArn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "iamRoleForIdentityCenterApplicationArn": { + "target": "com.amazonaws.opensearch#RoleArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name of IAM Identity Center's application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for IAM Identity Center.
" + } + }, + "com.amazonaws.opensearch#Id": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9]{3,30}$" + } + }, + "com.amazonaws.opensearch#IdentityCenterApplicationARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+$" + } + }, + "com.amazonaws.opensearch#IdentityCenterInstanceARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\\\-]*:[a-z]+:[a-z0-9\\\\-]*:[0-9]*:[a-z0-9\\\\-]+\\/[a-z0-9\\\\-]+$" + } + }, + "com.amazonaws.opensearch#IdentityCenterOptions": { "type": "structure", "members": { - "DomainName": { - "target": "com.amazonaws.opensearch#DomainName", + "EnabledAPIAccess": { + "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "The domain of the domain to get upgrade status information for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "True to enable IAM Identity Center for API access in Amazon OpenSearch Service.
" } - } - }, - "traits": { - "smithy.api#documentation": "Container for the request parameters to the GetUpgradeStatus operation.
One of three steps that an upgrade or upgrade eligibility check goes through.
" + "smithy.api#documentation": "The ARN for IAM Identity Center Instance.
" } }, - "StepStatus": { - "target": "com.amazonaws.opensearch#UpgradeStatus", + "SubjectKey": { + "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { - "smithy.api#documentation": "The status of the current step that an upgrade is on.
" + "smithy.api#documentation": "Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.
" } }, - "UpgradeName": { - "target": "com.amazonaws.opensearch#UpgradeName", + "RolesKey": { + "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { - "smithy.api#documentation": "A string that describes the update.
" + "smithy.api#documentation": "Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center
" + } + }, + "IdentityCenterApplicationARN": { + "target": "com.amazonaws.opensearch#IdentityCenterApplicationARN", + "traits": { + "smithy.api#documentation": "The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.
" + } + }, + "IdentityStoreId": { + "target": "com.amazonaws.opensearch#IdentityStoreId", + "traits": { + "smithy.api#documentation": "The ID of IAM Identity Store.
" } } }, "traits": { - "smithy.api#documentation": "Container for the response returned by the GetUpgradeStatus operation.
Container for IAM Identity Center Options settings.
" } }, - "com.amazonaws.opensearch#HostedZoneId": { - "type": "string" - }, - "com.amazonaws.opensearch#IPAddressType": { - "type": "enum", + "com.amazonaws.opensearch#IdentityCenterOptionsInput": { + "type": "structure", "members": { - "IPV4": { - "target": "smithy.api#Unit", + "EnabledAPIAccess": { + "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#enumValue": "ipv4" + "smithy.api#documentation": "True to enable IAM Identity Center for API access in Amazon OpenSearch Service.
" } }, - "DUALSTACK": { - "target": "smithy.api#Unit", + "IdentityCenterInstanceARN": { + "target": "com.amazonaws.opensearch#IdentityCenterInstanceARN", "traits": { - "smithy.api#enumValue": "dualstack" + "smithy.api#documentation": "The ARN for IAM Identity Center Instance which will be used for IAM Identity Center Application creation.
" + } + }, + "SubjectKey": { + "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", + "traits": { + "smithy.api#documentation": "Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.
" + } + }, + "RolesKey": { + "target": "com.amazonaws.opensearch#RolesKeyIdCOption", + "traits": { + "smithy.api#documentation": "Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center
" } } + }, + "traits": { + "smithy.api#documentation": "Container for IAM Identity Center Options settings.
" } }, - "com.amazonaws.opensearch#IPAddressTypeStatus": { + "com.amazonaws.opensearch#IdentityCenterOptionsStatus": { "type": "structure", "members": { "Options": { - "target": "com.amazonaws.opensearch#IPAddressType", + "target": "com.amazonaws.opensearch#IdentityCenterOptions", "traits": { - "smithy.api#documentation": "The IP address options for the domain.
", + "smithy.api#documentation": "Container for IAM Identity Center Options settings.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { + "smithy.api#documentation": "The status of IAM Identity Center Options settings for a domain.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The IP address type status for the domain.
" + "smithy.api#documentation": "The status of IAM Identity Center Options settings for a domain.
" } }, "com.amazonaws.opensearch#IdentityPoolId": { @@ -7396,6 +8114,16 @@ "smithy.api#pattern": "^[\\w-]+:[0-9a-f-]+$" } }, + "com.amazonaws.opensearch#IdentityStoreId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#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}$" + } + }, "com.amazonaws.opensearch#InboundConnection": { "type": "structure", "members": { @@ -7865,6 +8593,94 @@ "smithy.api#documentation": "The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can\n be one of the following:
\n\n data - A data node.
\n\n master - A dedicated master node.
\n\n ultra_warm - An UltraWarm node.
\nList all OpenSearch Applications under your account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/list-applications", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "ApplicationSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.opensearch#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.opensearch#NextToken", + "traits": { + "smithy.api#httpQuery": "nextToken" + } + }, + "statuses": { + "target": "com.amazonaws.opensearch#ApplicationStatuses", + "traits": { + "smithy.api#documentation": "OpenSearch Application Status can be used as filters for the listing request. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
Summary of the OpenSearch Applications, including ID, ARN, name, endpoint, status, create time and last update time.
" + } + }, + "nextToken": { + "target": "com.amazonaws.opensearch#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#ListDataSources": { "type": "operation", "input": { @@ -11234,8 +12050,13 @@ "Account": { "target": "com.amazonaws.opensearch#AWSAccount", "traits": { - "smithy.api#documentation": "The account ID to revoke access from.
", - "smithy.api#required": {} + "smithy.api#documentation": "The account ID to revoke access from.
" + } + }, + "Service": { + "target": "com.amazonaws.opensearch#AWSServicePrincipal", + "traits": { + "smithy.api#documentation": "The service SP to revoke access from.
" } } }, @@ -11269,6 +12090,23 @@ } } }, + "com.amazonaws.opensearch#RolesKeyIdCOption": { + "type": "enum", + "members": { + "GroupName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GroupName" + } + }, + "GroupId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GroupId" + } + } + } + }, "com.amazonaws.opensearch#RollbackOnDisable": { "type": "enum", "members": { @@ -12092,6 +12930,29 @@ } } }, + "com.amazonaws.opensearch#SubjectKeyIdCOption": { + "type": "enum", + "members": { + "UserName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UserName" + } + }, + "UserId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UserId" + } + }, + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" + } + } + } + }, "com.amazonaws.opensearch#TLSSecurityPolicy": { "type": "enum", "members": { @@ -12182,6 +13043,9 @@ "smithy.api#documentation": "The unit of a maintenance schedule duration. Valid value is HOUR.
Update the OpenSearch Application.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-01-01/opensearch/application/{id}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#UpdateApplicationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearch#Id", + "traits": { + "smithy.api#documentation": "Unique identifier of the OpenSearch Application to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSources": { + "target": "com.amazonaws.opensearch#DataSources", + "traits": { + "smithy.api#documentation": "Data sources to be associated with the OpenSearch Application.
" + } + }, + "appConfigs": { + "target": "com.amazonaws.opensearch#AppConfigs", + "traits": { + "smithy.api#documentation": "Configurations to be changed for the OpenSearch Application.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#UpdateApplicationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.opensearch#Id", + "traits": { + "smithy.api#documentation": "Unique identifier of the updated OpenSearch Application.
" + } + }, + "name": { + "target": "com.amazonaws.opensearch#ApplicationName", + "traits": { + "smithy.api#documentation": "Name of the updated OpenSearch Application.
" + } + }, + "arn": { + "target": "com.amazonaws.opensearch#ARN" + }, + "dataSources": { + "target": "com.amazonaws.opensearch#DataSources", + "traits": { + "smithy.api#documentation": "Data sources associated with the updated OpenSearch Application.
" + } + }, + "iamIdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IamIdentityCenterOptions", + "traits": { + "smithy.api#documentation": "IAM Identity Center settings for the updated OpenSearch Application.
" + } + }, + "appConfigs": { + "target": "com.amazonaws.opensearch#AppConfigs", + "traits": { + "smithy.api#documentation": "Configurations for the updated OpenSearch Application.
" + } + }, + "createdAt": { + "target": "com.amazonaws.opensearch#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp at which the OpenSearch Application was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.opensearch#Timestamp", + "traits": { + "smithy.api#documentation": "Timestamp at which the OpenSearch Application was last updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#UpdateDataSource": { "type": "operation", "input": { @@ -12422,6 +13407,9 @@ "smithy.api#documentation": "Options for fine-grained access control.
" } }, + "IdentityCenterOptions": { + "target": "com.amazonaws.opensearch#IdentityCenterOptionsInput" + }, "AutoTuneOptions": { "target": "com.amazonaws.opensearch#AutoTuneOptions", "traits": { diff --git a/codegen/sdk-codegen/aws-models/opensearchserverless.json b/codegen/sdk-codegen/aws-models/opensearchserverless.json index 9f0bd25054a..2b274c6f770 100644 --- a/codegen/sdk-codegen/aws-models/opensearchserverless.json +++ b/codegen/sdk-codegen/aws-models/opensearchserverless.json @@ -1005,6 +1005,33 @@ } } }, + "com.amazonaws.opensearchserverless#CreateIamIdentityCenterConfigOptions": { + "type": "structure", + "members": { + "instanceArn": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
", + "smithy.api#required": {} + } + }, + "userAttribute": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", + "traits": { + "smithy.api#documentation": "The user attribute for this IAM Identity Center integration. Defaults to UserId.
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.
" + } + }, "com.amazonaws.opensearchserverless#CreateLifecyclePolicy": { "type": "operation", "input": { @@ -1145,6 +1172,12 @@ "smithy.api#documentation": "Describes SAML options in in the form of a key-value map. This field is required if\n you specify saml for the type parameter.
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.
" + } + }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { @@ -2082,6 +2115,109 @@ } } }, + "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#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}$" + } + }, + "com.amazonaws.opensearchserverless#IamIdentityCenterConfigOptions": { + "type": "structure", + "members": { + "instanceArn": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
" + } + }, + "applicationArn": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" + } + }, + "applicationName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" + } + }, + "applicationDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
" + } + }, + "userAttribute": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", + "traits": { + "smithy.api#documentation": "The user attribute for this IAM Identity Center integration. Defaults to UserId\n
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
" + } + }, + "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "GroupId", + "value": "GroupId", + "documentation": "Group ID" + }, + { + "name": "GroupName", + "value": "GroupName", + "documentation": "Group Name" + } + ] + } + }, + "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + } + }, + "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "UserId", + "value": "UserId", + "documentation": "User ID" + }, + { + "name": "UserName", + "value": "UserName", + "documentation": "User Name" + }, + { + "name": "Email", + "value": "Email", + "documentation": "Email" + } + ] + } + }, "com.amazonaws.opensearchserverless#IndexingCapacityValue": { "type": "integer", "traits": { @@ -3825,6 +3961,12 @@ "smithy.api#documentation": "SAML options for the security configuration in the form of a key-value map.
" } }, + "iamIdentityCenterOptions": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterConfigOptions", + "traits": { + "smithy.api#documentation": "Describes IAM Identity Center options in the form of a key-value map.
" + } + }, "createdDate": { "target": "smithy.api#Long", "traits": { @@ -3923,6 +4065,11 @@ "name": "saml", "value": "saml", "documentation": "saml provider" + }, + { + "name": "iamidentitycenter", + "value": "iamidentitycenter", + "documentation": "iam identity center" } ] } @@ -4603,6 +4750,26 @@ } } }, + "com.amazonaws.opensearchserverless#UpdateIamIdentityCenterConfigOptions": { + "type": "structure", + "members": { + "userAttribute": { + "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", + "traits": { + "smithy.api#documentation": "The user attribute for this IAM Identity Center integration. Defaults to UserId.
The group attribute for this IAM Identity Center integration. Defaults to GroupId.
Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.
" + } + }, "com.amazonaws.opensearchserverless#UpdateLifecyclePolicy": { "type": "operation", "input": { @@ -4752,6 +4919,12 @@ "smithy.api#documentation": "SAML options in in the form of a key-value map.
" } }, + "iamIdentityCenterOptionsUpdates": { + "target": "com.amazonaws.opensearchserverless#UpdateIamIdentityCenterConfigOptions", + "traits": { + "smithy.api#documentation": "Describes IAM Identity Center options in the form of a key-value map.
" + } + }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { diff --git a/codegen/sdk-codegen/aws-models/redshift-serverless.json b/codegen/sdk-codegen/aws-models/redshift-serverless.json index 3cdf696223a..df11b9fbb99 100644 --- a/codegen/sdk-codegen/aws-models/redshift-serverless.json +++ b/codegen/sdk-codegen/aws-models/redshift-serverless.json @@ -993,6 +993,12 @@ "smithy.api#documentation": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
" } }, + "pricePerformanceTarget": { + "target": "com.amazonaws.redshiftserverless#PerformanceTarget", + "traits": { + "smithy.api#documentation": "An object that represents the price performance target settings for the workgroup.
" + } + }, "ipAddressType": { "target": "com.amazonaws.redshiftserverless#IpAddressType", "traits": { @@ -3669,6 +3675,45 @@ "com.amazonaws.redshiftserverless#ParameterValue": { "type": "string" }, + "com.amazonaws.redshiftserverless#PerformanceTarget": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.redshiftserverless#PerformanceTargetStatus", + "traits": { + "smithy.api#documentation": "Whether the price performance target is enabled for the workgroup.
" + } + }, + "level": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These\n correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the price performance target settings for the workgroup.
" + } + }, + "com.amazonaws.redshiftserverless#PerformanceTargetStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ENABLED", + "value": "ENABLED" + }, + { + "name": "DISABLED", + "value": "DISABLED" + } + ] + } + }, "com.amazonaws.redshiftserverless#PutResourcePolicy": { "type": "operation", "input": { @@ -6566,6 +6611,12 @@ "traits": { "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
An object that represents the price performance target settings for the workgroup.
" + } } }, "traits": { @@ -6947,6 +6998,12 @@ "traits": { "smithy.api#documentation": "The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
An object that represents the price performance target settings for the workgroup.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/redshift.json b/codegen/sdk-codegen/aws-models/redshift.json index 673acc0057a..3290049e528 100644 --- a/codegen/sdk-codegen/aws-models/redshift.json +++ b/codegen/sdk-codegen/aws-models/redshift.json @@ -3852,14 +3852,14 @@ } ], "traits": { - "smithy.api#documentation": "Creates a zero-ETL integration with Amazon Redshift.
" + "smithy.api#documentation": "Creates a zero-ETL integration or S3 event integration with Amazon Redshift.
" } }, "com.amazonaws.redshift#CreateIntegrationMessage": { "type": "structure", "members": { "SourceArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#SourceArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the database to use as the source for replication.
", @@ -3867,7 +3867,7 @@ } }, "TargetArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#TargetArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
", @@ -5372,7 +5372,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a zero-ETL integration with Amazon Redshift.
" + "smithy.api#documentation": "Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.
" } }, "com.amazonaws.redshift#DeleteIntegrationMessage": { @@ -7327,13 +7327,13 @@ "type": "structure", "members": { "IntegrationArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#InboundIntegrationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inbound integration.
" } }, "TargetArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#TargetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target of an inbound integration.
" } @@ -7372,7 +7372,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes one or more zero-ETL integrations with Amazon Redshift.
", + "smithy.api#documentation": "Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -8385,7 +8385,7 @@ "ResourceType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The type of resource with which you want to view tags. Valid resource types are:
\nCluster
\nCIDR/IP
\nEC2 security group
\nSnapshot
\nCluster security group
\nSubnet group
\nHSM connection
\nHSM certificate
\nParameter group
\nSnapshot copy grant
\nIntegration (zero-ETL integration)
\nTo describe the tags associated with an integration, don't specify ResourceType, \n instead specify the ResourceName of the integration.
For more information about Amazon Redshift resource types and constructing ARNs, go to\n Specifying Policy Elements: Actions, Effects, Resources, and Principals in\n the Amazon Redshift Cluster Management Guide.
" + "smithy.api#documentation": "The type of resource with which you want to view tags. Valid resource types are:
\nCluster
\nCIDR/IP
\nEC2 security group
\nSnapshot
\nCluster security group
\nSubnet group
\nHSM connection
\nHSM certificate
\nParameter group
\nSnapshot copy grant
\nIntegration (zero-ETL integration or S3 event integration)
\nTo describe the tags associated with an integration, don't specify ResourceType, \n instead specify the ResourceName of the integration.
For more information about Amazon Redshift resource types and constructing ARNs, go to\n Specifying Policy Elements: Actions, Effects, Resources, and Principals in\n the Amazon Redshift Cluster Management Guide.
" } }, "MaxRecords": { @@ -10333,7 +10333,7 @@ "type": "structure", "members": { "IntegrationArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#InboundIntegrationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an inbound integration.
" } @@ -10345,7 +10345,7 @@ } }, "TargetArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#TargetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target of an inbound integration.
" } @@ -10373,6 +10373,16 @@ "smithy.api#documentation": "The content of an inbound integration.
" } }, + "com.amazonaws.redshift#InboundIntegrationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#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}$" + } + }, "com.amazonaws.redshift#InboundIntegrationList": { "type": "list", "member": { @@ -10463,7 +10473,7 @@ "type": "structure", "members": { "IntegrationArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#IntegrationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integration.
" } @@ -10475,13 +10485,13 @@ } }, "SourceArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#SourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the database used as the source for\n replication.
" } }, "TargetArn": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#TargetArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
" } @@ -10680,7 +10690,7 @@ "code": "IntegrationQuotaExceededFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "You can't create any more zero-ETL integrations because the quota has been reached.
", + "smithy.api#documentation": "You can't create any more zero-ETL or S3 event integrations because the quota has been reached.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12655,7 +12665,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies a zero-ETL integration with Amazon Redshift.
" + "smithy.api#documentation": "Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.
" } }, "com.amazonaws.redshift#ModifyIntegrationMessage": { @@ -18623,6 +18633,16 @@ } } }, + "com.amazonaws.redshift#SourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:(s3|dynamodb):.*:.*:[a-zA-Z0-9._\\-\\/]+$" + } + }, "com.amazonaws.redshift#SourceIdsList": { "type": "list", "member": { @@ -19199,6 +19219,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#TargetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:redshift(-serverless)?:[a-z0-9\\-]+:[0-9]{12}:(namespace\\/|namespace:)[a-z0-9\\-]+$" + } + }, "com.amazonaws.redshift#TrackList": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/route-53.json b/codegen/sdk-codegen/aws-models/route-53.json index 16b78b0838d..205ae35f0f4 100644 --- a/codegen/sdk-codegen/aws-models/route-53.json +++ b/codegen/sdk-codegen/aws-models/route-53.json @@ -4039,7 +4039,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.
\nDNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:
\nRoute 53 edge location that responded to the DNS query
\nDomain or subdomain that was requested
\nDNS record type, such as A or AAAA
\nDNS response code, such as NoError or\n\t\t\t\t\tServFail\n
Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.
\nIf you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.
\nCreate a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:
\nYou must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.
\nYou must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.
\nWhen you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:
\n\n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n
In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.
\nCreate a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:
\n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n
To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:
\nFor aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.
For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.
For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.
\nYou can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.
\nWhen Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:
\nCreates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.
\nBegins to send query logs to the applicable log stream.
\nThe name of each log stream is in the following format:
\n\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n
The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.
\nQuery logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.
\nFor information about charges for query logs, see Amazon CloudWatch Pricing.
\nIf you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.
\nCreates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.
\nDNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:
\nRoute 53 edge location that responded to the DNS query
\nDomain or subdomain that was requested
\nDNS record type, such as A or AAAA
\nDNS response code, such as NoError or\n\t\t\t\t\tServFail\n
Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.
\nIf you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.
\nCreate a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:
\nYou must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.
\nYou must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.
\nWhen you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:
\n\n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n
In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.
\nCreate a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1\n\t\t\t\t\t\t\t\t\tregion. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:
\n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n
To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:
\nFor aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.
For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.
For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.
\nYou can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.
\nWhen Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:
\nCreates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.
\nBegins to send query logs to the applicable log stream.
\nThe name of each log stream is in the following format:
\n\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n
The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.
\nQuery logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.
\nFor information about charges for query logs, see Amazon CloudWatch Pricing.
\nIf you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.
\nGets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.
", + "smithy.api#documentation": "Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.
\n\n returns the VPCs associated with the specified hosted zone and does not reflect the VPC\n\t\t\tassociations by Route 53 Profiles. To get the associations to a Profile, call the ListProfileAssociations API.
The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.
\nYou can't change the value of Type after you create a health\n\t\t\t\tcheck.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTP request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTPS request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type, the\n\t\t\t\t\t\tendpoint must support TLS v1.0 or later.
\n HTTP_STR_MATCH: Route 53 tries to establish a\n\t\t\t\t\tTCP connection. If successful, Route 53 submits an HTTP request and searches the\n\t\t\t\t\tfirst 5,120 bytes of the response body for the string that you specify in\n\t\t\t\t\t\tSearchString.
\n HTTPS_STR_MATCH: Route 53 tries to establish\n\t\t\t\t\ta TCP connection. If successful, Route 53 submits an HTTPS request\n\t\t\t\t\tand searches the first 5,120 bytes of the response body for the string that you\n\t\t\t\t\tspecify in SearchString.
\n TCP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection.
\n\n CLOUDWATCH_METRIC: The health check is\n\t\t\t\t\tassociated with a CloudWatch alarm. If the state of the alarm is\n\t\t\t\t\tOK, the health check is considered healthy. If the state is\n\t\t\t\t\t\tALARM, the health check is considered unhealthy. If CloudWatch\n\t\t\t\t\tdoesn't have sufficient data to determine whether the state is OK\n\t\t\t\t\tor ALARM, the health check status depends on the setting for\n\t\t\t\t\t\tInsufficientDataHealthStatus: Healthy,\n\t\t\t\t\t\tUnhealthy, or LastKnownStatus.
\n CALCULATED: For health checks that monitor\n\t\t\t\t\tthe status of other health checks, Route 53 adds up the number of health checks\n\t\t\t\t\tthat Route 53 health checkers consider to be healthy and compares that number\n\t\t\t\t\twith the value of HealthThreshold.
\n RECOVERY_CONTROL: The health check is associated with a\n\t\t\t\t\tRoute53 Application Recovery Controller routing control. If the routing control\n\t\t\t\t\tstate is ON, the health check is considered healthy. If the state\n\t\t\t\t\tis OFF, the health check is considered unhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
", + "smithy.api#documentation": "The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.
\nYou can't change the value of Type after you create a health\n\t\t\t\tcheck.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTP request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTPS request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type, the endpoint must\n\t\t\t\t\t\tsupport TLS v1.0, v1.1, or v1.2.
\n HTTP_STR_MATCH: Route 53 tries to establish a\n\t\t\t\t\tTCP connection. If successful, Route 53 submits an HTTP request and searches the\n\t\t\t\t\tfirst 5,120 bytes of the response body for the string that you specify in\n\t\t\t\t\t\tSearchString.
\n HTTPS_STR_MATCH: Route 53 tries to establish\n\t\t\t\t\ta TCP connection. If successful, Route 53 submits an HTTPS request\n\t\t\t\t\tand searches the first 5,120 bytes of the response body for the string that you\n\t\t\t\t\tspecify in SearchString.
\n TCP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection.
\n\n CLOUDWATCH_METRIC: The health check is\n\t\t\t\t\tassociated with a CloudWatch alarm. If the state of the alarm is\n\t\t\t\t\tOK, the health check is considered healthy. If the state is\n\t\t\t\t\t\tALARM, the health check is considered unhealthy. If CloudWatch\n\t\t\t\t\tdoesn't have sufficient data to determine whether the state is OK\n\t\t\t\t\tor ALARM, the health check status depends on the setting for\n\t\t\t\t\t\tInsufficientDataHealthStatus: Healthy,\n\t\t\t\t\t\tUnhealthy, or LastKnownStatus.
\n CALCULATED: For health checks that monitor\n\t\t\t\t\tthe status of other health checks, Route 53 adds up the number of health checks\n\t\t\t\t\tthat Route 53 health checkers consider to be healthy and compares that number\n\t\t\t\t\twith the value of HealthThreshold.
\n RECOVERY_CONTROL: The health check is associated with a\n\t\t\t\t\tRoute53 Application Recovery Controller routing control. If the routing control\n\t\t\t\t\tstate is ON, the health check is considered healthy. If the state\n\t\t\t\t\tis OFF, the health check is considered unhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
", "smithy.api#required": {} } }, @@ -8711,7 +8711,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:
An OwningAccount element, which contains the account number of\n\t\t\t\t\teither the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create\n\t\t\t\t\thosted zones using the current account.
An OwningService element, which identifies the Amazon Web Services\n\t\t\t\t\tservice that created and owns the hosted zone. For example, if a hosted zone was\n\t\t\t\t\tcreated by Amazon Elastic File System (Amazon EFS), the value of\n\t\t\t\t\t\tOwner is efs.amazonaws.com.
When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nLists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:
An OwningAccount element, which contains the account number of\n\t\t\t\t\teither the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create\n\t\t\t\t\thosted zones using the current account.
An OwningService element, which identifies the Amazon Web Services\n\t\t\t\t\tservice that created and owns the hosted zone. For example, if a hosted zone was\n\t\t\t\t\tcreated by Amazon Elastic File System (Amazon EFS), the value of\n\t\t\t\t\t\tOwner is efs.amazonaws.com.
\n ListHostedZonesByVPC returns the hosted zones associated with the specified VPC and does not reflect the hosted zone\n\t\t\tassociations 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\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.
\nValid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n
Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.
Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n
SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.
Values for alias resource record sets:
\n\n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n A\n
\n CloudFront distributions:\n A\n
If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.
\n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n
\n ELB load balancers:\n A | AAAA\n
\n Amazon S3 buckets:\n A\n
\n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n A\n
\n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.
If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.
The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.
\nValid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\tSPF | SRV | TXT| TLSA| SSHFP| SVCB| HTTPS\n
Values for weighted, latency, geolocation, and failover resource record sets: A\n\t\t\t| AAAA | CAA | CNAME | MX |\n\t\t\t\tNAPTR | PTR | SPF | SRV |\n\t\t\t\tTXT| TLSA| SSHFP| SVCB|\n\t\t\t\tHTTPS. When creating a group of weighted, latency, geolocation,\n\t\t\tor\n\t\t\tfailover resource record sets, specify the same value for all of the resource record\n\t\t\tsets in the group.
Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\tSPF | SRV | TXT| CAA| TLSA| SSHFP| SVCB| HTTPS\n
SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.
Values for alias resource record sets:
\n\n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n A\n
\n CloudFront distributions:\n A\n
If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.
\n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n
\n ELB load balancers:\n A | AAAA\n
\n Amazon S3 buckets:\n A\n
\n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n A\n
\n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.
If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.
The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default \n lifecycle configuration.
" + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" } } }, @@ -9922,7 +9922,7 @@ "TagPropagation": { "target": "com.amazonaws.sagemaker#TagPropagation", "traits": { - "smithy.api#documentation": "Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" + } } }, "traits": { @@ -12955,7 +12961,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.
\nThe IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker\n Studio Through an Interface VPC Endpoint .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a default\n timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If\n you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.
Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.
\nThe IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker\n Studio Through an Interface VPC Endpoint .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a\n default timeout of 5 minutes. You can configure this value using\n ExpiresInSeconds. If you try to use the URL after the timeout limit\n expires, you are directed to the Amazon Web Services console sign-in page.
The JupyterLab session default expiration time is 12 hours. You can configure this\n value using SessionExpirationDurationInSeconds.
\nA file system, created by you, that you assign to a user profile or space for an\n Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.
" + "smithy.api#documentation": "A file system, created by you, that you assign to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker\n Studio.
" } }, "com.amazonaws.sagemaker#CustomFileSystemConfig": { @@ -14295,7 +14301,7 @@ } }, "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a user profile or space for an\n Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.
" + "smithy.api#documentation": "The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker\n Studio.
" } }, "com.amazonaws.sagemaker#CustomFileSystemConfigs": { @@ -15085,7 +15091,7 @@ } }, "traits": { - "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.
" + "smithy.api#documentation": "The default settings for shared spaces that users create in the domain.
\nSageMaker applies these settings only to shared spaces. It doesn't apply them to private\n spaces.
" } }, "com.amazonaws.sagemaker#DefaultSpaceStorageSettings": { @@ -23010,6 +23016,12 @@ "traits": { "smithy.api#documentation": "The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" + } } }, "traits": { @@ -26747,7 +26759,7 @@ } }, "traits": { - "smithy.api#documentation": "A file system, created by you in Amazon EFS, that you assign to a user profile\n or space for an Amazon SageMaker Domain. Permitted users can access this file\n system in Amazon SageMaker Studio.
" + "smithy.api#documentation": "A file system, created by you in Amazon EFS, that you assign to a user profile or\n space for an Amazon SageMaker Domain. Permitted users can access this file system in\n Amazon SageMaker Studio.
" } }, "com.amazonaws.sagemaker#EFSFileSystemConfig": { @@ -26764,12 +26776,12 @@ "FileSystemPath": { "target": "com.amazonaws.sagemaker#FileSystemPath", "traits": { - "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker\n Studio. Permitted users can access only this directory and below.
" + "smithy.api#documentation": "The path to the file system directory that is accessible in Amazon SageMaker Studio.\n Permitted users can access only this directory and below.
" } } }, "traits": { - "smithy.api#documentation": "The settings for assigning a custom Amazon EFS file system to a user profile\n or space for an Amazon SageMaker Domain.
" + "smithy.api#documentation": "The settings for assigning a custom Amazon EFS file system to a user profile or\n space for an Amazon SageMaker Domain.
" } }, "com.amazonaws.sagemaker#EMRStepMetadata": { @@ -30395,13 +30407,13 @@ "SageMakerImageName": { "target": "com.amazonaws.sagemaker#SageMakerImageName", "traits": { - "smithy.api#documentation": "\n The SageMaker image name that you are hiding from the Studio user interface.\n
" + "smithy.api#documentation": "The SageMaker image name that you are hiding from the Studio user interface.
" } }, "VersionAliases": { "target": "com.amazonaws.sagemaker#VersionAliasesList", "traits": { - "smithy.api#documentation": "\n The version aliases you are hiding from the Studio user interface.\n
" + "smithy.api#documentation": "The version aliases you are hiding from the Studio user interface.
" } } }, @@ -35569,7 +35581,7 @@ "BuiltInLifecycleConfigArn": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", "traits": { - "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default \n lifecycle configuration.
" + "smithy.api#documentation": "The lifecycle configuration that runs before the default lifecycle configuration. It can\n override changes made in the default lifecycle configuration.
" } } }, @@ -46108,6 +46120,36 @@ } } }, + "com.amazonaws.sagemaker#ModelLifeCycle": { + "type": "structure", + "members": { + "Stage": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The current stage in the model life cycle.\n
", + "smithy.api#required": {} + } + }, + "StageStatus": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "\n The current status of a stage in model life cycle.\n
", + "smithy.api#required": {} + } + }, + "StageDescription": { + "target": "com.amazonaws.sagemaker#StageDescription", + "traits": { + "smithy.api#documentation": "\n Describes the stage related details.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" + } + }, "com.amazonaws.sagemaker#ModelMetadataFilter": { "type": "structure", "members": { @@ -46446,6 +46488,12 @@ "ModelCard": { "target": "com.amazonaws.sagemaker#ModelPackageModelCard" }, + "ModelLifeCycle": { + "target": "com.amazonaws.sagemaker#ModelLifeCycle", + "traits": { + "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -61189,7 +61237,7 @@ "CustomFileSystems": { "target": "com.amazonaws.sagemaker#CustomFileSystems", "traits": { - "smithy.api#documentation": "A file system, created by you, that you assign to a space for an Amazon SageMaker\n Domain. Permitted users can access this file system in Amazon SageMaker\n Studio.
" + "smithy.api#documentation": "A file system, created by you, that you assign to a space for an Amazon SageMaker\n Domain. Permitted users can access this file system in Amazon SageMaker Studio.
" } } }, @@ -61362,6 +61410,16 @@ } } }, + "com.amazonaws.sagemaker#StageDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^.{0,1024}$" + } + }, "com.amazonaws.sagemaker#StageStatus": { "type": "enum", "members": { @@ -62755,13 +62813,13 @@ "HiddenInstanceTypes": { "target": "com.amazonaws.sagemaker#HiddenInstanceTypesList", "traits": { - "smithy.api#documentation": "\n The instance types you are hiding from the Studio user interface.\n
" + "smithy.api#documentation": "The instance types you are hiding from the Studio user interface.
" } }, "HiddenSageMakerImageVersionAliases": { "target": "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList", "traits": { - "smithy.api#documentation": "\n The version aliases you are hiding from the Studio user interface.\n
" + "smithy.api#documentation": "The version aliases you are hiding from the Studio user interface.
" } } }, @@ -64617,12 +64675,6 @@ "smithy.api#enumValue": "ml.p5e.48xlarge" } }, - "ML_P5EN_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.p5en.48xlarge" - } - }, "ML_C5_XLARGE": { "target": "smithy.api#Unit", "traits": { @@ -64749,12 +64801,6 @@ "smithy.api#enumValue": "ml.trn1n.32xlarge" } }, - "ML_TRN2_48XLARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ml.trn2.48xlarge" - } - }, "ML_M6I_LARGE": { "target": "smithy.api#Unit", "traits": { @@ -68219,7 +68265,7 @@ "TagPropagation": { "target": "com.amazonaws.sagemaker#TagPropagation", "traits": { - "smithy.api#documentation": "Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
Indicates whether custom tag propagation is supported for the domain. Defaults to\n DISABLED.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
\n A structure describing the current state of the model in its life cycle.\n
" + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#ClientToken", + "traits": { + "smithy.api#documentation": "\n A unique token that guarantees that the call to this API is idempotent.\n
" + } } }, "traits": { @@ -70544,7 +70602,7 @@ "CanvasAppSettings": { "target": "com.amazonaws.sagemaker#CanvasAppSettings", "traits": { - "smithy.api#documentation": "The Canvas app settings.
\nSageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.
" + "smithy.api#documentation": "The Canvas app settings.
\nSageMaker applies these settings only to private spaces that SageMaker creates for the Canvas\n app.
" } }, "CodeEditorAppSettings": { @@ -70828,7 +70886,7 @@ "min": 1, "max": 176 }, - "smithy.api#pattern": "^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?\n 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.\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#CreateIdentityCenterApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workmail#IdentityCenterApplicationName", + "traits": { + "smithy.api#documentation": "\n The name of the IAM Identity Center application.\n \n \n
", + "smithy.api#required": {} + } + }, + "InstanceArn": { + "target": "com.amazonaws.workmail#InstanceArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the instance.\n
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "\n The idempotency token associated with the request.\n \n \n
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#CreateIdentityCenterApplicationResponse": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.workmail#ApplicationArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the application.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workmail#CreateImpersonationRole": { "type": "operation", "input": { @@ -1357,6 +1428,12 @@ "smithy.api#default": false, "smithy.api#documentation": "If this parameter is enabled, the user will be hidden from the address book.
" } + }, + "IdentityProviderUserId": { + "target": "com.amazonaws.workmail#IdentityProviderUserId", + "traits": { + "smithy.api#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.
" + } } }, "traits": { @@ -1675,6 +1752,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.workmail#DeleteIdentityCenterApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeleteIdentityCenterApplicationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeleteIdentityCenterApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.\n
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeleteIdentityCenterApplicationRequest": { + "type": "structure", + "members": { + "ApplicationArn": { + "target": "com.amazonaws.workmail#ApplicationArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the application.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#DeleteIdentityCenterApplicationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workmail#DeleteIdentityProviderConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeleteIdentityProviderConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeleteIdentityProviderConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "\n 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.\n
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeleteIdentityProviderConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "\nThe Organization ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#DeleteIdentityProviderConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workmail#DeleteImpersonationRole": { "type": "operation", "input": { @@ -1962,6 +2128,13 @@ "smithy.api#default": false, "smithy.api#documentation": "Deletes a WorkMail organization even if the organization has enabled users.
" } + }, + "DeleteIdentityCenterApplication": { + "target": "com.amazonaws.workmail#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Deletes IAM Identity Center application for WorkMail. This action does not affect authentication settings for any organization.
" + } } }, "traits": { @@ -1988,6 +2161,59 @@ "smithy.api#output": {} } }, + "com.amazonaws.workmail#DeletePersonalAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DeletePersonalAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DeletePersonalAccessTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes the Personal Access Token from the provided WorkMail Organization.\n
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeletePersonalAccessTokenRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "\n The Organization ID.
", + "smithy.api#required": {} + } + }, + "PersonalAccessTokenId": { + "target": "com.amazonaws.workmail#PersonalAccessTokenId", + "traits": { + "smithy.api#documentation": "\n The Personal Access Token ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#DeletePersonalAccessTokenResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workmail#DeleteResource": { "type": "operation", "input": { @@ -2520,6 +2746,74 @@ "smithy.api#output": {} } }, + "com.amazonaws.workmail#DescribeIdentityProviderConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DescribeIdentityProviderConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DescribeIdentityProviderConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns detailed information on the current IdC setup for the WorkMail organization.\n
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DescribeIdentityProviderConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "\n The Organization ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#DescribeIdentityProviderConfigurationResponse": { + "type": "structure", + "members": { + "AuthenticationMode": { + "target": "com.amazonaws.workmail#IdentityProviderAuthenticationMode", + "traits": { + "smithy.api#documentation": "\nThe authentication mode used in WorkMail.
" + } + }, + "IdentityCenterConfiguration": { + "target": "com.amazonaws.workmail#IdentityCenterConfiguration", + "traits": { + "smithy.api#documentation": "\n The details of the IAM Identity Center configuration. \n
" + } + }, + "PersonalAccessTokenConfiguration": { + "target": "com.amazonaws.workmail#PersonalAccessTokenConfiguration", + "traits": { + "smithy.api#documentation": "\n The details of the Personal Access Token configuration.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workmail#DescribeInboundDmarcSettings": { "type": "operation", "input": { @@ -2942,6 +3236,12 @@ "target": "com.amazonaws.workmail#DescribeUserResponse" }, "errors": [ + { + "target": "com.amazonaws.workmail#DirectoryServiceAuthenticationFailedException" + }, + { + "target": "com.amazonaws.workmail#DirectoryUnavailableException" + }, { "target": "com.amazonaws.workmail#EntityNotFoundException" }, @@ -3123,6 +3423,18 @@ "traits": { "smithy.api#documentation": "Office where the user is located.
" } + }, + "IdentityProviderUserId": { + "target": "com.amazonaws.workmail#IdentityProviderUserId", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.workmail#IdentityProviderIdentityStoreId", + "traits": { + "smithy.api#documentation": "\n 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.\n
" + } } }, "traits": { @@ -4442,14 +4754,113 @@ "smithy.api#output": {} } }, - "com.amazonaws.workmail#Group": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.workmail#WorkMailIdentifier", - "traits": { - "smithy.api#documentation": "The identifier of the group.
" - } + "com.amazonaws.workmail#GetPersonalAccessTokenMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#GetPersonalAccessTokenMetadataRequest" + }, + "output": { + "target": "com.amazonaws.workmail#GetPersonalAccessTokenMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n Requests details of a specific Personal Access Token within the WorkMail organization.\n
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#GetPersonalAccessTokenMetadataRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "\n The Organization ID.
", + "smithy.api#required": {} + } + }, + "PersonalAccessTokenId": { + "target": "com.amazonaws.workmail#PersonalAccessTokenId", + "traits": { + "smithy.api#documentation": "\n The Personal Access Token ID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#GetPersonalAccessTokenMetadataResponse": { + "type": "structure", + "members": { + "PersonalAccessTokenId": { + "target": "com.amazonaws.workmail#PersonalAccessTokenId", + "traits": { + "smithy.api#documentation": "\n The Personal Access Token ID.
" + } + }, + "UserId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "\n The WorkMail User ID. \n
" + } + }, + "Name": { + "target": "com.amazonaws.workmail#PersonalAccessTokenName", + "traits": { + "smithy.api#documentation": "\n The Personal Access Token name.\n
" + } + }, + "DateCreated": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "\n The date when the Personal Access Token ID was created.\n
" + } + }, + "DateLastUsed": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "\n The date when the Personal Access Token ID was last used.\n
" + } + }, + "ExpiresTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "\n The time when the Personal Access Token ID will expire.\n
" + } + }, + "Scopes": { + "target": "com.amazonaws.workmail#PersonalAccessTokenScopeList", + "traits": { + "smithy.api#documentation": "\n Lists all the Personal Access Token permissions for a mailbox.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workmail#Group": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the group.
" + } }, "Email": { "target": "com.amazonaws.workmail#EmailAddress", @@ -4548,6 +4959,95 @@ "smithy.api#pattern": "^[\\x21-\\x7e]+$" } }, + "com.amazonaws.workmail#IdentityCenterApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\w+=,.@-]+$" + } + }, + "com.amazonaws.workmail#IdentityCenterConfiguration": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.workmail#InstanceArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the of IAM Identity Center instance. Must be in the same AWS account and region as WorkMail organization.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.workmail#ApplicationArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of IAMIdentity Center Application for WorkMail. Must be created by the WorkMail API, see CreateIdentityCenterApplication.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The IAM Identity Center configuration.\n
" + } + }, + "com.amazonaws.workmail#IdentityProviderAuthenticationMode": { + "type": "enum", + "members": { + "IDENTITY_PROVIDER_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY_PROVIDER_ONLY" + } + }, + "IDENTITY_PROVIDER_AND_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY_PROVIDER_AND_DIRECTORY" + } + } + } + }, + "com.amazonaws.workmail#IdentityProviderIdentityStoreId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#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}$" + } + }, + "com.amazonaws.workmail#IdentityProviderUserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + }, + "smithy.api#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}$" + } + }, + "com.amazonaws.workmail#IdentityProviderUserIdForUpdate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 47 + }, + "smithy.api#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}$" + } + }, + "com.amazonaws.workmail#IdentityProviderUserIdPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + }, + "smithy.api#pattern": "^[A-Fa-f0-9-]+$" + } + }, "com.amazonaws.workmail#ImpersonationMatchedRule": { "type": "structure", "members": { @@ -4787,6 +5287,16 @@ "smithy.api#pattern": "^[\\x21-\\x7e]+$" } }, + "com.amazonaws.workmail#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1124 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + } + }, "com.amazonaws.workmail#InvalidConfigurationException": { "type": "structure", "members": { @@ -5067,6 +5577,9 @@ "target": "com.amazonaws.workmail#ListAvailabilityConfigurationsResponse" }, "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, { "target": "com.amazonaws.workmail#OrganizationNotFoundException" }, @@ -5958,6 +6471,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.workmail#ListPersonalAccessTokens": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ListPersonalAccessTokensRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ListPersonalAccessTokensResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#EntityNotFoundException" + }, + { + "target": "com.amazonaws.workmail#EntityStateException" + }, + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns a summary of your Personal Access Tokens.\n
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PersonalAccessTokenSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.workmail#ListPersonalAccessTokensRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "\n The Organization ID.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.workmail#EntityIdentifier", + "traits": { + "smithy.api#documentation": "\n The WorkMail User ID. \n
" + } + }, + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "smithy.api#documentation": "\n The token from the previous response to query the next page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.workmail#MaxResults", + "traits": { + "smithy.api#documentation": "\n The maximum amount of items that should be returned in a response.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#ListPersonalAccessTokensResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "smithy.api#documentation": "\n The token from the previous response to query the next page.
" + } + }, + "PersonalAccessTokenSummaries": { + "target": "com.amazonaws.workmail#PersonalAccessTokenSummaryList", + "traits": { + "smithy.api#documentation": "\n Lists all the personal tokens in an organization or user, if user ID is provided. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workmail#ListResourceDelegates": { "type": "operation", "input": { @@ -6262,6 +6864,12 @@ "traits": { "smithy.api#documentation": "Filters only users with the provided state.
" } + }, + "IdentityProviderUserIdPrefix": { + "target": "com.amazonaws.workmail#IdentityProviderUserIdPrefix", + "traits": { + "smithy.api#documentation": "Filters only users with the ID from the IAM Identity Center.
" + } } }, "traits": { @@ -6850,7 +7458,8 @@ "smithy.api#length": { "min": 0, "max": 64 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.workmail#NextToken": { @@ -7036,6 +7645,151 @@ "target": "com.amazonaws.workmail#Permission" } }, + "com.amazonaws.workmail#PersonalAccessTokenConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.workmail#PersonalAccessTokenConfigurationStatus", + "traits": { + "smithy.api#documentation": "\n The status of the Personal Access Token allowed for the organization.\n
\n\n Active - Mailbox users can login to the web application and choose Settings to see the new Personal Access Tokens page to \n create and delete the Personal Access Tokens. Mailbox users can use the Personal Access Tokens to set up mailbox connection from desktop or mobile email clients.
\n\n Inactive - Personal Access Tokens are disabled for your organization. Mailbox users can’t create, list, or delete Personal Access Tokens and can’t use them to connect to \n their mailboxes from desktop or mobile email clients.
\n\n The validity of the Personal Access Token status in days.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Displays the Personal Access Token status.\n
" + } + }, + "com.amazonaws.workmail#PersonalAccessTokenConfigurationStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.workmail#PersonalAccessTokenId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.workmail#PersonalAccessTokenLifetimeInDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3653 + } + } + }, + "com.amazonaws.workmail#PersonalAccessTokenName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+$" + } + }, + "com.amazonaws.workmail#PersonalAccessTokenScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[^\\x00-\\x1F\\x7F\\x3C\\x3E\\x5C]+$" + } + }, + "com.amazonaws.workmail#PersonalAccessTokenScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#PersonalAccessTokenScope" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.workmail#PersonalAccessTokenSummary": { + "type": "structure", + "members": { + "PersonalAccessTokenId": { + "target": "com.amazonaws.workmail#PersonalAccessTokenId", + "traits": { + "smithy.api#documentation": "\n The ID of the Personal Access Token.\n
" + } + }, + "UserId": { + "target": "com.amazonaws.workmail#WorkMailIdentifier", + "traits": { + "smithy.api#documentation": "\n The user ID of the WorkMail user associated with the Personal Access Token.\n
" + } + }, + "Name": { + "target": "com.amazonaws.workmail#PersonalAccessTokenName", + "traits": { + "smithy.api#documentation": "\n The name of the Personal Access Token.\n
" + } + }, + "DateCreated": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "\n The date when the Personal Access Token was created.\n
" + } + }, + "DateLastUsed": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "\n The date when the Personal Access Token was last used.\n
" + } + }, + "ExpiresTime": { + "target": "com.amazonaws.workmail#Timestamp", + "traits": { + "smithy.api#documentation": "\n The date when the Personal Access Token will expire.\n
" + } + }, + "Scopes": { + "target": "com.amazonaws.workmail#PersonalAccessTokenScopeList", + "traits": { + "smithy.api#documentation": "\n Lists all the Personal Access Token permissions for a mailbox.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The summary of the Personal Access Token.\n
" + } + }, + "com.amazonaws.workmail#PersonalAccessTokenSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#PersonalAccessTokenSummary" + } + }, "com.amazonaws.workmail#PolicyDescription": { "type": "string", "traits": { @@ -7233,6 +7987,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.workmail#PutIdentityProviderConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#PutIdentityProviderConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#PutIdentityProviderConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n 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 \n IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication (MFA) and Personal Access Tokens.\n \n
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#PutIdentityProviderConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "\n The ID of the WorkMail Organization.
", + "smithy.api#required": {} + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.workmail#IdentityProviderAuthenticationMode", + "traits": { + "smithy.api#documentation": "\n The authentication mode used in WorkMail.
", + "smithy.api#required": {} + } + }, + "IdentityCenterConfiguration": { + "target": "com.amazonaws.workmail#IdentityCenterConfiguration", + "traits": { + "smithy.api#documentation": "\n The details of the IAM Identity Center configuration.
", + "smithy.api#required": {} + } + }, + "PersonalAccessTokenConfiguration": { + "target": "com.amazonaws.workmail#PersonalAccessTokenConfiguration", + "traits": { + "smithy.api#documentation": "\n The details of the Personal Access Token configuration. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workmail#PutIdentityProviderConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workmail#PutInboundDmarcSettings": { "type": "operation", "input": { @@ -7837,7 +8661,8 @@ "smithy.api#length": { "min": 1, "max": 64 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.workmail#ResourceId": { @@ -8520,7 +9345,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates attibutes in a group.
", + "smithy.api#documentation": "Updates attributes in a group.
", "smithy.api#idempotent": {} } }, @@ -9158,7 +9983,7 @@ "ZipCode": { "target": "com.amazonaws.workmail#UserAttribute", "traits": { - "smithy.api#documentation": "Updates the user's zipcode.
" + "smithy.api#documentation": "Updates the user's zip code.
" } }, "Department": { @@ -9178,6 +10003,12 @@ "traits": { "smithy.api#documentation": "Updates the user's office.
" } + }, + "IdentityProviderUserId": { + "target": "com.amazonaws.workmail#IdentityProviderUserIdForUpdate", + "traits": { + "smithy.api#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.
" + } } }, "traits": { @@ -9251,6 +10082,18 @@ "traits": { "smithy.api#documentation": "The date indicating when the user was disabled from WorkMail use.
" } + }, + "IdentityProviderUserId": { + "target": "com.amazonaws.workmail#IdentityProviderUserId", + "traits": { + "smithy.api#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": { + "target": "com.amazonaws.workmail#IdentityProviderIdentityStoreId", + "traits": { + "smithy.api#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.
" + } } }, "traits": { @@ -9368,6 +10211,9 @@ { "target": "com.amazonaws.workmail#CreateGroup" }, + { + "target": "com.amazonaws.workmail#CreateIdentityCenterApplication" + }, { "target": "com.amazonaws.workmail#CreateImpersonationRole" }, @@ -9398,6 +10244,12 @@ { "target": "com.amazonaws.workmail#DeleteGroup" }, + { + "target": "com.amazonaws.workmail#DeleteIdentityCenterApplication" + }, + { + "target": "com.amazonaws.workmail#DeleteIdentityProviderConfiguration" + }, { "target": "com.amazonaws.workmail#DeleteImpersonationRole" }, @@ -9413,6 +10265,9 @@ { "target": "com.amazonaws.workmail#DeleteOrganization" }, + { + "target": "com.amazonaws.workmail#DeletePersonalAccessToken" + }, { "target": "com.amazonaws.workmail#DeleteResource" }, @@ -9437,6 +10292,9 @@ { "target": "com.amazonaws.workmail#DescribeGroup" }, + { + "target": "com.amazonaws.workmail#DescribeIdentityProviderConfiguration" + }, { "target": "com.amazonaws.workmail#DescribeInboundDmarcSettings" }, @@ -9482,6 +10340,9 @@ { "target": "com.amazonaws.workmail#GetMobileDeviceAccessOverride" }, + { + "target": "com.amazonaws.workmail#GetPersonalAccessTokenMetadata" + }, { "target": "com.amazonaws.workmail#ListAccessControlRules" }, @@ -9521,6 +10382,9 @@ { "target": "com.amazonaws.workmail#ListOrganizations" }, + { + "target": "com.amazonaws.workmail#ListPersonalAccessTokens" + }, { "target": "com.amazonaws.workmail#ListResourceDelegates" }, @@ -9539,6 +10403,9 @@ { "target": "com.amazonaws.workmail#PutEmailMonitoringConfiguration" }, + { + "target": "com.amazonaws.workmail#PutIdentityProviderConfiguration" + }, { "target": "com.amazonaws.workmail#PutInboundDmarcSettings" }, @@ -9656,7 +10523,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -9699,7 +10565,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -9712,7 +10579,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -9726,7 +10592,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -9749,7 +10614,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -9784,7 +10648,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -9795,14 +10658,16 @@ }, "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": [ @@ -9816,14 +10681,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -9832,11 +10695,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -9847,14 +10710,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -9868,7 +10733,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -9888,7 +10752,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -9899,14 +10762,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -9917,9 +10782,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [],