NoSuchBucket
\nThe IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.
" } }, + "IpAddresses": { + "target": "com.amazonaws.globalaccelerator#IpAddresses", + "traits": { + "smithy.api#documentation": "The IP addresses for an accelerator.
" + } + }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { @@ -6094,6 +6100,12 @@ "smithy.api#documentation": "The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.
" } }, + "IpAddresses": { + "target": "com.amazonaws.globalaccelerator#IpAddresses", + "traits": { + "smithy.api#documentation": "The IP addresses for an accelerator.
" + } + }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index c9158662031..ce8f37793de 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -1655,6 +1655,16 @@ } } }, + "com.amazonaws.glue#AWSManagedClientApplicationReference": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.glue#AccessDeniedException": { "type": "structure", "members": { @@ -2340,6 +2350,111 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.glue#AuthenticationConfiguration": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.glue#AuthenticationType", + "traits": { + "smithy.api#documentation": "A structure containing the authentication configuration.
" + } + }, + "SecretArn": { + "target": "com.amazonaws.glue#SecretArn", + "traits": { + "smithy.api#documentation": "The secret manager ARN to store credentials.
" + } + }, + "OAuth2Properties": { + "target": "com.amazonaws.glue#OAuth2Properties", + "traits": { + "smithy.api#documentation": "The properties for OAuth2 authentication.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing the authentication configuration.
" + } + }, + "com.amazonaws.glue#AuthenticationConfigurationInput": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.glue#AuthenticationType", + "traits": { + "smithy.api#documentation": "A structure containing the authentication configuration in the CreateConnection request.
" + } + }, + "SecretArn": { + "target": "com.amazonaws.glue#SecretArn", + "traits": { + "smithy.api#documentation": "The secret manager ARN to store credentials in the CreateConnection request.
" + } + }, + "OAuth2Properties": { + "target": "com.amazonaws.glue#OAuth2PropertiesInput", + "traits": { + "smithy.api#documentation": "The properties for OAuth2 authentication in the CreateConnection request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing the authentication configuration in the CreateConnection request.
" + } + }, + "com.amazonaws.glue#AuthenticationType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.glue#AuthorizationCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.glue#AuthorizationCodeProperties": { + "type": "structure", + "members": { + "AuthorizationCode": { + "target": "com.amazonaws.glue#AuthorizationCode", + "traits": { + "smithy.api#documentation": "An authorization code to be used in the third leg of the AUTHORIZATION_CODE
grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.
The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type workflow.
A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup
, that are needed to make this connection successfully.
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to make this connection successfully.
The time that this connection definition was created.
" + "smithy.api#documentation": "The timestamp of the time that this connection definition was created.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "The last time that this connection definition was updated.
" + "smithy.api#documentation": "The timestamp of the last time the connection definition was updated.
" } }, "LastUpdatedBy": { @@ -6510,6 +6625,30 @@ "traits": { "smithy.api#documentation": "The user, group, or role that last updated this connection definition.
" } + }, + "Status": { + "target": "com.amazonaws.glue#ConnectionStatus", + "traits": { + "smithy.api#documentation": "The status of the connection. Can be one of: READY
, IN_PROGRESS
, or FAILED
.
The reason for the connection status.
" + } + }, + "LastConnectionValidationTime": { + "target": "com.amazonaws.glue#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the time this connection was last validated.
" + } + }, + "AuthenticationConfiguration": { + "target": "com.amazonaws.glue#AuthenticationConfiguration", + "traits": { + "smithy.api#documentation": "The authentication properties of the connection.
" + } } }, "traits": { @@ -6522,7 +6661,7 @@ "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "The name of the connection. Connection will not function as expected without a name.
", + "smithy.api#documentation": "The name of the connection.
", "smithy.api#required": {} } }, @@ -6535,7 +6674,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "The type of the connection. Currently, these types are supported:
\n\n JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).
\n JDBC
Connections use the following ConnectionParameters.
Required: All of (HOST
, PORT
, JDBC_ENGINE
) or JDBC_CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
Optional: JDBC_ENFORCE_SSL
, CUSTOM_JDBC_CERT
, CUSTOM_JDBC_CERT_STRING
, SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
\n KAFKA
- Designates a connection to an Apache Kafka streaming platform.
\n KAFKA
Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS
.
Optional: KAFKA_SSL_ENABLED
, KAFKA_CUSTOM_CERT
, KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL with KAFKA
.
Optional: KAFKA_CLIENT_KEYSTORE
, KAFKA_CLIENT_KEYSTORE_PASSWORD
, KAFKA_CLIENT_KEY_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL in KAFKA
.
Optional: KAFKA_SASL_MECHANISM
. Can be specified as SCRAM-SHA-512
, GSSAPI
, or AWS_MSK_IAM
.
Optional: KAFKA_SASL_SCRAM_USERNAME
, KAFKA_SASL_SCRAM_PASSWORD
, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA
.
Optional: KAFKA_SASL_GSSAPI_KEYTAB
, KAFKA_SASL_GSSAPI_KRB5_CONF
, KAFKA_SASL_GSSAPI_SERVICE
, KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication with KAFKA
.
\n MONGODB
- Designates a connection to a MongoDB document database.
\n MONGODB
Connections use the following ConnectionParameters.
Required: CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
\n NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
\n MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
\n MARKETPLACE
Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE
, CONNECTOR_URL
, CONNECTOR_CLASS_NAME
, CONNECTION_URL
.
Required for JDBC
\n CONNECTOR_TYPE
connections: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
\n SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
\nFor more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
", + "smithy.api#documentation": "The type of the connection. Currently, these types are supported:
\n\n JDBC
- Designates a connection to a database through Java Database Connectivity (JDBC).
\n JDBC
Connections use the following ConnectionParameters.
Required: All of (HOST
, PORT
, JDBC_ENGINE
) or JDBC_CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
Optional: JDBC_ENFORCE_SSL
, CUSTOM_JDBC_CERT
, CUSTOM_JDBC_CERT_STRING
, SKIP_CUSTOM_JDBC_CERT_VALIDATION
. These parameters are used to configure SSL with JDBC.
\n KAFKA
- Designates a connection to an Apache Kafka streaming platform.
\n KAFKA
Connections use the following ConnectionParameters.
Required: KAFKA_BOOTSTRAP_SERVERS
.
Optional: KAFKA_SSL_ENABLED
, KAFKA_CUSTOM_CERT
, KAFKA_SKIP_CUSTOM_CERT_VALIDATION
. These parameters are used to configure SSL with KAFKA
.
Optional: KAFKA_CLIENT_KEYSTORE
, KAFKA_CLIENT_KEYSTORE_PASSWORD
, KAFKA_CLIENT_KEY_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
. These parameters are used to configure TLS client configuration with SSL in KAFKA
.
Optional: KAFKA_SASL_MECHANISM
. Can be specified as SCRAM-SHA-512
, GSSAPI
, or AWS_MSK_IAM
.
Optional: KAFKA_SASL_SCRAM_USERNAME
, KAFKA_SASL_SCRAM_PASSWORD
, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA
.
Optional: KAFKA_SASL_GSSAPI_KEYTAB
, KAFKA_SASL_GSSAPI_KRB5_CONF
, KAFKA_SASL_GSSAPI_SERVICE
, KAFKA_SASL_GSSAPI_PRINCIPAL
. These parameters are used to configure SASL/GSSAPI authentication with KAFKA
.
\n MONGODB
- Designates a connection to a MongoDB document database.
\n MONGODB
Connections use the following ConnectionParameters.
Required: CONNECTION_URL
.
Required: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n SALESFORCE
- Designates a connection to Salesforce using OAuth authencation.
Requires the AuthenticationConfiguration
member to be configured.
\n NETWORK
- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
\n NETWORK
Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
\n MARKETPLACE
- Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.
\n MARKETPLACE
Connections use the following ConnectionParameters.
Required: CONNECTOR_TYPE
, CONNECTOR_URL
, CONNECTOR_CLASS_NAME
, CONNECTION_URL
.
Required for JDBC
\n CONNECTOR_TYPE
connections: All of (USERNAME
, PASSWORD
) or SECRET_ID
.
\n CUSTOM
- Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.
\n SFTP
is not supported.
For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
\nFor more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
", "smithy.api#required": {} } }, @@ -6555,7 +6694,20 @@ "PhysicalConnectionRequirements": { "target": "com.amazonaws.glue#PhysicalConnectionRequirements", "traits": { - "smithy.api#documentation": "A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup
, that are needed to successfully make this connection.
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to successfully make this connection.
The authentication properties of the connection. Used for a Salesforce connection.
" + } + }, + "ValidateCredentials": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.
" } } }, @@ -6863,6 +7015,35 @@ "traits": { "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_PRINCIPAL" } + }, + "ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_ARN" + } + } + } + }, + "com.amazonaws.glue#ConnectionStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } } } }, @@ -6910,6 +7091,12 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } } } }, @@ -7847,7 +8034,14 @@ }, "com.amazonaws.glue#CreateConnectionResponse": { "type": "structure", - "members": {}, + "members": { + "CreateConnectionStatus": { + "target": "com.amazonaws.glue#ConnectionStatus", + "traits": { + "smithy.api#documentation": "The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.
" + } + } + }, "traits": { "smithy.api#output": {} } @@ -8719,7 +8913,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT
\n status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT
\n status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
" } }, "MaxCapacity": { @@ -14413,6 +14607,30 @@ "com.amazonaws.glue#FederationSourceErrorCode": { "type": "enum", "members": { + "AccessDeniedException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDeniedException" + } + }, + "EntityNotFoundException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntityNotFoundException" + } + }, + "InvalidCredentialsException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidCredentialsException" + } + }, + "InvalidInputException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInputException" + } + }, "InvalidResponseException": { "target": "smithy.api#Unit", "traits": { @@ -14437,6 +14655,12 @@ "smithy.api#enumValue": "InternalServiceException" } }, + "PartialFailureException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartialFailureException" + } + }, "ThrottlingException": { "target": "smithy.api#Unit", "traits": { @@ -21999,7 +22223,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT
\n status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT
\n status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
" } }, "MaxCapacity": { @@ -22343,7 +22567,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "The JobRun
timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
The maximum value for timeout for batch jobs is 7 days or 10080 minutes. The default is 2880 minutes (48 hours) for batch jobs.
\nAny existing Glue jobs that have a greater timeout value are defaulted to 7 days. For instance you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
\nStreaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
" + "smithy.api#documentation": "The JobRun
timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
" } }, "MaxCapacity": { @@ -22559,7 +22783,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT
\n status. The default is 2,880 minutes (48 hours).
The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT
\n status. The default is 2,880 minutes (48 hours) for batch jobs.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
" } }, "MaxCapacity": { @@ -25014,6 +25238,15 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#LongValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, "com.amazonaws.glue#MLTransform": { "type": "structure", "members": { @@ -25964,6 +26197,119 @@ "com.amazonaws.glue#NullableString": { "type": "string" }, + "com.amazonaws.glue#OAuth2ClientApplication": { + "type": "structure", + "members": { + "UserManagedClientApplicationClientId": { + "target": "com.amazonaws.glue#UserManagedClientApplicationClientId", + "traits": { + "smithy.api#documentation": "The client application clientID if the ClientAppType is USER_MANAGED
.
The reference to the SaaS-side client app that is Amazon Web Services managed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The OAuth2 client app used for the connection.
" + } + }, + "com.amazonaws.glue#OAuth2GrantType": { + "type": "enum", + "members": { + "AUTHORIZATION_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZATION_CODE" + } + }, + "CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CREDENTIALS" + } + }, + "JWT_BEARER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT_BEARER" + } + } + } + }, + "com.amazonaws.glue#OAuth2Properties": { + "type": "structure", + "members": { + "OAuth2GrantType": { + "target": "com.amazonaws.glue#OAuth2GrantType", + "traits": { + "smithy.api#documentation": "The OAuth2 grant type. For example, AUTHORIZATION_CODE
, JWT_BEARER
, or CLIENT_CREDENTIALS
.
The client application type. For example, AWS_MANAGED or USER_MANAGED.
" + } + }, + "TokenUrl": { + "target": "com.amazonaws.glue#TokenUrl", + "traits": { + "smithy.api#documentation": "The URL of the provider's authentication server, to exchange an authorization code for an access token.
" + } + }, + "TokenUrlParametersMap": { + "target": "com.amazonaws.glue#TokenUrlParametersMap", + "traits": { + "smithy.api#documentation": "A map of parameters that are added to the token GET
request.
A structure containing properties for OAuth2 authentication.
" + } + }, + "com.amazonaws.glue#OAuth2PropertiesInput": { + "type": "structure", + "members": { + "OAuth2GrantType": { + "target": "com.amazonaws.glue#OAuth2GrantType", + "traits": { + "smithy.api#documentation": "The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE
, JWT_BEARER
, or CLIENT_CREDENTIALS
.
The client application type in the CreateConnection request. For example, AWS_MANAGED
or USER_MANAGED
.
The URL of the provider's authentication server, to exchange an authorization code for an access token.
" + } + }, + "TokenUrlParametersMap": { + "target": "com.amazonaws.glue#TokenUrlParametersMap", + "traits": { + "smithy.api#documentation": "A map of parameters that are added to the token GET
request.
The set of properties required for the the OAuth2 AUTHORIZATION_CODE
grant type.
A structure containing properties for OAuth2 in the CreateConnection request.
" + } + }, "com.amazonaws.glue#OneInput": { "type": "list", "member": { @@ -26847,12 +27193,12 @@ "AvailabilityZone": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "The connection's Availability Zone. This field is redundant because the specified subnet\n implies the Availability Zone to be used. Currently the field must be populated, but it will\n be deprecated in the future.
" + "smithy.api#documentation": "The connection's Availability Zone.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the physical requirements for a connection.
" + "smithy.api#documentation": "The OAuth client app in GetConnection response.
" } }, "com.amazonaws.glue#PiiType": { @@ -27735,6 +28081,16 @@ "smithy.api#documentation": "When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.
" } }, + "com.amazonaws.glue#RedirectUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^(https?):\\/\\/[^\\s/$.?#].[^\\s]*$" + } + }, "com.amazonaws.glue#RedshiftSource": { "type": "structure", "members": { @@ -30190,6 +30546,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$" + } + }, "com.amazonaws.glue#SecurityConfiguration": { "type": "structure", "members": { @@ -31869,7 +32231,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "The JobRun
timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
" + "smithy.api#documentation": "The JobRun
timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
" } }, "MaxCapacity": { @@ -33848,6 +34210,43 @@ "com.amazonaws.glue#Token": { "type": "string" }, + "com.amazonaws.glue#TokenUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, + "com.amazonaws.glue#TokenUrlParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#TokenUrlParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.glue#TokenUrlParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#TokenUrlParameterKey" + }, + "value": { + "target": "com.amazonaws.glue#TokenUrlParameterValue" + } + }, "com.amazonaws.glue#Topk": { "type": "integer", "traits": { @@ -36685,6 +37084,16 @@ "target": "com.amazonaws.glue#UserDefinedFunction" } }, + "com.amazonaws.glue#UserManagedClientApplicationClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.glue#ValidationException": { "type": "structure", "members": { @@ -36853,7 +37262,7 @@ "ViewExpandedText": { "target": "com.amazonaws.glue#ViewTextString", "traits": { - "smithy.api#documentation": "The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText
to ViewExpandedText
. For example:
Fully qualify identifiers: SELECT * from table1 → SELECT * from db1.table1
\n
The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText
to ViewExpandedText
. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
\n
Specifies the source object for the copy operation. The source object \n can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.
\nYou specify the value of the copy source in one of two\n formats, depending on whether you want to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket\n and the key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf
from the general purpose bucket \n awsexamplebucket
, use awsexamplebucket/reports/january.pdf
.\n The value must be URL-encoded. To copy the\n object reports/january.pdf
from the directory bucket \n awsexamplebucket--use1-az5--x-s3
, use awsexamplebucket--use1-az5--x-s3/reports/january.pdf
.\n The value must be URL-encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
\nAccess points are not supported by directory buckets.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your source bucket versioning is enabled, the x-amz-copy-source
header by default identifies the current\n version of an object to copy. If the current version is a delete marker, Amazon S3\n behaves as if the object was deleted. To copy a different version, use the\n versionId
query parameter. Specifically, append ?versionId=
\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version\n ID for the copied object. This version ID is different from the version ID\n of the source object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the destination bucket, the version\n ID that Amazon S3 generates in the\n x-amz-version-id
response header is always null.
\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
\nThe key of the destination object.
", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } } }, "Metadata": { @@ -30612,19 +30650,31 @@ "smithy.api#documentation": "Adds an object to a bucket.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject
to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All\n objects written to the bucket by any account will be owned by the bucket owner.
\n\n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
\n\n S3 Object Lock - To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\n\n S3 Versioning - When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID\n of that object being stored in Amazon S3. \n You can retrieve, replace, or delete any version of the object. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3\n User Guide. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nThis functionality is not supported for directory buckets.
\n\n General purpose bucket permissions - The following permissions are required in your policies when your \n PutObject
request includes specific headers.
\n \n s3:PutObject
\n - To successfully complete the PutObject
request, you must always have the s3:PutObject
permission on a bucket to add an object\n to it.
\n \n s3:PutObjectAcl
\n - To successfully change the objects ACL of your PutObject
request, you must have the s3:PutObjectAcl
.
\n \n s3:PutObjectTagging
\n - To successfully set the tag-set with your PutObject
request, you\n must have the s3:PutObjectTagging
.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - To ensure that data is not corrupted traversing the network, use the\n Content-MD5
header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, \n you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
\n Directory bucket - This functionality is not supported for directory buckets.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
For more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nAccepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known\n as the root user email address) for the specified account.
", + "smithy.api#http": { + "uri": "/acceptPrimaryEmailUpdate", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.account#AcceptPrimaryEmailUpdateRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThis operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.
\nThe management account can't specify its own AccountId
.
The new primary email address for use with the specified account. This must\n match the PrimaryEmail
from the StartPrimaryEmailUpdate
API\n call.
The OTP code sent to the PrimaryEmail
specified on the\n StartPrimaryEmailUpdate
API call.
Retrieves the status of the accepted primary email update request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.account#AccessDeniedException": { "type": "structure", "members": { @@ -27,6 +107,9 @@ { "target": "com.amazonaws.account#ContactInformationResource" }, + { + "target": "com.amazonaws.account#PrimaryEmailResource" + }, { "target": "com.amazonaws.account#RegionOptResource" } @@ -94,7 +177,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -137,7 +219,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -150,7 +233,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -164,7 +246,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -289,7 +370,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -324,7 +404,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -335,14 +414,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": [ @@ -356,14 +437,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -372,11 +451,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -387,14 +466,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -408,7 +489,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -428,7 +508,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -439,14 +518,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -457,9 +538,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1016,7 +1099,7 @@ "StateOrRegion": { "target": "com.amazonaws.account#StateOrRegion", "traits": { - "smithy.api#documentation": "The state or region of the primary contact address. This field is required in selected countries.
" + "smithy.api#documentation": "The state or region of the primary contact address. If the mailing address is within the United States (US), the\n value in this field can be either a two character state code (for example, NJ
) or the full state name\n (for example, New Jersey
). This field is required in the following countries: US
,\n CA
, GB
, DE
, JP
, IN
,\n and BR
.
The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
", + "smithy.api#documentation": "The phone number of the primary contact information. The number will be validated and,\n in some countries, checked for activation.
", "smithy.api#required": {} } }, "CompanyName": { "target": "com.amazonaws.account#CompanyName", "traits": { - "smithy.api#documentation": "The name of the company associated with the primary contact information, if any.
" + "smithy.api#documentation": "The name of the company associated with the primary contact information, if\n any.
" } }, "WebsiteUrl": { @@ -1060,7 +1143,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
" + "smithy.api#documentation": "Contains the details of the primary contact information associated with an\n Amazon Web Services account.
" } }, "com.amazonaws.account#ContactInformationPhoneNumber": { @@ -1180,7 +1263,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables (opts-out) a particular Region for an account.
", + "smithy.api#documentation": "Disables (opts-out) a particular Region for an account.
\nThe act of disabling a Region will remove all IAM access to any resources that\n reside in that Region.
\nSpecifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "Specifies the Region-code for a given Region name (for example, af-south-1
). When\n you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such\n as destroying IAM resources in the Region. This process takes a few minutes for most\n accounts, but this can take several hours. You cannot enable the Region until the\n disabling process is fully completed.
Specifies the Region-code for a given Region name (for example,\n af-south-1
). When you disable a Region, Amazon Web Services performs actions to\n deactivate that Region in your account, such as destroying IAM resources in the Region.\n This process takes a few minutes for most accounts, but this can take several hours. You\n cannot enable the Region until the disabling process is fully completed.
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "Specifies the Region-code for a given Region name (for example, af-south-1
). When\n you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such\n as distributing your IAM resources to the Region. This process takes a few minutes for\n most accounts, but it can take several hours. You cannot use the Region until this\n process is complete. Furthermore, you cannot disable the Region until the enabling\n process is fully completed.
Specifies the Region-code for a given Region name (for example,\n af-south-1
). When you enable a Region, Amazon Web Services performs actions to\n prepare your account in that Region, such as distributing your IAM resources to the\n Region. This process takes a few minutes for most accounts, but it can take several\n hours. You cannot use the Region until this process is complete. Furthermore, you cannot\n disable the Region until the enabling process is fully completed.
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" } } }, @@ -1426,7 +1509,74 @@ "ContactInformation": { "target": "com.amazonaws.account#ContactInformation", "traits": { - "smithy.api#documentation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
" + "smithy.api#documentation": "Contains the details of the primary contact information associated with an\n Amazon Web Services account.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.account#GetPrimaryEmail": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#GetPrimaryEmailRequest" + }, + "output": { + "target": "com.amazonaws.account#GetPrimaryEmailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the primary email address for the specified account.
", + "smithy.api#http": { + "uri": "/getPrimaryEmail", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.account#GetPrimaryEmailRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThis operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.
\nThe management account can't specify its own AccountId
.
Retrieves the primary email address associated with the specified\n account.
" } } }, @@ -1475,13 +1625,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "Specifies the Region-code for a given Region name (for example, af-south-1
). This\n function will return the status of whatever Region you pass into this parameter.
Specifies the Region-code for a given Region name (for example,\n af-south-1
). This function will return the status of whatever Region\n you pass into this parameter.
Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" } }, "MaxResults": { @@ -1637,6 +1787,13 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#Otp": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9]{6}$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.account#PhoneNumber": { "type": "string", "traits": { @@ -1658,6 +1815,50 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#PrimaryEmailAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.account#PrimaryEmailResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.account#AcceptPrimaryEmailUpdate" + }, + { + "target": "com.amazonaws.account#GetPrimaryEmail" + }, + { + "target": "com.amazonaws.account#StartPrimaryEmailUpdate" + } + ], + "traits": { + "aws.api#arn": { + "template": "PrimaryEmail" + } + } + }, + "com.amazonaws.account#PrimaryEmailUpdateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ACCEPTED", + "name": "ACCEPTED" + } + ] + } + }, "com.amazonaws.account#PutAlternateContact": { "type": "operation", "input": { @@ -1762,7 +1963,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the primary contact information of an Amazon Web Services account.
\nFor complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.
", + "smithy.api#documentation": "Updates the primary contact information of an Amazon Web Services account.
\nFor complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.
", "smithy.api#http": { "uri": "/putContactInformation", "method": "POST", @@ -1777,14 +1978,14 @@ "ContactInformation": { "target": "com.amazonaws.account#ContactInformation", "traits": { - "smithy.api#documentation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
", + "smithy.api#documentation": "Contains the details of the primary contact information associated with an\n Amazon Web Services account.
", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.
" + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThe management account can't specify its own AccountId
. It must call\n the operation in standalone context by not including the AccountId
\n parameter.
To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.
" } } }, @@ -1804,7 +2005,7 @@ "RegionOptStatus": { "target": "com.amazonaws.account#RegionOptStatus", "traits": { - "smithy.api#documentation": "One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling,\n Enabled_By_Default).
" + "smithy.api#documentation": "One of potential statuses a Region can undergo (Enabled, Enabling, Disabled,\n Disabling, Enabled_By_Default).
" } } }, @@ -1904,6 +2105,79 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#StartPrimaryEmailUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#StartPrimaryEmailUpdateRequest" + }, + "output": { + "target": "com.amazonaws.account#StartPrimaryEmailUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#ConflictException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts the process to update the primary email address for the specified\n account.
", + "smithy.api#http": { + "uri": "/startPrimaryEmailUpdate", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.account#StartPrimaryEmailUpdateRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.
\nThis operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.
\nThe management account can't specify its own AccountId
.
The new primary email address (also known as the root user email address) to\n use in the specified account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#StartPrimaryEmailUpdateResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.account#PrimaryEmailUpdateStatus", + "traits": { + "smithy.api#documentation": "The status of the primary email update request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.account#StateOrRegion": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/firehose.json b/codegen/sdk-codegen/aws-models/firehose.json index 09628529c9f..b31afc12c01 100644 --- a/codegen/sdk-codegen/aws-models/firehose.json +++ b/codegen/sdk-codegen/aws-models/firehose.json @@ -2614,7 +2614,7 @@ "name": "firehose" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.
\nAmazon Data Firehose is a fully managed service that delivers real-time\n streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon\n OpenSearch Service, Amazon Redshift, Splunk, and various other supportd\n destinations.
", + "smithy.api#documentation": "Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.
\nAmazon Data Firehose is a fully managed service that delivers real-time streaming\n data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch\n Service, Amazon Redshift, Splunk, and various other supported destinations.
", "smithy.api#title": "Amazon Kinesis Firehose", "smithy.api#xmlNamespace": { "uri": "http://firehose.amazonaws.com/doc/2015-08-04" @@ -3834,7 +3834,7 @@ "RequestConfiguration": { "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", "traits": { - "smithy.api#documentation": "The configuration of the requeste sent to the HTTP endpoint specified as the\n destination.
" + "smithy.api#documentation": "The configuration of the request sent to the HTTP endpoint that is specified as the\n destination.
" } }, "ProcessingConfiguration": { @@ -3863,6 +3863,12 @@ "traits": { "smithy.api#required": {} } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for HTTP Endpoint destination.\n
" + } } }, "traits": { @@ -3916,6 +3922,12 @@ }, "S3DestinationDescription": { "target": "com.amazonaws.firehose#S3DestinationDescription" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for HTTP Endpoint destination.\n
" + } } }, "traits": { @@ -3969,6 +3981,12 @@ }, "S3Update": { "target": "com.amazonaws.firehose#S3DestinationUpdate" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for HTTP Endpoint destination.\n
" + } } }, "traits": { @@ -4769,7 +4787,7 @@ } }, "traits": { - "smithy.api#documentation": "A serializer to use for converting data to the Parquet format before storing it in\n Amazon S3. For more information, see Apache Parquet.
" + "smithy.api#documentation": "A serializer to use for converting data to the Parquet format before storing it in\n Amazon S3. For more information, see Apache Parquet.
" } }, "com.amazonaws.firehose#ParquetWriterVersion": { @@ -5267,15 +5285,13 @@ "Username": { "target": "com.amazonaws.firehose#Username", "traits": { - "smithy.api#documentation": "The name of the user.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the user.
" } }, "Password": { "target": "com.amazonaws.firehose#Password", "traits": { - "smithy.api#documentation": "The user password.
", - "smithy.api#required": {} + "smithy.api#documentation": "The user password.
" } }, "RetryOptions": { @@ -5314,6 +5330,12 @@ "traits": { "smithy.api#documentation": "The CloudWatch logging options for your delivery stream.
" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Amazon Redshift.\n
" + } } }, "traits": { @@ -5347,8 +5369,7 @@ "Username": { "target": "com.amazonaws.firehose#Username", "traits": { - "smithy.api#documentation": "The name of the user.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the user.
" } }, "RetryOptions": { @@ -5387,6 +5408,12 @@ "traits": { "smithy.api#documentation": "The Amazon CloudWatch logging options for your delivery stream.
" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Amazon Redshift.\n
" + } } }, "traits": { @@ -5461,6 +5488,12 @@ "traits": { "smithy.api#documentation": "The Amazon CloudWatch logging options for your delivery stream.
" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Amazon Redshift.\n
" + } } }, "traits": { @@ -5806,6 +5839,43 @@ "smithy.api#documentation": "Specifies the schema to which you want Firehose to configure your data\n before it writes it to Amazon S3. This parameter is required if Enabled
is set\n to true.
The ARN of the secret that stores your credentials. It must be in the same region as the\n Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True
.
\n Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.\n
" + } + }, + "Enabled": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "Specifies whether you want to use the the secrets manager feature. When set as\n True
the secrets manager configuration overwrites the existing secrets in\n the destination configuration. When it's set to False
Firehose falls back to\n the credentials in the destination configuration.
The structure that defines how Firehose accesses the secret.
" + } + }, "com.amazonaws.firehose#SecurityGroupIdList": { "type": "list", "member": { @@ -5930,8 +6000,7 @@ "PrivateKey": { "target": "com.amazonaws.firehose#SnowflakePrivateKey", "traits": { - "smithy.api#documentation": "The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
" } }, "KeyPassphrase": { @@ -5943,8 +6012,7 @@ "User": { "target": "com.amazonaws.firehose#SnowflakeUser", "traits": { - "smithy.api#documentation": "User login name for the Snowflake account.
", - "smithy.api#required": {} + "smithy.api#documentation": "User login name for the Snowflake account.
" } }, "Database": { @@ -6028,6 +6096,12 @@ "traits": { "smithy.api#required": {} } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Snowflake.\n
" + } } }, "traits": { @@ -6123,6 +6197,12 @@ }, "S3DestinationDescription": { "target": "com.amazonaws.firehose#S3DestinationDescription" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Snowflake.\n
" + } } }, "traits": { @@ -6224,6 +6304,12 @@ }, "S3Update": { "target": "com.amazonaws.firehose#S3DestinationUpdate" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n Describes the Secrets Manager configuration in Snowflake.\n
" + } } }, "traits": { @@ -6465,8 +6551,7 @@ "HECToken": { "target": "com.amazonaws.firehose#HECToken", "traits": { - "smithy.api#documentation": "This is a GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.
", - "smithy.api#required": {} + "smithy.api#documentation": "This is a GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.
" } }, "HECAcknowledgmentTimeoutInSeconds": { @@ -6511,6 +6596,12 @@ "traits": { "smithy.api#documentation": "The buffering options. If no value is specified, the default values for Splunk are used.
" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Splunk.\n
" + } } }, "traits": { @@ -6579,6 +6670,12 @@ "traits": { "smithy.api#documentation": "The buffering options. If no value is specified, the default values for Splunk are used.
" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Splunk.\n
" + } } }, "traits": { @@ -6647,6 +6744,12 @@ "traits": { "smithy.api#documentation": "The buffering options. If no value is specified, the default values for Splunk are used.
" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "\n The configuration that defines how you access secrets for Splunk.\n
" + } } }, "traits": { @@ -6719,7 +6822,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables server-side encryption (SSE) for the delivery stream.
\nThis operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING
, and then\n to ENABLED
. The encryption status of a delivery stream is the\n Status
property in DeliveryStreamEncryptionConfiguration.\n If the operation fails, the encryption status changes to ENABLING_FAILED
. You\n can continue to read and write data to your delivery stream while the encryption status is\n ENABLING
, but the data is not encrypted. It can take up to 5 seconds after\n the encryption status changes to ENABLED
before all records written to the\n delivery stream are encrypted. To find out whether a record or a batch of records was\n encrypted, check the response elements PutRecordOutput$Encrypted and\n PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
\nEven if encryption is currently enabled for a delivery stream, you can still invoke this\n operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this\n method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK
,\n Firehose schedules the grant it had on the old CMK for retirement. If the new\n CMK is of type CUSTOMER_MANAGED_CMK
, Firehose creates a grant\n that enables it to use the new CMK to encrypt and decrypt data and to manage the\n grant.
For the KMS grant creation to be successful, Firehose APIs StartDeliveryStreamEncryption
and CreateDeliveryStream
should not be called with session credentials that are more than 6 hours old.
If a delivery stream already has encryption enabled and then you invoke this operation\n to change the ARN of the CMK or both its type and ARN and you get\n ENABLING_FAILED
, this only means that the attempt to change the CMK failed.\n In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED
, you\n can invoke this operation again with a valid CMK. The CMK must be enabled and the key\n policy mustn't explicitly deny the permission for Firehose to invoke KMS\n encrypt and decrypt operations.
You can enable SSE for a delivery stream only if it's a delivery stream that uses\n DirectPut
as its source.
The StartDeliveryStreamEncryption
and\n StopDeliveryStreamEncryption
operations have a combined limit of 25 calls\n per delivery stream per 24 hours. For example, you reach the limit if you call\n StartDeliveryStreamEncryption
13 times and\n StopDeliveryStreamEncryption
12 times for the same delivery stream in a\n 24-hour period.
Enables server-side encryption (SSE) for the delivery stream.
\nThis operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING
, and then\n to ENABLED
. The encryption status of a delivery stream is the\n Status
property in DeliveryStreamEncryptionConfiguration.\n If the operation fails, the encryption status changes to ENABLING_FAILED
. You\n can continue to read and write data to your delivery stream while the encryption status is\n ENABLING
, but the data is not encrypted. It can take up to 5 seconds after\n the encryption status changes to ENABLED
before all records written to the\n delivery stream are encrypted. To find out whether a record or a batch of records was\n encrypted, check the response elements PutRecordOutput$Encrypted and\n PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a delivery stream, use DescribeDeliveryStream.
\nEven if encryption is currently enabled for a delivery stream, you can still invoke this\n operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this\n method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK
,\n Firehose schedules the grant it had on the old CMK for retirement. If the new\n CMK is of type CUSTOMER_MANAGED_CMK
, Firehose creates a grant\n that enables it to use the new CMK to encrypt and decrypt data and to manage the\n grant.
For the KMS grant creation to be successful, the Firehose API operations\n StartDeliveryStreamEncryption
and CreateDeliveryStream
should\n not be called with session credentials that are more than 6 hours old.
If a delivery stream already has encryption enabled and then you invoke this operation\n to change the ARN of the CMK or both its type and ARN and you get\n ENABLING_FAILED
, this only means that the attempt to change the CMK failed.\n In this case, encryption remains enabled with the old CMK.
If the encryption status of your delivery stream is ENABLING_FAILED
, you\n can invoke this operation again with a valid CMK. The CMK must be enabled and the key\n policy mustn't explicitly deny the permission for Firehose to invoke KMS\n encrypt and decrypt operations.
You can enable SSE for a delivery stream only if it's a delivery stream that uses\n DirectPut
as its source.
The StartDeliveryStreamEncryption
and\n StopDeliveryStreamEncryption
operations have a combined limit of 25 calls\n per delivery stream per 24 hours. For example, you reach the limit if you call\n StartDeliveryStreamEncryption
13 times and\n StopDeliveryStreamEncryption
12 times for the same delivery stream in a\n 24-hour period.
Update to the Snowflake destination condiguration settings
" + "smithy.api#documentation": "Update to the Snowflake destination configuration settings.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/fsx.json b/codegen/sdk-codegen/aws-models/fsx.json index 42c5e7570be..29023e09dd0 100644 --- a/codegen/sdk-codegen/aws-models/fsx.json +++ b/codegen/sdk-codegen/aws-models/fsx.json @@ -3013,7 +3013,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem
API operation:
Amazon FSx for Lustre
\nAmazon FSx for NetApp ONTAP
\nAmazon FSx for OpenZFS
\nAmazon FSx for Windows File Server
\nThis operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem
operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem
returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError
. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem
does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING
.
Returns the description of the file system in JSON format.
\nThe CreateFileSystem
call returns while the file system's lifecycle\n state is still CREATING
. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.
Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem
API operation:
Amazon FSx for Lustre
\nAmazon FSx for NetApp ONTAP
\nAmazon FSx for OpenZFS
\nAmazon FSx for Windows File Server
\nThis operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem
operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.
If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem
returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError
. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem
does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING
.
Returns the description of the file system in JSON format.
\nThe CreateFileSystem
call returns while the file system's lifecycle\n state is still CREATING
. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.
(Optional) Choose SCRATCH_1
and SCRATCH_2
deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1
.
Choose PERSISTENT_1
for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive.\n PERSISTENT_1
supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2
for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2
supports \n SSD storage, and offers higher PerUnitStorageThroughput
(up to 1000 MB/s/TiB). PERSISTENT_2
\n is available in a limited number of Amazon Web Services Regions. \n For more information, and an up-to-date list of Amazon Web Services Regions in which \n PERSISTENT_2
is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2
, and you set FileSystemTypeVersion
to\n 2.10
, the CreateFileSystem
operation fails.
Encryption of data in transit is automatically turned on when you access\n SCRATCH_2
, PERSISTENT_1
and PERSISTENT_2
file\n systems from Amazon EC2 instances that support automatic encryption in\n the Amazon Web Services Regions where they are available. For more information about\n encryption in transit for FSx for Lustre file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1
)
(Optional) Choose SCRATCH_1
and SCRATCH_2
deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1
.
Choose PERSISTENT_1
for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive.\n PERSISTENT_1
supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2
for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2
supports \n SSD storage, and offers higher PerUnitStorageThroughput
(up to 1000 MB/s/TiB).\n You can optionally specify a metadata configuration mode for PERSISTENT_2
\n which supports increasing metadata performance. PERSISTENT_2
is available\n in a limited number of Amazon Web Services Regions. For more information, and an up-to-date\n list of Amazon Web Services Regions in which PERSISTENT_2
is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2
, and you set FileSystemTypeVersion
to\n 2.10
, the CreateFileSystem
operation fails.
Encryption of data in transit is automatically turned on when you access\n SCRATCH_2
, PERSISTENT_1
, and PERSISTENT_2
file\n systems from Amazon EC2 instances that support automatic encryption in\n the Amazon Web Services Regions where they are available. For more information about\n encryption in transit for FSx for Lustre file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1
)
The Lustre root squash configuration used when creating an Amazon FSx for Lustre\n file system. When enabled, root squash restricts root-level access from clients that\n try to access your file system as a root user.
" } + }, + "MetadataConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemLustreMetadataConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre metadata performance configuration for the creation of an\n FSx for Lustre file system using a PERSISTENT_2
\n deployment type.
The Lustre configuration for the file system being created.
\nThe following parameters are not supported for file systems\n with a data repository association created with\n .
\n\n AutoImportPolicy
\n
\n ExportPath
\n
\n ImportedFileChunkSize
\n
\n ImportPath
\n
(USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision\n for the file system. This parameter sets the maximum rate of metadata disk IOPS\n supported by the file system. Valid values are 1500
, 3000
,\n 6000
, 12000
, and multiples of 12000
\n up to a maximum of 192000
.
Iops doesn’t have a default value. If you're using USER_PROVISIONED mode,\n you can choose to specify a valid value. If you're using AUTOMATIC mode,\n you cannot specify a value because FSx for Lustre automatically sets\n the value based on your file system storage capacity.\n
\nThe metadata configuration mode for provisioning Metadata IOPS for\n an FSx for Lustre file system using a PERSISTENT_2
\n deployment type.
In AUTOMATIC mode, FSx for Lustre automatically\n provisions and scales the number of Metadata IOPS for your file system\n based on your file system storage capacity.
\nIn USER_PROVISIONED mode, you specify the number of Metadata\n IOPS to provision for your file system.
\nThe Lustre metadata performance configuration for the creation of an\n Amazon FSx for Lustre file system using a PERSISTENT_2
\n deployment type. The configuration uses a Metadata IOPS value to set the\n maximum rate of metadata disk IOPS supported by the file system.
After creation, the file system supports increasing metadata performance.\n For more information on Metadata IOPS, see Lustre\n metadata performance configuration in the Amazon FSx for Lustre User Guide.
" + } + }, "com.amazonaws.fsx#CreateFileSystemOntapConfiguration": { "type": "structure", "members": { @@ -3299,7 +3327,7 @@ "HAPairs": { "target": "com.amazonaws.fsx#HAPairs", "traits": { - "smithy.api#documentation": "Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity
, \n Iops
, and ThroughputCapacity
. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs
is less than 1 or greater than 12.
The value of HAPairs
is greater than 1 and the value of DeploymentType
is SINGLE_AZ_1
or MULTI_AZ_1
.
Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity
, \n Iops
, and ThroughputCapacity
. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs
is less than 1 or greater than 12.
The value of HAPairs
is greater than 1 and the value of DeploymentType
is SINGLE_AZ_1
or MULTI_AZ_1
.
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType
and the Lustre DeploymentType
, as\n follows:
For SCRATCH_2
, PERSISTENT_2
and PERSISTENT_1
deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1
deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs
property. The minimum value is calculated as 1,024 * HAPairs
and the maximum is calculated as 524,288 * HAPairs
.
\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType
as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nSets the storage capacity of the file system that you're creating, in gibibytes (GiB).
\n\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType
and the Lustre DeploymentType
, as\n follows:
For SCRATCH_2
, PERSISTENT_2
, and PERSISTENT_1
deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1
deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.
\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs
property. The minimum value is calculated as 1,024 * HAPairs
and the maximum is calculated as 524,288 * HAPairs
.
\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
\n\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType
as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
\nFor HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
\nSets the storage type for the file system that you're creating. Valid values are\n SSD
and HDD
.
Set to SSD
to use solid state drive storage. SSD is supported on all Windows,\n Lustre, ONTAP, and OpenZFS deployment types.
Set to HDD
to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2
and MULTI_AZ_1
Windows file system deployment types,\n and on PERSISTENT_1
Lustre file system deployment types. \n
Default value is SSD
. For more information, see Storage\n type options in the FSx for Windows File Server User\n Guide and Multiple storage\n options in the FSx for Lustre User\n Guide.
Sets the storage type for the file system that you're creating. Valid values are\n SSD
and HDD
.
Set to SSD
to use solid state drive storage. SSD is supported on all Windows,\n Lustre, ONTAP, and OpenZFS deployment types.
Set to HDD
to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2
and MULTI_AZ_1
Windows file system deployment types,\n and on PERSISTENT_1
Lustre file system deployment types.
Default value is SSD
. For more information, see Storage\n type options in the FSx for Windows File Server User\n Guide and Multiple storage\n options in the FSx for Lustre User\n Guide.
(Optional) For FSx for Lustre file systems, sets the Lustre version\n for the file system that you're creating. Valid values are 2.10
, \n 2.12
, and 2.15
:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
\n2.12 and 2.15 are supported by all Lustre deployment types. 2.12
\n or 2.15
is required when setting FSx for Lustre DeploymentType
\n to PERSISTENT_2
.
Default value = 2.10
, except when DeploymentType
is set to \n PERSISTENT_2
, then the default is 2.12
.
If you set FileSystemTypeVersion
to 2.10
for a \n PERSISTENT_2
Lustre deployment type, the CreateFileSystem
\n operation fails.
For FSx for Lustre file systems, sets the Lustre version for the file system\n that you're creating. Valid values are 2.10
, 2.12
, and\n 2.15
:
\n 2.10
is supported by the Scratch and Persistent_1 Lustre \n deployment types.
\n 2.12
is supported by all Lustre deployment types, except\n for PERSISTENT_2
with a metadata configuration mode.
\n 2.15
is supported by all Lustre deployment types and is\n recommended for all new file systems.
Default value is 2.10
, except for the following deployments:
Default value is 2.12
when DeploymentType
is set to \n PERSISTENT_2
without a metadata configuration mode.
Default value is 2.15
when DeploymentType
is set to \n PERSISTENT_2
with a metadata configuration mode.
Specifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. For more information, see \n Volume security style \n in the Amazon FSx for NetApp ONTAP User Guide.\n Specify one of the following values:
\n\n UNIX
if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n
\n NTFS
if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED
This is an advanced setting. For more information, see the topic \n What the security styles and their effects are \n in the NetApp Documentation Center.
For more information, see Volume security style in the \n FSx for ONTAP User Guide.
" + "smithy.api#documentation": "Specifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. Specify one of the following values:
\n\n UNIX
if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n
\n NTFS
if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.
\n MIXED
This is an advanced setting. For more information, see the topic \n What the security styles and their effects are \n in the NetApp Documentation Center.
For more information, see Volume security style in the \n FSx for ONTAP User Guide.
" } }, "SizeInMegabytes": { @@ -3608,7 +3636,7 @@ "OntapVolumeType": { "target": "com.amazonaws.fsx#InputOntapVolumeType", "traits": { - "smithy.api#documentation": "Specifies the type of volume you are creating. Valid values are the following:
\n\n RW
specifies a read/write volume. RW
is the default.
\n DP
specifies a data-protection volume. A DP
volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Specifies the type of volume you are creating. Valid values are the following:
\n\n RW
specifies a read/write volume. RW
is the default.
\n DP
specifies a data-protection volume. A DP
volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "SnapshotPolicy": { @@ -3632,7 +3660,7 @@ "VolumeStyle": { "target": "com.amazonaws.fsx#VolumeStyle", "traits": { - "smithy.api#documentation": "Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, \n FlexVol and FlexGroup volumes. For more information, see \n Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
" + "smithy.api#documentation": "Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, \n FlexVol and FlexGroup volumes. For more information, see \n Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
" } }, "AggregateConfiguration": { @@ -3942,7 +3970,7 @@ "RootVolumeSecurityStyle": { "target": "com.amazonaws.fsx#StorageVirtualMachineRootVolumeSecurityStyle", "traits": { - "smithy.api#documentation": "The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX
if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS
if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.
\n MIXED
This is an advanced setting. For more information, see \n Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
The security style of the root volume of the SVM. Specify one of the following values:
\n\n UNIX
if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.
\n NTFS
if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.
\n MIXED
This is an advanced setting. For more information, see \n Volume security style\n in the Amazon FSx for NetApp ONTAP User Guide.
Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId
value to the DeleFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\nTo delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId
\n value to the DeleFileSystem
operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem
operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup
to false
\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.
The DeleteFileSystem
operation returns while the file system has the\n DELETING
status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems
operation returns a FileSystemNotFound
\n error.
If a data repository task is in a PENDING
or EXECUTING
state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nDeletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId
value to the DeleteFileSystem
operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\nTo delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId
\n value to the DeleteFileSystem
operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem
operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup
to false
\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.
The DeleteFileSystem
operation returns while the file system has the\n DELETING
status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems
operation returns a FileSystemNotFound
\n error.
If a data repository task is in a PENDING
or EXECUTING
state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nThe path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:
\nThe path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:
\nIf you are not using the DataRepositorySubdirectories
\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nsf://nfs-domain-name/exportpath
. You can therefore\n link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories
\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name
, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories
\n parameter.
The path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/
.
The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:
\nThe path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:
\nIf you are not using the DataRepositorySubdirectories
\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nfs://nfs-domain-name/exportpath
. You can therefore\n link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories
\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name
, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories
\n parameter.
The path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/
.
The lifecycle status of the file system.
" } }, + "com.amazonaws.fsx#FileSystemLustreMetadataConfiguration": { + "type": "structure", + "members": { + "Iops": { + "target": "com.amazonaws.fsx#MetadataIops", + "traits": { + "smithy.api#documentation": "The number of Metadata IOPS provisioned for the file system. Valid values\n are 1500
, 3000
, 6000
, 12000
,\n and multiples of 12000
up to a maximum of 192000
.
The metadata configuration mode for provisioning Metadata IOPS for the\n file system.
\nIn AUTOMATIC mode, FSx for Lustre automatically\n provisions and scales the number of Metadata IOPS on your file system based\n on your file system storage capacity.
\nIn USER_PROVISIONED mode, you can choose to specify the number\n of Metadata IOPS to provision for your file system.
\nThe Lustre metadata performance configuration of an Amazon FSx for Lustre\n file system using a PERSISTENT_2
deployment type. The configuration\n enables the file system to support increasing metadata performance.
You use the MountName
value when mounting the file system.
For the SCRATCH_1
deployment type, this value is always \"fsx
\". \n For SCRATCH_2
, PERSISTENT_1
, and PERSISTENT_2
deployment\n types, this value is a string that is unique within an Amazon Web Services Region. \n \n
You use the MountName
value when mounting the file system.
For the SCRATCH_1
deployment type, this value is always \"fsx
\". \n For SCRATCH_2
, PERSISTENT_1
, and PERSISTENT_2
deployment\n types, this value is a string that is unique within an Amazon Web Services Region. \n
The Lustre root squash configuration for an Amazon FSx for Lustre\n file system. When enabled, root squash restricts root-level access from clients that\n try to access your file system as a root user.
" } + }, + "MetadataConfiguration": { + "target": "com.amazonaws.fsx#FileSystemLustreMetadataConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre metadata performance configuration for an Amazon FSx for Lustre file system\n using a PERSISTENT_2
deployment type.
Specifies the updated user name for the service account on your self-managed AD domain.\n Amazon FSx uses this account to join to your self-managed AD domain.
\nThis account must have the permissions required to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName
.
Specifies the updated user name for the service account on your self-managed Active Directory domain.\n Amazon FSx uses this account to join to your self-managed Active Directory domain.
\nThis account must have the permissions required to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName
.
Specifies the updated password for the service account on your self-managed AD domain. \n Amazon FSx uses this account to join to your self-managed AD domain.
" + "smithy.api#documentation": "Specifies the updated password for the service account on your self-managed Active Directory domain. \n Amazon FSx uses this account to join to your self-managed Active Directory domain.
" } }, "DnsIps": { "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "A list of up to three DNS server or domain controller IP addresses in your\n self-managed AD domain.
" + "smithy.api#documentation": "A list of up to three DNS server or domain controller IP addresses in your\n self-managed Active Directory domain.
" } }, "DomainName": { "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", "traits": { - "smithy.api#documentation": "Specifies an updated fully qualified domain name of your self-managed AD configuration.
" + "smithy.api#documentation": "Specifies an updated fully qualified domain name of your self-managed Active Directory configuration.
" } }, "OrganizationalUnitDistinguishedName": { "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", "traits": { - "smithy.api#documentation": "Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD.
" + "smithy.api#documentation": "Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory.
" } }, "FileSystemAdministratorsGroup": { "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", "traits": { - "smithy.api#documentation": "Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges\n for the Amazon FSx resource.
" + "smithy.api#documentation": "For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges\n for the Amazon FSx resource.
" } } }, "traits": { - "smithy.api#documentation": "Specifies changes you are making to the self-managed Microsoft Active Directory (AD) configuration to which \n an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.
" + "smithy.api#documentation": "Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which \n an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.
" } }, "com.amazonaws.fsx#ServiceLimit": { @@ -11212,7 +11294,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n SelfManagedActiveDirectoryConfiguration
\n
\n StorageCapacity
\n
\n StorageType
\n
\n ThroughputCapacity
\n
\n DiskIopsConfiguration
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DataCompressionType
\n
\n LogConfiguration
\n
\n LustreRootSquashConfiguration
\n
\n PerUnitStorageThroughput
\n
\n StorageCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n FsxAdminPassword
\n
\n HAPairs
\n
\n RemoveRouteTableIds
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n ThroughputCapacityPerHAPair
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AddRouteTableIds
\n
\n AutomaticBackupRetentionDays
\n
\n CopyTagsToBackups
\n
\n CopyTagsToVolumes
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n RemoveRouteTableIds
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n SelfManagedActiveDirectoryConfiguration
\n
\n StorageCapacity
\n
\n StorageType
\n
\n ThroughputCapacity
\n
\n DiskIopsConfiguration
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DataCompressionType
\n
\n LogConfiguration
\n
\n LustreRootSquashConfiguration
\n
\n MetadataConfiguration
\n
\n PerUnitStorageThroughput
\n
\n StorageCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds
\n
\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n FsxAdminPassword
\n
\n HAPairs
\n
\n RemoveRouteTableIds
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n ThroughputCapacityPerHAPair
\n
\n WeeklyMaintenanceStartTime
\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AddRouteTableIds
\n
\n AutomaticBackupRetentionDays
\n
\n CopyTagsToBackups
\n
\n CopyTagsToVolumes
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n RemoveRouteTableIds
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
The throughput of an Amazon FSx for Lustre Persistent SSD-based file system,\n measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease\n your file system's throughput. Valid values depend on the deployment type of the file\n system, as follows:
\nFor PERSISTENT_1
SSD-based deployment types, valid values\n are 50, 100, and 200 MB/s/TiB.
For PERSISTENT_2
SSD-based deployment types, valid values\n are 125, 250, 500, and 1000 MB/s/TiB.
For more information, see \n \n Managing throughput capacity.
" } + }, + "MetadataConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemLustreMetadataConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre metadata performance configuration for an Amazon FSx for Lustre\n file system using a PERSISTENT_2
deployment type. When this configuration\n is enabled, the file system supports increasing metadata performance.
The configuration object for Amazon FSx for Lustre file systems used in the\n UpdateFileSystem
operation.
(USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision\n for your file system. Valid values are 1500
, 3000
,\n 6000
, 12000
, and multiples of 12000
\n up to a maximum of 192000
.
The value you provide must be greater than or equal to the current number of\n Metadata IOPS provisioned for the file system.
" + } + }, + "Mode": { + "target": "com.amazonaws.fsx#MetadataConfigurationMode", + "traits": { + "smithy.api#documentation": "The metadata configuration mode for provisioning Metadata IOPS for\n an FSx for Lustre file system using a PERSISTENT_2
\n deployment type.
To increase the Metadata IOPS or to switch from AUTOMATIC mode,\n specify USER_PROVISIONED
as the value for this parameter. Then use the\n Iops parameter to provide a Metadata IOPS value that is greater than or equal to\n the current number of Metadata IOPS provisioned for the file system.
To switch from USER_PROVISIONED mode, specify\n AUTOMATIC
as the value for this parameter, but do not input a value\n for Iops.
If you request to switch from USER_PROVISIONED to AUTOMATIC mode and the\n current Metadata IOPS value is greater than the automated default, FSx for Lustre\n rejects the request because downscaling Metadata IOPS is not supported.
\nThe Lustre metadata performance configuration update for an Amazon FSx for Lustre\n file system using a PERSISTENT_2
deployment type. You can request\n an increase in your file system's Metadata IOPS and/or switch your file system's\n metadata configuration mode. For more information, see Managing\n metadata performance in the\n Amazon FSx for Lustre User Guide.
A TableIdentifier
structure that describes a target table for resource linking.
A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.
" + } } }, "traits": { @@ -36700,6 +36706,19 @@ "traits": { "smithy.api#documentation": "The version ID at which to update the table contents.
" } + }, + "ViewUpdateAction": { + "target": "com.amazonaws.glue#ViewUpdateAction", + "traits": { + "smithy.api#documentation": "The operation to be performed when updating the view.
" + } + }, + "Force": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.
" + } } }, "traits": { @@ -37206,6 +37225,38 @@ "smithy.api#documentation": "A structure containing details for representations.
" } }, + "com.amazonaws.glue#ViewDefinitionInput": { + "type": "structure", + "members": { + "IsProtected": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.
" + } + }, + "Definer": { + "target": "com.amazonaws.glue#ArnString", + "traits": { + "smithy.api#documentation": "The definer of a view in SQL.
" + } + }, + "Representations": { + "target": "com.amazonaws.glue#ViewRepresentationInputList", + "traits": { + "smithy.api#documentation": "A list of structures that contains the dialect of the view, and the query that defines the view.
" + } + }, + "SubObjects": { + "target": "com.amazonaws.glue#ViewSubObjectsList", + "traits": { + "smithy.api#documentation": "A list of base table ARNs that make up the view.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing details for creating or updating an Glue view.
" + } + }, "com.amazonaws.glue#ViewDialect": { "type": "enum", "members": { @@ -37265,6 +37316,12 @@ "smithy.api#documentation": "The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText
to ViewExpandedText
. For example:
Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1
\n
The name of the connection to be used to validate the specific representation of the view.
" + } + }, "IsStale": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { @@ -37276,6 +37333,56 @@ "smithy.api#documentation": "A structure that contains the dialect of the view, and the query that defines the view.
" } }, + "com.amazonaws.glue#ViewRepresentationInput": { + "type": "structure", + "members": { + "Dialect": { + "target": "com.amazonaws.glue#ViewDialect", + "traits": { + "smithy.api#documentation": "A parameter that specifies the engine type of a specific representation.
" + } + }, + "DialectVersion": { + "target": "com.amazonaws.glue#ViewDialectVersionString", + "traits": { + "smithy.api#documentation": "A parameter that specifies the version of the engine of a specific representation.
" + } + }, + "ViewOriginalText": { + "target": "com.amazonaws.glue#ViewTextString", + "traits": { + "smithy.api#documentation": "A string that represents the original SQL query that describes the view.
" + } + }, + "ValidationConnection": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the connection to be used to validate the specific representation of the view.
" + } + }, + "ViewExpandedText": { + "target": "com.amazonaws.glue#ViewTextString", + "traits": { + "smithy.api#documentation": "A string that represents the SQL query that describes the view with expanded resource ARNs
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing details of a representation to update or create a Lake Formation view.
" + } + }, + "com.amazonaws.glue#ViewRepresentationInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ViewRepresentationInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.glue#ViewRepresentationList": { "type": "list", "member": { @@ -37309,6 +37416,35 @@ } } }, + "com.amazonaws.glue#ViewUpdateAction": { + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE" + } + }, + "ADD_OR_REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_OR_REPLACE" + } + }, + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + } + } + }, "com.amazonaws.glue#WorkerType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/iot-wireless.json b/codegen/sdk-codegen/aws-models/iot-wireless.json index e703a56407c..7edd03b1933 100644 --- a/codegen/sdk-codegen/aws-models/iot-wireless.json +++ b/codegen/sdk-codegen/aws-models/iot-wireless.json @@ -4479,6 +4479,12 @@ "traits": { "smithy.api#enumValue": "Successful" } + }, + "Device_exist_in_conflict_fuota_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Device_exist_in_conflict_fuota_task" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/location.json b/codegen/sdk-codegen/aws-models/location.json index 29c384c36f9..0e2b3d4021f 100644 --- a/codegen/sdk-codegen/aws-models/location.json +++ b/codegen/sdk-codegen/aws-models/location.json @@ -37,7 +37,7 @@ "min": 5, "max": 200 }, - "smithy.api#pattern": "^geo:\\w*\\*?$" + "smithy.api#pattern": "^(geo|geo-routes|geo-places|geo-maps):\\w*\\*?$" } }, "com.amazonaws.location#ApiKeyActionList": { @@ -214,6 +214,15 @@ "type": "structure", "members": {} }, + "com.amazonaws.location#Base64EncodedGeobuf": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 600000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.location#BatchDeleteDevicePositionHistory": { "type": "operation", "input": { @@ -783,7 +792,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "Contains the details of the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.
\nEach \n geofence polygon can have a maximum of 1,000 vertices.
\nContains the details to specify the position of the geofence. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.
\nThe \n geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices.
\nContains details about additional route preferences for requests that specify\n TravelMode
as Truck
.
Information about the Long-Term Evolution (LTE) network the device is connected to.
", + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The cellular network communication infrastructure that the device uses.
" + } + }, "com.amazonaws.location#Circle": { "type": "structure", "members": { @@ -1479,12 +1507,6 @@ "smithy.api#httpError": 409 } }, - "com.amazonaws.location#CountryCode": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Z]{3}$" - } - }, "com.amazonaws.location#CountryCode3": { "type": "string", "traits": { @@ -1508,7 +1530,7 @@ "com.amazonaws.location#CountryCodeList": { "type": "list", "member": { - "target": "com.amazonaws.location#CountryCode" + "target": "com.amazonaws.location#CountryCode3" }, "traits": { "smithy.api#length": { @@ -1603,7 +1625,7 @@ "target": "com.amazonaws.location#KmsKeyId", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "A key identifier for an \n Amazon Web Services \n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.\n\t
" + "smithy.api#documentation": "A key identifier for an\n Amazon Web Services\n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.\n\t
" } } } @@ -2682,7 +2704,7 @@ "KmsKeyId": { "target": "com.amazonaws.location#KmsKeyId", "traits": { - "smithy.api#documentation": "A key identifier for an \n Amazon Web Services \n KMS customer managed key assigned to the Amazon Location resource
" + "smithy.api#documentation": "A key identifier for an\n Amazon Web Services\n KMS customer managed key assigned to the Amazon Location resource
" } }, "Tags": { @@ -3434,6 +3456,57 @@ "target": "com.amazonaws.location#DevicePositionUpdate" } }, + "com.amazonaws.location#DeviceState": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "The device identifier.
", + "smithy.api#required": {} + } + }, + "SampleTime": { + "target": "com.amazonaws.location#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the device's position was determined. Uses ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ
.
The last known device position.
", + "smithy.api#required": {} + } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy" + }, + "Ipv4Address": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The device's Ipv4 address.
", + "smithy.api#pattern": "^(?:(?:25[0-5]|(?:2[0-4]|1\\d|[0-9]|)\\d)\\.?\\b){4}$" + } + }, + "WiFiAccessPoints": { + "target": "com.amazonaws.location#WiFiAccessPointList", + "traits": { + "smithy.api#documentation": "The Wi-Fi access points the device is using.
" + } + }, + "CellSignals": { + "target": "com.amazonaws.location#CellSignals", + "traits": { + "smithy.api#documentation": "The cellular network infrastructure that the device is connected to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The device's position, IP address, and Wi-Fi access points.
" + } + }, "com.amazonaws.location#DimensionUnit": { "type": "string", "traits": { @@ -3521,173 +3594,45 @@ ] } }, - "com.amazonaws.location#FilterPlaceCategoryList": { - "type": "list", - "member": { - "target": "com.amazonaws.location#PlaceCategory" - }, + "com.amazonaws.location#Earfcn": { + "type": "integer", "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.location#GenericResource": { - "type": "resource", - "identifiers": { - "ResourceArn": { - "target": "com.amazonaws.location#Arn" - } - }, - "operations": [ - { - "target": "com.amazonaws.location#ListTagsForResource" - }, - { - "target": "com.amazonaws.location#TagResource" - }, - { - "target": "com.amazonaws.location#UntagResource" + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 262143 } - ], - "traits": { - "aws.api#controlPlane": {}, - "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.location#GeoArn": { - "type": "string", + "com.amazonaws.location#EutranCellId": { + "type": "integer", "traits": { - "aws.api#arnReference": {}, - "smithy.api#length": { - "max": 1600 - }, - "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$" + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 268435455 + } } }, - "com.amazonaws.location#GeoArnList": { + "com.amazonaws.location#FilterPlaceCategoryList": { "type": "list", "member": { - "target": "com.amazonaws.location#GeoArn" - } - }, - "com.amazonaws.location#GeofenceCollectionResource": { - "type": "resource", - "identifiers": { - "CollectionName": { - "target": "com.amazonaws.location#ResourceName" - } - }, - "put": { - "target": "com.amazonaws.location#CreateGeofenceCollection" - }, - "read": { - "target": "com.amazonaws.location#DescribeGeofenceCollection" - }, - "update": { - "target": "com.amazonaws.location#UpdateGeofenceCollection" - }, - "delete": { - "target": "com.amazonaws.location#DeleteGeofenceCollection" - }, - "list": { - "target": "com.amazonaws.location#ListGeofenceCollections" - }, - "operations": [ - { - "target": "com.amazonaws.location#BatchDeleteGeofence" - }, - { - "target": "com.amazonaws.location#BatchEvaluateGeofences" - }, - { - "target": "com.amazonaws.location#BatchPutGeofence" - }, - { - "target": "com.amazonaws.location#GetGeofence" - }, - { - "target": "com.amazonaws.location#ListGeofences" - }, - { - "target": "com.amazonaws.location#PutGeofence" - } - ], - "traits": { - "aws.api#arn": { - "template": "geofence-collection/{CollectionName}" - }, - "aws.cloudformation#cfnResource": { - "name": "GeofenceCollection" - }, - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.location#GeofenceGeometry": { - "type": "structure", - "members": { - "Polygon": { - "target": "com.amazonaws.location#LinearRings", - "traits": { - "smithy.api#documentation": "A polygon is a list of linear rings which are each made up of a list of\n vertices.
\nEach vertex is a 2-dimensional point of the form: [longitude, latitude]
.\n This is represented as an array of doubles of length 2 (so [double,\n double]
).
An array of 4 or more vertices, where the first and last vertex are the same (to form\n a closed boundary), is called a linear ring. The linear ring vertices must be listed in\n counter-clockwise order around the ring’s interior. The linear ring is represented as an\n array of vertices, or an array of arrays of doubles ([[double, double], ...]
).
A geofence consists of a single linear ring. To allow for future expansion, the\n Polygon parameter takes an array of linear rings, which is represented as an array of\n arrays of arrays of doubles ([[[double, double], ...], ...]
).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
" - } - }, - "Circle": { - "target": "com.amazonaws.location#Circle", - "traits": { - "smithy.api#documentation": "A circle on the earth, as defined by a center point and a radius.
" - } - } + "target": "com.amazonaws.location#PlaceCategory" }, "traits": { - "smithy.api#documentation": "Contains the geofence geometry details.
\nA geofence geometry is made up of either a polygon or a circle. Can be either a \n polygon or a circle. Including both will return a validation error.
\nAmazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.
\nRetrieves a device's most recent position according to its sample time.
\nDevice positions are deleted after 30 days.
\nRetrieves the device position history from a tracker resource within a specified range\n of time.
\nDevice positions are deleted after 30 days.
\nEvaluates device positions against\n geofence geometries from a given geofence collection. The event forecasts three states for which\n a device can be in relative to a geofence:
\n\n ENTER
: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.
\n EXIT
: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.
\n IDLE
: If a device is inside of a geofence, and the device is not moving.
The tracker resource receiving the request for the device position history.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The device's position.
", "smithy.api#required": {} } }, - "DeviceId": { - "target": "com.amazonaws.location#Id", + "Speed": { + "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "The device whose position history you want to retrieve.
", + "smithy.api#documentation": "The device's speed.
", + "smithy.api#range": { + "min": 0 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The device's position, IP address, and WiFi access points.
" + } + }, + "com.amazonaws.location#ForecastGeofenceEventsRequest": { + "type": "structure", + "members": { + "CollectionName": { + "target": "com.amazonaws.location#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the geofence collection.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.location#Token", + "DeviceState": { + "target": "com.amazonaws.location#ForecastGeofenceEventsDeviceState", "traits": { - "smithy.api#documentation": "The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null
\n
The device's state, including current position and speed.
", + "smithy.api#required": {} } }, - "StartTimeInclusive": { + "TimeHorizonMinutes": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Specifies the time horizon in minutes for the forecasted events.
", + "smithy.api#range": { + "min": 0 + } + } + }, + "DistanceUnit": { + "target": "com.amazonaws.location#DistanceUnit", + "traits": { + "smithy.api#documentation": "The distance unit used for the NearestDistance
property returned in a forecasted event.\n The measurement system must match for DistanceUnit
and SpeedUnit
; if Kilometers
\n is specified for DistanceUnit
, then SpeedUnit
must be KilometersPerHour
.\n
Default Value: Kilometers
\n
The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit
and SpeedUnit
; if Kilometers
\n is specified for DistanceUnit
, then SpeedUnit
must be KilometersPerHour
.
Default Value: KilometersPerHour
.
The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null
\n
An optional limit for the number of resources returned in a single call.
\nDefault value: 20
\n
The list of forecasted events.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.location#LargeToken", + "traits": { + "smithy.api#documentation": "The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
" + } + }, + "DistanceUnit": { + "target": "com.amazonaws.location#DistanceUnit", + "traits": { + "smithy.api#documentation": "The distance unit for the forecasted events.
", + "smithy.api#required": {} + } + }, + "SpeedUnit": { + "target": "com.amazonaws.location#SpeedUnit", + "traits": { + "smithy.api#documentation": "The speed unit for the forecasted events.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.location#ForecastedEvent": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.location#Uuid", + "traits": { + "smithy.api#documentation": "The forecasted event identifier.
", + "smithy.api#required": {} + } + }, + "GeofenceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "The geofence identifier pertaining to the forecasted event.
", + "smithy.api#required": {} + } + }, + "IsDeviceInGeofence": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the device is located within the geofence.
", + "smithy.api#required": {} + } + }, + "NearestDistance": { + "target": "com.amazonaws.location#NearestDistance", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The closest distance from the device's position to the geofence.
", + "smithy.api#required": {} + } + }, + "EventType": { + "target": "com.amazonaws.location#ForecastedGeofenceEventType", + "traits": { + "smithy.api#documentation": "The event type, forecasting three states for which\n a device can be in relative to a geofence:
\n\n ENTER
: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.
\n EXIT
: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.
\n IDLE
: If a device is inside of a geofence, and the device is not moving.
The forecasted time the device will breach the geofence in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ
\n
The geofence properties.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A forecasted event represents a geofence event in relation to the requested device state, that may occur\n given the provided device state and time horizon.
" + } + }, + "com.amazonaws.location#ForecastedEventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#ForecastedEvent" + } + }, + "com.amazonaws.location#ForecastedGeofenceEventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENTER", + "documentation": "This event type signifies that a device is forecasted to enter the geofence" + }, + { + "value": "EXIT", + "documentation": "This event type signifies that a device is forecasted to exit the geofence" + }, + { + "value": "IDLE", + "documentation": "This event type signifies that a device is stationary in the geofence and an exit/enter cannot be forecasted" + } + ] + } + }, + "com.amazonaws.location#GenericResource": { + "type": "resource", + "identifiers": { + "ResourceArn": { + "target": "com.amazonaws.location#Arn" + } + }, + "operations": [ + { + "target": "com.amazonaws.location#ListTagsForResource" + }, + { + "target": "com.amazonaws.location#TagResource" + }, + { + "target": "com.amazonaws.location#UntagResource" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.location#GeoArn": { + "type": "string", + "traits": { + "aws.api#arnReference": {}, + "smithy.api#length": { + "max": 1600 + }, + "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$" + } + }, + "com.amazonaws.location#GeoArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#GeoArnV2" + } + }, + "com.amazonaws.location#GeoArnV2": { + "type": "string", + "traits": { + "aws.api#arnReference": {}, + "smithy.api#length": { + "max": 1600 + }, + "smithy.api#pattern": "(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$)" + } + }, + "com.amazonaws.location#GeofenceCollectionResource": { + "type": "resource", + "identifiers": { + "CollectionName": { + "target": "com.amazonaws.location#ResourceName" + } + }, + "put": { + "target": "com.amazonaws.location#CreateGeofenceCollection" + }, + "read": { + "target": "com.amazonaws.location#DescribeGeofenceCollection" + }, + "update": { + "target": "com.amazonaws.location#UpdateGeofenceCollection" + }, + "delete": { + "target": "com.amazonaws.location#DeleteGeofenceCollection" + }, + "list": { + "target": "com.amazonaws.location#ListGeofenceCollections" + }, + "operations": [ + { + "target": "com.amazonaws.location#BatchDeleteGeofence" + }, + { + "target": "com.amazonaws.location#BatchEvaluateGeofences" + }, + { + "target": "com.amazonaws.location#BatchPutGeofence" + }, + { + "target": "com.amazonaws.location#ForecastGeofenceEvents" + }, + { + "target": "com.amazonaws.location#GetGeofence" + }, + { + "target": "com.amazonaws.location#ListGeofences" + }, + { + "target": "com.amazonaws.location#PutGeofence" + } + ], + "traits": { + "aws.api#arn": { + "template": "geofence-collection/{CollectionName}" + }, + "aws.cloudformation#cfnResource": { + "name": "GeofenceCollection" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.location#GeofenceGeometry": { + "type": "structure", + "members": { + "Polygon": { + "target": "com.amazonaws.location#LinearRings", + "traits": { + "smithy.api#documentation": "A polygon is a list of linear rings which are each made up of a list of\n vertices.
\nEach vertex is a 2-dimensional point of the form: [longitude, latitude]
.\n This is represented as an array of doubles of length 2 (so [double,\n double]
).
An array of 4 or more vertices, where the first and last vertex are the same (to form\n a closed boundary), is called a linear ring. The linear ring vertices must be listed in\n counter-clockwise order around the ring’s interior. The linear ring is represented as an\n array of vertices, or an array of arrays of doubles ([[double, double], ...]
).
A geofence consists of a single linear ring. To allow for future expansion, the\n Polygon parameter takes an array of linear rings, which is represented as an array of\n arrays of arrays of doubles ([[[double, double], ...], ...]
).
A linear ring for use in geofences can consist of between 4 and 1,000 vertices.
" + } + }, + "Circle": { + "target": "com.amazonaws.location#Circle", + "traits": { + "smithy.api#documentation": "A circle on the earth, as defined by a center point and a radius.
" + } + }, + "Geobuf": { + "target": "com.amazonaws.location#Base64EncodedGeobuf", + "traits": { + "smithy.api#documentation": "Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.
\nA polygon in Geobuf format can have up to 100,000 vertices.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the geofence geometry details.
\nA geofence geometry is made up of either a polygon or a circle. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.
\nAmazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.
\nRetrieves a device's most recent position according to its sample time.
\nDevice positions are deleted after 30 days.
\nRetrieves the device position history from a tracker resource within a specified range\n of time.
\nDevice positions are deleted after 30 days.
\nThe tracker resource receiving the request for the device position history.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeviceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "The device whose position history you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.location#Token", + "traits": { + "smithy.api#documentation": "The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null
\n
Specify the start time for the position history in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ
. By default, the value will be 24 hours\n prior to the time that the request is made.
Requirement:
\nThe time specified for StartTimeInclusive
must be before\n EndTimeExclusive
.
The timestamp for when the tracker resource received the device position in ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ
.
The timestamp for when the tracker resource received the device position. Uses ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ
.
Retrieves the geofence details from a geofence collection.
", + "smithy.api#documentation": "Retrieves the geofence details from a geofence collection.
\nThe returned geometry will always match the geometry format used when the geofence was created.
\nA comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode
.
Valid font stacks for Esri styles:
\nVectorEsriDarkGrayCanvas – Ubuntu Medium Italic
| Ubuntu\n Medium
| Ubuntu Italic
| Ubuntu Regular
|\n Ubuntu Bold
\n
VectorEsriLightGrayCanvas – Ubuntu Italic
| Ubuntu\n Regular
| Ubuntu Light
| Ubuntu Bold
\n
VectorEsriTopographic – Noto Sans Italic
| Noto Sans\n Regular
| Noto Sans Bold
| Noto Serif\n Regular
| Roboto Condensed Light Italic
\n
VectorEsriStreets – Arial Regular
| Arial Italic
|\n Arial Bold
\n
VectorEsriNavigation – Arial Regular
| Arial Italic
\n | Arial Bold
| Arial Unicode MS Bold
| Arial Unicode MS Regular
\n
Valid font stacks for HERE Technologies styles:
\nVectorHereContrast – Fira \n GO Regular
| Fira GO Bold
\n
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic
| Fira GO Map
| \n Fira GO Map Bold
| Noto Sans CJK JP Bold
| \n Noto Sans CJK JP Light
| \n Noto Sans CJK JP Regular
\n
Valid font stacks for GrabMaps styles:
\nVectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular
|\n Noto Sans Medium
|\n Noto Sans Bold
\n
Valid font stacks for Open Data styles:
\nVectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular
|\n Amazon Ember Bold,Noto Sans Bold
| \n Amazon Ember Medium,Noto Sans Medium
|\n Amazon Ember Regular Italic,Noto Sans Italic
| \n Amazon Ember Condensed RC Regular,Noto Sans Regular
| \n Amazon Ember Condensed RC Bold,Noto Sans Bold
|\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
|\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold
|\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
|\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular
|\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular
|\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
\n
The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember
for most glyphs but Noto Sans
\n for glyphs unsupported by Amazon Ember
.
A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode
.
Valid font stacks for Esri styles:
\nVectorEsriDarkGrayCanvas – Ubuntu Medium Italic
| Ubuntu\n Medium
| Ubuntu Italic
| Ubuntu Regular
|\n Ubuntu Bold
\n
VectorEsriLightGrayCanvas – Ubuntu Italic
| Ubuntu\n Regular
| Ubuntu Light
| Ubuntu Bold
\n
VectorEsriTopographic – Noto Sans Italic
| Noto Sans\n Regular
| Noto Sans Bold
| Noto Serif\n Regular
| Roboto Condensed Light Italic
\n
VectorEsriStreets – Arial Regular
| Arial Italic
|\n Arial Bold
\n
VectorEsriNavigation – Arial Regular
| Arial Italic
\n | Arial Bold
\n
Valid font stacks for HERE Technologies styles:
\nVectorHereContrast – Fira \n GO Regular
| Fira GO Bold
\n
VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic
| Fira GO Map
| \n Fira GO Map Bold
| Noto Sans CJK JP Bold
| \n Noto Sans CJK JP Light
| \n Noto Sans CJK JP Regular
\n
Valid font stacks for GrabMaps styles:
\nVectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular
|\n Noto Sans Medium
|\n Noto Sans Bold
\n
Valid font stacks for Open Data styles:
\nVectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular
|\n Amazon Ember Bold,Noto Sans Bold
| \n Amazon Ember Medium,Noto Sans Medium
|\n Amazon Ember Regular Italic,Noto Sans Italic
| \n Amazon Ember Condensed RC Regular,Noto Sans Regular
| \n Amazon Ember Condensed RC Bold,Noto Sans Bold
|\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular
|\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold
|\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold
|\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular
|\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular
|\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium
\n
The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember
for most glyphs but Noto Sans
\n for glyphs unsupported by Amazon Ember
.
The identifier of the place to find.
\nWhile you can use PlaceID in subsequent requests, \n PlaceID is not intended to be a permanent \n identifier and the ID can change between consecutive API calls. \n Please see the following PlaceID behaviour for each data provider:
\nEsri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
\nHERE: We recommend \n that you cache data for no longer than a week \n to keep your data data fresh. You can \n assume that less than 1% ID shifts will\n release over release which is approximately 1 - 2 times per week.
\nGrab: Place IDs can expire or become invalid in the following situations.
\nData operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth,\n such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
\nInterpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, \n and it will be marked as derived in the place.result_type
field in the response. \n The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by \n Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.
The identifier of the place to find.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4454,6 +4810,39 @@ "target": "com.amazonaws.location#Id" } }, + "com.amazonaws.location#InferredState": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.location#Position", + "traits": { + "smithy.api#documentation": "The device position inferred by the provided position, IP address, cellular signals, and Wi-Fi- access points.
" + } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy", + "traits": { + "smithy.api#documentation": "The level of certainty of the inferred position.
" + } + }, + "DeviationDistance": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The distance between the inferred position and the device's self-reported position.
" + } + }, + "ProxyDetected": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if a proxy was used.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.
" + } + }, "com.amazonaws.location#IntendedUse": { "type": "string", "traits": { @@ -4505,6 +4894,15 @@ } } }, + "com.amazonaws.location#LargeToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60000 + } + } + }, "com.amazonaws.location#Leg": { "type": "structure", "members": { @@ -4893,7 +5291,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the geofence collection details.
" + "smithy.api#documentation": "Contains the geofence collection details.
\nThe returned geometry will always match the geometry format used when the geofence was created.
\nContains a list of geofences stored in a given geofence collection.
" + "smithy.api#documentation": "Contains a list of geofences stored in a given geofence collection.
\nThe returned geometry will always match the geometry format used when the geofence was created.
\nThe pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.
\nDefault value: null
\n
A pagination token indicating there are additional pages available. You can use the\n token in a following request to fetch the next set of results.
" } @@ -6555,15 +6953,187 @@ "Endpoint": "https://example.com" } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.location#LteCellDetails": { + "type": "structure", + "members": { + "CellId": { + "target": "com.amazonaws.location#EutranCellId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The E-UTRAN Cell Identifier (ECI).
", + "smithy.api#required": {} + } + }, + "Mcc": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The Mobile Country Code (MCC).
", + "smithy.api#range": { + "min": 200, + "max": 999 + }, + "smithy.api#required": {} + } + }, + "Mnc": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The Mobile Network Code (MNC)
", + "smithy.api#range": { + "min": 0, + "max": 999 + }, + "smithy.api#required": {} + } + }, + "LocalId": { + "target": "com.amazonaws.location#LteLocalId", + "traits": { + "smithy.api#documentation": "The LTE local identification information (local ID).
" + } + }, + "NetworkMeasurements": { + "target": "com.amazonaws.location#LteNetworkMeasurementsList", + "traits": { + "smithy.api#documentation": "The network measurements.
", + "smithy.api#length": { + "min": 1, + "max": 32 } - ], - "version": "1.0" + } + }, + "TimingAdvance": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Timing Advance (TA).
", + "smithy.api#range": { + "min": 0, + "max": 1282 + } + } + }, + "NrCapable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the LTE object is capable of supporting NR (new radio).
" + } + }, + "Rsrp": { + "target": "com.amazonaws.location#Rsrp", + "traits": { + "smithy.api#documentation": "Signal power of the reference signal received, measured in decibel-milliwatts (dBm).
" + } + }, + "Rsrq": { + "target": "com.amazonaws.location#Rsrq", + "traits": { + "smithy.api#documentation": "Signal quality of the reference Signal received, measured in decibels (dB).
" + } + }, + "Tac": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "LTE Tracking Area Code (TAC).
", + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the Long-Term Evolution (LTE) network.
" + } + }, + "com.amazonaws.location#LteCellDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#LteCellDetails" + } + }, + "com.amazonaws.location#LteLocalId": { + "type": "structure", + "members": { + "Earfcn": { + "target": "com.amazonaws.location#Earfcn", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).
", + "smithy.api#required": {} + } + }, + "Pci": { + "target": "com.amazonaws.location#Pci", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Physical Cell ID (PCI).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "LTE local identification information (local ID).
" + } + }, + "com.amazonaws.location#LteNetworkMeasurements": { + "type": "structure", + "members": { + "Earfcn": { + "target": "com.amazonaws.location#Earfcn", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).
", + "smithy.api#required": {} + } + }, + "CellId": { + "target": "com.amazonaws.location#EutranCellId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "E-UTRAN Cell Identifier (ECI).
", + "smithy.api#required": {} + } + }, + "Pci": { + "target": "com.amazonaws.location#Pci", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Physical Cell ID (PCI).
", + "smithy.api#required": {} + } + }, + "Rsrp": { + "target": "com.amazonaws.location#Rsrp", + "traits": { + "smithy.api#documentation": "Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
" + } + }, + "Rsrq": { + "target": "com.amazonaws.location#Rsrq", + "traits": { + "smithy.api#documentation": "Signal quality of the reference Signal received, measured in decibels (dB).
" + } } + }, + "traits": { + "smithy.api#documentation": "LTE network measurements.
" + } + }, + "com.amazonaws.location#LteNetworkMeasurementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#LteNetworkMeasurements" } }, "com.amazonaws.location#MapConfiguration": { @@ -6572,7 +7142,7 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "Specifies the map style selected from an available data provider.
\nValid Esri map styles:
\n\n VectorEsriNavigation
– The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a \n custom navigation map style that's designed for use during the day in mobile devices. It also includes a richer set of places, \n such as shops, services, restaurants, attractions, and other points of interest. \n Enable the POI
layer by setting it in CustomLayers to leverage the additional places data.
\n RasterEsriImagery
– The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.
\n VectorEsriLightGrayCanvas
– The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.
\n VectorEsriTopographic
– The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.
\n VectorEsriStreets
– The Esri Street Map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.
\n VectorEsriDarkGrayCanvas
– The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.
Valid HERE\n Technologies map styles:
\n\n VectorHereExplore
– A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.
\n RasterHereExploreSatellite
– A global map containing high\n resolution satellite imagery.
\n HybridHereExploreSatellite
– A global map displaying the road \n network, street names, and city labels over satellite imagery. This style \n will automatically retrieve both raster and vector tiles, and your charges \n will be based on total tiles retrieved.
Hybrid styles use both vector and raster tiles when rendering the \n map that you see. This means that more tiles are retrieved than when using \n either vector or raster tiles alone. Your charges will include all tiles \n retrieved.
\n\n VectorHereContrast
– The HERE Contrast (Berlin) map style is a \n high contrast\n detailed base map of the world that blends 3D and 2D rendering.
The VectorHereContrast
style has been renamed from \n VectorHereBerlin
. \n VectorHereBerlin
has been deprecated, but will continue to work in \n applications that use it.
\n VectorHereExploreTruck
– A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.
Valid GrabMaps map styles:
\n\n VectorGrabStandardLight
– The Grab Standard Light \n map style provides a basemap with detailed land use coloring, \n area names, roads, landmarks, and points of interest covering \n Southeast Asia.
\n VectorGrabStandardDark
– The Grab Standard Dark \n map style provides a dark variation of the standard basemap \n covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1
).\n For more information, see GrabMaps countries and area covered.
Valid Open Data map styles:
\n\n VectorOpenDataStandardLight
– The Open Data Standard Light \n map style provides a detailed basemap for the world suitable for\n website and mobile application use. The map includes highways major roads, \n minor roads, railways, water features, cities, parks, landmarks, building\n footprints, and administrative boundaries.
\n VectorOpenDataStandardDark
– Open Data Standard Dark is a\n dark-themed map style that provides a detailed basemap for the world \n suitable for website and mobile application use. The map includes highways \n major roads, minor roads, railways, water features, cities, parks, \n landmarks, building footprints, and administrative boundaries.
\n VectorOpenDataVisualizationLight
– The Open Data \n Visualization Light map style is a light-themed style with muted colors and\n fewer features that aids in understanding overlaid data.
\n VectorOpenDataVisualizationDark
– The Open Data \n Visualization Dark map style is a dark-themed style with muted colors and\n fewer features that aids in understanding overlaid data.
Specifies the map style selected from an available data provider.
\nValid Esri map styles:
\n\n VectorEsriDarkGrayCanvas
– The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.
\n RasterEsriImagery
– The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.
\n VectorEsriLightGrayCanvas
– The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.
\n VectorEsriTopographic
– The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.
\n VectorEsriStreets
– The Esri Street Map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.
\n VectorEsriNavigation
– The Esri Navigation map style, which\n provides a detailed basemap for the world symbolized with a custom navigation\n map style that's designed for use during the day in mobile devices.
Valid HERE\n Technologies map styles:
\n\n VectorHereContrast
– The HERE Contrast (Berlin) map style is a \n high contrast\n detailed base map of the world that blends 3D and 2D rendering.
The VectorHereContrast
style has been renamed from \n VectorHereBerlin
. \n VectorHereBerlin
has been deprecated, but will continue to work in \n applications that use it.
\n VectorHereExplore
– A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.
\n VectorHereExploreTruck
– A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.
\n RasterHereExploreSatellite
– A global map containing high\n resolution satellite imagery.
\n HybridHereExploreSatellite
– A global map displaying the road \n network, street names, and city labels over satellite imagery. This style \n will automatically retrieve both raster and vector tiles, and your charges \n will be based on total tiles retrieved.
Hybrid styles use both vector and raster tiles when rendering the \n map that you see. This means that more tiles are retrieved than when using \n either vector or raster tiles alone. Your charges will include all tiles \n retrieved.
\nValid GrabMaps map styles:
\n\n VectorGrabStandardLight
– The Grab Standard Light \n map style provides a basemap with detailed land use coloring, \n area names, roads, landmarks, and points of interest covering \n Southeast Asia.
\n VectorGrabStandardDark
– The Grab Standard Dark \n map style provides a dark variation of the standard basemap \n covering Southeast Asia.
Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1
).\n For more information, see GrabMaps countries and area covered.
Valid Open Data map styles:
\n\n VectorOpenDataStandardLight
– The Open Data Standard Light \n map style provides a detailed basemap for the world suitable for\n website and mobile application use. The map includes highways major roads, \n minor roads, railways, water features, cities, parks, landmarks, building\n footprints, and administrative boundaries.
\n VectorOpenDataStandardDark
– Open Data Standard Dark is a\n dark-themed map style that provides a detailed basemap for the world \n suitable for website and mobile application use. The map includes highways \n major roads, minor roads, railways, water features, cities, parks, \n landmarks, building footprints, and administrative boundaries.
\n VectorOpenDataVisualizationLight
– The Open Data \n Visualization Light map style is a light-themed style with muted colors and\n fewer features that aids in understanding overlaid data.
\n VectorOpenDataVisualizationDark
– The Open Data \n Visualization Dark map style is a dark-themed style with muted colors and\n fewer features that aids in understanding overlaid data.
Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI
layer for the VectorEsriNavigation style.\nDefault is unset
.
Currenlty only VectorEsriNavigation
supports CustomLayers. \nFor more information, see Custom Layers.
Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style.\nDefault is unset
.
Not all map resources or styles support custom layers. See Custom Layers for more information.
\nSpecifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI
layer for the VectorEsriNavigation style.\nDefault is unset
.
Currenlty only VectorEsriNavigation
supports CustomLayers. \nFor more information, see Custom Layers.
Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style.\nDefault is unset
.
Not all map resources or styles support custom layers. See Custom Layers for more information.
\nFor addresses with a UnitNumber
, the type of unit. For example,\n Apartment
.
This property is returned only for a place index that uses Esri as a data provider.
\nFor addresses with a UnitNumber
, the type of unit. For example,\n Apartment
.
Returned only for a place index that uses Esri as a data provider.
\nFor addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B
or Unit 123
.
This property is returned only for a place index that uses Esri or Grab as a data provider. It is \n not returned for SearchPlaceIndexForPosition
.
For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is \n not returned for SearchPlaceIndexForPosition
.
An area that's part of a larger municipality. For example, Blissville
\n is a submunicipality in the Queen County in New York.
This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district
.
For more information about data providers, see Amazon Location Service data providers.
" + "smithy.api#documentation": "An area that's part of a larger municipality. For example, Blissville
\n is a submunicipality in the Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the OpenData property is borough
.
Estimated maximum distance, in meters, between the measured position and the true\n position of a device, along the Earth's surface.
", "smithy.api#range": { "min": 0, - "max": 10000 + "max": 10000000 }, "smithy.api#required": {} } @@ -7074,7 +7661,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "Contains the details to specify the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.
\nEach \n geofence polygon can have a maximum of 1,000 vertices.
\nContains the details to specify the position of the geofence. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.
\nThe \n geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.
\nThe unique identifier of the Place. You can use this with the GetPlace
\n operation to find the place again later, or to get full information for the Place.
The GetPlace
request must use the same PlaceIndex
\n resource as the SearchPlaceIndexForSuggestions
that generated the Place \n ID.
For SearchPlaceIndexForSuggestions
operations, the\n PlaceId
is returned by place indexes that use Esri, Grab, or HERE\n as data providers.
While you can use PlaceID in subsequent requests, \n PlaceID is not intended to be a permanent \n identifier and the ID can change between consecutive API calls. \n Please see the following PlaceID behaviour for each data provider:
\nEsri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
\nHERE: We recommend \n that you cache data for no longer than a week \n to keep your data data fresh. You can \n assume that less than 1% ID shifts will\n release over release which is approximately 1 - 2 times per week.
\nGrab: Place IDs can expire or become invalid in the following situations.
\nData operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth,\n such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
\nInterpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, \n and it will be marked as derived in the place.result_type
field in the response. \n The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by \n Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.
The unique identifier of the Place. You can use this with the GetPlace
\n operation to find the place again later, or to get full information for the Place.
The GetPlace
request must use the same PlaceIndex
\n resource as the SearchPlaceIndexForSuggestions
that generated the Place \n ID.
For SearchPlaceIndexForSuggestions
operations, the\n PlaceId
is returned by place indexes that use Esri, Grab, or HERE\n as data providers.
Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.
", + "smithy.api#endpoint": { + "hostPrefix": "tracking." + }, + "smithy.api#http": { + "uri": "/tracking/v0/trackers/{TrackerName}/positions/verify", + "method": "POST" + } + } + }, + "com.amazonaws.location#VerifyDevicePositionRequest": { + "type": "structure", + "members": { + "TrackerName": { + "target": "com.amazonaws.location#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the tracker resource to be associated with verification request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeviceState": { + "target": "com.amazonaws.location#DeviceState", + "traits": { + "smithy.api#documentation": "The device's state, including position, IP address, cell signals and Wi-Fi access points.
", + "smithy.api#required": {} + } + }, + "DistanceUnit": { + "target": "com.amazonaws.location#DistanceUnit", + "traits": { + "smithy.api#documentation": "The distance unit for the verification request.
\nDefault Value: Kilometers
\n
The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.
", + "smithy.api#required": {} + } + }, + "DeviceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "The device identifier.
", + "smithy.api#required": {} + } + }, + "SampleTime": { + "target": "com.amazonaws.location#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the device's position was determined. Uses ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ
.
The timestamp for when the tracker resource received the device position in ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ
.
The distance unit for the verification response.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.location#WaypointPositionList": { "type": "list", "member": { "target": "com.amazonaws.location#Position" } + }, + "com.amazonaws.location#WiFiAccessPoint": { + "type": "structure", + "members": { + "MacAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Medium access control address (Mac).
", + "smithy.api#length": { + "min": 12, + "max": 17 + }, + "smithy.api#pattern": "^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$", + "smithy.api#required": {} + } + }, + "Rss": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Received signal strength (dBm) of the WLAN measurement data.
", + "smithy.api#range": { + "min": -128, + "max": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Wi-Fi access point.
" + } + }, + "com.amazonaws.location#WiFiAccessPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#WiFiAccessPoint" + } } } } \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/sns.json b/codegen/sdk-codegen/aws-models/sns.json index c77285f4bf6..b523df57d06 100644 --- a/codegen/sdk-codegen/aws-models/sns.json +++ b/codegen/sdk-codegen/aws-models/sns.json @@ -1571,7 +1571,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal
and\n PlatformCredential
attributes when using the\n CreatePlatformApplication
action.
\n PlatformPrincipal
and PlatformCredential
are received from\n the notification service.
For ADM
, PlatformPrincipal
is client id
\n and PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
\n and PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
using certificate\n credentials, PlatformPrincipal
is SSL certificate
and\n PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials,\n PlatformPrincipal
is signing key ID
and\n PlatformCredential
is signing key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is\n API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`
.
For MPNS
, PlatformPrincipal
is TLS\n certificate
and PlatformCredential
is private\n key
.
For WNS
, PlatformPrincipal
is Package Security\n Identifier
and PlatformCredential
is secret\n key
.
You can use the returned PlatformApplicationArn
as an attribute for the\n CreatePlatformEndpoint
action.
Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal
and\n PlatformCredential
attributes when using the\n CreatePlatformApplication
action.
\n PlatformPrincipal
and PlatformCredential
are received from\n the notification service.
For ADM, PlatformPrincipal
is client id
\n and PlatformCredential
is client secret
.
For APNS and APNS_SANDBOX
using certificate\n credentials, PlatformPrincipal
is SSL certificate
and\n PlatformCredential
is private key
.
For APNS and APNS_SANDBOX
using token credentials,\n PlatformPrincipal
is signing key ID
and\n PlatformCredential
is signing key
.
For Baidu, PlatformPrincipal
is API key
\n and PlatformCredential
is secret key
.
For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is\n API key
.
For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal
. The PlatformCredential
is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`
.
For MPNS, PlatformPrincipal
is TLS\n certificate
and PlatformCredential
is private\n key
.
For WNS, PlatformPrincipal
is Package Security\n Identifier
and PlatformCredential
is secret\n key
.
You can use the returned PlatformApplicationArn
as an attribute for the\n CreatePlatformEndpoint
action.
A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateTopic
action uses:
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName
– The display name to use for a topic with SMS\n subscriptions.
\n FifoTopic
– Set to true to create a FIFO topic.
\n Policy
– The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n SignatureVersion
– The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion
is set to 1
.
\n TracingConfig
– Tracing mode of an Amazon SNS topic. By default\n TracingConfig
is set to PassThrough
, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
The following attribute applies only to server-side\n encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
\n\n ArchivePolicy
– Adds or updates an inline policy document\n to archive messages stored in the specified Amazon SNS topic.
\n BeginningArchiveTime
– The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.
\n ContentBasedDeduplication
– Enables content-based deduplication for\n FIFO topics.
By default, ContentBasedDeduplication
is set to false
.\n If you create a FIFO topic and this attribute is false
, you must\n specify a value for the MessageDeduplicationId
parameter for the\n Publish action.
When you set ContentBasedDeduplication
to true
, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using \n the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId
parameter for the Publish
\n action.
A map of attributes with their corresponding values.
\nThe following lists names, descriptions, and values of the special request\n parameters that the CreateTopic
action uses:
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n DisplayName
– The display name to use for a topic with SMS\n subscriptions.
\n FifoTopic
– Set to true to create a FIFO topic.
\n Policy
– The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.
\n SignatureVersion
– The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion
is set to 1
.
\n TracingConfig
– Tracing mode of an Amazon SNS topic. By default\n TracingConfig
is set to PassThrough
, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.
The following attribute applies only to server-side\n encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
\n\n ArchivePolicy
– Adds or updates an inline policy document\n to archive messages stored in the specified Amazon SNS topic.
\n BeginningArchiveTime
– The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.
\n ContentBasedDeduplication
– Enables content-based deduplication for\n FIFO topics.
By default, ContentBasedDeduplication
is set to false
.\n If you create a FIFO topic and this attribute is false
, you must\n specify a value for the MessageDeduplicationId
parameter for the\n Publish action.
When you set ContentBasedDeduplication
to true
, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using \n the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId
parameter for the Publish
\n action.
A map of the subscription's attributes. Attributes in this map include the\n following:
\n\n ConfirmationWasAuthenticated
– true
if the\n subscription confirmation request was authenticated.
\n DeliveryPolicy
– The JSON serialization of the\n subscription's delivery policy.
\n EffectiveDeliveryPolicy
– The JSON serialization of the\n effective delivery policy that takes into account the topic delivery policy and\n account system defaults.
\n FilterPolicy
– The filter policy JSON that is assigned to\n the subscription. For more information, see Amazon SNS Message\n Filtering in the Amazon SNS Developer Guide.
\n FilterPolicyScope
– This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes
(default) – The filter is\n applied on the message attributes.
\n MessageBody
– The filter is applied on the message\n body.
\n Owner
– The Amazon Web Services account ID of the subscription's\n owner.
\n PendingConfirmation
– true
if the subscription\n hasn't been confirmed. To confirm a pending subscription, call the\n ConfirmSubscription
action with a confirmation token.
\n RawMessageDelivery
– true
if raw message\n delivery is enabled for the subscription. Raw messages are free of JSON\n formatting and can be sent to HTTP/S and Amazon SQS endpoints.
\n RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
\n SubscriptionArn
– The subscription's ARN.
\n TopicArn
– The topic ARN that the subscription is associated\n with.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
\nA map of the subscription's attributes. Attributes in this map include the\n following:
\n\n ConfirmationWasAuthenticated
– true
if the\n subscription confirmation request was authenticated.
\n DeliveryPolicy
– The JSON serialization of the\n subscription's delivery policy.
\n EffectiveDeliveryPolicy
– The JSON serialization of the\n effective delivery policy that takes into account the topic delivery policy and\n account system defaults.
\n FilterPolicy
– The filter policy JSON that is assigned to\n the subscription. For more information, see Amazon SNS Message\n Filtering in the Amazon SNS Developer Guide.
\n FilterPolicyScope
– This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes
(default) – The filter is\n applied on the message attributes.
\n MessageBody
– The filter is applied on the message\n body.
\n Owner
– The Amazon Web Services account ID of the subscription's\n owner.
\n PendingConfirmation
– true
if the subscription\n hasn't been confirmed. To confirm a pending subscription, call the\n ConfirmSubscription
action with a confirmation token.
\n RawMessageDelivery
– true
if raw message\n delivery is enabled for the subscription. Raw messages are free of JSON\n formatting and can be sent to HTTP/S and Amazon SQS endpoints.
\n RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
\n SubscriptionArn
– The subscription's ARN.
\n TopicArn
– The topic ARN that the subscription is associated\n with.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.
\nOptional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.
\nConstraints: Subjects must be ASCII text that begins with a letter, number, or\n punctuation mark; must not include line breaks or control characters; and must be less\n than 100 characters long.
" + "smithy.api#documentation": "Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.
\nConstraints: Subjects must be UTF-8 text with no line breaks or control characters,\n and less than 100 characters long.
" } }, "MessageStructure": { @@ -4490,7 +4490,7 @@ "AttributeName": { "target": "com.amazonaws.sns#attributeName", "traits": { - "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that this action uses:
\n\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n FilterPolicy
– The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.
\n FilterPolicyScope
– This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes
(default) – The filter is\n applied on the message attributes.
\n MessageBody
– The filter is applied on the message\n body.
\n RawMessageDelivery
– When set to true
,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.
\n RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that this action uses:
\n\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n FilterPolicy
– The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.
\n FilterPolicyScope
– This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes
(default) – The filter is\n applied on the message attributes.
\n MessageBody
– The filter is applied on the message\n body.
\n RawMessageDelivery
– When set to true
,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.
\n RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the Subscribe
action uses:
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n FilterPolicy
– The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.
\n FilterPolicyScope
– This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes
(default) – The filter is\n applied on the message attributes.
\n MessageBody
– The filter is applied on the message\n body.
\n RawMessageDelivery
– When set to true
,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.
\n RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
\nThe following attributes apply only to FIFO topics:
\n\n ReplayPolicy
– Adds or updates an inline policy document\n for a subscription to replay messages stored in the specified Amazon SNS\n topic.
\n ReplayStatus
– Retrieves the status of the subscription\n message replay, which can be one of the following:
\n Completed
– The replay has successfully\n redelivered all messages, and is now delivering newly published\n messages. If an ending point was specified in the\n ReplayPolicy
then the subscription will no longer\n receive newly published messages.
\n In progress
– The replay is currently replaying\n the selected messages.
\n Failed
– The replay was unable to complete.
\n Pending
– The default state while the replay\n initiates.
A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the Subscribe
action uses:
\n DeliveryPolicy
– The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.
\n FilterPolicy
– The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.
\n FilterPolicyScope
– This attribute lets you choose the\n filtering scope by using one of the following string value types:
\n MessageAttributes
(default) – The filter is\n applied on the message attributes.
\n MessageBody
– The filter is applied on the message\n body.
\n RawMessageDelivery
– When set to true
,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.
\n RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
\n\n SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Firehose delivery stream
\nAmazon SNS listed as a trusted entity
\nSpecifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.
\nThe following attributes apply only to FIFO topics:
\n\n ReplayPolicy
– Adds or updates an inline policy document\n for a subscription to replay messages stored in the specified Amazon SNS\n topic.
\n ReplayStatus
– Retrieves the status of the subscription\n message replay, which can be one of the following:
\n Completed
– The replay has successfully\n redelivered all messages, and is now delivering newly published\n messages. If an ending point was specified in the\n ReplayPolicy
then the subscription will no longer\n receive newly published messages.
\n In progress
– The replay is currently replaying\n the selected messages.
\n Failed
– The replay was unable to complete.
\n Pending
– The default state while the replay\n initiates.
\n This parameter has been deprecated but will be supported for backward compatibility.\n To provide attribute names, you are encouraged to use MessageSystemAttributeNames
. \n
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
This parameter has been deprecated but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames
.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
The request was denied due to request throttling.
\nThe rate of requests per second exceeds the Amazon Web Services KMS request quota for an\n account and Region.
\nA burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"
\nRequests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
\nThe request was denied due to request throttling.
\nThe rate of requests per second exceeds the Amazon Web Services KMS request\n quota for an account and Region.
\nA burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"
\nRequests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
\nDelivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nDelivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD
before storing the message in the queue, as long as the message body contains at least one valid character.
You can use SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses\n the default value for the queue.
You can use SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD
before storing the message in the queue, as long as the message body contains at least one valid character.
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses\n the default value for the queue.
The message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nThe message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD
before storing the message in the queue, as long as the message body contains at least one valid character.
Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod
is reduced\n below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
Sets the value of one or more queue attributes, like a policy. When you change a\n queue's attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and will\n impact existing messages in the queue potentially causing them to be expired and deleted\n if the MessageRetentionPeriod
is reduced below the age of existing\n messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
Returns your gateway's weekly maintenance start time including the day and time of\n the week. Note that values are in terms of the gateway's time zone.
", + "smithy.api#documentation": "Returns your gateway's maintenance window schedule information, with values for\n monthly or weekly cadence, specific day and time to begin maintenance, and which types of\n updates to apply. Time values returned are for the gateway's time zone.
", "smithy.api#examples": [ { "title": "To describe gateway's maintenance start time", @@ -3850,7 +3867,7 @@ "DayOfMonth": { "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { - "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.
" + "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month. It is not possible to\n set the maintenance schedule to start on days 29 through 31.
" } }, "Timezone": { @@ -3858,10 +3875,16 @@ "traits": { "smithy.api#documentation": "A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.
" } + }, + "SoftwareUpdatePreferences": { + "target": "com.amazonaws.storagegateway#SoftwareUpdatePreferences", + "traits": { + "smithy.api#documentation": "A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy
field with the following inputs:
\n ALL_VERSIONS
- Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY
- Disables regular gateway maintenance\n updates.
A JSON object containing the following fields:
\nA JSON object containing the following fields:
\n\n DescribeMaintenanceStartTimeOutput$SoftwareUpdatePreferences\n
\nThe type of security strategy that was specified for file gateway.
\n\n ClientSpecified
: If you choose this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Supported\n only for S3 File Gateway.
\n MandatorySigning
: If you use this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing turned on. This option\n works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.\n
\n MandatoryEncryption
: If you use this option, File Gateway only allows\n connections from SMBv3 clients that have encryption turned on. Both 256-bit and\n 128-bit algorithms are allowed. This option is recommended for environments that\n handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows\n Server 2012, or later.
\n EnforceEncryption
: If you use this option, File Gateway only allows\n connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit\n algorithms are not allowed. This option is recommended for environments that handle\n sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server\n 2012, or later.
The type of security strategy that was specified for file gateway.
\n\n ClientSpecified
: If you choose this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Supported\n only for S3 File Gateway.
\n MandatorySigning
: If you choose this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing turned on. This option\n works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.\n
\n MandatoryEncryption
: If you choose this option, File Gateway only\n allows connections from SMBv3 clients that have encryption turned on. Both 256-bit\n and 128-bit algorithms are allowed. This option is recommended for environments that\n handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows\n Server 2012, or later.
\n MandatoryEncryptionNoAes128
: If you choose this option, File Gateway\n only allows connections from SMBv3 clients that use 256-bit AES encryption\n algorithms. 128-bit algorithms are not allowed. This option is recommended for\n environments that handle sensitive data. It works with SMB clients on Microsoft\n Windows 8, Windows Server 2012, or later.
Indicates the automatic update policy for a gateway.
\n\n ALL_VERSIONS
- Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY
- Disables regular gateway maintenance\n updates.
A set of variables indicating the software update preferences for the gateway.
" + } + }, "com.amazonaws.storagegateway#SoftwareUpdatesEndDate": { "type": "string", "traits": { @@ -10902,7 +10939,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a gateway's metadata, which includes the gateway's name and time zone.\n To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in\n your request.
\nFor gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.
\nUpdates a gateway's metadata, which includes the gateway's name, time zone,\n and metadata cache size. To specify which gateway to update, use the Amazon Resource Name\n (ARN) of the gateway in your request.
\nFor gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.
\nSpecifies the size of the gateway's metadata cache.
" + "smithy.api#documentation": "Specifies the size of the gateway's metadata cache. This setting impacts gateway\n performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares\n in the Amazon S3 File Gateway User Guide.
" } } }, @@ -11049,7 +11086,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a gateway's weekly maintenance start time information, including day and\n time of the week. The maintenance time is the time in your gateway's time zone.
", + "smithy.api#documentation": "Updates a gateway's maintenance window schedule, with settings for monthly or\n weekly cadence, specific day and time to begin maintenance, and which types of updates to\n apply. Time configuration uses the gateway's time zone. You can pass values for a complete\n maintenance schedule, or update policy, or both. Previous values will persist for whichever\n setting you choose not to modify. If an incomplete or invalid maintenance schedule is\n passed, the entire request will be rejected with an error and no changes will occur.
\nA complete maintenance schedule must include values for both\n MinuteOfHour
and HourOfDay
, and either\n DayOfMonth
\n or\n DayOfWeek
.
We recommend keeping maintenance updates turned on, except in specific use cases\n where the brief disruptions caused by updating the gateway could critically impact your\n deployment.
\nThe hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.
", - "smithy.api#required": {} + "smithy.api#documentation": "The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.
" } }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { - "smithy.api#documentation": "The minute component of the maintenance start time represented as\n mm, where mm is the minute (00 to 59). The\n minute of the hour is in the time zone of the gateway.
", - "smithy.api#required": {} + "smithy.api#documentation": "The minute component of the maintenance start time represented as\n mm, where mm is the minute (00 to 59). The\n minute of the hour is in the time zone of the gateway.
" } }, "DayOfWeek": { "target": "com.amazonaws.storagegateway#DayOfWeek", "traits": { - "smithy.api#documentation": "The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.
" + "smithy.api#documentation": "The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.
" } }, "DayOfMonth": { "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { - "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.
" + "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month. It is not possible to\n set the maintenance schedule to start on days 29 through 31.
" + } + }, + "SoftwareUpdatePreferences": { + "target": "com.amazonaws.storagegateway#SoftwareUpdatePreferences", + "traits": { + "smithy.api#documentation": "A set of variables indicating the software update preferences for the gateway.
\nIncludes AutomaticUpdatePolicy
field with the following inputs:
\n ALL_VERSIONS
- Enables regular gateway maintenance updates.
\n EMERGENCY_VERSIONS_ONLY
- Disables regular gateway maintenance\n updates.
A JSON object containing the following fields:
\nA JSON object containing the following fields:
\n\n UpdateMaintenanceStartTimeInput$SoftwareUpdatePreferences\n
\nUpdates the SMB security strategy on a file gateway. This action is only supported in\n file gateways.
\nThis API is called Security level in the User Guide.
\nA higher security level can affect performance of the gateway.
\nUpdates the SMB security strategy level for an Amazon S3 file gateway. This\n action is only supported for Amazon S3 file gateways.
\nFor information about configuring this setting using the Amazon Web Services console,\n see Setting a security level for your gateway in the Amazon S3\n File Gateway User Guide.
\nA higher security strategy level can affect performance of the gateway.
\nSpecifies the type of security strategy.
\nClientSpecified: if you use this option, requests are established based on what is\n negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only in S3 File\n Gateway.
\nMandatorySigning: if you use this option, file gateway only allows connections from\n SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on\n Microsoft Windows Vista, Windows Server 2008 or newer.
\nMandatoryEncryption: if you use this option, file gateway only allows connections from\n SMBv3 clients that have encryption enabled. This option is highly recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.
", + "smithy.api#documentation": "Specifies the type of security strategy.
\n\n ClientSpecified
: If you choose this option, requests are established based\n on what is negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only for S3 File\n Gateway.
\n MandatorySigning
: If you choose this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with\n SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
\n MandatoryEncryption
: If you choose this option, File Gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.
\n MandatoryEncryptionNoAes128
: If you choose this option, File Gateway only\n allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit\n algorithms are not allowed. This option is recommended for environments that handle\n sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or\n later.