From fe582a8d6806d590d9349ac2fd0b71c421c8fdac Mon Sep 17 00:00:00 2001
From: Kyle Thomson A single line format of the access logs of data, as specified by selected $context variables. The format must include at least A single line format of the access logs of data, as specified by selected $context variables. The format must include at least The ARN of an Amazon CloudWatch role for the current Account. The ARN of an Amazon CloudWatch role for the current Account. Specifies the API request limits configured for the current Account. Specifies the API request limits configured for the current Account. Represents an AWS account that is associated with API Gateway. To view the account info, call The following exception may be thrown when the request fails. For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes The successful response returns a In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource. Represents an AWS account that is associated with API Gateway. A list of Stage resources that are associated with the ApiKey resource. A list of Stage resources that are associated with the ApiKey resource. A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage. A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage. A list of all the ApiKey identifiers. A list of all the ApiKey identifiers. The identifier of an ApiKey used in a UsagePlan. The identifier of an ApiKey used in a UsagePlan. Represents a collection of API keys as represented by an ApiKeys resource. Represents a collection of API keys as represented by an ApiKeys resource. [Required] The name of the authorizer. The name of the authorizer. A list of the Amazon Cognito user pool ARNs for the A list of the Amazon Cognito user pool ARNs for the The identity source for which authorization is requested. $context.requestId
.$context.requestId
.GET
on this resource.Error Codes
\n \n
\n Example: Get the information about an account.
\n Request
\n
\n GET /account HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160531T184618Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}\n
Response
\n 200 OK
status code and a payload similar to the following:
\n {\n \"_links\": {\n \"curies\": {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html\",\n \"name\": \"account\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"/account\"\n },\n \"account:update\": {\n \"href\": \"/account\"\n }\n },\n \"cloudwatchRoleArn\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\",\n \"throttleSettings\": {\n \"rateLimit\": 500,\n \"burstLimit\": 1000\n }\n}\n
COGNITO_USER_POOLS
authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For a TOKEN
or REQUEST
authorizer, this is not defined.COGNITO_USER_POOLS
authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For a TOKEN
or REQUEST
authorizer, this is not defined. TOKEN
or COGNITO_USER_POOLS
authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth
, the header mapping expression is method.request.header.Auth
.REQUEST
authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth
header, a Name
query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
The identity source for which authorization is requested. For a TOKEN
or\n COGNITO_USER_POOLS
authorizer, this is required and specifies the request\n header mapping expression for the custom header holding the authorization token submitted by\n the client. For example, if the token header name is Auth
, the header mapping expression is\n method.request.header.Auth
. For the REQUEST
authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping expressions\n of the specified request parameters. For example, if an Auth
header, a Name
query string\n parameter are defined as identity sources, this value is method.request.header.Auth
,\n method.request.querystring.Name
. These parameters will be used to derive the authorization\n caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of\n the identity-related request parameters are present, not null and non-empty. Only when this is\n true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value is a string of\n comma-separated mapping expressions of the specified request parameters. When the\n authorization caching is not enabled, this property is optional.
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
\n " + "smithy.api#documentation": "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
" } }, "com.amazonaws.apigateway#AuthorizerType": { @@ -356,7 +356,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of Authorizer resources.
\n " + "smithy.api#documentation": "Represents a collection of Authorizer resources.
" } }, "com.amazonaws.apigateway#BackplaneControlService": { @@ -765,7 +765,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The string identifier of the associated RestApi.
" + "smithy.api#documentation": "The string identifier of the associated RestApi.
" } }, "stage": { @@ -776,7 +776,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the base path that callers of the API must provide as part of the URL after the domain name.
\nBasePathMapping
specification identifies a deployed RestApi in a given stage of the owner Account.Represents the base path that callers of the API must provide as part of the URL after the domain name.
" } }, "com.amazonaws.apigateway#BasePathMappings": { @@ -798,7 +798,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of BasePathMapping resources.
\n " + "smithy.api#documentation": "Represents a collection of BasePathMapping resources.
" } }, "com.amazonaws.apigateway#Blob": { @@ -810,7 +810,7 @@ "com.amazonaws.apigateway#CacheClusterSize": { "type": "string", "traits": { - "smithy.api#documentation": "Returns the size of the CacheCluster.
", + "smithy.api#documentation": "Returns the size of the CacheCluster.
", "smithy.api#enum": [ { "value": "0.5", @@ -850,7 +850,7 @@ "com.amazonaws.apigateway#CacheClusterStatus": { "type": "string", "traits": { - "smithy.api#documentation": "Returns the status of the CacheCluster.
", + "smithy.api#documentation": "Returns the status of the CacheCluster.
", "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", @@ -948,7 +948,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
\nRepresents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
" } }, "com.amazonaws.apigateway#ClientCertificates": { @@ -970,7 +970,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of ClientCertificate resources.
\n " + "smithy.api#documentation": "Represents a collection of ClientCertificate resources.
" } }, "com.amazonaws.apigateway#ConflictException": { @@ -1045,7 +1045,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an ApiKey resource.
\n ", + "smithy.api#documentation": "Create an ApiKey resource.
", "smithy.api#http": { "method": "POST", "uri": "/apikeys", @@ -1059,19 +1059,19 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The name of the ApiKey.
" + "smithy.api#documentation": "The name of the ApiKey.
" } }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of the ApiKey.
" + "smithy.api#documentation": "The description of the ApiKey.
" } }, "enabled": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether the ApiKey can be used by callers.
" + "smithy.api#documentation": "Specifies whether the ApiKey can be used by callers.
" } }, "generateDistinctId": { @@ -1083,7 +1083,7 @@ "value": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "Specifies a value of the API key.
" + "smithy.api#documentation": "Specifies a value of the API key.
" } }, "stageKeys": { @@ -1106,7 +1106,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to create an ApiKey resource.
" + "smithy.api#documentation": "Request to create an ApiKey resource.
" } }, "com.amazonaws.apigateway#CreateAuthorizer": { @@ -1138,7 +1138,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a new Authorizer resource to an existing RestApi resource.
\n ", + "smithy.api#documentation": "Adds a new Authorizer resource to an existing RestApi resource.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/authorizers", @@ -1152,7 +1152,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1160,21 +1160,21 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the authorizer.
", + "smithy.api#documentation": "The name of the authorizer.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.apigateway#AuthorizerType", "traits": { - "smithy.api#documentation": "[Required] The authorizer type. Valid values are TOKEN
for a Lambda function using a single authorization token submitted in a custom header, REQUEST
for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS
for using an Amazon Cognito user pool.
The authorizer type. Valid values are TOKEN
for a Lambda function using a single authorization token submitted in a custom header, REQUEST
for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS
for using an Amazon Cognito user pool.
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS
authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For a TOKEN
or REQUEST
authorizer, this is not defined.
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS
authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}
. For a TOKEN
or REQUEST
authorizer, this is not defined.
The identity source for which authorization is requested.
TOKEN
or COGNITO_USER_POOLS
authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth
, the header mapping expression is method.request.header.Auth
.REQUEST
authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth
header, a Name
query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST
authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.The identity source for which authorization is requested. For a TOKEN
or\n COGNITO_USER_POOLS
authorizer, this is required and specifies the request\n header mapping expression for the custom header holding the authorization token submitted by\n the client. For example, if the token header name is Auth
, the header mapping\n expression is method.request.header.Auth
. For the REQUEST
\n authorizer, this is required when authorization caching is enabled. The value is a\n comma-separated string of one or more mapping expressions of the specified request parameters.\n For example, if an Auth
header, a Name
query string parameter are\n defined as identity sources, this value is method.request.header.Auth,\n method.request.querystring.Name
. These parameters will be used to derive the\n authorization caching key and to perform runtime validation of the REQUEST
\n authorizer by verifying all of the identity-related request parameters are present, not null\n and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda\n function, otherwise, it returns a 401 Unauthorized response without calling the Lambda\n function. The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.
Request to add a new Authorizer to an existing RestApi resource.
" + "smithy.api#documentation": "Request to add a new Authorizer to an existing RestApi resource.
" } }, "com.amazonaws.apigateway#CreateBasePathMapping": { @@ -1247,7 +1247,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new BasePathMapping resource.
", + "smithy.api#documentation": "Creates a new BasePathMapping resource.
", "smithy.api#http": { "method": "POST", "uri": "/domainnames/{domainName}/basepathmappings", @@ -1261,7 +1261,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The domain name of the BasePathMapping resource to create.
", + "smithy.api#documentation": "The domain name of the BasePathMapping resource to create.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1275,7 +1275,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#required": {} } }, @@ -1287,7 +1287,7 @@ } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to create a new BasePathMapping resource.
" + "smithy.api#documentation": "Requests API Gateway to create a new BasePathMapping resource.
" } }, "com.amazonaws.apigateway#CreateDeployment": { @@ -1322,7 +1322,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
", + "smithy.api#documentation": "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/deployments", @@ -1336,7 +1336,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1344,37 +1344,37 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The name of the Stage resource for the Deployment resource to create.
" + "smithy.api#documentation": "The name of the Stage resource for the Deployment resource to create.
" } }, "stageDescription": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of the Stage resource for the Deployment resource to create.
" + "smithy.api#documentation": "The description of the Stage resource for the Deployment resource to create.
" } }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description for the Deployment resource to create.
" + "smithy.api#documentation": "The description for the Deployment resource to create.
" } }, "cacheClusterEnabled": { "target": "com.amazonaws.apigateway#NullableBoolean", "traits": { - "smithy.api#documentation": "Enables a cache cluster for the Stage resource specified in the input.
" + "smithy.api#documentation": "Enables a cache cluster for the Stage resource specified in the input.
" } }, "cacheClusterSize": { "target": "com.amazonaws.apigateway#CacheClusterSize", "traits": { - "smithy.api#documentation": "Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
" + "smithy.api#documentation": "Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
" } }, "variables": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "A map that defines the stage variables for the Stage resource that is associated\n with the new deployment. Variable names can have alphanumeric and underscore characters, and the values\n must match [A-Za-z0-9-._~:/?#&=,]+
.
A map that defines the stage variables for the Stage resource that is associated\n with the new deployment. Variable names can have alphanumeric and underscore characters, and the values\n must match [A-Za-z0-9-._~:/?#&=,]+
.
Specifies whether active tracing with X-ray is enabled for the Stage.
" + "smithy.api#documentation": "Specifies whether active tracing with X-ray is enabled for the Stage.
" } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to create a Deployment resource.
" + "smithy.api#documentation": "Requests API Gateway to create a Deployment resource.
" } }, "com.amazonaws.apigateway#CreateDocumentationPart": { @@ -1423,6 +1423,7 @@ } ], "traits": { + "smithy.api#documentation": "Creates a documentation part.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/documentation/parts", @@ -1436,7 +1437,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1444,14 +1445,14 @@ "location": { "target": "com.amazonaws.apigateway#DocumentationPartLocation", "traits": { - "smithy.api#documentation": "[Required] The location of the targeted API entity of the to-be-created documentation part.
", + "smithy.api#documentation": "The location of the targeted API entity of the to-be-created documentation part.
", "smithy.api#required": {} } }, "properties": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
", + "smithy.api#documentation": "The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
", "smithy.api#required": {} } } @@ -1489,6 +1490,7 @@ } ], "traits": { + "smithy.api#documentation": "Creates a documentation version
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/documentation/versions", @@ -1502,7 +1504,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1510,7 +1512,7 @@ "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The version identifier of the new snapshot.
", + "smithy.api#documentation": "The version identifier of the new snapshot.
", "smithy.api#required": {} } }, @@ -1571,7 +1573,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the DomainName resource.
", + "smithy.api#documentation": "The name of the DomainName resource.
", "smithy.api#required": {} } }, @@ -1620,7 +1622,7 @@ "endpointConfiguration": { "target": "com.amazonaws.apigateway#EndpointConfiguration", "traits": { - "smithy.api#documentation": "The endpoint configuration of this DomainName showing the endpoint types of the domain name.
" + "smithy.api#documentation": "The endpoint configuration of this DomainName showing the endpoint types of the domain name.
" } }, "tags": { @@ -1632,7 +1634,7 @@ "securityPolicy": { "target": "com.amazonaws.apigateway#SecurityPolicy", "traits": { - "smithy.api#documentation": "The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0
and TLS_1_2
.
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0
and TLS_1_2
.
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
" + "smithy.api#documentation": "The ARN of the public certificate issued by ACM to validate ownership of your custom\n domain. Only required when configuring mutual TLS and using an ACM imported or private CA\n certificate ARN as the regionalCertificateArn.
" } } }, @@ -1678,7 +1680,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a new Model resource to an existing RestApi resource.
", + "smithy.api#documentation": "Adds a new Model resource to an existing RestApi resource.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/models", @@ -1692,7 +1694,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The RestApi identifier under which the Model will be created.
", + "smithy.api#documentation": "The RestApi identifier under which the Model will be created.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1700,7 +1702,7 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the model. Must be alphanumeric.
", + "smithy.api#documentation": "The name of the model. Must be alphanumeric.
", "smithy.api#required": {} } }, @@ -1713,19 +1715,19 @@ "schema": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The schema for the model. For application/json
models, this should be JSON schema draft 4 model.
The schema for the model. For application/json
models, this should be JSON schema draft 4 model.
[Required] The content-type for the model.
", + "smithy.api#documentation": "The content-type for the model.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to add a new Model to an existing RestApi resource.
" + "smithy.api#documentation": "Request to add a new Model to an existing RestApi resource.
" } }, "com.amazonaws.apigateway#CreateRequestValidator": { @@ -1757,7 +1759,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a ReqeustValidator of a given RestApi.
", + "smithy.api#documentation": "Creates a RequestValidator of a given RestApi.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/requestvalidators", @@ -1771,7 +1773,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1779,7 +1781,7 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The name of the to-be-created RequestValidator.
" + "smithy.api#documentation": "The name of the to-be-created RequestValidator.
" } }, "validateRequestBody": { @@ -1796,7 +1798,7 @@ } }, "traits": { - "smithy.api#documentation": "Creates a RequestValidator of a given RestApi.
" + "smithy.api#documentation": "Creates a RequestValidator of a given RestApi.
" } }, "com.amazonaws.apigateway#CreateResource": { @@ -1828,7 +1830,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Resource resource.
", + "smithy.api#documentation": "Creates a Resource resource.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/resources/{parentId}", @@ -1842,7 +1844,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1850,7 +1852,7 @@ "parentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The parent resource's identifier.
", + "smithy.api#documentation": "The parent resource's identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1864,7 +1866,7 @@ } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to create a Resource resource.
" + "smithy.api#documentation": "Requests API Gateway to create a Resource resource.
" } }, "com.amazonaws.apigateway#CreateRestApi": { @@ -1893,7 +1895,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new RestApi resource.
", + "smithy.api#documentation": "Creates a new RestApi resource.
", "smithy.api#http": { "method": "POST", "uri": "/restapis", @@ -1907,14 +1909,14 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the RestApi.
", + "smithy.api#documentation": "The name of the RestApi.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of the RestApi.
" + "smithy.api#documentation": "The description of the RestApi.
" } }, "version": { @@ -1926,13 +1928,13 @@ "cloneFrom": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The ID of the RestApi that you want to clone from.
" + "smithy.api#documentation": "The ID of the RestApi that you want to clone from.
" } }, "binaryMediaTypes": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
" + "smithy.api#documentation": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
" } }, "minimumCompressionSize": { @@ -1944,19 +1946,19 @@ "apiKeySource": { "target": "com.amazonaws.apigateway#ApiKeySourceType", "traits": { - "smithy.api#documentation": "The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.The source of the API key for metering requests according to a usage plan. Valid values\n are: >HEADER
to read the API key from the X-API-Key
header of a\n request. AUTHORIZER
to read the API key from the UsageIdentifierKey
\n from a custom authorizer.
The endpoint configuration of this RestApi showing the endpoint types of the API.
" + "smithy.api#documentation": "The endpoint configuration of this RestApi showing the endpoint types of the API.
" } }, "policy": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration." + "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
" } }, "tags": { @@ -1968,12 +1970,12 @@ "disableExecuteApiEndpoint": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
Specifies whether clients can invoke your API by using the default execute-api
endpoint.\n By default, clients can invoke your API with the default\n https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a\n custom domain name to invoke your API, disable the default endpoint
The POST Request to add a new RestApi resource to your collection.
" + "smithy.api#documentation": "The POST Request to add a new RestApi resource to your collection.
" } }, "com.amazonaws.apigateway#CreateStage": { @@ -2005,7 +2007,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Stage resource that references a pre-existing Deployment for the API.
\n ", + "smithy.api#documentation": "Creates a new Stage resource that references a pre-existing Deployment for the API.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/stages", @@ -2019,7 +2021,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2027,21 +2029,21 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
", + "smithy.api#documentation": "The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
", "smithy.api#required": {} } }, "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Deployment resource for the Stage resource.
", + "smithy.api#documentation": "The identifier of the Deployment resource for the Stage resource.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of the Stage resource.
" + "smithy.api#documentation": "The description of the Stage resource.
" } }, "cacheClusterEnabled": { @@ -2059,7 +2061,7 @@ "variables": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "A map that defines the stage variables for the new Stage resource. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+
.
A map that defines the stage variables for the new Stage resource. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+
.
Specifies whether active tracing with X-ray is enabled for the Stage.
" + "smithy.api#documentation": "Specifies whether active tracing with X-ray is enabled for the Stage.
" } }, "tags": { @@ -2088,7 +2090,7 @@ } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to create a Stage resource.
" + "smithy.api#documentation": "Requests API Gateway to create a Stage resource.
" } }, "com.amazonaws.apigateway#CreateUsagePlan": { @@ -2171,7 +2173,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
", + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2179,14 +2181,14 @@ "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of a UsagePlanKey resource for a plan customer.
", + "smithy.api#documentation": "The identifier of a UsagePlanKey resource for a plan customer.
", "smithy.api#required": {} } }, "keyType": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The type of a UsagePlanKey resource for a plan customer.
", + "smithy.api#documentation": "The type of a UsagePlanKey resource for a plan customer.
", "smithy.api#required": {} } } @@ -2201,7 +2203,7 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the usage plan.
", + "smithy.api#documentation": "The name of the usage plan.
", "smithy.api#required": {} } }, @@ -2280,7 +2282,7 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name used to label and identify the VPC link.
", + "smithy.api#documentation": "The name used to label and identify the VPC link.
", "smithy.api#required": {} } }, @@ -2293,7 +2295,7 @@ "targetArns": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "[Required] The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
", + "smithy.api#documentation": "The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
", "smithy.api#required": {} } }, @@ -2313,6 +2315,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteApiKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2331,7 +2336,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the ApiKey resource.
", + "smithy.api#documentation": "Deletes the ApiKey resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/apikeys/{apiKey}", @@ -2345,14 +2350,14 @@ "apiKey": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the ApiKey resource to be deleted.
", + "smithy.api#documentation": "The identifier of the ApiKey resource to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A request to delete the ApiKey resource.
" + "smithy.api#documentation": "A request to delete the ApiKey resource.
" } }, "com.amazonaws.apigateway#DeleteAuthorizer": { @@ -2360,6 +2365,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteAuthorizerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2378,7 +2386,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing Authorizer resource.
\n ", + "smithy.api#documentation": "Deletes an existing Authorizer resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", @@ -2392,7 +2400,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2400,14 +2408,14 @@ "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Authorizer resource.
", + "smithy.api#documentation": "The identifier of the Authorizer resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to delete an existing Authorizer resource.
" + "smithy.api#documentation": "Request to delete an existing Authorizer resource.
" } }, "com.amazonaws.apigateway#DeleteBasePathMapping": { @@ -2415,6 +2423,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteBasePathMappingRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2433,7 +2444,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the BasePathMapping resource.
", + "smithy.api#documentation": "Deletes the BasePathMapping resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/domainnames/{domainName}/basepathmappings/{basePath}", @@ -2447,7 +2458,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The domain name of the BasePathMapping resource to delete.
", + "smithy.api#documentation": "The domain name of the BasePathMapping resource to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2455,14 +2466,14 @@ "basePath": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The base path name of the BasePathMapping resource to delete.
\nTo specify an empty base path, set this parameter to '(none)'
.
The base path name of the BasePathMapping resource to delete.
\nTo specify an empty base path, set this parameter to '(none)'
.
A request to delete the BasePathMapping resource.
" + "smithy.api#documentation": "A request to delete the BasePathMapping resource.
" } }, "com.amazonaws.apigateway#DeleteClientCertificate": { @@ -2470,6 +2481,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteClientCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2488,7 +2502,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the ClientCertificate resource.
", + "smithy.api#documentation": "Deletes the ClientCertificate resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/clientcertificates/{clientCertificateId}", @@ -2502,14 +2516,14 @@ "clientCertificateId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the ClientCertificate resource to be deleted.
", + "smithy.api#documentation": "The identifier of the ClientCertificate resource to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A request to delete the ClientCertificate resource.
" + "smithy.api#documentation": "A request to delete the ClientCertificate resource.
" } }, "com.amazonaws.apigateway#DeleteDeployment": { @@ -2517,6 +2531,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteDeploymentRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2538,7 +2555,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
", + "smithy.api#documentation": "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/deployments/{deploymentId}", @@ -2552,7 +2569,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2560,14 +2577,14 @@ "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Deployment resource to delete.
", + "smithy.api#documentation": "The identifier of the Deployment resource to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to delete a Deployment resource.
" + "smithy.api#documentation": "Requests API Gateway to delete a Deployment resource.
" } }, "com.amazonaws.apigateway#DeleteDocumentationPart": { @@ -2575,6 +2592,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteDocumentationPartRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2593,6 +2613,7 @@ } ], "traits": { + "smithy.api#documentation": "Deletes a documentation part
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/documentation/parts/{documentationPartId}", @@ -2606,7 +2627,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2614,7 +2635,7 @@ "documentationPartId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the to-be-deleted documentation part.
", + "smithy.api#documentation": "The identifier of the to-be-deleted documentation part.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2629,6 +2650,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteDocumentationVersionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2647,6 +2671,7 @@ } ], "traits": { + "smithy.api#documentation": "Deletes a documentation version.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/documentation/versions/{documentationVersion}", @@ -2660,7 +2685,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2668,7 +2693,7 @@ "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The version identifier of a to-be-deleted documentation snapshot.
", + "smithy.api#documentation": "The version identifier of a to-be-deleted documentation snapshot.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2683,6 +2708,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteDomainNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2701,7 +2729,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the DomainName resource.
", + "smithy.api#documentation": "Deletes the DomainName resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/domainnames/{domainName}", @@ -2715,14 +2743,14 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the DomainName resource to be deleted.
", + "smithy.api#documentation": "The name of the DomainName resource to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A request to delete the DomainName resource.
" + "smithy.api#documentation": "A request to delete the DomainName resource.
" } }, "com.amazonaws.apigateway#DeleteGatewayResponse": { @@ -2730,6 +2758,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteGatewayResponseRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2748,7 +2779,7 @@ } ], "traits": { - "smithy.api#documentation": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
", + "smithy.api#documentation": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", @@ -2762,7 +2793,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2770,14 +2801,14 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "[Required]
The response type of the associated GatewayResponse.
", + "smithy.api#documentation": "The response type of the associated GatewayResponse.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
" + "smithy.api#documentation": "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
" } }, "com.amazonaws.apigateway#DeleteIntegration": { @@ -2785,6 +2816,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteIntegrationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2817,7 +2851,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2825,7 +2859,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a delete integration request's resource identifier.
", + "smithy.api#documentation": "Specifies a delete integration request's resource identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2833,7 +2867,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a delete integration request's HTTP method.
", + "smithy.api#documentation": "Specifies a delete integration request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2848,6 +2882,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteIntegrationResponseRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2880,7 +2917,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2888,7 +2925,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a delete integration response request's resource identifier.
", + "smithy.api#documentation": "Specifies a delete integration response request's resource identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2896,7 +2933,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a delete integration response request's HTTP method.
", + "smithy.api#documentation": "Specifies a delete integration response request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2904,7 +2941,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] Specifies a delete integration response request's status code.
", + "smithy.api#documentation": "Specifies a delete integration response request's status code.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2919,6 +2956,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteMethodRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#ConflictException" @@ -2934,7 +2974,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing Method resource.
", + "smithy.api#documentation": "Deletes an existing Method resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", @@ -2948,7 +2988,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2956,7 +2996,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the Method resource.
", + "smithy.api#documentation": "The Resource identifier for the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2964,14 +3004,14 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The HTTP verb of the Method resource.
", + "smithy.api#documentation": "The HTTP verb of the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to delete an existing Method resource.
" + "smithy.api#documentation": "Request to delete an existing Method resource.
" } }, "com.amazonaws.apigateway#DeleteMethodResponse": { @@ -2979,6 +3019,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteMethodResponseRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -2997,7 +3040,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing MethodResponse resource.
", + "smithy.api#documentation": "Deletes an existing MethodResponse resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", @@ -3011,7 +3054,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3019,7 +3062,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the MethodResponse resource.
", + "smithy.api#documentation": "The Resource identifier for the MethodResponse resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3027,7 +3070,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The HTTP verb of the Method resource.
", + "smithy.api#documentation": "The HTTP verb of the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3035,14 +3078,14 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] The status code identifier for the MethodResponse resource.
", + "smithy.api#documentation": "The status code identifier for the MethodResponse resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A request to delete an existing MethodResponse resource.
" + "smithy.api#documentation": "A request to delete an existing MethodResponse resource.
" } }, "com.amazonaws.apigateway#DeleteModel": { @@ -3050,6 +3093,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteModelRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3082,7 +3128,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3090,14 +3136,14 @@ "modelName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the model to delete.
", + "smithy.api#documentation": "The name of the model to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to delete an existing model in an existing RestApi resource.
" + "smithy.api#documentation": "Request to delete an existing model in an existing RestApi resource.
" } }, "com.amazonaws.apigateway#DeleteRequestValidator": { @@ -3105,6 +3151,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteRequestValidatorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3123,7 +3172,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a RequestValidator of a given RestApi.
", + "smithy.api#documentation": "Deletes a RequestValidator of a given RestApi.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/requestvalidators/{requestValidatorId}", @@ -3137,7 +3186,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3145,14 +3194,14 @@ "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the RequestValidator to be deleted.
", + "smithy.api#documentation": "The identifier of the RequestValidator to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Deletes a specified RequestValidator of a given RestApi.
" + "smithy.api#documentation": "Deletes a specified RequestValidator of a given RestApi.
" } }, "com.amazonaws.apigateway#DeleteResource": { @@ -3160,6 +3209,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3178,7 +3230,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Resource resource.
", + "smithy.api#documentation": "Deletes a Resource resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/resources/{resourceId}", @@ -3192,7 +3244,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3200,14 +3252,14 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Resource resource.
", + "smithy.api#documentation": "The identifier of the Resource resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to delete a Resource.
" + "smithy.api#documentation": "Request to delete a Resource.
" } }, "com.amazonaws.apigateway#DeleteRestApi": { @@ -3215,6 +3267,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteRestApiRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3247,7 +3302,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3262,6 +3317,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteStageRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3283,7 +3341,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a Stage resource.
", + "smithy.api#documentation": "Deletes a Stage resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/restapis/{restApiId}/stages/{stageName}", @@ -3297,7 +3355,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3305,14 +3363,14 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the Stage resource to delete.
", + "smithy.api#documentation": "The name of the Stage resource to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to delete a Stage resource.
" + "smithy.api#documentation": "Requests API Gateway to delete a Stage resource.
" } }, "com.amazonaws.apigateway#DeleteUsagePlan": { @@ -3320,6 +3378,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteUsagePlanRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3351,6 +3412,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteUsagePlanKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3383,7 +3447,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
", + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3391,7 +3455,7 @@ "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the UsagePlanKey resource to be deleted.
", + "smithy.api#documentation": "The Id of the UsagePlanKey resource to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3407,7 +3471,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the to-be-deleted usage plan.
", + "smithy.api#documentation": "The Id of the to-be-deleted usage plan.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3422,6 +3486,9 @@ "input": { "target": "com.amazonaws.apigateway#DeleteVpcLinkRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -3440,7 +3507,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing VpcLink of a specified identifier.
", + "smithy.api#documentation": "Deletes an existing VpcLink of a specified identifier.
", "smithy.api#http": { "method": "DELETE", "uri": "/vpclinks/{vpcLinkId}", @@ -3454,14 +3521,14 @@ "vpcLinkId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Deletes an existing VpcLink of a specified identifier.
" + "smithy.api#documentation": "Deletes an existing VpcLink of a specified identifier.
" } }, "com.amazonaws.apigateway#Deployment": { @@ -3488,12 +3555,12 @@ "apiSummary": { "target": "com.amazonaws.apigateway#PathToMapOfMethodSnapshot", "traits": { - "smithy.api#documentation": "A summary of the RestApi at the date and time that the deployment resource was created.
" + "smithy.api#documentation": "A summary of the RestApi at the date and time that the deployment resource was created.
" } } }, "traits": { - "smithy.api#documentation": "An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
\nPOST
on the Deployments resource of a RestApi.\n To view, update, or delete a deployment, call GET
, PATCH
, or DELETE
on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}
).An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
" } }, "com.amazonaws.apigateway#DeploymentCanarySettings": { @@ -3541,7 +3608,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
\nPOST
request against this resource. To view, update, or delete an existing\n deployment, make a GET
, PATCH
, or DELETE
request, respectively, on a specified Deployment resource.Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
" } }, "com.amazonaws.apigateway#DocumentationPart": { @@ -3550,7 +3617,7 @@ "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The DocumentationPart identifier, generated by API Gateway when the DocumentationPart
is created.
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart
is created.
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., \"{ \\\"description\\\": \\\"The API does ...\\\" }\"
. Only OpenAPI-compliant documentation-related fields from the x-amazon-apigateway-documentation
.
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., \"{ \\\"description\\\": \\\"The API does ...\\\" }\"
. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation
.
A documentation part for a targeted API entity.
\nA documentation part consists of a content map (properties
) and a target (location
). The target specifies an API entity to which the documentation content applies. The supported API entity types are API
, AUTHORIZER
, MODEL
, RESOURCE
, METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. Valid location
fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
A documentation part for a targeted API entity.
" } }, "com.amazonaws.apigateway#DocumentationPartIds": { @@ -3587,7 +3654,7 @@ } }, "traits": { - "smithy.api#documentation": "A collection of the imported DocumentationPart identifiers.
\nA collection of the imported DocumentationPart identifiers.
" } }, "com.amazonaws.apigateway#DocumentationPartLocation": { @@ -3596,7 +3663,7 @@ "type": { "target": "com.amazonaws.apigateway#DocumentationPartType", "traits": { - "smithy.api#documentation": "[Required] The type of API entity to which the documentation content applies. Valid values are API
, AUTHORIZER
, MODEL
, RESOURCE
, METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. Content inheritance does not apply to any entity of the API
, AUTHORIZER
, METHOD
, MODEL
, REQUEST_BODY
, or RESOURCE
type.
The type of API entity to which the documentation content applies. Valid values are API
, AUTHORIZER
, MODEL
, RESOURCE
, METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. Content inheritance does not apply to any entity of the API
, AUTHORIZER
, METHOD
, MODEL
, REQUEST_BODY
, or RESOURCE
type.
The collection of documentation parts of an API.
\n \n " + "smithy.api#documentation": "The collection of documentation parts of an API.
" } }, "com.amazonaws.apigateway#DocumentationVersion": { @@ -3735,7 +3802,7 @@ } }, "traits": { - "smithy.api#documentation": "A snapshot of the documentation of an API.
\nPublishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.
A snapshot of the documentation of an API.
" } }, "com.amazonaws.apigateway#DocumentationVersions": { @@ -3757,7 +3824,7 @@ } }, "traits": { - "smithy.api#documentation": "The collection of documentation snapshots of an API.
\nUse the DocumentationVersions to manage documentation snapshots associated with various API stages.
The collection of documentation snapshots of an API.
" } }, "com.amazonaws.apigateway#DomainName": { @@ -3796,7 +3863,7 @@ "regionalHostedZoneId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
" + "smithy.api#documentation": "The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
" } }, "regionalCertificateName": { @@ -3814,37 +3881,37 @@ "distributionDomainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
" + "smithy.api#documentation": "The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
" } }, "distributionHostedZoneId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
" + "smithy.api#documentation": "The endpoint configuration of this DomainName showing the endpoint types of the domain name.
" } }, "domainNameStatus": { "target": "com.amazonaws.apigateway#DomainNameStatus", "traits": { - "smithy.api#documentation": "The status of the DomainName migration. The valid values are AVAILABLE
, UPDATING
, PENDING_CERTIFICATE_REIMPORT
, and PENDING_OWNERSHIP_VERIFICATION
. If the status is UPDATING
, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE
, the domain can be updated.
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING
. If the status is UPDATING
, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE
, the domain can be updated.
An optional text message containing detailed information about status of the DomainName migration.
" + "smithy.api#documentation": "An optional text message containing detailed information about status of the DomainName migration.
" } }, "securityPolicy": { "target": "com.amazonaws.apigateway#SecurityPolicy", "traits": { - "smithy.api#documentation": "The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0
and TLS_1_2
.
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0
and TLS_1_2
.
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
" + "smithy.api#documentation": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\n performs two-way authentication between the client and the server. Clients must present a\n trusted certificate to access your API.
" } }, "ownershipVerificationCertificateArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
" + "smithy.api#documentation": "The ARN of the public certificate issued by ACM to validate ownership of your custom\n domain. Only required when configuring mutual TLS and using an ACM imported or private CA\n certificate ARN as the regionalCertificateArn.
" } } }, "traits": { - "smithy.api#documentation": "Represents a custom domain name as a user-friendly host name of an API (RestApi).
\nWhen you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com
format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/
. When you set up a custom domain name of apis.example.com
for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi
, where myApi
is the base path mapping (BasePathMapping) of your API under the custom domain name.\n
Represents a custom domain name as a user-friendly host name of an API (RestApi).
" } }, "com.amazonaws.apigateway#DomainNameStatus": { @@ -3916,7 +3983,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of DomainName resources.
\n " + "smithy.api#documentation": "Represents a collection of DomainName resources.
" } }, "com.amazonaws.apigateway#Double": { @@ -3928,18 +3995,18 @@ "types": { "target": "com.amazonaws.apigateway#ListOfEndpointType", "traits": { - "smithy.api#documentation": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is \"EDGE\"
. For a regional API and its custom domain name, the endpoint type is REGIONAL
. For a private API, the endpoint type is PRIVATE
.
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is \"EDGE\"
. For a regional API and its custom domain name, the endpoint type is REGIONAL
. For a private API, the endpoint type is PRIVATE
.
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE
endpoint type.
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE
endpoint type.
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
" + "smithy.api#documentation": "The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
" } }, "com.amazonaws.apigateway#EndpointType": { @@ -3982,13 +4049,13 @@ "body": { "target": "com.amazonaws.apigateway#Blob", "traits": { - "smithy.api#documentation": "The binary blob response to GetExport, which contains the export.
", + "smithy.api#documentation": "The binary blob response to GetExport, which contains the export.
", "smithy.api#httpPayload": {} } } }, "traits": { - "smithy.api#documentation": "The binary blob response to GetExport, which contains the generated SDK.
" + "smithy.api#documentation": "The binary blob response to GetExport, which contains the generated SDK.
" } }, "com.amazonaws.apigateway#FlushStageAuthorizersCache": { @@ -3996,6 +4063,9 @@ "input": { "target": "com.amazonaws.apigateway#FlushStageAuthorizersCacheRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -4031,7 +4101,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4054,6 +4124,9 @@ "input": { "target": "com.amazonaws.apigateway#FlushStageCacheRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -4089,7 +4162,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4097,7 +4170,7 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the stage to flush its cache.
", + "smithy.api#documentation": "The name of the stage to flush its cache.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4113,36 +4186,36 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "The response type of the associated GatewayResponse.
" + "smithy.api#documentation": "The response type of the associated GatewayResponse.
" } }, "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "The HTTP status code for this GatewayResponse.
" + "smithy.api#documentation": "The HTTP status code for this GatewayResponse.
" } }, "responseParameters": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
" + "smithy.api#documentation": "Response parameters (paths, query strings and headers) of the GatewayResponse as a\n string-to-string map of key-value pairs.
" } }, "responseTemplates": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" + "smithy.api#documentation": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" } }, "defaultResponse": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
\nThis example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN
type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1\nHost: beta-apigateway.us-east-1.amazonaws.com\nContent-Type: application/json\nX-Amz-Date: 20170503T202516Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a\nCache-Control: no-cache\nPostman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45\n
\n The response type is specified as a URL path.
\nThe successful operation returns the 200 OK
status code and a payload similar to the following:
{\n \"_links\": {\n \"curies\": {\n \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\",\n \"name\": \"gatewayresponse\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n },\n \"gatewayresponse:delete\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n }\n },\n \"defaultResponse\": false,\n \"responseParameters\": {\n \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\",\n \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\",\n \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\",\n \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\"\n },\n \"responseTemplates\": {\n \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\"\n },\n \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\",\n \"statusCode\": \"404\"\n}
\n \n A gateway response of a given response type and status code, with optional response parameters and mapping templates.
" } }, "com.amazonaws.apigateway#GatewayResponseType": { @@ -4249,13 +4322,13 @@ "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", + "smithy.api#documentation": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", "smithy.api#httpQuery": "position" } } }, "traits": { - "smithy.api#documentation": "The collection of the GatewayResponse instances of a RestApi as a responseType
-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
This example request shows how to retrieve the GatewayResponses collection from an API.
\nGET /restapis/o81lxisefl/gatewayresponses HTTP/1.1\nHost: beta-apigateway.us-east-1.amazonaws.com\nContent-Type: application/json\nX-Amz-Date: 20170503T220604Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a\nCache-Control: no-cache\nPostman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515\n
\n \n The successful operation returns the 200 OK
status code and a payload similar to the following:
{\n \"_links\": {\n \"curies\": {\n \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\",\n \"name\": \"gatewayresponse\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses\"\n },\n \"first\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses\"\n },\n \"gatewayresponse:by-type\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"item\": [\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\"\n },\n {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\"\n }\n ]\n },\n \"_embedded\": {\n \"item\": [\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"INTEGRATION_FAILURE\",\n \"statusCode\": \"504\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"RESOURCE_NOT_FOUND\",\n \"statusCode\": \"404\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"REQUEST_TOO_LARGE\",\n \"statusCode\": \"413\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"THROTTLED\",\n \"statusCode\": \"429\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"UNSUPPORTED_MEDIA_TYPE\",\n \"statusCode\": \"415\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"AUTHORIZER_CONFIGURATION_ERROR\",\n \"statusCode\": \"500\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"DEFAULT_5XX\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"DEFAULT_4XX\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"BAD_REQUEST_PARAMETERS\",\n \"statusCode\": \"400\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"BAD_REQUEST_BODY\",\n \"statusCode\": \"400\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"EXPIRED_TOKEN\",\n \"statusCode\": \"403\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"ACCESS_DENIED\",\n \"statusCode\": \"403\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"INVALID_API_KEY\",\n \"statusCode\": \"403\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"UNAUTHORIZED\",\n \"statusCode\": \"401\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"API_CONFIGURATION_ERROR\",\n \"statusCode\": \"500\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"QUOTA_EXCEEDED\",\n \"statusCode\": \"429\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"INTEGRATION_TIMEOUT\",\n \"statusCode\": \"504\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\",\n \"statusCode\": \"403\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"INVALID_SIGNATURE\",\n \"statusCode\": \"403\"\n },\n {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\"\n },\n \"gatewayresponse:put\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\",\n \"templated\": true\n },\n \"gatewayresponse:update\": {\n \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\"\n }\n },\n \"defaultResponse\": true,\n \"responseParameters\": {},\n \"responseTemplates\": {\n \"application/json\": \"{\\\"message\\\":$context.error.messageString}\"\n },\n \"responseType\": \"AUTHORIZER_FAILURE\",\n \"statusCode\": \"500\"\n }\n ]\n }\n}
\n \n The collection of the GatewayResponse instances of a RestApi as a responseType
-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
Generates a ClientCertificate resource.
", + "smithy.api#documentation": "Generates a ClientCertificate resource.
", "smithy.api#http": { "method": "POST", "uri": "/clientcertificates", @@ -4298,7 +4371,7 @@ "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of the ClientCertificate.
" + "smithy.api#documentation": "The description of the ClientCertificate.
" } }, "tags": { @@ -4309,7 +4382,7 @@ } }, "traits": { - "smithy.api#documentation": "A request to generate a ClientCertificate resource.
" + "smithy.api#documentation": "A request to generate a ClientCertificate resource.
" } }, "com.amazonaws.apigateway#GetAccount": { @@ -4335,7 +4408,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the current Account resource.
", + "smithy.api#documentation": "Gets information about the current Account resource.
", "smithy.api#http": { "method": "GET", "uri": "/account", @@ -4347,7 +4420,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Requests API Gateway to get information about the current Account resource.
" + "smithy.api#documentation": "Requests API Gateway to get information about the current Account resource.
" } }, "com.amazonaws.apigateway#GetApiKey": { @@ -4373,7 +4446,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the current ApiKey resource.
", + "smithy.api#documentation": "Gets information about the current ApiKey resource.
", "smithy.api#http": { "method": "GET", "uri": "/apikeys/{apiKey}", @@ -4387,7 +4460,7 @@ "apiKey": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the ApiKey resource.
", + "smithy.api#documentation": "The identifier of the ApiKey resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4401,7 +4474,7 @@ } }, "traits": { - "smithy.api#documentation": "A request to get information about the current ApiKey resource.
" + "smithy.api#documentation": "A request to get information about the current ApiKey resource.
" } }, "com.amazonaws.apigateway#GetApiKeys": { @@ -4427,7 +4500,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the current ApiKeys resource.
", + "smithy.api#documentation": "Gets information about the current ApiKeys resource.
", "smithy.api#http": { "method": "GET", "uri": "/apikeys", @@ -4481,7 +4554,7 @@ } }, "traits": { - "smithy.api#documentation": "A request to get information about the current ApiKeys resource.
" + "smithy.api#documentation": "A request to get information about the current ApiKeys resource.
" } }, "com.amazonaws.apigateway#GetAuthorizer": { @@ -4507,7 +4580,7 @@ } ], "traits": { - "smithy.api#documentation": "Describe an existing Authorizer resource.
\n ", + "smithy.api#documentation": "Describe an existing Authorizer resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", @@ -4521,7 +4594,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4529,14 +4602,14 @@ "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Authorizer resource.
", + "smithy.api#documentation": "The identifier of the Authorizer resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to describe an existing Authorizer resource.
" + "smithy.api#documentation": "Request to describe an existing Authorizer resource.
" } }, "com.amazonaws.apigateway#GetAuthorizers": { @@ -4562,7 +4635,7 @@ } ], "traits": { - "smithy.api#documentation": "Describe an existing Authorizers resource.
\n ", + "smithy.api#documentation": "Describe an existing Authorizers resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/authorizers", @@ -4576,7 +4649,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4597,7 +4670,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to describe an existing Authorizers resource.
" + "smithy.api#documentation": "Request to describe an existing Authorizers resource.
" } }, "com.amazonaws.apigateway#GetBasePathMapping": { @@ -4623,7 +4696,7 @@ } ], "traits": { - "smithy.api#documentation": "Describe a BasePathMapping resource.
", + "smithy.api#documentation": "Describe a BasePathMapping resource.
", "smithy.api#http": { "method": "GET", "uri": "/domainnames/{domainName}/basepathmappings/{basePath}", @@ -4637,7 +4710,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The domain name of the BasePathMapping resource to be described.
", + "smithy.api#documentation": "The domain name of the BasePathMapping resource to be described.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4645,14 +4718,14 @@ "basePath": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
", + "smithy.api#documentation": "The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to describe a BasePathMapping resource.
" + "smithy.api#documentation": "Request to describe a BasePathMapping resource.
" } }, "com.amazonaws.apigateway#GetBasePathMappings": { @@ -4678,7 +4751,7 @@ } ], "traits": { - "smithy.api#documentation": "Represents a collection of BasePathMapping resources.
", + "smithy.api#documentation": "Represents a collection of BasePathMapping resources.
", "smithy.api#http": { "method": "GET", "uri": "/domainnames/{domainName}/basepathmappings", @@ -4698,7 +4771,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The domain name of a BasePathMapping resource.
", + "smithy.api#documentation": "The domain name of a BasePathMapping resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4719,7 +4792,7 @@ } }, "traits": { - "smithy.api#documentation": "A request to get information about a collection of BasePathMapping resources.
" + "smithy.api#documentation": "A request to get information about a collection of BasePathMapping resources.
" } }, "com.amazonaws.apigateway#GetClientCertificate": { @@ -4745,7 +4818,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the current ClientCertificate resource.
", + "smithy.api#documentation": "Gets information about the current ClientCertificate resource.
", "smithy.api#http": { "method": "GET", "uri": "/clientcertificates/{clientCertificateId}", @@ -4759,14 +4832,14 @@ "clientCertificateId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the ClientCertificate resource to be described.
", + "smithy.api#documentation": "The identifier of the ClientCertificate resource to be described.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A request to get information about the current ClientCertificate resource.
" + "smithy.api#documentation": "A request to get information about the current ClientCertificate resource.
" } }, "com.amazonaws.apigateway#GetClientCertificates": { @@ -4792,7 +4865,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a collection of ClientCertificate resources.
", + "smithy.api#documentation": "Gets a collection of ClientCertificate resources.
", "smithy.api#http": { "method": "GET", "uri": "/clientcertificates", @@ -4825,7 +4898,7 @@ } }, "traits": { - "smithy.api#documentation": "A request to get information about a collection of ClientCertificate resources.
" + "smithy.api#documentation": "A request to get information about a collection of ClientCertificate resources.
" } }, "com.amazonaws.apigateway#GetDeployment": { @@ -4854,7 +4927,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Deployment resource.
", + "smithy.api#documentation": "Gets information about a Deployment resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/deployments/{deploymentId}", @@ -4868,7 +4941,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4876,7 +4949,7 @@ "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Deployment resource to get information about.
", + "smithy.api#documentation": "The identifier of the Deployment resource to get information about.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4884,13 +4957,13 @@ "embed": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed
parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2
. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the \"apisummary\"
string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary
.
A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed
parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2
. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the \"apisummary\"
string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary
.
Requests API Gateway to get information about a Deployment resource.
" + "smithy.api#documentation": "Requests API Gateway to get information about a Deployment resource.
" } }, "com.amazonaws.apigateway#GetDeployments": { @@ -4919,7 +4992,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Deployments collection.
", + "smithy.api#documentation": "Gets information about a Deployments collection.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/deployments", @@ -4939,7 +5012,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4960,7 +5033,7 @@ } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to get information about a Deployments collection.
" + "smithy.api#documentation": "Requests API Gateway to get information about a Deployments collection.
" } }, "com.amazonaws.apigateway#GetDocumentationPart": { @@ -4986,6 +5059,7 @@ } ], "traits": { + "smithy.api#documentation": "Gets a documentation part.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/documentation/parts/{documentationPartId}", @@ -4999,7 +5073,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5007,7 +5081,7 @@ "documentationPartId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5040,6 +5114,7 @@ } ], "traits": { + "smithy.api#documentation": "Gets documentation parts.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/documentation/parts", @@ -5053,7 +5128,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5096,7 +5171,7 @@ "locationStatus": { "target": "com.amazonaws.apigateway#LocationStatusType", "traits": { - "smithy.api#documentation": "The status of the API documentation parts to retrieve. Valid values are DOCUMENTED
for retrieving DocumentationPart resources with content and UNDOCUMENTED
for DocumentationPart resources without content.
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED
for retrieving DocumentationPart resources with content and UNDOCUMENTED
for DocumentationPart resources without content.
Gets a documentation version.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/documentation/versions/{documentationVersion}", @@ -5138,7 +5214,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5146,7 +5222,7 @@ "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The version identifier of the to-be-retrieved documentation snapshot.
", + "smithy.api#documentation": "The version identifier of the to-be-retrieved documentation snapshot.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5179,6 +5255,7 @@ } ], "traits": { + "smithy.api#documentation": "Gets documentation versions.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/documentation/versions", @@ -5192,7 +5269,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5253,14 +5330,14 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the DomainName resource.
", + "smithy.api#documentation": "The name of the DomainName resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to get the name of a DomainName resource.
" + "smithy.api#documentation": "Request to get the name of a DomainName resource.
" } }, "com.amazonaws.apigateway#GetDomainNames": { @@ -5286,7 +5363,7 @@ } ], "traits": { - "smithy.api#documentation": "Represents a collection of DomainName resources.
", + "smithy.api#documentation": "Represents a collection of DomainName resources.
", "smithy.api#http": { "method": "GET", "uri": "/domainnames", @@ -5319,7 +5396,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to describe a collection of DomainName resources.
" + "smithy.api#documentation": "Request to describe a collection of DomainName resources.
" } }, "com.amazonaws.apigateway#GetExport": { @@ -5351,7 +5428,7 @@ } ], "traits": { - "smithy.api#documentation": "Exports a deployed version of a RestApi in a specified format.
", + "smithy.api#documentation": "Exports a deployed version of a RestApi in a specified format.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/stages/{stageName}/exports/{exportType}", @@ -5365,7 +5442,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5373,7 +5450,7 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the Stage that will be exported.
", + "smithy.api#documentation": "The name of the Stage that will be exported.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5381,7 +5458,7 @@ "exportType": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
", + "smithy.api#documentation": "The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5389,7 +5466,7 @@ "parameters": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "A key-value map of query string parameters that specify properties of the export, depending on the requested exportType
. For exportType
oas30
and swagger
, any combination of the following parameters are supported: extensions='integrations'
or extensions='apigateway'
will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers'
will export the API with x-amazon-apigateway-authorizer extensions. postman
will export the API with Postman extensions, allowing for import to the Postman tool
A key-value map of query string parameters that specify properties of the export, depending on the requested exportType
. For exportType
\n oas30
and swagger
, any combination of the following parameters are supported: extensions='integrations'
or extensions='apigateway'
will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers'
will export the API with x-amazon-apigateway-authorizer extensions. postman
will export the API with Postman extensions, allowing for import to the Postman tool
Request a new export of a RestApi for a particular Stage.
" + "smithy.api#documentation": "Request a new export of a RestApi for a particular Stage.
" } }, "com.amazonaws.apigateway#GetGatewayResponse": { @@ -5428,7 +5505,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a GatewayResponse of a specified response type on the given RestApi.
", + "smithy.api#documentation": "Gets a GatewayResponse of a specified response type on the given RestApi.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", @@ -5442,7 +5519,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5450,14 +5527,14 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "[Required]
The response type of the associated GatewayResponse.
", + "smithy.api#documentation": "The response type of the associated GatewayResponse.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Gets a GatewayResponse of a specified response type on the given RestApi.
" + "smithy.api#documentation": "Gets a GatewayResponse of a specified response type on the given RestApi.
" } }, "com.amazonaws.apigateway#GetGatewayResponses": { @@ -5483,7 +5560,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
", + "smithy.api#documentation": "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/gatewayresponses", @@ -5497,7 +5574,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5505,20 +5582,20 @@ "position": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", + "smithy.api#documentation": "The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
", "smithy.api#httpQuery": "position" } }, "limit": { "target": "com.amazonaws.apigateway#NullableInteger", "traits": { - "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
", + "smithy.api#documentation": "The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
", "smithy.api#httpQuery": "limit" } } }, "traits": { - "smithy.api#documentation": "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
" + "smithy.api#documentation": "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
" } }, "com.amazonaws.apigateway#GetIntegration": { @@ -5558,7 +5635,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5566,7 +5643,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a get integration request's resource identifier
", + "smithy.api#documentation": "Specifies a get integration request's resource identifier
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5574,7 +5651,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a get integration request's HTTP method.
", + "smithy.api#documentation": "Specifies a get integration request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5621,7 +5698,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5629,7 +5706,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a get integration response request's resource identifier.
", + "smithy.api#documentation": "Specifies a get integration response request's resource identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5637,7 +5714,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a get integration response request's HTTP method.
", + "smithy.api#documentation": "Specifies a get integration response request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5645,7 +5722,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] Specifies a get integration response request's status code.
", + "smithy.api#documentation": "Specifies a get integration response request's status code.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5675,7 +5752,7 @@ } ], "traits": { - "smithy.api#documentation": "Describe an existing Method resource.
", + "smithy.api#documentation": "Describe an existing Method resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", @@ -5689,7 +5766,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5697,7 +5774,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the Method resource.
", + "smithy.api#documentation": "The Resource identifier for the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5705,14 +5782,14 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies the method request's HTTP method type.
", + "smithy.api#documentation": "Specifies the method request's HTTP method type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to describe an existing Method resource.
" + "smithy.api#documentation": "Request to describe an existing Method resource.
" } }, "com.amazonaws.apigateway#GetMethodResponse": { @@ -5735,7 +5812,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a MethodResponse resource.
", + "smithy.api#documentation": "Describes a MethodResponse resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", @@ -5749,7 +5826,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5757,7 +5834,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the MethodResponse resource.
", + "smithy.api#documentation": "The Resource identifier for the MethodResponse resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5765,7 +5842,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The HTTP verb of the Method resource.
", + "smithy.api#documentation": "The HTTP verb of the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5773,14 +5850,14 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] The status code for the MethodResponse resource.
", + "smithy.api#documentation": "The status code for the MethodResponse resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request to describe a MethodResponse resource.
" + "smithy.api#documentation": "Request to describe a MethodResponse resource.
" } }, "com.amazonaws.apigateway#GetModel": { @@ -5806,7 +5883,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing model defined for a RestApi resource.
", + "smithy.api#documentation": "Describes an existing model defined for a RestApi resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/models/{modelName}", @@ -5820,7 +5897,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The RestApi identifier under which the Model exists.
", + "smithy.api#documentation": "The RestApi identifier under which the Model exists.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5828,7 +5905,7 @@ "modelName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the model as an identifier.
", + "smithy.api#documentation": "The name of the model as an identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5842,7 +5919,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to list information about a model in an existing RestApi resource.
" + "smithy.api#documentation": "Request to list information about a model in an existing RestApi resource.
" } }, "com.amazonaws.apigateway#GetModelTemplate": { @@ -5882,7 +5959,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5890,7 +5967,7 @@ "modelName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the model for which to generate a template.
", + "smithy.api#documentation": "The name of the model for which to generate a template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5923,7 +6000,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes existing Models defined for a RestApi resource.
", + "smithy.api#documentation": "Describes existing Models defined for a RestApi resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/models", @@ -5943,7 +6020,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5964,7 +6041,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to list existing Models defined for a RestApi resource.
" + "smithy.api#documentation": "Request to list existing Models defined for a RestApi resource.
" } }, "com.amazonaws.apigateway#GetRequestValidator": { @@ -5990,7 +6067,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a RequestValidator of a given RestApi.
", + "smithy.api#documentation": "Gets a RequestValidator of a given RestApi.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/requestvalidators/{requestValidatorId}", @@ -6004,7 +6081,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6012,14 +6089,14 @@ "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the RequestValidator to be retrieved.
", + "smithy.api#documentation": "The identifier of the RequestValidator to be retrieved.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Gets a RequestValidator of a given RestApi.
" + "smithy.api#documentation": "Gets a RequestValidator of a given RestApi.
" } }, "com.amazonaws.apigateway#GetRequestValidators": { @@ -6045,7 +6122,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the RequestValidators collection of a given RestApi.
", + "smithy.api#documentation": "Gets the RequestValidators collection of a given RestApi.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/requestvalidators", @@ -6059,7 +6136,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6080,7 +6157,7 @@ } }, "traits": { - "smithy.api#documentation": "Gets the RequestValidators collection of a given RestApi.
" + "smithy.api#documentation": "Gets the RequestValidators collection of a given RestApi.
" } }, "com.amazonaws.apigateway#GetResource": { @@ -6117,7 +6194,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6125,7 +6202,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier for the Resource resource.
", + "smithy.api#documentation": "The identifier for the Resource resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6133,7 +6210,7 @@ "embed": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\"
string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods
.
A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\"
string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods
.
Lists information about a collection of Resource resources.
", + "smithy.api#documentation": "Lists information about a collection of Resource resources.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/resources", @@ -6185,7 +6262,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6207,7 +6284,7 @@ "embed": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\"
string. For example, GET /restapis/{restapi_id}/resources?embed=methods
.
A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed
parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\"
string. For example, GET /restapis/{restapi_id}/resources?embed=methods
.
Lists the RestApi resource in the collection.
", + "smithy.api#documentation": "Lists the RestApi resource in the collection.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}", @@ -6253,14 +6330,14 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The GET request to list an existing RestApi defined for your collection.
" + "smithy.api#documentation": "The GET request to list an existing RestApi defined for your collection.
" } }, "com.amazonaws.apigateway#GetRestApis": { @@ -6286,7 +6363,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the RestApis resources for your collection.
", + "smithy.api#documentation": "Lists the RestApis resources for your collection.
", "smithy.api#http": { "method": "GET", "uri": "/restapis", @@ -6319,7 +6396,7 @@ } }, "traits": { - "smithy.api#documentation": "The GET request to list existing RestApis defined for your collection.
" + "smithy.api#documentation": "The GET request to list existing RestApis defined for your collection.
" } }, "com.amazonaws.apigateway#GetSdk": { @@ -6351,7 +6428,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates a client SDK for a RestApi and Stage.
", + "smithy.api#documentation": "Generates a client SDK for a RestApi and Stage.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/stages/{stageName}/sdks/{sdkType}", @@ -6365,7 +6442,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6373,7 +6450,7 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the Stage that the SDK will use.
", + "smithy.api#documentation": "The name of the Stage that the SDK will use.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6381,7 +6458,7 @@ "sdkType": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The language for the generated SDK. Currently java
, javascript
, android
, objectivec
(for iOS), swift
(for iOS), and ruby
are supported.
The language for the generated SDK. Currently java
, javascript
, android
, objectivec
(for iOS), swift
(for iOS), and ruby
are supported.
Request a new generated client SDK for a RestApi and Stage.
" + "smithy.api#documentation": "Request a new generated client SDK for a RestApi and Stage.
" } }, "com.amazonaws.apigateway#GetSdkType": { @@ -6421,6 +6498,7 @@ } ], "traits": { + "smithy.api#documentation": "Gets an SDK type.
", "smithy.api#http": { "method": "GET", "uri": "/sdktypes/{id}", @@ -6434,14 +6512,14 @@ "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the queried SdkType instance.
", + "smithy.api#documentation": "The identifier of the queried SdkType instance.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get an SdkType instance.
" + "smithy.api#documentation": "Get an SdkType instance.
" } }, "com.amazonaws.apigateway#GetSdkTypes": { @@ -6467,6 +6545,7 @@ } ], "traits": { + "smithy.api#documentation": "Gets SDK types
", "smithy.api#http": { "method": "GET", "uri": "/sdktypes", @@ -6493,7 +6572,7 @@ } }, "traits": { - "smithy.api#documentation": "Get the SdkTypes collection.
" + "smithy.api#documentation": "Get the SdkTypes collection.
" } }, "com.amazonaws.apigateway#GetStage": { @@ -6525,7 +6604,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a Stage resource.
", + "smithy.api#documentation": "Gets information about a Stage resource.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/stages/{stageName}", @@ -6539,7 +6618,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6547,14 +6626,14 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the Stage resource to get information about.
", + "smithy.api#documentation": "The name of the Stage resource to get information about.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to get information about a Stage resource.
" + "smithy.api#documentation": "Requests API Gateway to get information about a Stage resource.
" } }, "com.amazonaws.apigateway#GetStages": { @@ -6586,7 +6665,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about one or more Stage resources.
", + "smithy.api#documentation": "Gets information about one or more Stage resources.
", "smithy.api#http": { "method": "GET", "uri": "/restapis/{restApiId}/stages", @@ -6600,7 +6679,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6614,7 +6693,7 @@ } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to get information about one or more Stage resources.
" + "smithy.api#documentation": "Requests API Gateway to get information about one or more Stage resources.
" } }, "com.amazonaws.apigateway#GetTags": { @@ -6640,7 +6719,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the Tags collection for a given resource.
", + "smithy.api#documentation": "Gets the Tags collection for a given resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -6654,7 +6733,7 @@ "resourceArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The ARN of a resource that can be tagged.
", + "smithy.api#documentation": "The ARN of a resource that can be tagged.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6675,7 +6754,7 @@ } }, "traits": { - "smithy.api#documentation": "Gets the Tags collection for a given resource.
" + "smithy.api#documentation": "Gets the Tags collection for a given resource.
" } }, "com.amazonaws.apigateway#GetUsage": { @@ -6783,7 +6862,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6791,7 +6870,7 @@ "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
", + "smithy.api#documentation": "The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6844,7 +6923,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", + "smithy.api#documentation": "The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6881,7 +6960,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the UsagePlan resource to be retrieved.
", + "smithy.api#documentation": "The identifier of the UsagePlan resource to be retrieved.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6963,7 +7042,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the usage plan associated with the usage data.
", + "smithy.api#documentation": "The Id of the usage plan associated with the usage data.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6978,7 +7057,7 @@ "startDate": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The starting date (e.g., 2016-01-01) of the usage data.
", + "smithy.api#documentation": "The starting date (e.g., 2016-01-01) of the usage data.
", "smithy.api#httpQuery": "startDate", "smithy.api#required": {} } @@ -6986,7 +7065,7 @@ "endDate": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The ending date (e.g., 2016-12-31) of the usage data.
", + "smithy.api#documentation": "The ending date (e.g., 2016-12-31) of the usage data.
", "smithy.api#httpQuery": "endDate", "smithy.api#required": {} } @@ -7047,7 +7126,7 @@ "vpcLinkId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7080,7 +7159,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the VpcLinks collection under the caller's account in a selected region.
", + "smithy.api#documentation": "Gets the VpcLinks collection under the caller's account in a selected region.
", "smithy.api#http": { "method": "GET", "uri": "/vpclinks", @@ -7113,7 +7192,7 @@ } }, "traits": { - "smithy.api#documentation": "Gets the VpcLinks collection under the caller's account in a selected region.
" + "smithy.api#documentation": "Gets the VpcLinks collection under the caller's account in a selected region.
" } }, "com.amazonaws.apigateway#ImportApiKeys": { @@ -7159,7 +7238,7 @@ "body": { "target": "com.amazonaws.apigateway#Blob", "traits": { - "smithy.api#documentation": "The payload of the POST request to import API keys. For the payload format, see API Key File Format.
", + "smithy.api#documentation": "The payload of the POST request to import API keys. For the payload format, see API Key File Format.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -7175,7 +7254,7 @@ "failOnWarnings": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "A query parameter to indicate whether to rollback ApiKey importation (true
) or not (false
) when error is encountered.
A query parameter to indicate whether to rollback ApiKey importation (true
) or not (false
) when error is encountered.
Imports documentation parts
", "smithy.api#http": { "method": "PUT", "uri": "/restapis/{restApiId}/documentation/parts", @@ -7226,7 +7306,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7234,7 +7314,7 @@ "mode": { "target": "com.amazonaws.apigateway#PutMode", "traits": { - "smithy.api#documentation": "A query parameter to indicate whether to overwrite (OVERWRITE
) any existing DocumentationParts definition or to merge (MERGE
) the new definition into the existing one. The default value is MERGE
.
A query parameter to indicate whether to overwrite (OVERWRITE
) any existing DocumentationParts definition or to merge (MERGE
) the new definition into the existing one. The default value is MERGE
.
[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
", + "smithy.api#documentation": "Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -7308,14 +7388,14 @@ "parameters": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
\n To exclude DocumentationParts from the import, set parameters
as ignore=documentation
.
To configure the endpoint type, set parameters
as endpointConfigurationTypes=EDGE
, endpointConfigurationTypes=REGIONAL
, or endpointConfigurationTypes=PRIVATE
. The default endpoint type is EDGE
.
To handle imported basepath
, set parameters
as basepath=ignore
, basepath=prepend
or basepath=split
.
For example, the AWS CLI command to exclude documentation from the imported API is:
\naws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
\n The AWS CLI command to set the regional endpoint on the imported API is:
\naws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
",
+ "smithy.api#documentation": "A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
\n To exclude DocumentationParts from the import, set parameters
as ignore=documentation
.
To configure the endpoint type, set parameters
as endpointConfigurationTypes=EDGE
, endpointConfigurationTypes=REGIONAL
, or endpointConfigurationTypes=PRIVATE
. The default endpoint type is EDGE
.
To handle imported basepath
, set parameters
as basepath=ignore
, basepath=prepend
or basepath=split
.
For example, the AWS CLI command to exclude documentation from the imported API is:
\nThe AWS CLI command to set the regional endpoint on the imported API is:
", "smithy.api#httpQueryParams": {} } }, "body": { "target": "com.amazonaws.apigateway#Blob", "traits": { - "smithy.api#documentation": "[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
", + "smithy.api#documentation": "The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -7334,7 +7414,7 @@ "type": { "target": "com.amazonaws.apigateway#IntegrationType", "traits": { - "smithy.api#documentation": "Specifies an API method integration type. The valid value is one of the following:
\nAWS
: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.AWS_PROXY
: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.HTTP
: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.HTTP_PROXY
: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.MOCK
: for integrating the API method request with API Gateway as a \"loop-back\" endpoint without invoking any backend.For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType
of VPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
Specifies an API method integration type. The valid value is one of the following:
\n \nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType
of VPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
\n For HTTP
or HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK
, or private integration, where connectionType
is VPC_LINK
. For a private HTTP integration, the URI is not used for routing.
For AWS
or AWS_PROXY
integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region}
is the API Gateway region (e.g., us-east-1
); {service}
is the name of the integrated AWS service (e.g., s3
); and {subdomain}
is a designated subdomain supported by certain AWS service for fast host-name lookup. action
can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}...
query string. The ensuing {service_api}
refers to a supported action {name}
plus any required input parameters. Alternatively, path
can be used for an AWS service path-based API. The ensuing service_api
refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject
, the uri
can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
\nFor HTTP
or HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL\n according to the RFC-3986 specification, for either standard integration, where connectionType
\n is not VPC_LINK
, or private integration, where connectionType
is VPC_LINK
. For a private HTTP\n integration, the URI is not used for routing. For AWS
or AWS_PROXY
integrations, the URI is of\n the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
.\n Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the\n integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by\n certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service\n action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing\n {service_api} refers to a supported action {name} plus any required input parameters.\n Alternatively, path can be used for an AWS service path-based API. The ensuing service_api\n refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services \n service, if applicable. For example, for integration with the S3 API of GetObject, the uri can\n be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
or\n arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
\n
The (id
) of the VpcLink used for the integration when connectionType=VPC_LINK
and undefined, otherwise.
The ID of the VpcLink used for the integration when connectionType=VPC_LINK
and undefined, otherwise.
\n Specifies how the method request body of an unmapped content type will be passed through the integration request\n to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration\n or the content type does not match any of the mapped content types, as specified in requestTemplates
.\n The valid value is one of the following:\n
WHEN_NO_MATCH
: passes the method request body through the integration request to the back end without transformation\n when the method request content type does not match any content type associated with the mapping templates defined in the integration request.\n WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back end without transformation\n when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request\n of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type
response.\n NEVER
: rejects the method request with an HTTP 415 Unsupported Media Type
response when either the method\n request content type does not match any content type associated with the mapping templates defined in the integration request or\n no mapping template is defined in the integration request.\n Specifies how the method request body of an unmapped content type will be passed through\n the integration request to the back end without transformation. A content type is unmapped if\n no mapping template is defined in the integration or the content type does not match any of\n the mapped content types, as specified in requestTemplates
. The valid value is one of the\n following: WHEN_NO_MATCH
: passes the method request body through the integration request to\n the back end without transformation when the method request content type does not match any\n content type associated with the mapping templates defined in the integration request.\n WHEN_NO_TEMPLATES
: passes the method request body through the integration request to the back\n end without transformation when no mapping template is defined in the integration request. If\n a template is defined when this option is selected, the method request of an unmapped\n content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER
: rejects\n the method request with an HTTP 415 Unsupported Media Type response when either the method\n request content type does not match any content type associated with the mapping templates\n defined in the integration request or no mapping template is defined in the integration\n request.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior
is configured to support payload pass-through.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior
is configured to support payload pass-through.
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters
, these parameters must also be specified for Method requestParameters
.
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters
, these parameters must also be specified for Method requestParameters
.
Specifies the integration's responses.
\nGET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160607T191449Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}\n
\n The successful response returns 200 OK
status and a payload as follows:
{\n \"_links\": {\n \"curies\": {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n \"name\": \"integrationresponse\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\",\n \"title\": \"200\"\n },\n \"integrationresponse:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n },\n \"integrationresponse:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n }\n },\n \"responseParameters\": {\n \"method.response.header.Content-Type\": \"'application/xml'\"\n },\n \"responseTemplates\": {\n \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\"\n },\n \"statusCode\": \"200\"\n}
\n \n Specifies the integration's responses.
" } }, "tlsConfig": { @@ -7423,7 +7503,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
\nRepresents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
" } }, "com.amazonaws.apigateway#IntegrationResponse": { @@ -7432,7 +7512,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
" + "smithy.api#documentation": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
" } }, "selectionPattern": { @@ -7456,12 +7536,12 @@ "contentHandling": { "target": "com.amazonaws.apigateway#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
" + "smithy.api#documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
" } } }, "traits": { - "smithy.api#documentation": "Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
\nRepresents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
" } }, "com.amazonaws.apigateway#IntegrationType": { @@ -7601,7 +7681,7 @@ "target": "com.amazonaws.apigateway#PatchOperation" }, "traits": { - "smithy.api#documentation": "A list of operations describing the updates to apply to the specified resource. The patches are applied\n in the order specified in the list." + "smithy.api#documentation": "A list of operations describing the updates to apply to the specified resource. The patches are applied\n in the order specified in the list.
" } }, "com.amazonaws.apigateway#ListOfRequestValidator": { @@ -7802,19 +7882,19 @@ "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of an Authorizer to use on this method. The authorizationType
must be CUSTOM
.
The identifier of an Authorizer to use on this method. The authorizationType
must be CUSTOM
.
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
" + "smithy.api#documentation": "A boolean flag specifying whether a valid ApiKey is required to invoke this method.
" } }, "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of a RequestValidator for request validation.
" + "smithy.api#documentation": "The identifier of a RequestValidator for request validation.
" } }, "operationName": { @@ -7826,25 +7906,25 @@ "requestParameters": { "target": "com.amazonaws.apigateway#MapOfStringToBoolean", "traits": { - "smithy.api#documentation": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
" + "smithy.api#documentation": "A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
" } }, "methodResponses": { "target": "com.amazonaws.apigateway#MapOfMethodResponse", "traits": { - "smithy.api#documentation": "Gets a method response associated with a given HTTP status code.
\nThe collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.
\nGET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nContent-Length: 117\nX-Amz-Date: 20160613T215008Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n The successful response returns a 200 OK
status code and a payload similar to the following:
{\n \"_links\": {\n \"curies\": {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n \"name\": \"methodresponse\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\",\n \"title\": \"200\"\n },\n \"methodresponse:delete\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\"\n },\n \"methodresponse:update\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\"\n }\n },\n \"responseModels\": {\n \"application/json\": \"Empty\"\n },\n \"responseParameters\": {\n \"method.response.header.operator\": false,\n \"method.response.header.operand_2\": false,\n \"method.response.header.operand_1\": false\n },\n \"statusCode\": \"200\"\n}
\n \n Gets a method response associated with a given HTTP status code.
" } }, "methodIntegration": { "target": "com.amazonaws.apigateway#Integration", "traits": { - "smithy.api#documentation": "Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
\nGET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nContent-Length: 117\nX-Amz-Date: 20160613T213210Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n The successful response returns a 200 OK
status code and a payload similar to the following:
{\n \"_links\": {\n \"curies\": [\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\",\n \"name\": \"integration\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n \"name\": \"integrationresponse\",\n \"templated\": true\n }\n ],\n \"self\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n },\n \"integration:delete\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n },\n \"integration:responses\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"integration:update\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\"\n },\n \"integrationresponse:put\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}\",\n \"templated\": true\n }\n },\n \"cacheKeyParameters\": [],\n \"cacheNamespace\": \"0cjtch\",\n \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\",\n \"httpMethod\": \"POST\",\n \"passthroughBehavior\": \"WHEN_NO_MATCH\",\n \"requestTemplates\": {\n \"application/json\": \"{\\n \\\"a\\\": \\\"$input.params('operand1')\\\",\\n \\\"b\\\": \\\"$input.params('operand2')\\\", \\n \\\"op\\\": \\\"$input.params('operator')\\\" \\n}\"\n },\n \"type\": \"AWS\",\n \"uri\": \"arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations\",\n \"_embedded\": {\n \"integration:responses\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"integrationresponse:delete\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\"\n },\n \"integrationresponse:update\": {\n \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\"\n }\n },\n \"responseParameters\": {\n \"method.response.header.operator\": \"integration.response.body.op\",\n \"method.response.header.operand_2\": \"integration.response.body.b\",\n \"method.response.header.operand_1\": \"integration.response.body.a\"\n },\n \"responseTemplates\": {\n \"application/json\": \"#set($res = $input.path('$'))\\n{\\n \\\"result\\\": \\\"$res.a, $res.b, $res.op => $res.c\\\",\\n \\\"a\\\" : \\\"$res.a\\\",\\n \\\"b\\\" : \\\"$res.b\\\",\\n \\\"op\\\" : \\\"$res.op\\\",\\n \\\"c\\\" : \\\"$res.c\\\"\\n}\"\n },\n \"selectionPattern\": \"\",\n \"statusCode\": \"200\"\n }\n }\n}
\n \n Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
" } }, "authorizationScopes": { @@ -7855,7 +7935,7 @@ } }, "traits": { - "smithy.api#documentation": "\n Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is\n integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes\n the client input that is passed to the back end through the integration request. A method response returns the output from\n the back end to the client through an integration response. A method request is embodied in a Method resource, whereas\n an integration request is embodied in an Integration resource. On the other hand, a method response is represented\n by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.\n
\nThe following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2
) of an API (fugvjdxtri
).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160603T210259Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n The successful response returns a 200 OK
status code and a payload similar to the following:
{\n \"_links\": {\n \"curies\": [\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\",\n \"name\": \"integration\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n \"name\": \"integrationresponse\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\",\n \"name\": \"method\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n \"name\": \"methodresponse\",\n \"templated\": true\n }\n ],\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\",\n \"name\": \"GET\",\n \"title\": \"GET\"\n },\n \"integration:put\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"method:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\"\n },\n \"method:integration\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"method:responses\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"method:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\"\n },\n \"methodresponse:put\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\",\n \"templated\": true\n }\n },\n \"apiKeyRequired\": true,\n \"authorizationType\": \"NONE\",\n \"httpMethod\": \"GET\",\n \"_embedded\": {\n \"method:integration\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"integration:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"integration:responses\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"integration:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"integrationresponse:put\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\",\n \"templated\": true\n }\n },\n \"cacheKeyParameters\": [],\n \"cacheNamespace\": \"3kzxbg5sa2\",\n \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\",\n \"httpMethod\": \"POST\",\n \"passthroughBehavior\": \"WHEN_NO_MATCH\",\n \"requestParameters\": {\n \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\"\n },\n \"requestTemplates\": {\n \"application/json\": \"{\\n}\"\n },\n \"type\": \"AWS\",\n \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\",\n \"_embedded\": {\n \"integration:responses\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"integrationresponse:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n },\n \"integrationresponse:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n }\n },\n \"responseParameters\": {\n \"method.response.header.Content-Type\": \"'application/xml'\"\n },\n \"responseTemplates\": {\n \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\\\")\"\n },\n \"statusCode\": \"200\"\n }\n }\n },\n \"method:responses\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"methodresponse:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n },\n \"methodresponse:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n }\n },\n \"responseModels\": {\n \"application/json\": \"Empty\"\n },\n \"responseParameters\": {\n \"method.response.header.Content-Type\": false\n },\n \"statusCode\": \"200\"\n }\n }\n}
\n In the example above, the response template for the 200 OK
response maps the JSON output from the ListStreams
action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E
and the output is decoded using the $util.urlDecode() helper function.
\n Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is\n integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes\n the client input that is passed to the back end through the integration request. A method response returns the output from\n the back end to the client through an integration response. A method request is embodied in a Method resource, whereas\n an integration request is embodied in an Integration resource. On the other hand, a method response is represented\n by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.\n
" } }, "com.amazonaws.apigateway#MethodResponse": { @@ -7870,18 +7950,18 @@ "responseParameters": { "target": "com.amazonaws.apigateway#MapOfStringToBoolean", "traits": { - "smithy.api#documentation": "A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}
, where name
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid JSON expression without the $
prefix.)
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}
, where name
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid JSON expression without the $
prefix.)
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
" + "smithy.api#documentation": "Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
" } } }, "traits": { - "smithy.api#documentation": "Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
\nThe example request retrieves a MethodResponse of the 200 status code.
\nGET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20160603T222952Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n The successful response returns 200 OK
status and a payload as follows:
{\n \"_links\": {\n \"curies\": {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n \"name\": \"methodresponse\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n \"title\": \"200\"\n },\n \"methodresponse:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n },\n \"methodresponse:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n }\n },\n \"responseModels\": {\n \"application/json\": \"Empty\"\n },\n \"responseParameters\": {\n \"method.response.header.Content-Type\": false\n },\n \"statusCode\": \"200\"\n}
\n \n Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
" } }, "com.amazonaws.apigateway#MethodSetting": { @@ -7902,7 +7982,7 @@ "dataTraceEnabled": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether full requests and responses are logged for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace
, and the value is a Boolean.
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace
, and the value is a Boolean.
Specifies whether the method requires a valid ApiKey.
" + "smithy.api#documentation": "Specifies whether the method requires a valid ApiKey.
" } } }, "traits": { - "smithy.api#documentation": "Represents a summary of a Method resource, given a particular date and time.
" + "smithy.api#documentation": "Represents a summary of a Method resource, given a particular date and time.
" } }, "com.amazonaws.apigateway#Model": { @@ -7996,7 +8076,7 @@ "schema": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The schema for the model. For application/json
models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
The schema for the model. For application/json
models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
Represents the data structure of a method's request or response payload.
\nA request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
\nA model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
\nRepresents the data structure of a method's request or response payload.
" } }, "com.amazonaws.apigateway#Models": { @@ -8029,7 +8109,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of Model resources.
\n " + "smithy.api#documentation": "Represents a collection of Model resources.
" } }, "com.amazonaws.apigateway#MutualTlsAuthentication": { @@ -8038,24 +8118,24 @@ "truststoreUri": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication,\n for example s3://bucket-name/key-name
.\n The truststore can contain certificates from public or private certificate authorities.\n To update the truststore, upload a new version to S3, and then update your custom domain\n name to use the new version. To update the truststore, you must have permissions to\n access the S3 object.
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example\n s3://bucket-name/key-name
. The truststore can contain certificates from public or private\n certificate authorities. To update the truststore, upload a new version to S3, and then update\n your custom domain name to use the new version. To update the truststore, you must have\n permissions to access the S3 object.
The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.
" + "smithy.api#documentation": "The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
" } }, "truststoreWarnings": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "A list of warnings that API Gateway returns while processing your truststore. Invalid\n certificates produce warnings. Mutual TLS is still enabled, but some clients might not\n be able to access your API. To resolve warnings, upload a new truststore to S3, and then\n update you domain name to use the new version.
" + "smithy.api#documentation": "A list of warnings that API Gateway returns while processing your truststore. Invalid\n certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able\n to access your API. To resolve warnings, upload a new truststore to S3, and then update you\n domain name to use the new version.
" } } }, "traits": { - "smithy.api#documentation": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.
" + "smithy.api#documentation": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\n performs two-way authentication between the client and the server. Clients must present a\n trusted certificate to access your API.
" } }, "com.amazonaws.apigateway#MutualTlsAuthenticationInput": { @@ -8064,18 +8144,18 @@ "truststoreUri": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication,\n for example,\n s3://bucket-name/key-name
.\n The truststore can contain certificates from public or private certificate authorities.\n To update the truststore, upload a new version to S3, and then update your custom domain\n name to use the new version. To update the truststore, you must have permissions to\n access the S3 object.
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example\n s3://bucket-name/key-name
. The truststore can contain certificates from public or private\n certificate authorities. To update the truststore, upload a new version to S3, and then update\n your custom domain name to use the new version. To update the truststore, you must have\n permissions to access the S3 object.
The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.
" + "smithy.api#documentation": "The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket
" } } }, "traits": { - "smithy.api#documentation": "If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.
" + "smithy.api#documentation": "The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway\n performs two-way authentication between the client and the server. Clients must present a\n trusted certificate to access your API.
" } }, "com.amazonaws.apigateway#NotFoundException": { @@ -8140,30 +8220,30 @@ "op": { "target": "com.amazonaws.apigateway#Op", "traits": { - "smithy.api#documentation": " An update operation to be performed with this PATCH request. The valid value can be add
, remove
, replace
or copy
. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.
An update operation to be performed with this PATCH request. The valid value can be\n add, remove, replace or copy. Not all valid operations are supported for a given\n resource. Support of the operations depends on specific operational contexts. Attempts\n to apply an unsupported operation on a resource will return an error message..
" } }, "path": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The op
operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {\"name\":\"value\"}
, the path for this property is /name
. If the name
property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}
), the path for the child/name
property will be /name/child~1name
. Any slash (\"/\") character appearing in path names must be escaped with \"~1\", as shown in the example above. Each op
operation can have only one path
associated with it.
The op operation's target, as identified by a JSON Pointer value that references a\n location within the targeted resource. For example, if the target resource has an\n updateable property of {\"name\":\"value\"}, the path for this property is /name. If the\n name property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}),\n the path for the child/name property will be /name/child~1name. Any slash (\"/\")\n character appearing in path names must be escaped with \"~1\", as shown in the example\n above. Each op operation can have only one path associated with it.
" } }, "value": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The new target value of the update operation. It is applicable for the add
or replace
operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see Using JSON for Parameters.
The new target value of the update operation. It is applicable for the add or replace\n operation. When using AWS CLI to update a property of a JSON value, enclose the JSON\n object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'.
" } }, "from": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The copy
update operation's source as identified by a JSON-Pointer
value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with \"op\":\"copy\"
, \"from\":\"/canarySettings/deploymentId\"
and \"path\":\"/deploymentId\"
.
The copy update operation's source as identified by a JSON-Pointer value referencing\n the location within the targeted resource to copy the value from. For example, to\n promote a canary deployment, you copy the canary deployment ID to the affiliated\n deployment ID by calling a PATCH request on a Stage resource with \"op\":\"copy\",\n \"from\":\"/canarySettings/deploymentId\" and \"path\":\"/deploymentId\".
" } } }, "traits": { - "smithy.api#documentation": "A single patch operation to apply to the specified resource. Please refer to\n http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used." + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } }, "com.amazonaws.apigateway#PathToMapOfMethodSnapshot": { @@ -8207,7 +8287,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
", + "smithy.api#documentation": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
", "smithy.api#http": { "method": "PUT", "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", @@ -8221,7 +8301,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8229,7 +8309,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "[Required]
The response type of the associated GatewayResponse.
", + "smithy.api#documentation": "The response type of the associated GatewayResponse
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8237,24 +8317,24 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "The HTTP status code of the GatewayResponse." + "smithy.api#documentation": "The HTTP status code of the GatewayResponse.
" } }, "responseParameters": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
" + "smithy.api#documentation": "Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
" } }, "responseTemplates": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" + "smithy.api#documentation": "Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
" } } }, "traits": { - "smithy.api#documentation": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
" + "smithy.api#documentation": "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
" } }, "com.amazonaws.apigateway#PutIntegration": { @@ -8300,7 +8380,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8308,7 +8388,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a put integration request's resource ID.
", + "smithy.api#documentation": "Specifies a put integration request's resource ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8316,7 +8396,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a put integration request's HTTP method.
", + "smithy.api#documentation": "Specifies the HTTP method for the integration.
", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "requestHttpMethod", "smithy.api#required": {} @@ -8325,21 +8405,21 @@ "type": { "target": "com.amazonaws.apigateway#IntegrationType", "traits": { - "smithy.api#documentation": "[Required] Specifies a put integration input's type.
", + "smithy.api#documentation": "Specifies a put integration input's type.
", "smithy.api#required": {} } }, "integrationHttpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
", + "smithy.api#documentation": "The HTTP method for the integration.
", "smithy.api#jsonName": "httpMethod" } }, "uri": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "Specifies Uniform Resource Identifier (URI) of the integration endpoint.
\n For HTTP
or HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK
, or private integration, where connectionType
is VPC_LINK
. For a private HTTP integration, the URI is not used for routing.
For AWS
or AWS_PROXY
integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}
. Here, {Region}
is the API Gateway region (e.g., us-east-1
); {service}
is the name of the integrated AWS service (e.g., s3
); and {subdomain}
is a designated subdomain supported by certain AWS service for fast host-name lookup. action
can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}...
query string. The ensuing {service_api}
refers to a supported action {name}
plus any required input parameters. Alternatively, path
can be used for an AWS service path-based API. The ensuing service_api
refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject
, the uri
can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or\n HTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the\n RFC-3986 specification, for either standard integration, where connectionType
is not VPC_LINK
,\n or private integration, where connectionType
is VPC_LINK
. For a private HTTP integration, the\n URI is not used for routing. For AWS
or AWS_PROXY
integrations, the URI is of the form\n arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api
}. Here,\n {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated\n Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services\n service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API,\n using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to\n a supported action {name} plus any required input parameters. Alternatively, path can be used\n for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services\n service resource, including the region of the integrated Amazon Web Services service, if applicable. For\n example, for integration with the S3 API of GetObject
, the uri
can be either\n arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
or\n arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
.
The (id
) of the VpcLink used for the integration when connectionType=VPC_LINK
and undefined, otherwise.
The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK
as the connection type.
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates
property on the Integration resource. There are three valid values: WHEN_NO_MATCH
, WHEN_NO_TEMPLATES
, and NEVER
.\n
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates
property on the Integration resource. There are three valid values: WHEN_NO_MATCH
, WHEN_NO_TEMPLATES
, and NEVER
.\n
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters
, these parameters must also be specified for Method requestParameters
.
A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters
, these parameters must also be specified for Method requestParameters
.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior
is configured to support payload pass-through.
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior
is configured to support payload pass-through.
[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8461,7 +8541,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a put integration response request's resource identifier.
", + "smithy.api#documentation": "Specifies a put integration response request's resource identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8469,7 +8549,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a put integration response request's HTTP method.
", + "smithy.api#documentation": "Specifies a put integration response request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8477,7 +8557,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.
", + "smithy.api#documentation": "Specifies the status code that is used to map the integration response to an existing MethodResponse.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8503,7 +8583,7 @@ "contentHandling": { "target": "com.amazonaws.apigateway#ContentHandlingStrategy", "traits": { - "smithy.api#documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
" + "smithy.api#documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
" } } }, @@ -8540,7 +8620,7 @@ } ], "traits": { - "smithy.api#documentation": "Add a method to an existing Resource resource.
", + "smithy.api#documentation": "Add a method to an existing Resource resource.
", "smithy.api#http": { "method": "PUT", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", @@ -8554,7 +8634,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8562,7 +8642,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the new Method resource.
", + "smithy.api#documentation": "The Resource identifier for the new Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8570,7 +8650,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies the method request's HTTP method type.
", + "smithy.api#documentation": "Specifies the method request's HTTP method type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8578,20 +8658,20 @@ "authorizationType": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The method's authorization type. Valid values are NONE
for open access, AWS_IAM
for using AWS IAM permissions, CUSTOM
for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
The method's authorization type. Valid values are NONE
for open access, AWS_IAM
for using AWS IAM permissions, CUSTOM
for using a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito user pool.
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
" + "smithy.api#documentation": "Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
" } }, "apiKeyRequired": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether the method required a valid ApiKey.
" + "smithy.api#documentation": "Specifies whether the method required a valid ApiKey.
" } }, "operationName": { @@ -8603,19 +8683,19 @@ "requestParameters": { "target": "com.amazonaws.apigateway#MapOfStringToBoolean", "traits": { - "smithy.api#documentation": "A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and name
is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true
) or optional (false
). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
" + "smithy.api#documentation": "Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
" } }, "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of a RequestValidator for validating the method request.
" + "smithy.api#documentation": "The identifier of a RequestValidator for validating the method request.
" } }, "authorizationScopes": { @@ -8626,7 +8706,7 @@ } }, "traits": { - "smithy.api#documentation": "Request to add a method to an existing Resource resource.
" + "smithy.api#documentation": "Request to add a method to an existing Resource resource.
" } }, "com.amazonaws.apigateway#PutMethodResponse": { @@ -8658,7 +8738,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a MethodResponse to an existing Method resource.
", + "smithy.api#documentation": "Adds a MethodResponse to an existing Method resource.
", "smithy.api#http": { "method": "PUT", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", @@ -8672,7 +8752,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8680,7 +8760,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the Method resource.
", + "smithy.api#documentation": "The Resource identifier for the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8688,7 +8768,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The HTTP verb of the Method resource.
", + "smithy.api#documentation": "The HTTP verb of the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8696,7 +8776,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] The method response's status code.
", + "smithy.api#documentation": "The method response's status code.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8710,12 +8790,12 @@ "responseModels": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
" + "smithy.api#documentation": "Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
" } } }, "traits": { - "smithy.api#documentation": "Request to add a MethodResponse to an existing Method resource.
" + "smithy.api#documentation": "Request to add a MethodResponse to an existing Method resource.
" } }, "com.amazonaws.apigateway#PutMode": { @@ -8776,7 +8856,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8798,14 +8878,14 @@ "parameters": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation
as a parameters
value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation
as a parameters
value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.
[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
", + "smithy.api#documentation": "The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -8846,7 +8926,7 @@ "offset": { "target": "com.amazonaws.apigateway#Integer", "traits": { - "smithy.api#documentation": "The day that a time period starts. For example, with a time period of WEEK
, an offset of 0
starts on Sunday, and an offset of 1
starts on Monday.
The number of requests subtracted from the given limit in the initial time period.
" } }, "period": { @@ -8866,19 +8946,19 @@ "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of this RequestValidator.
" + "smithy.api#documentation": "The identifier of this RequestValidator.
" } }, "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The name of this RequestValidator
" + "smithy.api#documentation": "The name of this RequestValidator
" } }, "validateRequestBody": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
" + "smithy.api#documentation": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
" } }, "validateRequestParameters": { @@ -8889,7 +8969,7 @@ } }, "traits": { - "smithy.api#documentation": "A set of validation rules for incoming Method requests.
\nIn OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.
\nA set of validation rules for incoming Method requests.
" } }, "com.amazonaws.apigateway#RequestValidators": { @@ -8911,7 +8991,7 @@ } }, "traits": { - "smithy.api#documentation": "A collection of RequestValidator resources of a given RestApi.
\nIn OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.
\nA collection of RequestValidator resources of a given RestApi.
" } }, "com.amazonaws.apigateway#Resource": { @@ -8944,12 +9024,12 @@ "resourceMethods": { "target": "com.amazonaws.apigateway#MapOfMethod", "traits": { - "smithy.api#documentation": "Gets an API resource's method of a given HTTP verb.
\nThe resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK
response of the GET /restapis/{restapi_id}/resources/{resource_id}
or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods
request.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1\nContent-Type: application/json\nHost: apigateway.us-east-1.amazonaws.com\nX-Amz-Date: 20170223T031827Z\nAuthorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
\n {\n \"_links\": {\n \"curies\": [\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\",\n \"name\": \"integration\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\",\n \"name\": \"integrationresponse\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\",\n \"name\": \"method\",\n \"templated\": true\n },\n {\n \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\",\n \"name\": \"methodresponse\",\n \"templated\": true\n }\n ],\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\",\n \"name\": \"GET\",\n \"title\": \"GET\"\n },\n \"integration:put\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"method:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\"\n },\n \"method:integration\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"method:responses\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"method:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\"\n },\n \"methodresponse:put\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\",\n \"templated\": true\n }\n },\n \"apiKeyRequired\": false,\n \"authorizationType\": \"NONE\",\n \"httpMethod\": \"GET\",\n \"_embedded\": {\n \"method:integration\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"integration:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"integration:responses\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"integration:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\"\n },\n \"integrationresponse:put\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\",\n \"templated\": true\n }\n },\n \"cacheKeyParameters\": [],\n \"cacheNamespace\": \"3kzxbg5sa2\",\n \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\",\n \"httpMethod\": \"POST\",\n \"passthroughBehavior\": \"WHEN_NO_MATCH\",\n \"requestParameters\": {\n \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\"\n },\n \"requestTemplates\": {\n \"application/json\": \"{\\n}\"\n },\n \"type\": \"AWS\",\n \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\",\n \"_embedded\": {\n \"integration:responses\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"integrationresponse:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n },\n \"integrationresponse:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\"\n }\n },\n \"responseParameters\": {\n \"method.response.header.Content-Type\": \"'application/xml'\"\n },\n \"responseTemplates\": {\n \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\"\n },\n \"statusCode\": \"200\"\n }\n }\n },\n \"method:responses\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\",\n \"name\": \"200\",\n \"title\": \"200\"\n },\n \"methodresponse:delete\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n },\n \"methodresponse:update\": {\n \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\"\n }\n },\n \"responseModels\": {\n \"application/json\": \"Empty\"\n },\n \"responseParameters\": {\n \"method.response.header.Content-Type\": false\n },\n \"statusCode\": \"200\"\n }\n }\n}
\n If the OPTIONS
is enabled on the resource, you can follow the example here to get that method. Just replace the GET
of the last path segment in the request URL with OPTIONS
.
Gets an API resource's method of a given HTTP verb.
" } } }, "traits": { - "smithy.api#documentation": "Represents an API resource.
\nRepresents an API resource.
" } }, "com.amazonaws.apigateway#Resources": { @@ -8971,7 +9051,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of Resource resources.
\nRepresents a collection of Resource resources.
" } }, "com.amazonaws.apigateway#RestApi": { @@ -9016,7 +9096,7 @@ "binaryMediaTypes": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
" + "smithy.api#documentation": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
" } }, "minimumCompressionSize": { @@ -9028,19 +9108,19 @@ "apiKeySource": { "target": "com.amazonaws.apigateway#ApiKeySourceType", "traits": { - "smithy.api#documentation": "The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.The source of the API key for metering requests according to a usage plan. Valid values\n are: >HEADER
to read the API key from the X-API-Key
header of a\n request. AUTHORIZER
to read the API key from the UsageIdentifierKey
\n from a custom authorizer.
The endpoint configuration of this RestApi showing the endpoint types of the API.
" + "smithy.api#documentation": "The endpoint configuration of this RestApi showing the endpoint types of the API.
" } }, "policy": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
" + "smithy.api#documentation": "A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
" } }, "tags": { @@ -9052,12 +9132,12 @@ "disableExecuteApiEndpoint": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
Specifies whether clients can invoke your API by using the default execute-api
endpoint.\n By default, clients can invoke your API with the default\n https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a\n custom domain name to invoke your API, disable the default endpoint.
Represents a REST API.
\nRepresents a REST API.
" } }, "com.amazonaws.apigateway#RestApis": { @@ -9079,7 +9159,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
\nContains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
" } }, "com.amazonaws.apigateway#SdkConfigurationProperty": { @@ -9088,31 +9168,31 @@ "name": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The name of a an SdkType configuration property.
" + "smithy.api#documentation": "The name of a an SdkType configuration property.
" } }, "friendlyName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The user-friendly name of an SdkType configuration property.
" + "smithy.api#documentation": "The user-friendly name of an SdkType configuration property.
" } }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of an SdkType configuration property.
" + "smithy.api#documentation": "The description of an SdkType configuration property.
" } }, "required": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true
) or not (false
).
A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true
) or not (false
).
The default value of an SdkType configuration property.
" + "smithy.api#documentation": "The default value of an SdkType configuration property.
" } } }, @@ -9140,13 +9220,13 @@ "body": { "target": "com.amazonaws.apigateway#Blob", "traits": { - "smithy.api#documentation": "The binary blob response to GetSdk, which contains the generated SDK.
", + "smithy.api#documentation": "The binary blob response to GetSdk, which contains the generated SDK.
", "smithy.api#httpPayload": {} } } }, "traits": { - "smithy.api#documentation": "The binary blob response to GetSdk, which contains the generated SDK.
" + "smithy.api#documentation": "The binary blob response to GetSdk, which contains the generated SDK.
" } }, "com.amazonaws.apigateway#SdkType": { @@ -9155,25 +9235,25 @@ "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of an SdkType instance.
" + "smithy.api#documentation": "The identifier of an SdkType instance.
" } }, "friendlyName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The user-friendly name of an SdkType instance.
" + "smithy.api#documentation": "The user-friendly name of an SdkType instance.
" } }, "description": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The description of an SdkType.
" + "smithy.api#documentation": "The description of an SdkType.
" } }, "configurationProperties": { "target": "com.amazonaws.apigateway#ListOfSdkConfigurationProperty", "traits": { - "smithy.api#documentation": "A list of configuration properties of an SdkType.
" + "smithy.api#documentation": "A list of configuration properties of an SdkType.
" } } }, @@ -9193,7 +9273,7 @@ } }, "traits": { - "smithy.api#documentation": "The collection of SdkType instances.
" + "smithy.api#documentation": "The collection of SdkType instances.
" } }, "com.amazonaws.apigateway#SecurityPolicy": { @@ -9236,7 +9316,7 @@ "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of the Deployment that the stage points to.
" + "smithy.api#documentation": "The identifier of the Deployment that the stage points to.
" } }, "clientCertificateId": { @@ -9278,13 +9358,13 @@ "methodSettings": { "target": "com.amazonaws.apigateway#MapOfMethodSettings", "traits": { - "smithy.api#documentation": "A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key
below) are method paths defined as {resource_path}/{http_method}
for an individual method override, or /\\*/\\*
for overriding all methods in the stage.
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key
below) are method paths defined as {resource_path}/{http_method}
for an individual method override, or /\\*/\\*
for overriding all methods in the stage.
A map that defines the stage variables for a Stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
.
A map that defines the stage variables for a Stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
.
Specifies whether active tracing with X-ray is enabled for the Stage.
" + "smithy.api#documentation": "Specifies whether active tracing with X-ray is enabled for the Stage.
" } }, "webAclArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The ARN of the WebAcl associated with the Stage.
" + "smithy.api#documentation": "The ARN of the WebAcl associated with the Stage.
" } }, "tags": { @@ -9337,7 +9417,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
\nRepresents a unique identifier for a version of a deployed RestApi that is callable by users.
" } }, "com.amazonaws.apigateway#StageKey": { @@ -9346,7 +9426,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The string identifier of the associated RestApi.
" + "smithy.api#documentation": "The string identifier of the associated RestApi.
" } }, "stageName": { @@ -9371,7 +9451,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of Stage resources that are associated with the ApiKey resource.
\n " + "smithy.api#documentation": "A list of Stage resources that are associated with the ApiKey resource.
" } }, "com.amazonaws.apigateway#StatusCode": { @@ -9389,6 +9469,9 @@ "input": { "target": "com.amazonaws.apigateway#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -9424,7 +9507,7 @@ "resourceArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The ARN of a resource that can be tagged.
", + "smithy.api#documentation": "The ARN of a resource that can be tagged.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9432,7 +9515,7 @@ "tags": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The Apache Velocity Template Language (VTL) template content used for the template resource.
" + "smithy.api#documentation": "The Apache Velocity Template Language (VTL) template content used for the template resource.
" } } }, "traits": { - "smithy.api#documentation": "Represents a mapping template used to transform a payload.
\nRepresents a mapping template used to transform a payload.
" } }, "com.amazonaws.apigateway#TestInvokeAuthorizer": { @@ -9492,7 +9575,7 @@ } ], "traits": { - "smithy.api#documentation": "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
\n ", + "smithy.api#documentation": "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", @@ -9506,7 +9589,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9514,7 +9597,7 @@ "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a test invoke authorizer request's Authorizer ID.
", + "smithy.api#documentation": "Specifies a test invoke authorizer request's Authorizer ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9522,42 +9605,42 @@ "headers": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
" + "smithy.api#documentation": "A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
" } }, "multiValueHeaders": { "target": "com.amazonaws.apigateway#MapOfStringToList", "traits": { - "smithy.api#documentation": "[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
" + "smithy.api#documentation": "The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
" } }, "pathWithQueryString": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
" + "smithy.api#documentation": "The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
" } }, "body": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Optional] The simulated request body of an incoming invocation request.
" + "smithy.api#documentation": "The simulated request body of an incoming invocation request.
" } }, "stageVariables": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" + "smithy.api#documentation": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" } }, "additionalContext": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "[Optional] A key-value map of additional context variables.
" + "smithy.api#documentation": "A key-value map of additional context variables.
" } } }, "traits": { - "smithy.api#documentation": "Make a request to simulate the execution of an Authorizer.
" + "smithy.api#documentation": "Make a request to simulate the invocation of an Authorizer.
" } }, "com.amazonaws.apigateway#TestInvokeAuthorizerResponse": { @@ -9584,27 +9667,30 @@ "principalId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The principal identity returned by the Authorizer
" + "smithy.api#documentation": "The principal identity returned by the Authorizer
" } }, "policy": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The JSON policy document returned by the Authorizer
" + "smithy.api#documentation": "The JSON policy document returned by the Authorizer
" } }, "authorization": { - "target": "com.amazonaws.apigateway#MapOfStringToList" + "target": "com.amazonaws.apigateway#MapOfStringToList", + "traits": { + "smithy.api#documentation": "The authorization response.
" + } }, "claims": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
" + "smithy.api#documentation": "The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
" } } }, "traits": { - "smithy.api#documentation": "Represents the response of the test invoke request for a custom Authorizer
" + "smithy.api#documentation": "Represents the response of the test invoke request for a custom Authorizer
" } }, "com.amazonaws.apigateway#TestInvokeMethod": { @@ -9630,7 +9716,7 @@ } ], "traits": { - "smithy.api#documentation": "Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
", + "smithy.api#documentation": "Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
", "smithy.api#http": { "method": "POST", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", @@ -9644,7 +9730,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9652,7 +9738,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a test invoke method request's resource ID.
", + "smithy.api#documentation": "Specifies a test invoke method request's resource ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9660,7 +9746,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies a test invoke method request's HTTP method.
", + "smithy.api#documentation": "Specifies a test invoke method request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9692,18 +9778,18 @@ "clientCertificateId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
" + "smithy.api#documentation": "A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
" } }, "stageVariables": { "target": "com.amazonaws.apigateway#MapOfStringToString", "traits": { - "smithy.api#documentation": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" + "smithy.api#documentation": "A key-value map of stage variables to simulate an invocation on a deployed Stage.
" } } }, "traits": { - "smithy.api#documentation": "Make a request to simulate the execution of a Method.
" + "smithy.api#documentation": "Make a request to simulate the invocation of a Method.
" } }, "com.amazonaws.apigateway#TestInvokeMethodResponse": { @@ -9747,7 +9833,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response of the test invoke request in the HTTP method.
\n " + "smithy.api#documentation": "Represents the response of the test invoke request in the HTTP method.
" } }, "com.amazonaws.apigateway#ThrottleSettings": { @@ -9779,9 +9865,12 @@ "insecureSkipVerification": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is\n issued by a supported certificate authority. This isn’t recommended, but it enables you to\n use certificates that are signed by private certificate authorities, or certificates\n that are self-signed. If enabled, API Gateway still performs basic certificate\n validation, which includes checking the certificate's expiration date, hostname, and\n presence of a root certificate authority. Supported only for HTTP
and\n HTTP_PROXY
integrations.
Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is\n issued by a supported certificate authority. This isn’t recommended, but it enables you to\n use certificates that are signed by private certificate authorities, or certificates\n that are self-signed. If enabled, API Gateway still performs basic certificate\n validation, which includes checking the certificate's expiration date, hostname, and\n presence of a root certificate authority. Supported only for HTTP
and\n HTTP_PROXY
integrations.
Specifies the TLS configuration for an integration.
" } }, "com.amazonaws.apigateway#TooManyRequestsException": { @@ -9840,6 +9929,9 @@ "input": { "target": "com.amazonaws.apigateway#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.apigateway#BadRequestException" @@ -9875,7 +9967,7 @@ "resourceArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The ARN of a resource that can be tagged.
", + "smithy.api#documentation": "The ARN of a resource that can be tagged.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9883,7 +9975,7 @@ "tagKeys": { "target": "com.amazonaws.apigateway#ListOfString", "traits": { - "smithy.api#documentation": "[Required] The Tag keys to delete.
", + "smithy.api#documentation": "The Tag keys to delete.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -9922,7 +10014,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about the current Account resource.
", + "smithy.api#documentation": "Changes information about the current Account resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/account", @@ -9936,12 +10028,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to change information about the current Account resource.
" + "smithy.api#documentation": "Requests API Gateway to change information about the current Account resource.
" } }, "com.amazonaws.apigateway#UpdateApiKey": { @@ -9973,7 +10065,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about an ApiKey resource.
", + "smithy.api#documentation": "Changes information about an ApiKey resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/apikeys/{apiKey}", @@ -9987,7 +10079,7 @@ "apiKey": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the ApiKey resource to be updated.
", + "smithy.api#documentation": "The identifier of the ApiKey resource to be updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9995,12 +10087,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "A request to change information about an ApiKey resource.
" + "smithy.api#documentation": "A request to change information about an ApiKey resource.
" } }, "com.amazonaws.apigateway#UpdateAuthorizer": { @@ -10032,7 +10124,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Authorizer resource.
\n ", + "smithy.api#documentation": "Updates an existing Authorizer resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/authorizers/{authorizerId}", @@ -10046,7 +10138,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10054,7 +10146,7 @@ "authorizerId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Authorizer resource.
", + "smithy.api#documentation": "The identifier of the Authorizer resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10062,12 +10154,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Request to update an existing Authorizer resource.
" + "smithy.api#documentation": "Request to update an existing Authorizer resource.
" } }, "com.amazonaws.apigateway#UpdateBasePathMapping": { @@ -10099,7 +10191,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about the BasePathMapping resource.
", + "smithy.api#documentation": "Changes information about the BasePathMapping resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/domainnames/{domainName}/basepathmappings/{basePath}", @@ -10113,7 +10205,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The domain name of the BasePathMapping resource to change.
", + "smithy.api#documentation": "The domain name of the BasePathMapping resource to change.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10121,7 +10213,7 @@ "basePath": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The base path of the BasePathMapping resource to change.
\nTo specify an empty base path, set this parameter to '(none)'
.
The base path of the BasePathMapping resource to change.
\nTo specify an empty base path, set this parameter to '(none)'
.
A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "A request to change information about the BasePathMapping resource.
" + "smithy.api#documentation": "A request to change information about the BasePathMapping resource.
" } }, "com.amazonaws.apigateway#UpdateClientCertificate": { @@ -10166,7 +10258,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about an ClientCertificate resource.
", + "smithy.api#documentation": "Changes information about an ClientCertificate resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/clientcertificates/{clientCertificateId}", @@ -10180,7 +10272,7 @@ "clientCertificateId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the ClientCertificate resource to be updated.
", + "smithy.api#documentation": "The identifier of the ClientCertificate resource to be updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10188,12 +10280,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "A request to change information about an ClientCertificate resource.
" + "smithy.api#documentation": "A request to change information about an ClientCertificate resource.
" } }, "com.amazonaws.apigateway#UpdateDeployment": { @@ -10228,7 +10320,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about a Deployment resource.
", + "smithy.api#documentation": "Changes information about a Deployment resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/deployments/{deploymentId}", @@ -10242,7 +10334,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10250,7 +10342,7 @@ "deploymentId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The replacement identifier for the Deployment resource to change information about.
", + "smithy.api#documentation": "The replacement identifier for the Deployment resource to change information about.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10258,12 +10350,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to change information about a Deployment resource.
" + "smithy.api#documentation": "Requests API Gateway to change information about a Deployment resource.
" } }, "com.amazonaws.apigateway#UpdateDocumentationPart": { @@ -10295,6 +10387,7 @@ } ], "traits": { + "smithy.api#documentation": "Updates a documentation part.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/documentation/parts/{documentationPartId}", @@ -10308,7 +10401,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10316,7 +10409,7 @@ "documentationPartId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the to-be-updated documentation part.
", + "smithy.api#documentation": "The identifier of the to-be-updated documentation part.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10324,7 +10417,7 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, @@ -10361,6 +10454,7 @@ } ], "traits": { + "smithy.api#documentation": "Updates a documentation version.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/documentation/versions/{documentationVersion}", @@ -10374,7 +10468,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi..
", + "smithy.api#documentation": "The string identifier of the associated RestApi..
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10382,7 +10476,7 @@ "documentationVersion": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The version identifier of the to-be-updated documentation version.
", + "smithy.api#documentation": "The version identifier of the to-be-updated documentation version.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10390,7 +10484,7 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, @@ -10427,7 +10521,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about the DomainName resource.
", + "smithy.api#documentation": "Changes information about the DomainName resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/domainnames/{domainName}", @@ -10441,7 +10535,7 @@ "domainName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the DomainName resource to be changed.
", + "smithy.api#documentation": "The name of the DomainName resource to be changed.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10449,12 +10543,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "A request to change information about the DomainName resource.
" + "smithy.api#documentation": "A request to change information about the DomainName resource.
" } }, "com.amazonaws.apigateway#UpdateGatewayResponse": { @@ -10486,7 +10580,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a GatewayResponse of a specified response type on the given RestApi.
", + "smithy.api#documentation": "Updates a GatewayResponse of a specified response type on the given RestApi.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/gatewayresponses/{responseType}", @@ -10500,7 +10594,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10508,7 +10602,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "[Required]
The response type of the associated GatewayResponse.
", + "smithy.api#documentation": "The response type of the associated GatewayResponse.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10516,12 +10610,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Updates a GatewayResponse of a specified response type on the given RestApi.
" + "smithy.api#documentation": "Updates a GatewayResponse of a specified response type on the given RestApi.
" } }, "com.amazonaws.apigateway#UpdateIntegration": { @@ -10567,7 +10661,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10575,7 +10669,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Represents an update integration request's resource identifier.
", + "smithy.api#documentation": "Represents an update integration request's resource identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10583,7 +10677,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Represents an update integration request's HTTP method.
", + "smithy.api#documentation": "Represents an update integration request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10591,7 +10685,7 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, @@ -10642,7 +10736,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10650,7 +10744,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies an update integration response request's resource identifier.
", + "smithy.api#documentation": "Specifies an update integration response request's resource identifier.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10658,7 +10752,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] Specifies an update integration response request's HTTP method.
", + "smithy.api#documentation": "Specifies an update integration response request's HTTP method.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10666,7 +10760,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] Specifies an update integration response request's status code.
", + "smithy.api#documentation": "Specifies an update integration response request's status code.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10674,7 +10768,7 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, @@ -10708,7 +10802,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Method resource.
", + "smithy.api#documentation": "Updates an existing Method resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}", @@ -10722,7 +10816,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10730,7 +10824,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the Method resource.
", + "smithy.api#documentation": "The Resource identifier for the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10738,7 +10832,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The HTTP verb of the Method resource.
", + "smithy.api#documentation": "The HTTP verb of the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10746,12 +10840,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Request to update an existing Method resource.
" + "smithy.api#documentation": "Request to update an existing Method resource.
" } }, "com.amazonaws.apigateway#UpdateMethodResponse": { @@ -10783,7 +10877,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing MethodResponse resource.
", + "smithy.api#documentation": "Updates an existing MethodResponse resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/resources/{resourceId}/methods/{httpMethod}/responses/{statusCode}", @@ -10797,7 +10891,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10805,7 +10899,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Resource identifier for the MethodResponse resource.
", + "smithy.api#documentation": "The Resource identifier for the MethodResponse resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10813,7 +10907,7 @@ "httpMethod": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The HTTP verb of the Method resource.
", + "smithy.api#documentation": "The HTTP verb of the Method resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10821,7 +10915,7 @@ "statusCode": { "target": "com.amazonaws.apigateway#StatusCode", "traits": { - "smithy.api#documentation": "[Required] The status code for the MethodResponse resource.
", + "smithy.api#documentation": "The status code for the MethodResponse resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10829,12 +10923,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "A request to update an existing MethodResponse resource.
" + "smithy.api#documentation": "A request to update an existing MethodResponse resource.
" } }, "com.amazonaws.apigateway#UpdateModel": { @@ -10880,7 +10974,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10888,7 +10982,7 @@ "modelName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the model to update.
", + "smithy.api#documentation": "The name of the model to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10896,12 +10990,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Request to update an existing model in an existing RestApi resource.
" + "smithy.api#documentation": "Request to update an existing model in an existing RestApi resource.
" } }, "com.amazonaws.apigateway#UpdateRequestValidator": { @@ -10933,7 +11027,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a RequestValidator of a given RestApi.
", + "smithy.api#documentation": "Updates a RequestValidator of a given RestApi.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/requestvalidators/{requestValidatorId}", @@ -10947,7 +11041,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10955,7 +11049,7 @@ "requestValidatorId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of RequestValidator to be updated.
", + "smithy.api#documentation": "The identifier of RequestValidator to be updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10963,12 +11057,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Updates a RequestValidator of a given RestApi.
" + "smithy.api#documentation": "Updates a RequestValidator of a given RestApi.
" } }, "com.amazonaws.apigateway#UpdateResource": { @@ -10997,7 +11091,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about a Resource resource.
", + "smithy.api#documentation": "Changes information about a Resource resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/resources/{resourceId}", @@ -11011,7 +11105,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11019,7 +11113,7 @@ "resourceId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the Resource resource.
", + "smithy.api#documentation": "The identifier of the Resource resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11027,12 +11121,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Request to change information about a Resource resource.
" + "smithy.api#documentation": "Request to change information about a Resource resource.
" } }, "com.amazonaws.apigateway#UpdateRestApi": { @@ -11078,7 +11172,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11086,12 +11180,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Request to update an existing RestApi resource in your collection.
" + "smithy.api#documentation": "Request to update an existing RestApi resource in your collection.
" } }, "com.amazonaws.apigateway#UpdateStage": { @@ -11123,7 +11217,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes information about a Stage resource.
", + "smithy.api#documentation": "Changes information about a Stage resource.
", "smithy.api#http": { "method": "PATCH", "uri": "/restapis/{restApiId}/stages/{stageName}", @@ -11137,7 +11231,7 @@ "restApiId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The string identifier of the associated RestApi.
", + "smithy.api#documentation": "The string identifier of the associated RestApi.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11145,7 +11239,7 @@ "stageName": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The name of the Stage resource to change information about.
", + "smithy.api#documentation": "The name of the Stage resource to change information about.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11153,12 +11247,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Requests API Gateway to change information about a Stage resource.
" + "smithy.api#documentation": "Requests API Gateway to change information about a Stage resource.
" } }, "com.amazonaws.apigateway#UpdateUsage": { @@ -11241,7 +11335,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the to-be-updated usage plan.
", + "smithy.api#documentation": "The Id of the to-be-updated usage plan.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11249,7 +11343,7 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, @@ -11263,7 +11357,7 @@ "usagePlanId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The Id of the usage plan associated with the usage data.
", + "smithy.api#documentation": "The Id of the usage plan associated with the usage data.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11271,7 +11365,7 @@ "keyId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
", + "smithy.api#documentation": "The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11279,7 +11373,7 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, @@ -11316,7 +11410,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing VpcLink of a specified identifier.
", + "smithy.api#documentation": "Updates an existing VpcLink of a specified identifier.
", "smithy.api#http": { "method": "PATCH", "uri": "/vpclinks/{vpcLinkId}", @@ -11330,7 +11424,7 @@ "vpcLinkId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "[Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11338,12 +11432,12 @@ "patchOperations": { "target": "com.amazonaws.apigateway#ListOfPatchOperation", "traits": { - "smithy.api#documentation": "A list of update operations to be applied to the specified resource and in the order specified in this list.
" + "smithy.api#documentation": "For more information about supported patch operations, see Patch Operations.
" } } }, "traits": { - "smithy.api#documentation": "Updates an existing VpcLink of a specified identifier.
" + "smithy.api#documentation": "Updates an existing VpcLink of a specified identifier.
" } }, "com.amazonaws.apigateway#Usage": { @@ -11383,7 +11477,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the usage data of a usage plan.
\n \n " + "smithy.api#documentation": "Represents the usage data of a usage plan.
" } }, "com.amazonaws.apigateway#UsagePlan": { @@ -11392,7 +11486,7 @@ "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of a UsagePlan resource.
" + "smithy.api#documentation": "The identifier of a UsagePlan resource.
" } }, "name": { @@ -11416,7 +11510,7 @@ "throttle": { "target": "com.amazonaws.apigateway#ThrottleSettings", "traits": { - "smithy.api#documentation": "Map containing method level throttling information for API stage in a usage plan.
" + "smithy.api#documentation": "A map containing method level throttling information for API stage in a usage plan.
" } }, "quota": { @@ -11439,7 +11533,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. \n In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. \n Consider using AWS Budgets to monitor costs \n and AWS WAF to manage API requests.
\nIn a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
\nRepresents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. \n In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. \n Consider using Amazon Web Services Budgets to monitor costs \n and WAF to manage API requests.
" } }, "com.amazonaws.apigateway#UsagePlanKey": { @@ -11471,7 +11565,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a usage plan key to identify a plan customer.
\nTo associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
\nRepresents a usage plan key to identify a plan customer.
" } }, "com.amazonaws.apigateway#UsagePlanKeys": { @@ -11493,7 +11587,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
\n " + "smithy.api#documentation": "Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
" } }, "com.amazonaws.apigateway#UsagePlans": { @@ -11515,7 +11609,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a collection of usage plans for an AWS account.
\n " + "smithy.api#documentation": "Represents a collection of usage plans for an AWS account.
" } }, "com.amazonaws.apigateway#VpcLink": { @@ -11524,7 +11618,7 @@ "id": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
" + "smithy.api#documentation": "The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
" } }, "name": { @@ -11548,7 +11642,7 @@ "status": { "target": "com.amazonaws.apigateway#VpcLinkStatus", "traits": { - "smithy.api#documentation": "The status of the VPC link. The valid values are AVAILABLE
, PENDING
, DELETING
, or FAILED
. Deploying an API will wait if the status is PENDING
and will fail if the status is DELETING
.
The status of the VPC link. The valid values are AVAILABLE
, PENDING
, DELETING
, or FAILED
. Deploying an API will wait if the status is PENDING
and will fail if the status is DELETING
.
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
\nTo enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP
or HTTP_PROXY
and has a connection type of VPC_LINK
. The integration uses the connectionId
property to identify the VpcLink used.
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
" } }, "com.amazonaws.apigateway#VpcLinkStatus": { @@ -11610,7 +11704,7 @@ } }, "traits": { - "smithy.api#documentation": "The collection of VPC links under the caller's account in a region.
\n " + "smithy.api#documentation": "The collection of VPC links under the caller's account in a region.
" } } } diff --git a/aws/sdk/aws-models/appflow.json b/aws/sdk/aws-models/appflow.json index f21f240a81f..df664066f50 100644 --- a/aws/sdk/aws-models/appflow.json +++ b/aws/sdk/aws-models/appflow.json @@ -68,7 +68,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 2048 + "max": 4096 }, "smithy.api#pattern": "^\\S+$", "smithy.api#sensitive": {} @@ -90,7 +90,7 @@ "aggregationType": { "target": "com.amazonaws.appflow#AggregationType", "traits": { - "smithy.api#documentation": "Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave\n them unaggregated.
" + "smithy.api#documentation": "Specifies whether Amazon AppFlow aggregates the flow records into a single file, or\n leave them unaggregated.
" } } }, @@ -830,7 +830,7 @@ } }, "traits": { - "smithy.api#documentation": "The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce\n entity might be an Account or Opportunity, whereas a\n ServiceNow entity might be an Incident.
" + "smithy.api#documentation": "The high-level entity that can be queried in Amazon AppFlow. For example, a\n Salesforce entity might be an Account or\n Opportunity, whereas a ServiceNow entity might be an\n Incident.
" } }, "com.amazonaws.appflow#ConnectorEntityField": { @@ -1871,7 +1871,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new connector profile associated with your Amazon Web Services account. There\n is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more\n connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team\n through the Amazon AppFlow support channel.
", + "smithy.api#documentation": "Creates a new connector profile associated with your Amazon Web Services account. There\n is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more\n connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you\n create, you can provide the credentials and properties for only one connector.
", "smithy.api#http": { "method": "POST", "uri": "/create-connector-profile", @@ -1892,7 +1892,7 @@ "kmsArn": { "target": "com.amazonaws.appflow#KMSArn", "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If\n you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n
" + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS\n key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
" } }, "connectorType": { @@ -1967,7 +1967,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables your application to create a new flow using Amazon AppFlow. You must create a\n connector profile before calling this API. Please note that the Request Syntax below shows\n syntax for multiple destinations, however, you can only transfer data to one item in this list\n at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.
", + "smithy.api#documentation": "Enables your application to create a new flow using Amazon AppFlow. You must create\n a connector profile before calling this API. Please note that the Request Syntax below shows\n syntax for multiple destinations, however, you can only transfer data to one item in this list\n at a time. Amazon AppFlow does not currently support flows to multiple destinations at\n once.
", "smithy.api#http": { "method": "POST", "uri": "/create-flow", @@ -1994,7 +1994,7 @@ "kmsArn": { "target": "com.amazonaws.appflow#KMSArn", "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If\n you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n
" + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS\n key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
" } }, "triggerConfig": { @@ -2021,7 +2021,7 @@ "tasks": { "target": "com.amazonaws.appflow#Tasks", "traits": { - "smithy.api#documentation": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n
", + "smithy.api#documentation": "A list of tasks that Amazon AppFlow performs while transferring the data in the\n flow run.
", "smithy.api#required": {} } }, @@ -2167,7 +2167,7 @@ "errorHandlingConfig": { "target": "com.amazonaws.appflow#ErrorHandlingConfig", "traits": { - "smithy.api#documentation": "The settings that determine how Amazon AppFlow handles an error when placing data in the\n custom connector as destination.
" + "smithy.api#documentation": "The settings that determine how Amazon AppFlow handles an error when placing data in\n the custom connector as destination.
" } }, "writeOperationType": { @@ -2179,7 +2179,7 @@ "idFieldNames": { "target": "com.amazonaws.appflow#IdFieldNameList", "traits": { - "smithy.api#documentation": "The name of the field that Amazon AppFlow uses as an ID when performing a write operation\n such as update, delete, or upsert.
" + "smithy.api#documentation": "The name of the field that Amazon AppFlow uses as an ID when performing a write\n operation such as update, delete, or upsert.
" } }, "customProperties": { @@ -2318,7 +2318,7 @@ "objectTypeName": { "target": "com.amazonaws.appflow#ObjectTypeName", "traits": { - "smithy.api#documentation": "The object specified in the Amazon Connect Customer Profiles flow destination.
" + "smithy.api#documentation": "The object specified in the Amazon Connect Customer Profiles flow destination.\n
" } } }, @@ -2538,7 +2538,7 @@ "forceDelete": { "target": "com.amazonaws.appflow#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether Amazon AppFlow should delete the profile, even if it is currently in\n use in one or more flows.
" + "smithy.api#documentation": "Indicates whether Amazon AppFlow should delete the profile, even if it is currently\n in use in one or more flows.
" } } } @@ -2567,7 +2567,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables your application to delete an existing flow. Before deleting the flow, Amazon\n AppFlow validates the request by checking the flow configuration and status. You can delete\n flows one at a time.
", + "smithy.api#documentation": "Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can\n delete flows one at a time.
", "smithy.api#http": { "method": "POST", "uri": "/delete-flow", @@ -2588,7 +2588,7 @@ "forceDelete": { "target": "com.amazonaws.appflow#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.\n
" + "smithy.api#documentation": "Indicates whether Amazon AppFlow should delete the flow, even if it is currently in\n use.
" } } } @@ -2651,7 +2651,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides details regarding the entity used with the connector, with a description of the\n data model for each entity.
", + "smithy.api#documentation": "Provides details regarding the entity used with the connector, with a description of the\n data model for each field in that entity.
", "smithy.api#http": { "method": "POST", "uri": "/describe-connector-entity", @@ -2829,7 +2829,7 @@ } ], "traits": { - "smithy.api#documentation": " Describes the connectors vended by Amazon AppFlow for specified connector types. If you\n don't specify a connector type, this operation describes all connectors vended by Amazon\n AppFlow. If there are more connectors than can be returned in one page, the response contains\n a nextToken
object, which can be be passed in to the next call to the\n DescribeConnectors
API operation to retrieve the next page.
Describes the connectors vended by Amazon AppFlow for specified connector types. If\n you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response\n contains a nextToken
object, which can be be passed in to the next call to the\n DescribeConnectors
API operation to retrieve the next page.
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If\n you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n
" + "smithy.api#documentation": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS\n key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
" } }, "flowStatus": { @@ -3047,7 +3047,7 @@ "destinationFlowConfigList": { "target": "com.amazonaws.appflow#DestinationFlowConfigList", "traits": { - "smithy.api#documentation": "The configuration that controls how Amazon AppFlow transfers data to the destination\n connector.
" + "smithy.api#documentation": "The configuration that controls how Amazon AppFlow transfers data to the\n destination connector.
" } }, "lastRunExecutionDetails": { @@ -3065,7 +3065,7 @@ "tasks": { "target": "com.amazonaws.appflow#Tasks", "traits": { - "smithy.api#documentation": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n
" + "smithy.api#documentation": "A list of tasks that Amazon AppFlow performs while transferring the data in the\n flow run.
" } }, "createdAt": { @@ -3475,7 +3475,7 @@ } }, "traits": { - "smithy.api#documentation": " The settings that determine how Amazon AppFlow handles an error when placing data in the\n destination. For example, this setting would determine if the flow should fail after one\n insertion error, or continue and attempt to insert every record regardless of the initial\n failure. ErrorHandlingConfig
is a part of the destination connector details.\n
The settings that determine how Amazon AppFlow handles an error when placing data\n in the destination. For example, this setting would determine if the flow should fail after\n one insertion error, or continue and attempt to insert every record regardless of the initial\n failure. ErrorHandlingConfig
is a part of the destination connector details.\n
The properties that are applied when Amazon EventBridge is being used as a destination.\n
" + "smithy.api#documentation": "The properties that are applied when Amazon EventBridge is being used as a\n destination.
" } }, "com.amazonaws.appflow#EventBridgeMetadata": { @@ -3800,7 +3800,7 @@ "sourceConnectorType": { "target": "com.amazonaws.appflow#ConnectorType", "traits": { - "smithy.api#documentation": "Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.\n
" + "smithy.api#documentation": "Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude,\n and so on.
" } }, "sourceConnectorLabel": { @@ -3812,7 +3812,7 @@ "destinationConnectorType": { "target": "com.amazonaws.appflow#ConnectorType", "traits": { - "smithy.api#documentation": "Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and\n so on.
" + "smithy.api#documentation": "Specifies the destination connector type, such as Salesforce, Amazon S3,\n Amplitude, and so on.
" } }, "destinationConnectorLabel": { @@ -3878,6 +3878,15 @@ "smithy.api#pattern": "^[\\w!@#\\-.?,\\s]*$" } }, + "com.amazonaws.appflow#FlowErrorDeactivationThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.appflow#FlowExecutionList": { "type": "list", "member": { @@ -4303,6 +4312,12 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.appflow#JavaBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.appflow#KMSArn": { "type": "string", "traits": { @@ -4771,7 +4786,7 @@ } }, "traits": { - "smithy.api#documentation": "The properties that Amazon AppFlow applies when you use Marketo as a flow destination.
" + "smithy.api#documentation": "The properties that Amazon AppFlow applies when you use Marketo as a flow\n destination.
" } }, "com.amazonaws.appflow#MarketoMetadata": { @@ -5021,7 +5036,7 @@ "tokenUrlCustomProperties": { "target": "com.amazonaws.appflow#TokenUrlCustomProperties", "traits": { - "smithy.api#documentation": "Associates your token URL with a map of properties that you define. Use this parameter\n to provide any additional details that the connector requires to authenticate your\n request.
" + "smithy.api#documentation": "Associates your token URL with a map of properties that you define. Use this parameter to\n provide any additional details that the connector requires to authenticate your\n request.
" } } }, @@ -5420,7 +5435,7 @@ } }, "traits": { - "smithy.api#documentation": "Determines the prefix that Amazon AppFlow applies to the destination folder name. You can\n name your destination folders according to the flow frequency and date.
" + "smithy.api#documentation": "Determines the prefix that Amazon AppFlow applies to the destination folder name.\n You can name your destination folders according to the flow frequency and date.
" } }, "com.amazonaws.appflow#PrefixFormat": { @@ -5655,7 +5670,7 @@ } }, "traits": { - "smithy.api#documentation": "The connector-specific profile credentials required when using Amazon Redshift.
" + "smithy.api#documentation": "The connector-specific profile credentials required when using Amazon Redshift.\n
" } }, "com.amazonaws.appflow#RedshiftConnectorProfileProperties": { @@ -5706,7 +5721,7 @@ "intermediateBucketName": { "target": "com.amazonaws.appflow#BucketName", "traits": { - "smithy.api#documentation": "The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.\n
", + "smithy.api#documentation": "The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
", "smithy.api#required": {} } }, @@ -5719,7 +5734,7 @@ "errorHandlingConfig": { "target": "com.amazonaws.appflow#ErrorHandlingConfig", "traits": { - "smithy.api#documentation": " The settings that determine how Amazon AppFlow handles an error when placing data in the\n Amazon Redshift destination. For example, this setting would determine if the flow should fail\n after one insertion error, or continue and attempt to insert every record regardless of the\n initial failure. ErrorHandlingConfig
is a part of the destination connector\n details.
The settings that determine how Amazon AppFlow handles an error when placing data\n in the Amazon Redshift destination. For example, this setting would determine if the flow\n should fail after one insertion error, or continue and attempt to insert every record\n regardless of the initial failure. ErrorHandlingConfig
is a part of the\n destination connector details.
The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
", + "smithy.api#documentation": "The Amazon S3 bucket name in which Amazon AppFlow places the transferred\n data.
", "smithy.api#required": {} } }, @@ -6016,7 +6031,7 @@ } }, "traits": { - "smithy.api#documentation": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
" + "smithy.api#documentation": "When you use Amazon S3 as the source, the configuration format that you provide\n the flow input data.
" } }, "com.amazonaws.appflow#S3Metadata": { @@ -6032,21 +6047,27 @@ "fileType": { "target": "com.amazonaws.appflow#FileType", "traits": { - "smithy.api#documentation": "Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
" + "smithy.api#documentation": "Indicates the file type that Amazon AppFlow places in the Amazon S3\n bucket.
" } }, "prefixConfig": { "target": "com.amazonaws.appflow#PrefixConfig", "traits": { - "smithy.api#documentation": "Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3\n bucket. You can name folders according to the flow frequency and date.
" + "smithy.api#documentation": "Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.
" } }, "aggregationConfig": { "target": "com.amazonaws.appflow#AggregationConfig" + }, + "preserveSourceDataTyping": { + "target": "com.amazonaws.appflow#JavaBoolean", + "traits": { + "smithy.api#documentation": "If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.
\n\n true
: Amazon AppFlow preserves the data types when it writes to\n Amazon S3. For example, an integer or 1
in your source data is\n still an integer in your output.
\n false
: Amazon AppFlow converts all of the source data into strings\n when it writes to Amazon S3. For example, an integer of 1
in your\n source data becomes the string \"1\"
in the output.
The configuration that determines how Amazon AppFlow should format the flow output data\n when Amazon S3 is used as the destination.
" + "smithy.api#documentation": "The configuration that determines how Amazon AppFlow should format the flow output\n data when Amazon S3 is used as the destination.
" } }, "com.amazonaws.appflow#S3SourceProperties": { @@ -6062,7 +6083,7 @@ "bucketPrefix": { "target": "com.amazonaws.appflow#BucketPrefix", "traits": { - "smithy.api#documentation": "The object key for the Amazon S3 bucket in which the source files are stored.
" + "smithy.api#documentation": "The object key for the Amazon S3 bucket in which the source files are stored.\n
" } }, "s3InputFormatConfig": { @@ -6070,7 +6091,7 @@ } }, "traits": { - "smithy.api#documentation": "The properties that are applied when Amazon S3 is being used as the flow source.
" + "smithy.api#documentation": "The properties that are applied when Amazon S3 is being used as the flow source.\n
" } }, "com.amazonaws.appflow#SAPODataConnectorOperator": { @@ -6252,7 +6273,7 @@ "successResponseHandlingConfig": { "target": "com.amazonaws.appflow#SuccessResponseHandlingConfig", "traits": { - "smithy.api#documentation": "Determines how Amazon AppFlow handles the success response that it gets\n from the connector after placing data.
\nFor example, this setting would determine where to write the response from a destination\n connector upon a successful insert operation.
" + "smithy.api#documentation": "Determines how Amazon AppFlow handles the success response that it gets from the\n connector after placing data.
\nFor example, this setting would determine where to write the response from a destination\n connector upon a successful insert operation.
" } }, "idFieldNames": { @@ -6446,13 +6467,13 @@ "idFieldNames": { "target": "com.amazonaws.appflow#IdFieldNameList", "traits": { - "smithy.api#documentation": "The name of the field that Amazon AppFlow uses as an ID when performing a write operation\n such as update or delete.
" + "smithy.api#documentation": "The name of the field that Amazon AppFlow uses as an ID when performing a write\n operation such as update or delete.
" } }, "errorHandlingConfig": { "target": "com.amazonaws.appflow#ErrorHandlingConfig", "traits": { - "smithy.api#documentation": " The settings that determine how Amazon AppFlow handles an error when placing data in the\n Salesforce destination. For example, this setting would determine if the flow should fail\n after one insertion error, or continue and attempt to insert every record regardless of the\n initial failure. ErrorHandlingConfig
is a part of the destination connector\n details.
The settings that determine how Amazon AppFlow handles an error when placing data\n in the Salesforce destination. For example, this setting would determine if the flow should\n fail after one insertion error, or continue and attempt to insert every record regardless of\n the initial failure. ErrorHandlingConfig
is a part of the destination connector\n details.
Welcome to the Amazon AppFlow API reference. This guide is for developers who need\n detailed information about the Amazon AppFlow API operations, data types, and errors.
\n\nAmazon AppFlow is a fully managed integration service that enables you to securely\n transfer data between software as a service (SaaS) applications like Salesforce, Marketo,\n Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.
\n\n\n\nUse the following links to get started on the Amazon AppFlow API:
\n\n\n Actions: An alphabetical list of all Amazon AppFlow API operations.
\n\n Data\n types: An alphabetical list of all Amazon AppFlow data types.
\n\n Common parameters: Parameters that all Query operations can use.
\n\n Common\n errors: Client and server errors that all operations can return.
\nIf you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User\n Guide.
\nAmazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include\n applicable OAuth attributes (such as auth-code
and redirecturi
) with\n the connector-specific ConnectorProfileProperties
when creating a new connector\n profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the\n \n Authorize Apps with OAuth\n documentation.
Welcome to the Amazon AppFlow API reference. This guide is for developers who need\n detailed information about the Amazon AppFlow API operations, data types, and errors.
\nAmazon AppFlow is a fully managed integration service that enables you to securely\n transfer data between software as a service (SaaS) applications like Salesforce, Marketo,\n Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.
\nUse the following links to get started on the Amazon AppFlow API:
\n\n Actions: An alphabetical list of all Amazon AppFlow API\n operations.
\n\n Data\n types: An alphabetical list of all Amazon AppFlow data types.
\n\n Common parameters: Parameters that all Query operations can use.
\n\n Common\n errors: Client and server errors that all operations can return.
\nIf you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.
\nAmazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include\n applicable OAuth attributes (such as auth-code
and redirecturi
) with\n the connector-specific ConnectorProfileProperties
when creating a new connector\n profile using Amazon AppFlow API operations. For example, Salesforce users can refer to\n the \n Authorize Apps with OAuth\n documentation.
Specifies the scheduled start time for a schedule-triggered flow.
" + "smithy.api#documentation": "The time at which the scheduled flow starts. The time is formatted as a timestamp that\n follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00
.
Specifies the scheduled end time for a schedule-triggered flow.
" + "smithy.api#documentation": "The time at which the scheduled flow ends. The time is formatted as a timestamp that\n follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00
.
Specifies the time zone used when referring to the date and time of a scheduled-triggered\n flow, such as America/New_York
.
Specifies the time zone used when referring to the dates and times of a scheduled flow,\n such as America/New_York
. This time zone is only a descriptive label. It doesn't affect how\n Amazon AppFlow interprets the timestamps that you specify to schedule the flow.
If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC\n offset in your timestamps. For example, the UTC offsets for the America/New_York
timezone are\n -04:00
EDT and -05:00 EST
.
Specifies the date range for the records to import from the connector in the first flow\n run.
" } + }, + "flowErrorDeactivationThreshold": { + "target": "com.amazonaws.appflow#FlowErrorDeactivationThreshold", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Defines how many times a scheduled flow fails consecutively before Amazon AppFlow\n deactivates it.
" + } } }, "traits": { @@ -7179,7 +7207,7 @@ "stage": { "target": "com.amazonaws.appflow#Stage", "traits": { - "smithy.api#documentation": " The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in\n the Snowflake account. This is written in the following format: < Database><\n Schema>
The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: <\n Database>< Schema>
The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
" + "smithy.api#documentation": "The bucket path that refers to the Amazon S3 bucket associated with Snowflake.\n
" } }, "privateLinkServiceName": { @@ -7232,7 +7260,7 @@ "intermediateBucketName": { "target": "com.amazonaws.appflow#BucketName", "traits": { - "smithy.api#documentation": "The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
", + "smithy.api#documentation": "The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.\n
", "smithy.api#required": {} } }, @@ -7245,7 +7273,7 @@ "errorHandlingConfig": { "target": "com.amazonaws.appflow#ErrorHandlingConfig", "traits": { - "smithy.api#documentation": " The settings that determine how Amazon AppFlow handles an error when placing data in the\n Snowflake destination. For example, this setting would determine if the flow should fail after\n one insertion error, or continue and attempt to insert every record regardless of the initial\n failure. ErrorHandlingConfig
is a part of the destination connector details.\n
The settings that determine how Amazon AppFlow handles an error when placing data\n in the Snowflake destination. For example, this setting would determine if the flow should\n fail after one insertion error, or continue and attempt to insert every record regardless of\n the initial failure. ErrorHandlingConfig
is a part of the destination connector\n details.
Determines how Amazon AppFlow handles the success response that it gets\n from the connector after placing data.
\nFor example, this setting would determine\n where to write the response from the destination connector upon a successful insert\n operation.
" + "smithy.api#documentation": "Determines how Amazon AppFlow handles the success response that it gets from the\n connector after placing data.
\nFor example, this setting would determine where to write the response from the destination\n connector upon a successful insert operation.
" } }, "com.amazonaws.appflow#SupportedApiVersion": { @@ -8028,7 +8056,7 @@ } }, "traits": { - "smithy.api#documentation": "The trigger settings that determine how and when Amazon AppFlow runs the specified flow.\n
" + "smithy.api#documentation": "The trigger settings that determine how and when Amazon AppFlow runs the specified\n flow.
" } }, "com.amazonaws.appflow#TriggerProperties": { @@ -8111,7 +8139,7 @@ "forceDelete": { "target": "com.amazonaws.appflow#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether Amazon AppFlow should unregister the connector, even if it is currently\n in use in one or more connector profiles. The default value is false.
" + "smithy.api#documentation": "Indicates whether Amazon AppFlow should unregister the connector, even if it is\n currently in use in one or more connector profiles. The default value is false.
" } } } @@ -8329,14 +8357,14 @@ "destinationFlowConfigList": { "target": "com.amazonaws.appflow#DestinationFlowConfigList", "traits": { - "smithy.api#documentation": "The configuration that controls how Amazon AppFlow transfers data to the destination\n connector.
", + "smithy.api#documentation": "The configuration that controls how Amazon AppFlow transfers data to the\n destination connector.
", "smithy.api#required": {} } }, "tasks": { "target": "com.amazonaws.appflow#Tasks", "traits": { - "smithy.api#documentation": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n
", + "smithy.api#documentation": "A list of tasks that Amazon AppFlow performs while transferring the data in the\n flow run.
", "smithy.api#required": {} } } @@ -8379,14 +8407,14 @@ "bucketName": { "target": "com.amazonaws.appflow#UpsolverBucketName", "traits": { - "smithy.api#documentation": "The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.\n
", + "smithy.api#documentation": "The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the\n transferred data.
", "smithy.api#required": {} } }, "bucketPrefix": { "target": "com.amazonaws.appflow#BucketPrefix", "traits": { - "smithy.api#documentation": "The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow\n places the files.
" + "smithy.api#documentation": "The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
" } }, "s3OutputFormatConfig": { @@ -8414,7 +8442,7 @@ "fileType": { "target": "com.amazonaws.appflow#FileType", "traits": { - "smithy.api#documentation": "Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.\n
" + "smithy.api#documentation": "Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
" } }, "prefixConfig": { @@ -8428,7 +8456,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration that determines how Amazon AppFlow formats the flow output data when\n Upsolver is used as the destination.
" + "smithy.api#documentation": "The configuration that determines how Amazon AppFlow formats the flow output data\n when Upsolver is used as the destination.
" } }, "com.amazonaws.appflow#Username": { diff --git a/aws/sdk/aws-models/appmesh.json b/aws/sdk/aws-models/appmesh.json index 9273d629e0b..c848c8ec46a 100644 --- a/aws/sdk/aws-models/appmesh.json +++ b/aws/sdk/aws-models/appmesh.json @@ -26,6 +26,22 @@ }, "com.amazonaws.appmesh#AppMesh": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "App Mesh", + "arnNamespace": "appmesh", + "cloudFormationName": "AppMesh", + "cloudTrailEventSource": "appmesh.amazonaws.com", + "endpointPrefix": "appmesh" + }, + "aws.auth#sigv4": { + "name": "appmesh" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "App Mesh is a service mesh based on the Envoy proxy that makes it easy to\n monitor and control microservices. App Mesh standardizes how your microservices\n communicate, giving you end-to-end visibility and helping to ensure high availability for\n your applications.
\nApp Mesh gives you consistent visibility and network traffic controls for\n every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and\n Amazon EC2.
\nApp Mesh supports microservice applications that use service discovery\n naming for their components. For more information about service discovery on Amazon ECS, see Service\n Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes\n kube-dns
and coredns
are supported. For more information,\n see DNS\n for Services and Pods in the Kubernetes documentation.
App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control microservices. App Mesh standardizes how your microservices communicate, giving you\n end-to-end visibility and helping to ensure high availability for your applications.
\nApp Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS,\n Kubernetes on Amazon Web Services, and Amazon EC2.
\nApp Mesh supports microservice applications that use service discovery naming for their\n components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes\n kube-dns
and coredns
are supported. For more information,\n see DNS\n for Services and Pods in the Kubernetes documentation.
The name of an Cloud Map service instance attribute key. Any Cloud Map service\n instance that contains the specified key and value is returned.
", + "smithy.api#documentation": "The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is\n returned.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.appmesh#AwsCloudMapInstanceAttributeValue", "traits": { - "smithy.api#documentation": "The value of an Cloud Map service instance attribute key. Any Cloud Map service\n instance that contains the specified key and value is returned.
", + "smithy.api#documentation": "The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is\n returned.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An object that represents the Cloud Map attribute information for your virtual\n node.
\nAWS Cloud Map is not available in the eu-south-1 Region.
\nAn object that represents the Cloud Map attribute information for your\n virtual node.
\nCloud Map is not available in the eu-south-1 Region.
\nA string map that contains attributes with values that you can use to filter instances\n by any custom attribute that you specified when you registered the instance. Only instances\n that match all of the specified key/value pairs will be returned.
" } + }, + "ipPreference": { + "target": "com.amazonaws.appmesh#IpPreference", + "traits": { + "smithy.api#documentation": "The IP version to use to control traffic within the mesh.
" + } } }, "traits": { - "smithy.api#documentation": "An object that represents the Cloud Map service discovery information for your virtual\n node.
\nCloud Map is not available in the eu-south-1 Region.
\nAn object that represents the Cloud Map service discovery information for\n your virtual node.
\nCloud Map is not available in the eu-south-1 Region.
\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -593,7 +599,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -653,7 +659,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a virtual gateway.
\nA virtual gateway allows resources outside your mesh to communicate to resources that\n are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS\n task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which\n represents an Envoy running with an application, a virtual gateway represents Envoy\n deployed by itself.
\nFor more information about virtual gateways, see Virtual gateways.
", + "smithy.api#documentation": "Creates a virtual gateway.
\nA virtual gateway allows resources outside your mesh to communicate to resources that\n are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a\n virtual node, which represents an Envoy running with an application, a virtual gateway\n represents Envoy deployed by itself.
\nFor more information about virtual gateways, see Virtual gateways.
", "smithy.api#http": { "method": "PUT", "uri": "/v20190125/meshes/{meshName}/virtualGateways", @@ -703,7 +709,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -757,7 +763,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a virtual node within a service mesh.
\nA virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you can specify the\n service discovery information for your task group, and whether the proxy running in a task\n group will communicate with other proxies using Transport Layer Security (TLS).
\nYou define a listener
for any inbound traffic that your virtual node\n expects. Any virtual service that your virtual node expects to communicate to is specified\n as a backend
.
The response metadata for your new virtual node contains the arn
that is\n associated with the virtual node. Set this value to the full ARN; for example,\n arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp
)\n as the APPMESH_RESOURCE_ARN
environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n node.id
and node.cluster
Envoy parameters.
By default, App Mesh uses the name of the resource you specified in\n APPMESH_RESOURCE_ARN
when Envoy is referring to itself in metrics and\n traces. You can override this behavior by setting the\n APPMESH_RESOURCE_CLUSTER
environment variable with your own name.
For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0
or later of the Envoy image when\n setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in\n the AWS App Mesh User Guide.
Creates a virtual node within a service mesh.
\nA virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can\n specify the service discovery information for your task group, and whether the proxy\n running in a task group will communicate with other proxies using Transport Layer Security\n (TLS).
\nYou define a listener
for any inbound traffic that your virtual node\n expects. Any virtual service that your virtual node expects to communicate to is specified\n as a backend
.
The response metadata for your new virtual node contains the arn
that is\n associated with the virtual node. Set this value to the full ARN; for example,\n arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp
)\n as the APPMESH_RESOURCE_ARN
environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n node.id
and node.cluster
Envoy parameters.
By default, App Mesh uses the name of the resource you specified in\n APPMESH_RESOURCE_ARN
when Envoy is referring to itself in metrics and\n traces. You can override this behavior by setting the\n APPMESH_RESOURCE_CLUSTER
environment variable with your own name.
For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0
or later of the Envoy image when\n setting these variables. For more information aboutApp Mesh Envoy variables, see\n Envoy\n image in the App Mesh User Guide.
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -923,7 +929,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1036,7 +1042,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1147,7 +1153,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1310,7 +1316,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1398,7 +1404,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1480,7 +1486,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1568,7 +1574,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1656,7 +1662,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1749,7 +1755,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1820,7 +1826,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -1905,7 +1911,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } }, @@ -1998,7 +2004,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -2077,7 +2083,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -2162,7 +2168,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -2247,7 +2253,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -2302,6 +2308,12 @@ "traits": { "smithy.api#documentation": "Specifies the DNS response type for the virtual node.
" } + }, + "ipPreference": { + "target": "com.amazonaws.appmesh#IpPreference", + "traits": { + "smithy.api#documentation": "The IP version to use to control traffic within the mesh.
" + } } }, "traits": { @@ -2358,7 +2370,7 @@ "type": { "target": "com.amazonaws.appmesh#EgressFilterType", "traits": { - "smithy.api#documentation": "The egress filter type. By default, the type is DROP_ALL
, which allows\n egress only from virtual nodes to other defined resources in the service mesh (and any\n traffic to *.amazonaws.com
for Amazon Web Services API calls). You can set the egress filter\n type to ALLOW_ALL
to allow egress to any endpoint inside or outside of the\n service mesh.
The egress filter type. By default, the type is DROP_ALL
, which allows\n egress only from virtual nodes to other defined resources in the service mesh (and any\n traffic to *.amazonaws.com
for Amazon Web Services API calls). You can set the\n egress filter type to ALLOW_ALL
to allow egress to any endpoint inside or\n outside of the service mesh.
The file path to write access logs to. You can use /dev/stdout
to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n awslogs
, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.
The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.
\nThe file path to write access logs to. You can use /dev/stdout
to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n awslogs
, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.
The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.
\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -2818,7 +2830,7 @@ "invert": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Specify True
to match anything except the match criteria. The default value is False
.
Specify True
to match anything except the match criteria. The default value\n is False
.
Specify at least one of the following values.
\n\n server-error – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511
\n\n gateway-error – HTTP status codes 502,\n 503, and 504
\n\n client-error – HTTP status code 409
\n\n stream-error – Retry on refused\n stream
\nSpecify at least one of the following values.
\n\n server-error – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511
\n\n gateway-error – HTTP status codes 502,\n 503, and 504
\n\n client-error – HTTP status code 409
\n\n stream-error – Retry on refused\n stream
\nSpecify True
to match anything except the match criteria. The default value is False
.
Specify True
to match anything except the match criteria. The default value\n is False
.
An object that represents the method and value to match with the header value sent in a\n request. Specify one match method.
" + } } }, "traits": { @@ -3613,7 +3628,7 @@ "httpRetryEvents": { "target": "com.amazonaws.appmesh#HttpRetryPolicyEvents", "traits": { - "smithy.api#documentation": "Specify at least one of the following values.
\n\n server-error – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511
\n\n gateway-error – HTTP status codes 502,\n 503, and 504
\n\n client-error – HTTP status code 409
\n\n stream-error – Retry on refused\n stream
\nSpecify at least one of the following values.
\n\n server-error – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511
\n\n gateway-error – HTTP status codes 502,\n 503, and 504
\n\n client-error – HTTP status code 409
\n\n stream-error – Retry on refused\n stream
\nYou have exceeded a service limit for your account. For more information, see Service\n Limits in the AWS App Mesh User Guide.
", + "smithy.api#documentation": "You have exceeded a service limit for your account. For more information, see Service\n Limits in the App Mesh User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3922,7 +3960,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -4006,7 +4044,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The nextToken
value returned from a previous paginated\n ListMeshes
request where limit
was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken
value.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken
value returned from a previous paginated\n ListMeshes
request where limit
was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken
value.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -4343,7 +4381,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -4449,7 +4487,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -4561,7 +4599,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -4673,7 +4711,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -4758,6 +4796,16 @@ "smithy.api#documentation": "An object that represents a listener for a virtual node.
" } }, + "com.amazonaws.lattice.v20190125#ListenerPort": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, "com.amazonaws.appmesh#ListenerTimeout": { "type": "union", "members": { @@ -4830,7 +4878,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that represents an AWS Certicate Manager (ACM) certificate.
" + "smithy.api#documentation": "An object that represents an Certificate Manager certificate.
" } }, "com.amazonaws.appmesh#ListenerTlsCertificate": { @@ -4839,7 +4887,7 @@ "acm": { "target": "com.amazonaws.appmesh#ListenerTlsAcmCertificate", "traits": { - "smithy.api#documentation": "A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
" + "smithy.api#documentation": "A reference to an object that represents an Certificate Manager certificate.
" } }, "file": { @@ -4912,7 +4960,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that represents the listener's Secret Discovery Service certificate. The proxy\n must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation\n for more info.
" + "smithy.api#documentation": "An object that represents the listener's Secret Discovery Service certificate. The proxy\n must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh\n TLS\n documentation for more info.
" } }, "com.amazonaws.appmesh#ListenerTlsValidationContext": { @@ -4960,12 +5008,6 @@ "type": "list", "member": { "target": "com.amazonaws.appmesh#Listener" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } } }, "com.amazonaws.appmesh#Logging": { @@ -5142,14 +5184,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -5186,6 +5228,20 @@ "smithy.api#documentation": "An object that represents a service mesh returned by a list operation.
" } }, + "com.amazonaws.appmesh#MeshServiceDiscovery": { + "type": "structure", + "members": { + "ipPreference": { + "target": "com.amazonaws.appmesh#IpPreference", + "traits": { + "smithy.api#documentation": "The IP version to use to control traffic within the mesh.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that represents the service discovery information for a service mesh.
" + } + }, "com.amazonaws.appmesh#MeshSpec": { "type": "structure", "members": { @@ -5194,6 +5250,9 @@ "traits": { "smithy.api#documentation": "The egress filter rules for the service mesh.
" } + }, + "serviceDiscovery": { + "target": "com.amazonaws.appmesh#MeshServiceDiscovery" } }, "traits": { @@ -5450,14 +5509,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } } @@ -5610,14 +5669,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -6104,7 +6163,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The\n proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh\n TLS\n documentation for more info.
" + "smithy.api#documentation": "An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The\n proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh\n TLS\n documentation for more info.
" } }, "com.amazonaws.appmesh#TlsValidationContextTrust": { @@ -6113,7 +6172,7 @@ "acm": { "target": "com.amazonaws.appmesh#TlsValidationContextAcmTrust", "traits": { - "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an\n Certificate Manager certificate.
" + "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
" } }, "file": { @@ -6141,7 +6200,7 @@ } }, "traits": { - "smithy.api#documentation": "The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between\n requests.
", + "smithy.api#documentation": "The maximum request rate permitted by the App Mesh APIs has been exceeded for\n your account. For best results, use an increasing or variable sleep interval between\n requests.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -6321,7 +6380,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -6513,7 +6572,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -6618,7 +6677,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -6717,7 +6776,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -6822,7 +6881,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -6927,7 +6986,7 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#httpQuery": "meshOwner" } } @@ -7532,12 +7591,6 @@ "type": "list", "member": { "target": "com.amazonaws.appmesh#VirtualGatewayListener" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } } }, "com.amazonaws.appmesh#VirtualGatewayLogging": { @@ -7615,14 +7668,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -7783,7 +7836,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service\n validation context trust. The proxy must be configured with a local SDS provider via a Unix\n Domain Socket. See App Mesh TLS documentation for more info.
" + "smithy.api#documentation": "An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service\n validation context trust. The proxy must be configured with a local SDS provider via a Unix\n Domain Socket. See App Mesh\n TLS\n documentation for more info.
" } }, "com.amazonaws.appmesh#VirtualGatewayTlsValidationContextTrust": { @@ -7792,7 +7845,7 @@ "acm": { "target": "com.amazonaws.appmesh#VirtualGatewayTlsValidationContextAcmTrust", "traits": { - "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an\n Certificate Manager certificate.
" + "smithy.api#documentation": "A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
" } }, "file": { @@ -8004,14 +8057,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -8261,12 +8314,6 @@ "type": "list", "member": { "target": "com.amazonaws.appmesh#VirtualRouterListener" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } } }, "com.amazonaws.appmesh#VirtualRouterRef": { @@ -8289,14 +8336,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -8544,14 +8591,14 @@ "meshOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, "resourceOwner": { "target": "com.amazonaws.appmesh#AccountId", "traits": { - "smithy.api#documentation": "The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", + "smithy.api#documentation": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
", "smithy.api#required": {} } }, @@ -8594,7 +8641,7 @@ "provider": { "target": "com.amazonaws.appmesh#VirtualServiceProvider", "traits": { - "smithy.api#documentation": "The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.
" + "smithy.api#documentation": "The App Mesh object that is acting as the provider for a virtual service. You\n can specify a single virtual node or virtual router.
" } } }, diff --git a/aws/sdk/aws-models/apprunner.json b/aws/sdk/aws-models/apprunner.json index ad29ce60899..d8664c2c476 100644 --- a/aws/sdk/aws-models/apprunner.json +++ b/aws/sdk/aws-models/apprunner.json @@ -549,7 +549,7 @@ "CodeConfiguration": { "target": "com.amazonaws.apprunner#CodeConfiguration", "traits": { - "smithy.api#documentation": "Configuration for building and running the service from a source code repository.
" + "smithy.api#documentation": "Configuration for building and running the service from a source code repository.
\n\n CodeConfiguration
is required only for CreateService
request.
A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single\n Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
", + "smithy.api#documentation": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single\n Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
\n\n App Runner currently only provides support for IPv4.\n
\nKey-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }
. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any\n changes to these tags require that you create a new compute environment and remove the old compute environment. These\n tags aren't seen when using the Batch ListTagsForResource
API operation.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.
\nKey-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }
. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute environment. For\n more information, see Updating compute\n environments in the Batch User Guide. These tags aren't seen when using the Batch\n ListTagsForResource
API operation.
This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.
\nCreates an Batch compute environment. You can create MANAGED
or UNMANAGED
compute\n environments. MANAGED
compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED
compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that\n each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nBatch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it\n doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible\n for managing the guest operating system (including its updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nCreates an Batch compute environment. You can create MANAGED
or UNMANAGED
compute\n environments. MANAGED
compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED
compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that\n each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nBatch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nIn April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:
\nEither do not set the service role (serviceRole
) parameter or set it to the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy
) parameter to BEST_FIT_PROGRESSIVE
\n or SPOT_CAPACITY_OPTIMIZED
.
Set the update to latest image version (updateToLatestImageVersion
) parameter to\n true
.
Do not specify an AMI ID in imageId
, imageIdOverride
(in \n ec2Configuration
\n ), or in the launch template (launchTemplate
). In that case\n Batch will select the latest Amazon ECS optimized AMI supported by Batch at the time the infrastructure update is\n initiated. Alternatively you can specify the AMI ID in the imageId
or imageIdOverride
\n parameters, or the launch template identified by the LaunchTemplate
properties. Changing any of these\n properties will trigger an infrastructure update. If the AMI ID is specified in the launch template, it can not be\n replaced by specifying an AMI ID in either the imageId
or imageIdOverride
parameters. It\n can only be replaced by specifying a different launch template, or if the launch template version is set to\n $Default
or $Latest
, by setting either a new default version for the launch template\n (if $Default
)or by adding a new version to the launch template (if $Latest
).
If these rules are followed, any update that triggers an infrastructure update will cause the AMI ID to be\n re-selected. If the version
setting in the launch template (launchTemplate
) is set to\n $Latest
or $Default
, the latest or default version of the launch template will be\n evaluated up at the time of the infrastructure update, even if the launchTemplate
was not\n updated.
The share identifier for the job.
" + "smithy.api#documentation": "The share identifier for the job. If the job queue does not have a scheduling policy, then this parameter must\n not be specified. If the job queue has a scheduling policy, then this parameter must be specified.
" } }, "schedulingPriorityOverride": { diff --git a/aws/sdk/aws-models/cloudformation.json b/aws/sdk/aws-models/cloudformation.json index 667bd5700d6..1b699ba2eae 100644 --- a/aws/sdk/aws-models/cloudformation.json +++ b/aws/sdk/aws-models/cloudformation.json @@ -158,7 +158,7 @@ "PublicTypeArn": { "target": "com.amazonaws.cloudformation#ThirdPartyTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn
, or TypeName
,\n Type
, and PublisherId
.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn
, or TypeName
,\n Type
, and PublisherId
.
The Amazon Resource Number (ARN) of the activated extension, in this account and\n region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the activated extension, in this account and\n region.
" } } } @@ -417,6 +417,9 @@ "input": { "target": "com.amazonaws.cloudformation#CancelUpdateStackInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" @@ -1284,7 +1287,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM
or CAPABILITY_NAMED_IAM
\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, CloudFormation\n returns an InsufficientCapabilities
error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND
\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when\n creating change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack\n directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information on macros, see Using CloudFormation macros to\n perform custom processing on templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM
or CAPABILITY_NAMED_IAM
\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, CloudFormation\n returns an InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND
\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or\n more macros, and you choose to create a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when\n creating change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack\n directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to\n perform custom processing on templates.
\nThe stack ID you are importing into a new stack set. Specify the Amazon Resource Number\n (ARN) of the stack.
" + "smithy.api#documentation": "The stack ID you are importing into a new stack set. Specify the Amazon Resource Name\n (ARN) of the stack.
" } }, "Parameters": { @@ -1707,7 +1710,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the IAM role to use to create this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to create this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -1878,6 +1881,9 @@ "input": { "target": "com.amazonaws.cloudformation#DeleteStackInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" @@ -2034,7 +2040,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a stack set. Before you can delete a stack set, all of its member stack\n instances must be deleted. For more information about how to do this, see DeleteStackInstances.
" + "smithy.api#documentation": "Deletes a stack set. Before you can delete a stack set, all its member stack instances\n must be deleted. For more information about how to complete this, see DeleteStackInstances.
" } }, "com.amazonaws.cloudformation#DeleteStackSetInput": { @@ -2519,7 +2525,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId
, and you have registered as an extension\n publisher, DescribePublisher
returns information about your own publisher\n account.
For more information on registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User Guide\n
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId
, and you have registered as an extension\n publisher, DescribePublisher
returns information about your own publisher\n account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User Guide\n
\nReturns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information on stack and\n resource drift, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift
returns a StackDriftDetectionId
you can use\n to monitor the progress of the operation using\n DescribeStackDriftDetectionStatus
. Once the drift detection operation has\n completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
Returns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information about stack and\n resource drift, see Detecting\n Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift
returns a StackDriftDetectionId
you can use\n to monitor the progress of the operation using\n DescribeStackDriftDetectionStatus
. Once the drift detection operation has\n completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
If the request doesn't return all of the remaining results, NextToken
is\n set to a token. To retrieve the next set of results, call\n DescribeStackResourceDrifts
again and assign that token to the request\n object's NextToken
parameter. If the request returns all results,\n NextToken
is set to null
.
If the request doesn't return all the remaining results, NextToken
is set\n to a token. To retrieve the next set of results, call\n DescribeStackResourceDrifts
again and assign that token to the request\n object's NextToken
parameter. If the request returns all results,\n NextToken
is set to null
.
The publisher ID of the extension publisher.
\nExtensions provided by Amazon are not assigned a publisher ID.
" + "smithy.api#documentation": "The publisher ID of the extension publisher.
\nExtensions provided by Amazon Web Services are not assigned a publisher ID.
" } }, "PublicVersionNumber": { @@ -3520,25 +3526,25 @@ "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use \n SetTypeDefaultVersion\n
.
The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use \n SetTypeDefaultVersion\n
.
Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and\n extensions published by Amazon. For public third-party extensions, whether or not they are\n activated in your account, CloudFormation returns null
.
Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and\n extensions published by Amazon Web Services. For public third-party extensions, whether they\n are activated in your account, CloudFormation returns null
.
The contract test status of the registered extension version. To return the extension\n test status of a specific extension version, you must specify\n VersionId
.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether or not they are activated in\n your account.
\n\n PASSED
: The extension has passed all its contract tests.
An extension must have a test status of PASSED
before it can be\n published. For more information, see Publishing extensions to make them available for public\n use in the CloudFormation Command Line Interface User\n Guide.
\n FAILED
: The extension has failed one or more contract tests.
\n IN_PROGRESS
: Contract tests are currently being performed on the\n extension.
\n NOT_TESTED
: Contract tests haven't been performed on the\n extension.
The contract test status of the registered extension version. To return the extension\n test status of a specific extension version, you must specify\n VersionId
.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether they are activated in your\n account.
\n\n PASSED
: The extension has passed all its contract tests.
An extension must have a test status of PASSED
before it can be\n published. For more information, see Publishing extensions to make them available for public\n use in the CloudFormation Command Line Interface User\n Guide.
\n FAILED
: The extension has failed one or more contract tests.
\n IN_PROGRESS
: Contract tests are currently being performed on the\n extension.
\n NOT_TESTED
: Contract tests haven't been performed on the\n extension.
The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId
.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether or not they are activated in\n your account.
" + "smithy.api#documentation": "The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId
.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether they are activated in your\n account.
" } }, "Description": { @@ -3550,7 +3556,7 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information on extension schemas, see Resource Provider\n Schema in the CloudFormation CLI User\n Guide.
" + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider\n Schema in the CloudFormation CLI User\n Guide.
" } }, "ProvisioningType": { @@ -3568,7 +3574,7 @@ "LoggingConfig": { "target": "com.amazonaws.cloudformation#LoggingConfig", "traits": { - "smithy.api#documentation": "Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns\n null
. For more information, see RegisterType.
Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns\n null
. For more information, see RegisterType.
The Amazon Resource Name (ARN) of the IAM execution role used to register\n the extension. This applies only to private extensions you have registered in your account.\n For more information, see RegisterType.
\n \nIf the registered extension calls any Amazon Web Services APIs, you must create an\n \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your\n extension with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register\n the extension. This applies only to private extensions you have registered in your account.\n For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an\n \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your\n extension with the appropriate credentials.
" } }, "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "The scope at which the extension is visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE
: The extension is only visible and usable within the account\n in which it is registered. CloudFormation marks any extensions you register as\n PRIVATE
.
\n PUBLIC
: The extension is publicly visible and usable within any\n Amazon account.
The scope at which the extension is visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE
: The extension is only visible and usable within the account\n in which it is registered. CloudFormation marks any extensions you register as\n PRIVATE
.
\n PUBLIC
: The extension is publicly visible and usable within any\n Amazon Web Services account.
Whether or not the extension is activated in the account and region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns null
.
Whether the extension is activated in the account and region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns null
.
Detect drift on a stack set. When CloudFormation performs drift detection on a\n stack set, it performs drift detection on the stack associated with each stack instance in\n the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
\n\n DetectStackSetDrift
returns the OperationId
of the stack set\n drift detection operation. Use this operation id with \n DescribeStackSetOperation\n
to monitor the progress of the drift\n detection operation. The drift detection operation may take some time, depending on the\n number of stack instances included in the stack set, in addition to the number of resources\n included in each stack.
Once the operation has completed, use the following actions to return drift\n information:
\nUse \n DescribeStackSet\n
to return detailed information\n about the stack set, including detailed information about the last\n completed drift operation performed on the stack set.\n (Information about drift operations that are in progress isn't included.)
Use \n ListStackInstances\n
to return a list of stack\n instances belonging to the stack set, including the drift status and last drift time\n checked of each instance.
Use \n DescribeStackInstance\n
to return detailed\n information about a specific stack instance, including its drift status and last\n drift time checked.
For more information on performing a drift detection operation on a stack set, see\n Detecting unmanaged\n changes in stack sets.
\nYou can only run a single drift detection operation on a given stack set at one\n time.
\nTo stop a drift detection stack set operation, use \n StopStackSetOperation\n
.
Detect drift on a stack set. When CloudFormation performs drift detection on a\n stack set, it performs drift detection on the stack associated with each stack instance in\n the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
\n\n DetectStackSetDrift
returns the OperationId
of the stack set\n drift detection operation. Use this operation id with \n DescribeStackSetOperation\n
to monitor the progress of the drift\n detection operation. The drift detection operation may take some time, depending on the\n number of stack instances included in the stack set, in addition to the number of resources\n included in each stack.
Once the operation has completed, use the following actions to return drift\n information:
\nUse \n DescribeStackSet\n
to return detailed information\n about the stack set, including detailed information about the last\n completed drift operation performed on the stack set.\n (Information about drift operations that are in progress isn't included.)
Use \n ListStackInstances\n
to return a list of stack\n instances belonging to the stack set, including the drift status and last drift time\n checked of each instance.
Use \n DescribeStackInstance\n
to return detailed\n information about a specific stack instance, including its drift status and last\n drift time checked.
For more information about performing a drift detection operation on a stack set, see\n Detecting unmanaged\n changes in stack sets.
\nYou can only run a single drift detection operation on a given stack set at one\n time.
\nTo stop a drift detection stack set operation, use \n StopStackSetOperation\n
.
The quota for the resource has already been reached.
\nFor information on resource and stack limitations, see CloudFormation\n quotas in the CloudFormation User Guide.
", + "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation\n quotas in the CloudFormation User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5080,7 +5086,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the previous request didn't return all of the remaining results, the response's\n NextToken
parameter value is set to a token. To retrieve the next set of\n results, call ListStackInstances
again and assign that token to the request\n object's NextToken
parameter. If there are no remaining results, the previous\n response object's NextToken
parameter is set to null
.
If the previous request didn't return all the remaining results, the response's\n NextToken
parameter value is set to a token. To retrieve the next set of\n results, call ListStackInstances
again and assign that token to the request\n object's NextToken
parameter. If there are no remaining results, the previous\n response object's NextToken
parameter is set to null
.
If the previous request didn't return all of the remaining results, the response\n object's NextToken
parameter value is set to a token. To retrieve the next set\n of results, call ListStackSetOperationResults
again and assign that token to\n the request object's NextToken
parameter. If there are no remaining results,\n the previous response object's NextToken
parameter is set to\n null
.
If the previous request didn't return all the remaining results, the response object's\n NextToken
parameter value is set to a token. To retrieve the next set of\n results, call ListStackSetOperationResults
again and assign that token to the\n request object's NextToken
parameter. If there are no remaining results, the\n previous response object's NextToken
parameter is set to\n null
.
If the request doesn't return all of the remaining results, NextToken
is\n set to a token. To retrieve the next set of results, call this action again and assign that\n token to the request object's NextToken
parameter. If the request returns all\n results, NextToken
is set to null
.
If the request doesn't return all the remaining results, NextToken
is set\n to a token. To retrieve the next set of results, call this action again and assign that\n token to the request object's NextToken
parameter. If the request returns all\n results, NextToken
is set to null
.
The scope at which the extensions are visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE
: Extensions that are visible and usable within this account\n and region. This includes:
Private extensions you have registered in this account and region.
\nPublic extensions that you have activated in this account and region.
\n\n PUBLIC
: Extensions that are publicly visible and available to be\n activated within any Amazon account. This includes extensions from Amazon, as well as\n third-party publishers.
The default is PRIVATE
.
The scope at which the extensions are visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE
: Extensions that are visible and usable within this account\n and region. This includes:
Private extensions you have registered in this account and region.
\nPublic extensions that you have activated in this account and region.
\n\n PUBLIC
: Extensions that are publicly visible and available to be\n activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in\n addition to third-party publishers.
The default is PRIVATE
.
If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken
parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken
parameter. If there are no remaining results, the previous\n response object's NextToken
parameter is set to null
.
If the previous paginated request didn't return all the remaining results, the response\n object's NextToken
parameter value is set to a token. To retrieve the next set\n of results, call this action again and assign that token to the request object's\n NextToken
parameter. If there are no remaining results, the previous\n response object's NextToken
parameter is set to null
.
Contains information about the module from which the resource was created, if the\n resource was created from a module included in the stack template.
\nFor more information on modules, see Using modules to encapsulate and\n reuse resource configurations in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the\n resource was created from a module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and\n reuse resource configurations in the\n CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { @@ -6353,7 +6359,7 @@ } ], "traits": { - "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public\n extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use in the\n CloudFormation CLI User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", + "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public\n extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the\n CloudFormation CLI User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", "smithy.api#idempotent": {} } }, @@ -6369,7 +6375,7 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the extension.
\nConditional: You must specify Arn
, or TypeName
and\n Type
.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn
, or TypeName
and\n Type
.
The Amazon Resource Number (ARN) assigned to the public extension upon\n publication.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) assigned to the public extension upon\n publication.
" } } } @@ -6560,7 +6566,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.\n This publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information on requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation\n extensions in the CloudFormation CLI User\n Guide.
\n ", + "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.\n This publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation\n extensions in the CloudFormation CLI User\n Guide.
\n ", "smithy.api#idempotent": {} } }, @@ -6606,7 +6612,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an\n extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information on how to develop extensions and ready them for registration, see\n Creating Resource\n Providers in the CloudFormation CLI User\n Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using \n RegisterType\n
, you can use \n DescribeTypeRegistration\n
to\n monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an\n extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration,\n see Creating Resource\n Providers in the CloudFormation CLI User\n Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using \n RegisterType\n
, you can use \n DescribeTypeRegistration\n
to\n monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, @@ -6622,14 +6628,14 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension being registered.
\nWe recommend that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nThe following organization namespaces are reserved and can't be used in your\n extension names:
\n\n Alexa
\n
\n AMZN
\n
\n Amazon
\n
\n AWS
\n
\n Custom
\n
\n Dev
\n
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks, MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your\n extension names:
\n\n Alexa
\n
\n AMZN
\n
\n Amazon
\n
\n AWS
\n
\n Custom
\n
\n Dev
\n
A URL to the S3 bucket containing the extension project package that contains the\n necessary files for the extension you want to register.
\nFor information on generating a schema handler package for the extension you want to\n register, see submit\n in the CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3\n bucket. That's, the user needs to have GetObject permissions for the\n schema handler package. For more information, see Actions, Resources, and Condition Keys\n for Amazon S3 in the Identity and Access Management User\n Guide.
\nA URL to the S3 bucket containing the extension project package that contains the\n necessary files for the extension you want to register.
\nFor information about generating a schema handler package for the extension you want to\n register, see submit\n in the CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3\n bucket. That's, the user needs to have GetObject permissions for the\n schema handler package. For more information, see Actions, Resources, and Condition Keys\n for Amazon S3 in the Identity and Access Management User\n Guide.
\nThe Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must\n contain a trust relationship with the CloudFormation service principle\n (resources.cloudformation.amazonaws.com
). For more information on adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create\n an \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler,\n CloudFormation assumes this execution role to create a temporary session token,\n which it then passes to the resource type handler, thereby supplying your resource type\n with the appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must\n contain a trust relationship with the CloudFormation service principle\n (resources.cloudformation.amazonaws.com
). For more information about adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create\n an \n IAM execution role\n that includes the necessary\n permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler,\n CloudFormation assumes this execution role to create a temporary session token,\n which it then passes to the resource type handler, thereby supplying your resource type\n with the appropriate credentials.
" } }, "ClientRequestToken": { @@ -7410,6 +7416,9 @@ "input": { "target": "com.amazonaws.cloudformation#SetStackPolicyInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "Sets a stack policy for a specified stack.
" } @@ -7567,6 +7576,9 @@ "input": { "target": "com.amazonaws.cloudformation#SignalResourceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use\n the SignalResource
operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive\n the required number of signals or the timeout period is exceeded. The SignalResource
operation is\n useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.
Whether termination protection is enabled for the stack.
\nFor nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack. For more information, see Protecting a Stack From Being\n Deleted in the CloudFormation User Guide.
" + "smithy.api#documentation": "Whether termination protection is enabled for the stack.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack. For more information, see Protecting a Stack From Being Deleted in the\n CloudFormation User Guide.
" } }, "ParentId": { @@ -7742,7 +7754,7 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformation", "traits": { - "smithy.api#documentation": "Information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" + "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" } } }, @@ -8593,7 +8605,7 @@ "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected\n configuration.
\n\n DELETED
: The resource differs from its expected configuration in that\n it has been deleted.
\n MODIFIED
: The resource differs from its expected\n configuration.
\n NOT_CHECKED
: CloudFormation hasn't checked if the resource differs from its\n expected configuration.
Any resources that don't currently support drift detection have a status of\n NOT_CHECKED
. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip
will also have a status of NOT_CHECKED
.\n For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
\n IN_SYNC
: The resource's actual configuration matches its expected\n configuration.
Status of the resource's actual configuration compared to its expected\n configuration.
\n\n DELETED
: The resource differs from its expected configuration in that\n it has been deleted.
\n MODIFIED
: The resource differs from its expected\n configuration.
\n NOT_CHECKED
: CloudFormation hasn't checked if the resource differs from its\n expected configuration.
Any resources that don't currently support drift detection have a status of\n NOT_CHECKED
. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip
will also have a status of NOT_CHECKED
.\n For more information about skipping resources during rollback operations, see Continue Rolling Back an Update in the CloudFormation User Guide.
\n IN_SYNC
: The resource's actual configuration matches its expected\n configuration.
The Amazon Resource Number (ARN) of the stack set.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack set.
" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the IAM role used to create or update\n the stack set.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update\n the stack set.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -9018,7 +9030,7 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the IAM role used to perform this\n stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the CloudFormation User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to perform this\n stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific\n stack sets within the same administrator account. For more information, see Define Permissions for Multiple\n Administrators in the CloudFormation User Guide.
" } }, "ExecutionRoleName": { @@ -9050,6 +9062,12 @@ "traits": { "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information\n about drift operations currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action
\n type is DETECT_DRIFT
.
For more information, see Detecting Unmanaged\n Changes in Stack Sets in the CloudFormation User Guide.
" } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", + "traits": { + "smithy.api#documentation": "The status of the operation in details.
" + } } }, "traits": { @@ -9120,7 +9138,7 @@ } }, "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
" + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set\n operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -9231,6 +9249,9 @@ ] } }, + "com.amazonaws.cloudformation#StackSetOperationStatusReason": { + "type": "string" + }, "com.amazonaws.cloudformation#StackSetOperationSummaries": { "type": "list", "member": { @@ -9269,6 +9290,12 @@ "traits": { "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions\n specified. Note that this doesn't necessarily mean that the stack set operation was\n successful, or even attempted, in each account or Region.
" } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", + "traits": { + "smithy.api#documentation": "The status of the operation in details.
" + } } }, "traits": { @@ -9541,7 +9568,7 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { - "smithy.api#documentation": "Summarizes information on whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" + "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from it's expected configuration, as defined in the stack\n template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration\n Changes to Stacks and Resources.
" } } }, @@ -10007,7 +10034,7 @@ "IsDefaultConfiguration": { "target": "com.amazonaws.cloudformation#IsDefaultConfiguration", "traits": { - "smithy.api#documentation": "Whether or not this configuration data is the default configuration for the\n extension.
" + "smithy.api#documentation": "Whether this configuration data is the default configuration for the extension.
" } } }, @@ -10246,7 +10273,7 @@ "IsActivated": { "target": "com.amazonaws.cloudformation#IsActivated", "traits": { - "smithy.api#documentation": "Whether or not the extension is activated for this account and region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are\n activated by default.
" + "smithy.api#documentation": "Whether the extension is activated for this account and region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are\n activated by default.
" } } }, @@ -10416,13 +10443,13 @@ "StackPolicyDuringUpdateBody": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody", "traits": { - "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody
or the StackPolicyDuringUpdateURL
\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" + "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody
or the StackPolicyDuringUpdateURL
\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is\n associated with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point\n to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You\n can specify either the StackPolicyDuringUpdateBody
or the\n StackPolicyDuringUpdateURL
parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point\n to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You\n can specify either the StackPolicyDuringUpdateBody
or the\n StackPolicyDuringUpdateURL
parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is\n associated with the stack will be used.
" } }, "Parameters": { @@ -10434,7 +10461,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM
or CAPABILITY_NAMED_IAM
\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities
error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND
\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or\n more macros, and you choose to update a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from\n the template using this capability.
\nYou should only update stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for\n processing stack templates. Be aware that the Lambda function owner can update the\n function operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM
and CAPABILITY_NAMED_IAM
\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management\n (IAM) users. For those stacks, you must explicitly acknowledge this\n by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM
or CAPABILITY_NAMED_IAM
\n capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM
.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities
error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND
\n
Some template contain macros. Macros perform custom processing on templates; this\n can include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change\n set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or\n more macros, and you choose to update a stack directly from the processed template,\n without first reviewing the resulting changes in a change set, you must acknowledge\n this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from\n the template using this capability.
\nYou should only update stacks directly from a stack template that contains\n macros if you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for\n processing stack templates. Be aware that the Lambda function owner can update the\n function operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nThe Amazon Resource Number (ARN) of the IAM role to use to update this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you\n must specify a customized administrator role, even if it is the same customized\n administrator role used with this stack set previously.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this\n stack set.
\nSpecify an IAM role only if you are using customized administrator roles\n to control which users or groups can manage specific stack sets within the same\n administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you\n must specify a customized administrator role, even if it is the same customized\n administrator role used with this stack set previously.
" } }, "ExecutionRoleName": { diff --git a/aws/sdk/aws-models/cloudfront.json b/aws/sdk/aws-models/cloudfront.json index 1769a5bab77..cb590c05b44 100644 --- a/aws/sdk/aws-models/cloudfront.json +++ b/aws/sdk/aws-models/cloudfront.json @@ -2851,6 +2851,9 @@ { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyAlreadyExists" }, + { + "target": "com.amazonaws.cloudfront#TooLongCSPInResponseHeadersPolicy" + }, { "target": "com.amazonaws.cloudfront#TooManyCustomHeadersInResponseHeadersPolicy" }, @@ -12309,6 +12312,19 @@ "smithy.api#documentation": "Contains the result of testing a CloudFront function with TestFunction
.
The length of the Content-Security-Policy
header value in the response headers\n\t\t\tpolicy exceeds the maximum.
For more information, see Quotas (formerly known as limits) in the\n\t\t\t\tAmazon CloudFront Developer Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudfront#TooManyCacheBehaviors": { "type": "structure", "members": { @@ -14201,6 +14217,9 @@ { "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyAlreadyExists" }, + { + "target": "com.amazonaws.cloudfront#TooLongCSPInResponseHeadersPolicy" + }, { "target": "com.amazonaws.cloudfront#TooManyCustomHeadersInResponseHeadersPolicy" } diff --git a/aws/sdk/aws-models/cognito-idp.json b/aws/sdk/aws-models/cognito-idp.json index 7fc817d042b..b2ca47a4d02 100644 --- a/aws/sdk/aws-models/cognito-idp.json +++ b/aws/sdk/aws-models/cognito-idp.json @@ -46,7 +46,7 @@ "name": "cognito-idp" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
\nThis API reference provides information about user pools in Amazon Cognito user pools.
\nFor more information, see the Amazon Cognito Documentation.
", + "smithy.api#documentation": "Using the Amazon Cognito user pools API, you can create a user pool to manage directories and\n users. You can authenticate a user to obtain tokens related to user identity and access\n policies.
\nThis API reference provides information about user pools in Amazon Cognito user pools.
\nFor more information, see the Amazon Cognito\n Documentation.
", "smithy.api#title": "Amazon Cognito Identity Provider", "smithy.api#xmlNamespace": { "uri": "http://cognito-idp.amazonaws.com/doc/2016-04-18/" @@ -399,7 +399,7 @@ "EventAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", "traits": { - "smithy.api#documentation": "The action to take in response to the account takeover action. Valid values\n are:
\n \n\n BLOCK
Choosing this action will block the request.
\n MFA_IF_CONFIGURED
Present an MFA challenge if user has configured it, else allow the request.
\n MFA_REQUIRED
Present an MFA challenge if user has configured it, else block the request.
\n NO_ACTION
Allow the user to sign in.
The action to take in response to the account takeover action. Valid values are as\n follows:
\n\n BLOCK
Choosing this action will block the request.
\n MFA_IF_CONFIGURED
Present an MFA challenge if user has configured\n it, else allow the request.
\n MFA_REQUIRED
Present an MFA challenge if user has configured it,\n else block the request.
\n NO_ACTION
Allow the user to sign in.
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
" + "smithy.api#documentation": "Configuration for mitigation actions and notification for different levels of risk\n detected for a potential account takeover.
" } }, "com.amazonaws.cognitoidentityprovider#AddCustomAttributes": { @@ -536,7 +536,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Represents the response from the server for the request to add custom attributes.
" + "smithy.api#documentation": "Represents the response from the server for the request to add custom\n attributes.
" } }, "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroup": { @@ -544,6 +544,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -638,7 +641,7 @@ } ], "traits": { - "smithy.api#documentation": "Confirms user registration as an admin without using a confirmation code. Works on any user.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Confirms user registration as an admin without using a confirmation code. Works on any\n user.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUpRequest": { @@ -661,7 +664,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nIf your user pool configuration includes triggers, the AdminConfirmSignUp API action\n invokes the Lambda function that is specified for the post\n confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON\n payload, which the function receives as input. In this payload, the\n clientMetadata
attribute provides the data that you assigned to the\n ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in\n Lambda, you can process the ClientMetadata value to enhance your workflow for your\n specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nIf your user pool configuration includes triggers, the AdminConfirmSignUp API action\n invokes the Lambda function that is specified for the post\n confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON\n payload, which the function receives as input. In this payload, the\n clientMetadata
attribute provides the data that you assigned to the\n ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in\n Lambda, you can process the ClientMetadata value to enhance your workflow for your\n specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nRepresents the response from the server for the request to confirm registration.
" + "smithy.api#documentation": "Represents the response from the server for the request to confirm\n registration.
" } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUser": { @@ -735,7 +738,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new user in the specified user pool.
\nIf MessageAction
isn't set, the default is to send a welcome message via email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for \n user name and temporary password.
\nAlternatively, you can call AdminCreateUser
with SUPPRESS
for the MessageAction
parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD
state until they sign in and change their password.
\n AdminCreateUser
requires developer credentials.
Creates a new user in the specified user pool.
\nIf MessageAction
isn't set, the default is to send a welcome message via\n email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.
\nAlternatively, you can call AdminCreateUser
with SUPPRESS
\n for the MessageAction
parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD
state until\n they sign in and change their password.
\n AdminCreateUser
requires developer credentials.
Set to True
if only the administrator is allowed to create user profiles. Set to False
if users can sign themselves up via an app.
Set to True
if only the administrator is allowed to create user profiles.\n Set to False
if users can sign themselves up via an app.
The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser
again, \n specifying \"RESEND\"
for the MessageAction
parameter. The default value for this parameter is 7.
If you set a value for TemporaryPasswordValidityDays
in PasswordPolicy
, that value will be used, and UnusedAccountValidityDays
will be no longer \n be an available parameter for that user pool.
The user account expiration limit, in days, after which a new account that hasn't\n signed in is no longer usable. To reset the account after that time limit, you must call\n AdminCreateUser
again, specifying \"RESEND\"
for the\n MessageAction
parameter. The default value for this parameter is 7.
If you set a value for TemporaryPasswordValidityDays
in\n PasswordPolicy
, that value will be used, and\n UnusedAccountValidityDays
will be no longer be an available\n parameter for that user pool.
The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username can't be changed.
", + "smithy.api#documentation": "The username for the user. Must be unique within the user pool. Must be a UTF-8 string\n between 1 and 128 characters. After the user is created, the username can't be\n changed.
", "smithy.api#required": {} } }, "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes \n other than Username
. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab \n of the console) either you should supply (in your call to AdminCreateUser
) or the user should supply (when they sign up in response to your welcome message).
For custom attributes, you must prepend the custom:
prefix to the attribute name.
To send a message inviting the user to sign up, you must specify the user's email address or phone number. You can do this in your call to AdminCreateUser or \n in the Users tab of the Amazon Cognito console for managing your user pools.
\nIn your call to AdminCreateUser
, you can set the email_verified
attribute to True
, and you can set the phone_number_verified
\n attribute to True
. You can also do this by calling \n AdminUpdateUserAttributes.
\n email: The email address of the user to whom the message that contains the code and username will be sent. Required if the \n email_verified
attribute is set to True
, or if \"EMAIL\"
is specified in the DesiredDeliveryMediums
parameter.
\n phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the \n phone_number_verified
attribute is set to True
, or if \"SMS\"
is specified in the DesiredDeliveryMediums
parameter.
An array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than Username
. However, any attributes that you specify as required\n (when creating a user pool or in the Attributes tab of\n the console) either you should supply (in your call to AdminCreateUser
) or\n the user should supply (when they sign up in response to your welcome message).
For custom attributes, you must prepend the custom:
prefix to the\n attribute name.
To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. You can do this in your call to AdminCreateUser or in the\n Users tab of the Amazon Cognito console for managing your\n user pools.
\nIn your call to AdminCreateUser
, you can set the\n email_verified
attribute to True
, and you can set the\n phone_number_verified
attribute to True
. You can also do\n this by calling AdminUpdateUserAttributes.
\n email: The email address of the user to whom\n the message that contains the code and username will be sent. Required if the\n email_verified
attribute is set to True
, or if\n \"EMAIL\"
is specified in the DesiredDeliveryMediums
\n parameter.
\n phone_number: The phone number of the user to\n whom the message that contains the code and username will be sent. Required if\n the phone_number_verified
attribute is set to True
, or\n if \"SMS\"
is specified in the DesiredDeliveryMediums
\n parameter.
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the \n types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
\nTo configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation \n data and uses it in the validation process.
\nThe user's validation data isn't persisted.
" + "smithy.api#documentation": "The user's validation data. This is an array of name-value pairs that contain user\n attributes and attribute values that you can use for custom validation, such as\n restricting the types of user accounts that can be registered. For example, you might\n choose to allow or disallow user sign-up based on the user's domain.
\nTo configure custom validation, you must create a Pre Sign-up Lambda trigger for\n the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the\n validation data and uses it in the validation process.
\nThe user's validation data isn't persisted.
" } }, "TemporaryPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { - "smithy.api#documentation": "The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
\nThe temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used \n in all future sign-ins.
\nThis parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
\nThe temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must \n call AdminCreateUser
again, specifying \"RESEND\"
for the MessageAction
parameter.
The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.
\nThe temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page, along with a new password to\n be used in all future sign-ins.
\nThis parameter isn't required. If you don't specify a value, Amazon Cognito generates one for\n you.
\nThe temporary password can only be used until the user account expiration limit that\n you specified when you created the user pool. To reset the account after that time\n limit, you must call AdminCreateUser
again, specifying\n \"RESEND\"
for the MessageAction
parameter.
This parameter is used only if the phone_number_verified
or email_verified
attribute is set to True
. Otherwise, it is ignored.
If this parameter is set to True
and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API \n call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False
, the API throws an AliasExistsException
error if the alias already exists. The default value is False
.
This parameter is used only if the phone_number_verified
or\n email_verified
attribute is set to True
. Otherwise, it is\n ignored.
If this parameter is set to True
and the phone number or email address\n specified in the UserAttributes parameter already exists as an alias with a different\n user, the API call will migrate the alias from the previous user to the newly created\n user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False
, the API throws an\n AliasExistsException
error if the alias already exists. The default\n value is False
.
Set to RESEND
to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS
to suppress \n sending the message. You can specify only one value.
Set to RESEND
to resend the invitation message to a user that already\n exists and reset the expiration limit on the user's account. Set to\n SUPPRESS
to suppress sending the message. You can specify only one\n value.
Specify \"EMAIL\"
if email will be used to send the welcome message. Specify \"SMS\"
if the phone number will be used. The default value is \"SMS\"
. You \n can specify more than one value.
Specify \"EMAIL\"
if email will be used to send the welcome message.\n Specify \"SMS\"
if the phone number will be used. The default value is\n \"SMS\"
. You can specify more than one value.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, \n Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, \n it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
attribute, \n which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code \n in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned\n to the pre sign-up trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your AdminCreateUser request. In your function code in\n Lambda, you can process the clientMetadata
value to enhance your\n workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nDeletes the user attributes in a user pool as an administrator. Works on any user.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Deletes the user attributes in a user pool as an administrator. Works on any\n user.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteUserAttributesRequest": { @@ -932,7 +938,7 @@ "UserAttributeNames": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameListType", "traits": { - "smithy.api#documentation": "An array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prepend the custom:
prefix to the attribute name.
An array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
Represents the response received from the server for a request to delete user attributes.
" + "smithy.api#documentation": "Represents the response received from the server for a request to delete user\n attributes.
" } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteUserRequest": { @@ -1002,7 +1008,7 @@ } ], "traits": { - "smithy.api#documentation": "Prevents the user from signing in with the specified external (SAML or social)\n identity provider. If the user that you want to deactivate is a Amazon Cognito user pools native\n username + password user, they can't use their password to sign in. If the user to\n deactivate is a linked external identity provider (IdP) user, any link between that user\n and an existing user is removed. When the external user signs in again, and the user is\n no longer attached to the previously linked DestinationUser
, the user must\n create a new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer credentials.
\nThe ProviderName
must match the value specified when creating an IdP for the pool.
To deactivate a native username + password user, the ProviderName
value must be Cognito
and the ProviderAttributeName
must be Cognito_Subject
. \n The ProviderAttributeValue
must be the name that is used in the user pool for the user.
The ProviderAttributeName
must always be Cognito_Subject
for social identity providers. The ProviderAttributeValue
must always be the exact \n subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign in, the ProviderAttributeName
and ProviderAttributeValue
\n must be the same values that were used for the SourceUser
when the identities were originally linked using AdminLinkProviderForUser
call. (If the linking was done \n with ProviderAttributeName
set to Cognito_Subject
, the same applies here). However, if the user has already signed in, the ProviderAttributeName
must \n be Cognito_Subject
and ProviderAttributeValue
must be the subject of the SAML assertion.
Prevents the user from signing in with the specified external (SAML or social)\n identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools\n native username + password user, they can't use their password to sign in. If the user\n to deactivate is a linked external IdP user, any link between that user and an existing\n user is removed. When the external user signs in again, and the user is no longer\n attached to the previously linked DestinationUser
, the user must create a\n new user account. See AdminLinkProviderForUser.
This action is enabled only for admin access and requires developer\n credentials.
\nThe ProviderName
must match the value specified when creating an IdP for\n the pool.
To deactivate a native username + password user, the ProviderName
value\n must be Cognito
and the ProviderAttributeName
must be\n Cognito_Subject
. The ProviderAttributeValue
must be the\n name that is used in the user pool for the user.
The ProviderAttributeName
must always be Cognito_Subject
for\n social IdPs. The ProviderAttributeValue
must always be the exact subject\n that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has\n not yet been used to sign in, the ProviderAttributeName
and\n ProviderAttributeValue
must be the same values that were used for the\n SourceUser
when the identities were originally linked using \n AdminLinkProviderForUser
call. (If the linking was done with\n ProviderAttributeName
set to Cognito_Subject
, the same\n applies here). However, if the user has already signed in, the\n ProviderAttributeName
must be Cognito_Subject
and\n ProviderAttributeValue
must be the subject of the SAML\n assertion.
Represents the response received from the server to disable the user as an administrator.
" + "smithy.api#documentation": "Represents the response received from the server to disable the user as an\n administrator.
" } }, "com.amazonaws.cognitoidentityprovider#AdminEnableUser": { @@ -1147,7 +1153,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Represents the response from the server for the request to enable a user as an administrator.
" + "smithy.api#documentation": "Represents the response from the server for the request to enable a user as an\n administrator.
" } }, "com.amazonaws.cognitoidentityprovider#AdminForgetDevice": { @@ -1155,6 +1161,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminForgetDeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -1316,7 +1325,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the specified user by user name in a user pool as an administrator. Works on any user.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Gets the specified user by user name in a user pool as an administrator. Works on any\n user.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminGetUserRequest": { @@ -1325,7 +1334,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool where you want to get information about the user.
", + "smithy.api#documentation": "The user pool ID for the user pool where you want to get information about the\n user.
", "smithy.api#required": {} } }, @@ -1378,13 +1387,13 @@ "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { - "smithy.api#documentation": "The user status. Can be one of the following:
\nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nARCHIVED - User is no longer active.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value \n before doing anything else.
\nThe user status. Can be one of the following:
\nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nARCHIVED - User is no longer active.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset\n their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a\n temporary password, but on first sign-in, the user must change their password to\n a new value before doing anything else.
\n\n This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time \n password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
" + "smithy.api#documentation": "\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about\n time-based one-time password (TOTP) software token MFA configurations. To look up\n information about either type of MFA configuration, use UserMFASettingList\n instead.
" } }, "PreferredMfaSetting": { @@ -1396,12 +1405,12 @@ "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { - "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA
and SOFTWARE_TOKEN_MFA
.
Represents the response from the server from the request to get the specified user as an administrator.
" + "smithy.api#documentation": "Represents the response from the server from the request to get the specified user as\n an administrator.
" } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuth": { @@ -1460,7 +1469,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates the authentication flow, as an administrator.
\n\n\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Initiates the authentication flow, as an administrator.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthRequest": { @@ -1483,32 +1492,32 @@ "AuthFlow": { "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", "traits": { - "smithy.api#documentation": "The authentication flow for this call to run. The API action will depend on this value. For example:
\n \n\n REFRESH_TOKEN_AUTH
will take in a valid refresh token and return new tokens.
\n USER_SRP_AUTH
will take in USERNAME
and SRP_A
and return the Secure Remote Password (SRP) protocol variables to be used for next \n challenge execution.
\n ADMIN_USER_PASSWORD_AUTH
will take in USERNAME
and PASSWORD
and return the next challenge or tokens.
Valid values include:
\n\n USER_SRP_AUTH
: Authentication flow for the Secure Remote Password (SRP) protocol.
\n REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
\n CUSTOM_AUTH
: Custom authentication flow.
\n ADMIN_NO_SRP_AUTH
: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
\n ADMIN_USER_PASSWORD_AUTH
: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH
authentication flow. In this flow, Amazon Cognito \n receives the password in the request instead of using the SRP process to verify passwords.
The authentication flow for this call to run. The API action will depend on this\n value. For example:
\n\n REFRESH_TOKEN_AUTH
will take in a valid refresh token and return\n new tokens.
\n USER_SRP_AUTH
will take in USERNAME
and\n SRP_A
and return the Secure Remote Password (SRP) protocol\n variables to be used for next challenge execution.
\n ADMIN_USER_PASSWORD_AUTH
will take in USERNAME
and\n PASSWORD
and return the next challenge or tokens.
Valid values include:
\n\n USER_SRP_AUTH
: Authentication flow for the Secure Remote Password\n (SRP) protocol.
\n REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication\n flow for refreshing the access token and ID token by supplying a valid refresh\n token.
\n CUSTOM_AUTH
: Custom authentication flow.
\n ADMIN_NO_SRP_AUTH
: Non-SRP authentication flow; you can pass in\n the USERNAME and PASSWORD directly if the flow is enabled for calling the app\n client.
\n ADMIN_USER_PASSWORD_AUTH
: Admin-based user password\n authentication. This replaces the ADMIN_NO_SRP_AUTH
authentication\n flow. In this flow, Amazon Cognito receives the password in the request instead of using\n the SRP process to verify passwords.
The authentication parameters. These are inputs corresponding to the AuthFlow
that you're invoking. The required values depend on the value of AuthFlow
:
For USER_SRP_AUTH
: USERNAME
(required), SRP_A
(required), SECRET_HASH
(required if the app client is configured with a client \n secret), DEVICE_KEY
.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN
: REFRESH_TOKEN
(required), SECRET_HASH
(required if the app client is configured with a client secret), \n DEVICE_KEY
.
For ADMIN_NO_SRP_AUTH
: USERNAME
(required), SECRET_HASH
(if app client is configured with client secret), PASSWORD
(required), \n DEVICE_KEY
.
For CUSTOM_AUTH
: USERNAME
(required), SECRET_HASH
(if app client is configured with client secret), DEVICE_KEY
. To start the \n authentication flow with password verification, include ChallengeName: SRP_A
and SRP_A: (The SRP_A Value)
.
The authentication parameters. These are inputs corresponding to the\n AuthFlow
that you're invoking. The required values depend on the value\n of AuthFlow
:
For USER_SRP_AUTH
: USERNAME
(required),\n SRP_A
(required), SECRET_HASH
(required if the app\n client is configured with a client secret), DEVICE_KEY
.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN
: REFRESH_TOKEN
\n (required), SECRET_HASH
(required if the app client is configured\n with a client secret), DEVICE_KEY
.
For ADMIN_NO_SRP_AUTH
: USERNAME
(required),\n SECRET_HASH
(if app client is configured with client secret),\n PASSWORD
(required), DEVICE_KEY
.
For CUSTOM_AUTH
: USERNAME
(required),\n SECRET_HASH
(if app client is configured with client secret),\n DEVICE_KEY
. To start the authentication flow with password\n verification, include ChallengeName: SRP_A
and SRP_A: (The\n SRP_A Value)
.
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for \n various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nVerify auth challenge
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that\n are specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your AdminInitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for\n the following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nVerify auth challenge
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for\n AdminInitiateAuth
calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } } }, @@ -1522,25 +1531,25 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth
response if you must pass another challenge.
\n MFA_SETUP
: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP
challenge. The user must set up at \n least one MFA type to continue to authenticate.
\n SELECT_MFA_TYPE
: Selects the MFA type. Valid MFA options are SMS_MFA
for text SMS MFA, and SOFTWARE_TOKEN_MFA
for time-based one-time password (TOTP) \n software token MFA.
\n SMS_MFA
: Next challenge is to supply an SMS_MFA_CODE
, delivered via SMS.
\n PASSWORD_VERIFIER
: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE
, PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after the \n client-side SRP calculations.
\n CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
\n DEVICE_SRP_AUTH
: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking \n this device.
\n DEVICE_PASSWORD_VERIFIER
: Similar to PASSWORD_VERIFIER
, but for devices only.
\n ADMIN_NO_SRP_AUTH
: This is returned if you must authenticate with USERNAME
and PASSWORD
directly. An app client must be enabled to use this flow.
\n NEW_PASSWORD_REQUIRED
: For users who are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD
\n and any other required attributes.
\n MFA_SETUP
: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge \n parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from InitiateAuth
as an input to AssociateSoftwareToken
, and use the session returned by \n VerifySoftwareToken
as an input to RespondToAuthChallenge
with challenge name MFA_SETUP
to complete sign-in. To set up SMS MFA, users will \n need help from an administrator to add a phone number to their account and then call InitiateAuth
again to restart sign-in.
The name of the challenge that you're responding to with this call. This is returned\n in the AdminInitiateAuth
response if you must pass another\n challenge.
\n MFA_SETUP
: If MFA is required, users who don't have at least one\n of the MFA methods set up are presented with an MFA_SETUP
\n challenge. The user must set up at least one MFA type to continue to\n authenticate.
\n SELECT_MFA_TYPE
: Selects the MFA type. Valid MFA options are\n SMS_MFA
for text SMS MFA, and SOFTWARE_TOKEN_MFA
\n for time-based one-time password (TOTP) software token MFA.
\n SMS_MFA
: Next challenge is to supply an\n SMS_MFA_CODE
, delivered via SMS.
\n PASSWORD_VERIFIER
: Next challenge is to supply\n PASSWORD_CLAIM_SIGNATURE
,\n PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after\n the client-side SRP calculations.
\n CUSTOM_CHALLENGE
: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued.
\n DEVICE_SRP_AUTH
: If device tracking was activated in your user\n pool and the previous challenges were passed, this challenge is returned so that\n Amazon Cognito can start tracking this device.
\n DEVICE_PASSWORD_VERIFIER
: Similar to\n PASSWORD_VERIFIER
, but for devices only.
\n ADMIN_NO_SRP_AUTH
: This is returned if you must authenticate with\n USERNAME
and PASSWORD
directly. An app client must\n be enabled to use this flow.
\n NEW_PASSWORD_REQUIRED
: For users who are required to change their\n passwords after successful first login. Respond to this challenge with\n NEW_PASSWORD
and any required attributes that Amazon Cognito returned in\n the requiredAttributes
parameter. You can also set values for\n attributes that aren't required by your user pool and that your app client can\n write. For more information, see AdminRespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in the requiredAttributes
parameter, \nthen use the AdminUpdateUserAttributes
API operation to modify the value of any additional attributes.
\n MFA_SETUP
: For users who are required to set up an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from\n InitiateAuth
as an input to\n AssociateSoftwareToken
, and use the session returned by\n VerifySoftwareToken
as an input to\n RespondToAuthChallenge
with challenge name\n MFA_SETUP
to complete sign-in. To set up SMS MFA, users will\n need help from an administrator to add a phone number to their account and then\n call InitiateAuth
again to restart sign-in.
The session that should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth
or AdminRespondToAuthChallenge
API call determines \n that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge
\n API call.
The session that should be passed both ways in challenge-response calls to the\n service. If AdminInitiateAuth
or AdminRespondToAuthChallenge
\n API call determines that the caller must pass another challenge, they return a session\n with other challenge parameters. This session should be passed as it is to the next\n AdminRespondToAuthChallenge
API call.
The challenge parameters. These are returned to you in the AdminInitiateAuth
response if you must pass another challenge. The responses in this parameter should be used to \n compute inputs to the next call (AdminRespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
The value of the USER_ID_FOR_SRP
attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call \n to AdminInitiateAuth
. This happens because, in the AdminRespondToAuthChallenge
API ChallengeResponses
, the USERNAME
attribute can't be \n an alias.
The challenge parameters. These are returned to you in the\n AdminInitiateAuth
response if you must pass another challenge. The\n responses in this parameter should be used to compute inputs to the next call\n (AdminRespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if\n applicable).
The value of the USER_ID_FOR_SRP
attribute is the user's actual username,\n not an alias (such as email address or phone number), even if you specified an alias in\n your call to AdminInitiateAuth
. This happens because, in the\n AdminRespondToAuthChallenge
API ChallengeResponses
, the\n USERNAME
attribute can't be an alias.
The result of the authentication response. This is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, \n ChallengeName
, ChallengeParameters
, and Session
are returned.
The result of the authentication response. This is only returned if the caller doesn't\n need to pass another challenge. If the caller does need to pass another challenge before\n it gets tokens, ChallengeName
, ChallengeParameters
, and\n Session
are returned.
Links an existing user account in a user pool (DestinationUser
) to an identity from an external identity provider (SourceUser
) based on a specified \n attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not \n yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user \n identity, they sign in as the existing user account.
\nThe maximum number of federated identities linked to a user is 5.
\nBecause this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external \n identity providers and provider attributes that have been trusted by the application owner.
\nThis action is administrative and requires developer credentials.
" + "smithy.api#documentation": "Links an existing user account in a user pool (DestinationUser
) to an\n identity from an external IdP (SourceUser
) based on a specified attribute\n name and value from the external IdP. This allows you to create a link from the existing\n user account to an external federated user identity that has not yet been used to sign\n in. You can then use the federated user identity to sign in as the existing user\n account.
For example, if there is an existing user with a username and password, this API\n links that user to a federated user identity. When the user signs in with a federated\n user identity, they sign in as the existing user account.
\nThe maximum number of federated identities linked to a user is five.
\nBecause this API allows a user with an external federated identity to sign in as\n an existing user in the user pool, it is critical that it only be used with external\n IdPs and provider attributes that have been trusted by the application owner.
\nThis action is administrative and requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUserRequest": { @@ -1599,14 +1608,14 @@ "DestinationUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { - "smithy.api#documentation": "The existing user in the user pool that you want to assign to the external identity\n provider user account. This user can be a native (Username + Password) Amazon Cognito user pools\n user or a federated user (for example, a SAML or Facebook user). If the user doesn't\n exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the\n linked identity provider attribute) signs in.
\nFor a native username + password user, the ProviderAttributeValue
for the DestinationUser
should be the username in the user pool. For a federated user, \n it should be the provider-specific user_id
.
The ProviderAttributeName
of the DestinationUser
is ignored.
The ProviderName
should be set to Cognito
for users in Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won't succeed.
\nThe existing user in the user pool that you want to assign to the external IdP user\n account. This user can be a native (Username + Password) Amazon Cognito user pools user or a\n federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito\n generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP\n attribute) signs in.
\nFor a native username + password user, the ProviderAttributeValue
for the\n DestinationUser
should be the username in the user pool. For a\n federated user, it should be the provider-specific user_id
.
The ProviderAttributeName
of the DestinationUser
is\n ignored.
The ProviderName
should be set to Cognito
for users in\n Cognito user pools.
All attributes in the DestinationUser profile must be mutable. If you have\n assigned the user any immutable custom attributes, the operation won't\n succeed.
\nAn external identity provider account for a user who doesn't exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.
\nIf the SourceUser
is using a federated social identity provider, such as Facebook, Google, or Login with Amazon, you must set the ProviderAttributeName
\n to Cognito_Subject
. For social identity providers, the ProviderName
will be Facebook
, Google
, or LoginWithAmazon
, \n and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id
, sub
, and user_id
, respectively. The \n ProviderAttributeValue
for the user must be the same value as the id
, sub
, or user_id
value found in the social identity provider token.
For SAML, the ProviderAttributeName
can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML \n assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the ProviderAttributeName
. If you set \n ProviderAttributeName
to Cognito_Subject
, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
An external IdP account for a user who doesn't exist yet in the user pool. This user\n must be a federated user (for example, a SAML or Facebook user), not another native\n user.
\nIf the SourceUser
is using a federated social IdP, such as Facebook,\n Google, or Login with Amazon, you must set the ProviderAttributeName
to\n Cognito_Subject
. For social IdPs, the ProviderName
will be\n Facebook
, Google
, or LoginWithAmazon
, and\n Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for\n id
, sub
, and user_id
, respectively. The\n ProviderAttributeValue
for the user must be the same value as the\n id
, sub
, or user_id
value found in the social\n IdP token.
For SAML, the ProviderAttributeName
can be any value that matches a claim\n in the SAML assertion. If you want to link SAML users based on the subject of the SAML\n assertion, you should map the subject to a claim through the SAML IdP and submit that\n claim name as the ProviderAttributeName
. If you set\n ProviderAttributeName
to Cognito_Subject
, Amazon Cognito will\n automatically parse the default unique identifier found in the subject from the SAML\n token.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } } @@ -1783,7 +1792,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } } @@ -1820,7 +1829,7 @@ } ], "traits": { - "smithy.api#documentation": "A history of user activity and any risks detected as part of Amazon Cognito advanced security.
", + "smithy.api#documentation": "A history of user activity and any risks detected as part of Amazon Cognito advanced\n security.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1866,7 +1875,7 @@ "AuthEvents": { "target": "com.amazonaws.cognitoidentityprovider#AuthEventsType", "traits": { - "smithy.api#documentation": "The response object. It includes the EventID
, EventType
, CreationDate
, EventRisk
, and EventResponse
.
The response object. It includes the EventID
, EventType
,\n CreationDate
, EventRisk
, and\n EventResponse
.
Resets the specified user's password in a user pool as an administrator. Works on any user.
\nWhen a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, \n the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same \n as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if \n email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user \n with the code to change their password.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Resets the specified user's password in a user pool as an administrator. Works on any\n user.
\nWhen a developer calls this API, the current password is invalidated, so it must be\n changed. If a user tries to sign in after the API is called, the app will get a\n PasswordResetRequiredException exception back and should direct the user down the flow\n to reset the password, which is the same as the forgot password flow. In addition, if\n the user pool has phone verification selected and a verified phone number exists for the\n user, or if email verification is selected and a verified email exists for the user,\n calling this API will also result in sending a message to the end user with the code to\n change their password.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordRequest": { @@ -2005,7 +2017,7 @@ "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\n \nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, \n Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, \n which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata
\n value to enhance your workflow for your specific needs.\n
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function\n that is assigned to the custom message trigger. When Amazon Cognito invokes\n this function, it passes a JSON payload, which the function receives as input. This\n payload contains a clientMetadata
attribute, which provides the data that\n you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In\n your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nRepresents the response from the server to reset a user password as an administrator.
" + "smithy.api#documentation": "Represents the response from the server to reset a user password as an\n administrator.
" } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallenge": { @@ -2091,7 +2103,7 @@ } ], "traits": { - "smithy.api#documentation": "Responds to an authentication challenge, as an administrator.
\n\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Responds to an authentication challenge, as an administrator.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeRequest": { @@ -2121,31 +2133,31 @@ "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponsesType", "traits": { - "smithy.api#documentation": "The challenge responses. These are inputs corresponding to the value of ChallengeName
, for example:
\n SMS_MFA
: SMS_MFA_CODE
, USERNAME
, SECRET_HASH
(if app client is configured with client secret).
\n PASSWORD_VERIFIER
: PASSWORD_CLAIM_SIGNATURE
, PASSWORD_CLAIM_SECRET_BLOCK
, TIMESTAMP
, USERNAME
, SECRET_HASH
\n (if app client is configured with client secret).
\n PASSWORD_VERIFIER
requires DEVICE_KEY
when signing in with a remembered device.
\n ADMIN_NO_SRP_AUTH
: PASSWORD
, USERNAME
, SECRET_HASH
(if app client is configured with client secret).
\n NEW_PASSWORD_REQUIRED
: NEW_PASSWORD
, any other required attributes, USERNAME
, SECRET_HASH
(if app client is configured with \n client secret).
\n MFA_SETUP
requires USERNAME
, plus you must use the session value returned by VerifySoftwareToken
in the Session
parameter.
The value of the USERNAME
attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the \n AdminInitiateAuth
response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute. This happens even if you specified an \n alias in your call to AdminInitiateAuth
.
The challenge responses. These are inputs corresponding to the value of\n ChallengeName
, for example:
\n SMS_MFA
: SMS_MFA_CODE
, USERNAME
,\n SECRET_HASH
(if app client is configured with client\n secret).
\n PASSWORD_VERIFIER
: PASSWORD_CLAIM_SIGNATURE
,\n PASSWORD_CLAIM_SECRET_BLOCK
, TIMESTAMP
,\n USERNAME
, SECRET_HASH
(if app client is configured\n with client secret).
\n PASSWORD_VERIFIER
requires DEVICE_KEY
when\n signing in with a remembered device.
\n ADMIN_NO_SRP_AUTH
: PASSWORD
, USERNAME
,\n SECRET_HASH
(if app client is configured with client secret).\n
\n NEW_PASSWORD_REQUIRED
: NEW_PASSWORD
,\n USERNAME
, SECRET_HASH
(if app client is configured\n with client secret). To set any required attributes that Amazon Cognito returned as\n requiredAttributes
in the AdminInitiateAuth
\n response, add a userAttributes.attributename\n
\n parameter. This parameter can also set values for writable attributes that\n aren't required by your user pool.
In a NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in the requiredAttributes
parameter, \nthen use the AdminUpdateUserAttributes
API operation to modify the value of any additional attributes.
\n MFA_SETUP
requires USERNAME
, plus you must use the\n session value returned by VerifySoftwareToken
in the\n Session
parameter.
The value of the USERNAME
attribute must be the user's actual username,\n not an alias (such as an email address or phone number). To make this simpler, the\n AdminInitiateAuth
response includes the actual username value in the\n USERNAMEUSER_ID_FOR_SRP
attribute. This happens even if you specified\n an alias in your call to AdminInitiateAuth
.
The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth
or RespondToAuthChallenge
API call determines \n that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge
\n API call.
The session that should be passed both ways in challenge-response calls to the\n service. If an InitiateAuth
or RespondToAuthChallenge
API call\n determines that the caller must pass another challenge, it returns a session with other\n challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge
calls.
The analytics metadata for collecting Amazon Pinpoint metrics for\n AdminRespondToAuthChallenge
calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that you have assigned to the following triggers:
\npre sign-up
\ncustom message
\npost authentication
\nuser migration
\npre token generation
\ndefine auth challenge
\ncreate auth challenge
\nverify auth challenge response
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions\n that you have assigned to the following triggers:
\npre sign-up
\ncustom message
\npost authentication
\nuser migration
\npre token generation
\ndefine auth challenge
\ncreate auth challenge
\nverify auth challenge response
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your AdminRespondToAuthChallenge request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. \n This session should be passed as it is to the next RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to the\n service. If the caller must pass another challenge, they return a session with other\n challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred \n MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will \n be returned during sign-in.
" + "smithy.api#documentation": "The user's multi-factor authentication (MFA) preference, including which MFA options\n are activated, and if any are preferred. Only one factor can be set as preferred. The\n preferred MFA factor will be used to authenticate a user if multiple factors are\n activated. If multiple options are activated and no preference is set, a challenge to\n choose an MFA option will be returned during sign-in.
" } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserMFAPreferenceRequest": { @@ -2287,7 +2299,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the specified user's password in a user pool as an administrator. Works on any user.
\nThe password can be temporary or permanent. If it is temporary, the user status enters the FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, \n the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in before it expires, the user won't be \n able to sign in, and an administrator must reset their password.
Once the user has set a new password, or the password is permanent, the user status is set to Confirmed
.
Sets the specified user's password in a user pool as an administrator. Works on any\n user.
\nThe password can be temporary or permanent. If it is temporary, the user status enters\n the FORCE_CHANGE_PASSWORD
state. When the user next tries to sign in, the\n InitiateAuth/AdminInitiateAuth response will contain the\n NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in before it\n expires, the user won't be able to sign in, and an administrator must reset their\n password.
Once the user has set a new password, or the password is permanent, the user status is\n set to Confirmed
.
\n True
if the password is permanent, False
if it is temporary.
\n True
if the password is permanent, False
if it is\n temporary.
\n This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) \n software token MFA. To configure either type of MFA, \n use AdminSetUserMFAPreference instead.
" + "smithy.api#documentation": "\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
" } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserSettingsRequest": { @@ -2375,20 +2387,20 @@ "MFAOptions": { "target": "com.amazonaws.cognitoidentityprovider#MFAOptionListType", "traits": { - "smithy.api#documentation": "You can use this parameter only to set an SMS configuration that uses SMS for delivery.
", + "smithy.api#documentation": "You can use this parameter only to set an SMS configuration that uses SMS for\n delivery.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
" + "smithy.api#documentation": "You can use this parameter to set an MFA configuration that uses the SMS delivery\n medium.
" } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserSettingsResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Represents the response from the server to set user settings as an administrator.
" + "smithy.api#documentation": "Represents the response from the server to set user settings as an\n administrator.
" } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedback": { @@ -2423,7 +2435,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool \n as part of Amazon Cognito advanced security.
" + "smithy.api#documentation": "Provides feedback for an authentication event indicating if it was from a valid user.\n This feedback is used for improving the risk evaluation decision for the user pool as\n part of Amazon Cognito advanced security.
" } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedbackRequest": { @@ -2590,7 +2602,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
\nFor custom attributes, you must prepend the custom:
prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Updates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesRequest": { @@ -2613,14 +2625,14 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the attribute name.
An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that\n you specify in this request, Amazon Cognito doesn’t immediately update the value of that\n attribute. After your user receives and responds to a verification message to verify the\n new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages\n with the original attribute value until they verify the new value.
\nTo update the value of an attribute that requires verification in the same API\n request, include the email_verified
or phone_number_verified
\n attribute, with a value of true
. If you set the email_verified
\n or phone_number_verified
value for an email
or\n phone_number
attribute that requires verification to true
,\n Amazon Cognito doesn’t send a verification message to your user.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\n \nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes \n the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives \n as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your \n AdminUpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for \n your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the\n function that is assigned to the custom message trigger. When Amazon Cognito\n invokes this function, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata
attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes\n request. In your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nRepresents the response from the server for the request to update user attributes as an administrator.
" + "smithy.api#documentation": "Represents the response from the server for the request to update user attributes as\n an administrator.
" } }, "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOut": { @@ -2664,7 +2676,7 @@ } ], "traits": { - "smithy.api#documentation": "Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and \n Id tokens expire one hour after they're issued.
\nCalling this action requires developer credentials.
" + "smithy.api#documentation": "Signs out a user from all devices. You must sign AdminUserGlobalSignOut
requests\n with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to\n a user. The user's current access and ID tokens remain valid until they expire. By\n default, access and ID tokens expire one hour after they're issued. A user can still use\n a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period\n of 1 hour.
Calling this action requires developer credentials.
" } }, "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOutRequest": { @@ -2751,7 +2763,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception \n tells user that an account with this email or phone already exists.
", + "smithy.api#documentation": "This exception is thrown when a user tries to confirm the account with an email\n address or phone number that has already been supplied as an alias from a different\n account. This exception indicates that an account with this email address or phone\n already exists in a user pool that you've configured to use email address or phone\n number as a sign-in alias.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2768,13 +2780,13 @@ "ApplicationArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project\n to integrate with the chosen user pool Client. Amazon Cognito publishes events to the\n Amazon Pinpointproject declared by the app ARN.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project\n to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint\n project that the app ARN declares.
" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
" + "smithy.api#documentation": "The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint\n analytics.
" } }, "ExternalId": { @@ -2786,12 +2798,12 @@ "UserDataShared": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "If UserDataShared
is true
, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
If UserDataShared
is true
, Amazon Cognito includes user data in the\n events that it publishes to Amazon Pinpoint analytics.
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
\nIn Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint\n projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support\n sending events to Amazon Pinpoint projects within that same Region.
\nThe Amazon Pinpoint analytics configuration necessary to collect metrics for a user\n pool.
\nIn Regions where Amazon Pinpointisn't available, user pools only support sending events to\n Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools\n support sending events to Amazon Pinpoint projects within that same Region.
\nAn Amazon Pinpoint analytics endpoint.
\nAn endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.
\nAmazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N.\n Virginia) us-east-1 Region, regardless of the Region where the user pool\n resides.
\nAn Amazon Pinpoint analytics endpoint.
\nAn endpoint uniquely identifies a mobile device, email address, or phone number that\n can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that\n can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
" } }, "com.amazonaws.cognitoidentityprovider#ArnType": { @@ -2847,7 +2859,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
\nCalling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token, \n their account is set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then log in without MFA. However, if MFA is \n set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.
\nReturns a unique generated shared secret key code for the user account. The request\n takes an access token or a session string, but not both.
\nCalling AssociateSoftwareToken immediately disassociates the existing software\n token from the user account. If the user doesn't subsequently verify the software\n token, their account is set up to authenticate without MFA. If MFA config is set to\n Optional at the user pool level, the user can then log in without MFA. However, if\n MFA is set to Required for the user pool, the user is asked to set up a new software\n token MFA during sign-in.
\nThe access token.
" + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose software token you want to\n generate.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
" + "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.
" } } } @@ -2873,13 +2885,13 @@ "SecretCode": { "target": "com.amazonaws.cognitoidentityprovider#SecretCodeType", "traits": { - "smithy.api#documentation": "A unique generated shared secret code that is used in the time-based one-time password (TOTP) algorithm to generate a one-time code.
" + "smithy.api#documentation": "A unique generated shared secret code that is used in the time-based one-time password\n (TOTP) algorithm to generate a one-time code.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
" + "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the\n service. This allows authentication of the user as part of the MFA setup process.
" } } } @@ -2978,6 +2990,12 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.cognitoidentityprovider#AttributesRequireVerificationBeforeUpdateType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributeType" + } + }, "com.amazonaws.cognitoidentityprovider#AuthEventType": { "type": "structure", "members": { @@ -3020,13 +3038,13 @@ "EventContextData": { "target": "com.amazonaws.cognitoidentityprovider#EventContextDataType", "traits": { - "smithy.api#documentation": "The user context data captured at the time of an event request. This value provides additional information about the client from which event the request is received.
" + "smithy.api#documentation": "The user context data captured at the time of an event request. This value provides\n additional information about the client from which event the request is received.
" } }, "EventFeedback": { "target": "com.amazonaws.cognitoidentityprovider#EventFeedbackType", "traits": { - "smithy.api#documentation": "A flag specifying the user feedback captured at the time of an event request is good or bad.
" + "smithy.api#documentation": "A flag specifying the user feedback captured at the time of an event request is good\n or bad.
" } } }, @@ -3093,7 +3111,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
" + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user who you want to\n authenticate.
" } }, "ExpiresIn": { @@ -3351,7 +3369,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose password you want to\n change.
", "smithy.api#required": {} } } @@ -3435,24 +3453,24 @@ "Destination": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The destination for the code delivery details.
" + "smithy.api#documentation": "The email address or phone number destination where Amazon Cognito sent the code.
" } }, "DeliveryMedium": { "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType", "traits": { - "smithy.api#documentation": "The delivery medium (email message or phone number).
" + "smithy.api#documentation": "The method that Amazon Cognito used to send the code.
" } }, "AttributeName": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", "traits": { - "smithy.api#documentation": "The attribute name.
" + "smithy.api#documentation": "The name of the attribute that Amazon Cognito verifies with the code.
" } } }, "traits": { - "smithy.api#documentation": "The code delivery details being returned from the server.
" + "smithy.api#documentation": "The delivery details for an email or SMS message that Amazon Cognito sent for authentication or\n verification.
" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException": { @@ -3466,7 +3484,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a verification code fails to deliver successfully.
", + "smithy.api#documentation": "This exception is thrown when a verification code fails to deliver\n successfully.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3482,7 +3500,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown if the provided code doesn't match what the server was expecting.
", + "smithy.api#documentation": "This exception is thrown if the provided code doesn't match what the server was\n expecting.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3533,7 +3551,7 @@ "EventFilter": { "target": "com.amazonaws.cognitoidentityprovider#EventFiltersType", "traits": { - "smithy.api#documentation": "Perform the action for these events. The default is to perform all events if no event filter is specified.
" + "smithy.api#documentation": "Perform the action for these events. The default is to perform all events if no event\n filter is specified.
" } }, "Actions": { @@ -3559,7 +3577,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown if two or more modifications are happening concurrently.
", + "smithy.api#documentation": "This exception is thrown if two or more modifications are happening\n concurrently.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3611,7 +3629,7 @@ } ], "traits": { - "smithy.api#documentation": "Confirms tracking of the device. This API call is the call that begins device tracking.
" + "smithy.api#documentation": "Confirms tracking of the device. This API call is the call that begins device\n tracking.
" } }, "com.amazonaws.cognitoidentityprovider#ConfirmDeviceRequest": { @@ -3620,7 +3638,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose device you want to\n confirm.
", "smithy.api#required": {} } }, @@ -3736,20 +3754,20 @@ "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { - "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "The user name of the user for whom you want to enter a code to retrieve a forgotten password.
", + "smithy.api#documentation": "The user name of the user for whom you want to enter a code to retrieve a forgotten\n password.
", "smithy.api#required": {} } }, "ConfirmationCode": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmationCodeType", "traits": { - "smithy.api#documentation": "The confirmation code sent by a user's request to retrieve a forgotten password. For more information, \n see ForgotPassword.
", + "smithy.api#documentation": "The confirmation code sent by a user's request to retrieve a forgotten password. For\n more information, see ForgotPassword.
", "smithy.api#required": {} } }, @@ -3763,19 +3781,19 @@ "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for\n ConfirmForgotPassword
calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your\n function code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your\n function code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe response from the server that results from a user's request to retrieve a forgotten password.
" + "smithy.api#documentation": "The response from the server that results from a user's request to retrieve a\n forgotten password.
" } }, "com.amazonaws.cognitoidentityprovider#ConfirmSignUp": { @@ -3844,7 +3862,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Confirms registration of a user and handles the existing alias from a previous user.
", + "smithy.api#documentation": "Confirms registration of a new user.
", "smithy.api#optionalAuth": {} } }, @@ -3861,7 +3879,7 @@ "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { - "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" } }, "Username": { @@ -3881,25 +3899,25 @@ "ForceAliasCreation": { "target": "com.amazonaws.cognitoidentityprovider#ForceAliasCreation", "traits": { - "smithy.api#documentation": "Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False
. If this parameter is set to \n True
and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate \n the alias from the previous user to the newly created user being confirmed. If set to False
, the API will throw an \n AliasExistsException error.
Boolean to be specified to force user confirmation irrespective of existing alias. By\n default set to False
. If this parameter is set to True
and the\n phone number/email used for sign up confirmation already exists as an alias with a\n different user, the API call will migrate the alias from the previous user to the newly\n created user being confirmed. If set to False
, the API will throw an\n AliasExistsException error.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
calls.
The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
\n calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\n \nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, \n Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this \n function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
attribute, which \n provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, \n you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is\n assigned to the post confirmation trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function\n code in Lambda, you can process the clientMetadata
value to\n enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nEncoded data containing device fingerprinting details collected using the Amazon Cognito context data collection library.
" + "smithy.api#documentation": "Encoded data containing device fingerprinting details collected using the Amazon Cognito\n context data collection library.
" } } }, "traits": { - "smithy.api#documentation": "Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito\n advanced security.
" } }, "com.amazonaws.cognitoidentityprovider#CreateGroup": { @@ -4033,7 +4051,7 @@ "Precedence": { "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", "traits": { - "smithy.api#documentation": "A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. \n Zero is the highest precedence value. Groups with lower Precedence
values take precedence over groups with higher ornull Precedence
\n values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the \n cognito:roles
and cognito:preferred_role
claims.
Two groups can have the same Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the same \n Precedence
have the same role ARN, that role is used in the cognito:preferred_role
claim in tokens for users in each group. If \n the two groups have different role ARNs, the cognito:preferred_role
claim isn't set in users' tokens.
The default Precedence
value is null.
A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence
values take precedence over\n groups with higher or null Precedence
values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles
and\n cognito:preferred_role
claims.
Two groups can have the same Precedence
value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence
have the same role ARN, that role is used in the\n cognito:preferred_role
claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role
claim isn't\n set in users' tokens.
The default Precedence
value is null. The maximum Precedence
\n value is 2^31-1
.
Creates an identity provider for a user pool.
" + "smithy.api#documentation": "Creates an IdP for a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#CreateIdentityProviderRequest": { @@ -4097,34 +4115,34 @@ "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameTypeV1", "traits": { - "smithy.api#documentation": "The identity provider name.
", + "smithy.api#documentation": "The IdP name.
", "smithy.api#required": {} } }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { - "smithy.api#documentation": "The identity provider type.
", + "smithy.api#documentation": "The IdP type.
", "smithy.api#required": {} } }, "ProviderDetails": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for each identity provider type.
\nFor Google and Login with Amazon:
\nclient_id
\nclient_secret
\nauthorize_scopes
\nFor Facebook:
\nclient_id
\nclient_secret
\nauthorize_scopes
\napi_version
\nFor Sign in with Apple:
\nclient_id
\nteam_id
\nkey_id
\nprivate_key
\nauthorize_scopes
\nFor OpenID Connect (OIDC) providers:
\nclient_id
\nclient_secret
\nattributes_request_method
\noidc_issuer
\nauthorize_scopes
\nauthorize_url if not available from discovery URL specified by oidc_issuer key\n
\ntoken_url if not available from discovery URL specified by oidc_issuer key\n
\nattributes_url if not available from discovery URL specified by oidc_issuer key\n
\njwks_uri if not available from discovery URL specified by oidc_issuer key\n
\nattributes_url_add_attributes a read-only property that is set automatically\n
\nFor SAML providers:
\nMetadataFile OR MetadataURL
\nIDPSignout (optional)
\nThe IdP details. The following list describes the provider detail keys for each IdP\n type.
\nFor Google and Login with Amazon:
\nclient_id
\nclient_secret
\nauthorize_scopes
\nFor Facebook:
\nclient_id
\nclient_secret
\nauthorize_scopes
\napi_version
\nFor Sign in with Apple:
\nclient_id
\nteam_id
\nkey_id
\nprivate_key
\nauthorize_scopes
\nFor OpenID Connect (OIDC) providers:
\nclient_id
\nclient_secret
\nattributes_request_method
\noidc_issuer
\nauthorize_scopes
\nThe following keys are only present if Amazon Cognito didn't discover them at\n the oidc_issuer
URL.
authorize_url
\ntoken_url
\nattributes_url
\njwks_uri
\nAmazon Cognito sets the value of the following keys automatically. They are\n read-only.
\nattributes_url_add_attributes
\nFor SAML providers:
\nMetadataFile or MetadataURL
\nIDPSignout optional\n
\nA mapping of identity provider attributes to standard and custom user pool attributes.
" + "smithy.api#documentation": "A mapping of IdP attributes to standard and custom user pool attributes.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { - "smithy.api#documentation": "A list of identity provider identifiers.
" + "smithy.api#documentation": "A list of IdP identifiers.
" } } } @@ -4135,7 +4153,7 @@ "IdentityProvider": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderType", "traits": { - "smithy.api#documentation": "The newly created identity provider object.
", + "smithy.api#documentation": "The newly created IdP object.
", "smithy.api#required": {} } } @@ -4186,7 +4204,7 @@ "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { - "smithy.api#documentation": "A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as https://my-weather-api.example.com
.
A unique resource server identifier for the resource server. This could be an HTTPS\n endpoint where the resource server is located, such as\n https://my-weather-api.example.com
.
A list of scopes. Each scope is a key-value map with the keys name
and description
.
A list of scopes. Each scope is a key-value map with the keys name
and\n description
.
The user pool ID for the user pool that the users are being imported\n into.
", + "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
", "smithy.api#required": {} } }, @@ -4292,7 +4310,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to create the user import job.
" + "smithy.api#documentation": "Represents the response from the server to the request to create the user import\n job.
" } }, "com.amazonaws.cognitoidentityprovider#CreateUserPool": { @@ -4333,7 +4351,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Cognito user pool and sets the password policy for the pool.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool and sets the password policy for the\n pool.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates the user pool client.
\nWhen you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, \n see RevokeToken.
" + "smithy.api#documentation": "Creates the user pool client.
\nWhen you create a new user pool client, token revocation is automatically activated.\n For more information about revoking tokens, see RevokeToken.
" } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolClientRequest": { @@ -4394,31 +4412,31 @@ "GenerateSecret": { "target": "com.amazonaws.cognitoidentityprovider#GenerateSecret", "traits": { - "smithy.api#documentation": "Boolean to specify whether you want to generate a secret for the user pool client being created.
" + "smithy.api#documentation": "Boolean to specify whether you want to generate a secret for the user pool client\n being created.
" } }, "RefreshTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { - "smithy.api#documentation": "The time limit, in days, after which the refresh token is no longer valid and can't be used.
" + "smithy.api#documentation": "The refresh token time limit. After this limit expires, your user can't use \n their refresh token. To specify the time unit for RefreshTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and\n TokenValidityUnits
as days
, your user can refresh their session\n and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. \n You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the \n value with the default value of 30 days. Valid range is displayed below \n in seconds.
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override \n the default time unit.
" + "smithy.api#documentation": "The access token time limit. After this limit expires, your user can't use \n their access token. To specify the time unit for AccessTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and\n TokenValidityUnits
to hours
, your user can authorize access with\n their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. \n Valid range is displayed below in seconds.
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override \n the default time unit.
" + "smithy.api#documentation": "The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and\n TokenValidityUnits
as hours
, your user can authenticate their \n session with their ID token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. \n Valid range is displayed below in seconds.
The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens are hours.
" + "smithy.api#documentation": "The units in which the validity times are represented. The default unit for\n RefreshToken is days, and default for ID and access tokens are hours.
" } }, "ReadAttributes": { @@ -4430,55 +4448,55 @@ "WriteAttributes": { "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", "traits": { - "smithy.api#documentation": "The user pool attributes that the app client can write to.
\nIf your app client allows users to sign in through an identity provider, this array\n must include all attributes that you have mapped to identity provider attributes. Amazon Cognito\n updates mapped attributes when users sign in to your application through an identity\n provider. If your app client does not have write access to a mapped attribute, Amazon Cognito\n throws an error when it tries to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your user\n pool.
" + "smithy.api#documentation": "The user pool attributes that the app client can write to.
\nIf your app client allows users to sign in through an IdP, this array must include all\n attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when\n users sign in to your application through an IdP. If your app client does not have write\n access to a mapped attribute, Amazon Cognito throws an error when it tries to update the\n attribute. For more information, see Specifying IdP Attribute Mappings for Your user\n pool.
" } }, "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_
prefix are no longer supported, in favor of new names\n with the ALLOW_
prefix.
Values with ALLOW_
prefix must be used only along with the\n ALLOW_
prefix.
Valid values include:
\n \n\n ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces\n the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito\n receives the password in the request instead of using the Secure Remote Password\n (SRP) protocol to verify passwords.
\n ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH
: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh\n tokens.
The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_
prefix are no longer supported, in favor of new names\n with the ALLOW_
prefix.
Values with ALLOW_
prefix must be used only along with the\n ALLOW_
prefix.
Valid values include:
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces\n the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito\n receives the password in the request instead of using the Secure Remote Password\n (SRP) protocol to verify passwords.
\n ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH
: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh\n tokens.
If you don't specify a value for ExplicitAuthFlows
, your app client\n activates the ALLOW_USER_SRP_AUTH
and ALLOW_CUSTOM_AUTH
\n authentication flows.
A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO
, Facebook
, Google
\n and LoginWithAmazon
.
A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO
, Facebook
, Google
\n LoginWithAmazon
, and the names of your own SAML and OIDC providers.
A list of allowed redirect (callback) URLs for the identity providers.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a \n fragment component.
\nSee OAuth 2.0 - Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "A list of allowed redirect (callback) URLs for the IdPs.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" } }, "LogoutURLs": { "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { - "smithy.api#documentation": "A list of allowed logout URLs for the identity providers.
" + "smithy.api#documentation": "A list of allowed logout URLs for the IdPs.
" } }, "DefaultRedirectURI": { "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a \n fragment component.
\nSee OAuth 2.0 - Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" } }, "AllowedOAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", "traits": { - "smithy.api#documentation": "The allowed OAuth flows.
\nSet to code
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a \n combination of client and client_secret.
The allowed OAuth flows.
\nUse a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token
endpoint.
Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.
\nIssue the access token from the /oauth2/token
endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The allowed OAuth scopes. Possible values provided by OAuth are: phone
, email
, openid
, and profile
. Possible values \n provided by Amazon Web Services are: aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are phone
,\n email
, openid
, and profile
. Possible values\n provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom\n scopes created in Resource Servers are also supported.
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
" + "smithy.api#documentation": "Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Amazon Cognito user pools.
" } }, "AnalyticsConfiguration": { @@ -4490,13 +4508,13 @@ "PreventUserExistenceErrors": { "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", "traits": { - "smithy.api#documentation": "Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user \n pool. When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. \n Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those \n APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
\n \n\n ENABLED
- This prevents user existence-related errors.
\n LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account\n confirmation, and password recovery when the user doesn't exist in the user pool. When\n set to ENABLED
and the user doesn't exist, authentication returns an error\n indicating either the username or password was incorrect. Account confirmation and\n password recovery return a response indicating a code was sent to a simulated\n destination. When set to LEGACY
, those APIs return a\n UserNotFoundException
exception if the user doesn't exist in the user\n pool.
Valid values include:
\n\n ENABLED
- This prevents user existence-related errors.
\n LEGACY
- This represents the early behavior of Amazon Cognito where user\n existence related errors aren't prevented.
Activates or deactivates token revocation. For more information about revoking tokens, \n see RevokeToken.
\nIf you don't include this parameter, token revocation is automatically activated for the new user pool client.
" + "smithy.api#documentation": "Activates or deactivates token revocation. For more information about revoking tokens,\n see RevokeToken.
\nIf you don't include this parameter, token revocation is automatically activated for\n the new user pool client.
" } } }, @@ -4553,7 +4571,7 @@ "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone, \n such as auth
.
The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
\nProvide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
\nFor more information about the hosted domain and custom domains, \n see Configuring a User Pool Domain.
" + "smithy.api#documentation": "The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.
\nProvide this parameter only if you want to use a custom domain for your user pool.\n Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain\n instead.
\nFor more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
" } } } @@ -4578,7 +4596,7 @@ "CloudFrontDomain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
" + "smithy.api#documentation": "The Amazon CloudFront endpoint that you use as the target of the alias that you set up with\n your Domain Name Service (DNS) provider.
" } } } @@ -4602,7 +4620,7 @@ "LambdaConfig": { "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { - "smithy.api#documentation": "The Lambda trigger configuration information for the new user pool.
\nIn a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an \n extra call to add permission for these event sources to invoke your Lambda function.
\n \nFor more information on using the Lambda API \n to add permission, see AddPermission .
\nFor adding permission using the CLI, see add-permission .
\nThe Lambda trigger configuration information for the new user pool.
\nIn a push model, event sources (such as Amazon S3 and custom applications) need\n permission to invoke a function. So you must make an extra call to add permission\n for these event sources to invoke your Lambda function.
\n \nFor more information on using the Lambda API to add permission, see\n AddPermission .
\nFor adding permission using the CLI, see add-permission\n .
\nAttributes supported as an alias for this user pool. Possible values: phone_number, email, or \n preferred_username.
" + "smithy.api#documentation": "Attributes supported as an alias for this user pool. Possible values: phone_number, email, or\n preferred_username.
" } }, "UsernameAttributes": { "target": "com.amazonaws.cognitoidentityprovider#UsernameAttributesListType", "traits": { - "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when they sign up.
" + "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when\n they sign up.
" } }, "SmsVerificationMessage": { @@ -4632,19 +4650,19 @@ "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "A string representing the email verification message. EmailVerificationMessage is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "A string representing the email verification message. EmailVerificationMessage is\n allowed only if EmailSendingAccount is DEVELOPER.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "A string representing the email verification subject. EmailVerificationSubject is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "A string representing the email verification subject. EmailVerificationSubject is\n allowed only if EmailSendingAccount is DEVELOPER.
" } }, "VerificationMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { - "smithy.api#documentation": "The template for the verification message that the user sees when the app requests permission to access the user's information.
" + "smithy.api#documentation": "The template for the verification message that the user sees when the app requests\n permission to access the user's information.
" } }, "SmsAuthenticationMessage": { @@ -4659,6 +4677,12 @@ "smithy.api#documentation": "Specifies MFA configuration details.
" } }, + "UserAttributeUpdateSettings": { + "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", + "traits": { + "smithy.api#documentation": "" + } + }, "DeviceConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType", "traits": { @@ -4680,7 +4704,7 @@ "UserPoolTags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { - "smithy.api#documentation": "The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, \n or other criteria.
" + "smithy.api#documentation": "The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.
" } }, "AdminCreateUserConfig": { @@ -4692,25 +4716,25 @@ "Schema": { "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", "traits": { - "smithy.api#documentation": "An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
" + "smithy.api#documentation": "An array of schema attributes for the new user pool. These attributes can be standard\n or custom attributes.
" } }, "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "Enables advanced security risk detection. Set the key AdvancedSecurityMode
to the value \"AUDIT\".
Enables advanced security risk detection. Set the key\n AdvancedSecurityMode
to the value \"AUDIT\".
Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False
, users can sign in using either \"username\" \n or \"Username\". This configuration is immutable once it has been set. For more information, \n see UsernameConfigurationType.
Case sensitivity on the username input for the selected sign-in option. For example,\n when case sensitivity is set to False
, users can sign in using either\n \"username\" or \"Username\". This configuration is immutable once it has been set. For more\n information, see UsernameConfigurationType.
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a \n preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the \n user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method \n where SMS is preferred through email.
The available verified method a user can use to recover their password when they call\n ForgotPassword
. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
" + "smithy.api#documentation": "The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.
" } }, "com.amazonaws.cognitoidentityprovider#CustomEmailLambdaVersionConfigType": { @@ -4775,14 +4799,14 @@ "LambdaVersion": { "target": "com.amazonaws.cognitoidentityprovider#CustomEmailSenderLambdaVersionType", "traits": { - "smithy.api#documentation": "Signature of the \"request\" attribute in the \"event\" information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0
.
Signature of the \"request\" attribute in the \"event\" information Amazon Cognito passes to your\n custom email Lambda function. The only supported value is V1_0
.
The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send\n email notifications to users.
", "smithy.api#required": {} } } @@ -4808,14 +4832,14 @@ "LambdaVersion": { "target": "com.amazonaws.cognitoidentityprovider#CustomSMSSenderLambdaVersionType", "traits": { - "smithy.api#documentation": "Signature of the \"request\" attribute in the \"event\" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0
.
Signature of the \"request\" attribute in the \"event\" information that Amazon Cognito passes to\n your custom SMS Lambda function. The only supported value is V1_0
.
The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS\n notifications to users.
", "smithy.api#required": {} } } @@ -4858,6 +4882,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -4903,6 +4930,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteIdentityProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -4924,7 +4954,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an identity provider for a user pool.
" + "smithy.api#documentation": "Deletes an IdP for a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteIdentityProviderRequest": { @@ -4940,7 +4970,7 @@ "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "The identity provider name.
", + "smithy.api#documentation": "The IdP name.
", "smithy.api#required": {} } } @@ -4951,6 +4981,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -4996,6 +5029,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -5074,14 +5110,14 @@ "UserAttributeNames": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameListType", "traits": { - "smithy.api#documentation": "An array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prependattach the custom:
prefix to the front of the attribute name.
An array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prependattach the custom:
prefix to the\n front of the attribute name.
The access token used in the request to delete user attributes.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose attributes you want to\n delete.
", "smithy.api#required": {} } } @@ -5102,6 +5138,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -5131,6 +5170,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -5206,7 +5248,7 @@ "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone, \n such as auth
.
The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
The access token from a request to delete a user.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose user profile you want to\n delete.
", "smithy.api#required": {} } } @@ -5300,7 +5342,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about a specific identity provider.
" + "smithy.api#documentation": "Gets information about a specific IdP.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeIdentityProviderRequest": { @@ -5316,7 +5358,7 @@ "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "The identity provider name.
", + "smithy.api#documentation": "The IdP name.
", "smithy.api#required": {} } } @@ -5328,7 +5370,7 @@ "IdentityProvider": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderType", "traits": { - "smithy.api#documentation": "The identity provider that was deleted.
", + "smithy.api#documentation": "The IdP that was deleted.
", "smithy.api#required": {} } } @@ -5518,7 +5560,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to describe the user import job.
" + "smithy.api#documentation": "Represents the response from the server to the request to describe the user import\n job.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPool": { @@ -5579,7 +5621,7 @@ } ], "traits": { - "smithy.api#documentation": "Client method for returning the configuration information and metadata of the specified user pool app client.
" + "smithy.api#documentation": "Client method for returning the configuration information and metadata of the\n specified user pool app client.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolClientRequest": { @@ -5615,7 +5657,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response from the server from a request to describe the user pool client.
" + "smithy.api#documentation": "Represents the response from the server from a request to describe the user pool\n client.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolDomain": { @@ -5650,7 +5692,7 @@ "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone, \n such as auth
.
The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
\nUsers that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user \n pool requires MFA.
\nWhen true, device authentication can replace SMS and time-based one-time password\n (TOTP) factors for multi-factor authentication (MFA).
\nUsers that sign in with devices that have not been confirmed or remembered will\n still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice\n is true, when your user pool requires MFA.
\nWhen true, users can opt in to remembering their device. Your app code must use callback functions to return the user's choice.
" + "smithy.api#documentation": "When true, users can opt in to remembering their device. Your app code must use\n callback functions to return the user's choice.
" } } }, "traits": { - "smithy.api#documentation": "The device tracking configuration for a user pool. A user pool with device tracking deactivated returns a null value.
\nWhen you provide values for any DeviceConfiguration field, you activate device tracking.
\nThe device tracking configuration for a user pool. A user pool with device tracking\n deactivated returns a null value.
\nWhen you provide values for any DeviceConfiguration field, you activate device\n tracking.
\nThe salt.
" + "smithy.api#documentation": "The salt\n
" } } }, @@ -5841,7 +5883,7 @@ "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone, such as auth
.
The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com
. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth
.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
" + "smithy.api#documentation": "The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.
" } } }, @@ -5933,7 +5975,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the provider is already supported by the user pool.
", + "smithy.api#documentation": "This exception is thrown when the provider is already supported by the user\n pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5950,7 +5992,7 @@ "SourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount
\n parameter:
If you specify COGNITO_DEFAULT
, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER
, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn
parameter must indicate a supported\n Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn
and\n the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer\n Guide.
The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of\n the following ways, depending on the value that you specify for the\n EmailSendingAccount
parameter:
If you specify COGNITO_DEFAULT
, Amazon Cognito uses this address as the\n custom FROM address when it emails your users using its built-in email\n account.
If you specify DEVELOPER
, Amazon Cognito emails your users with this\n address by calling Amazon SES on your behalf.
The Region value of the SourceArn
parameter must indicate a supported\n Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn
and\n the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer\n Guide.
Specifies whether Amazon Cognito uses its built-in functionality to send your users email\n messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\n values:
\nWhen Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. \n For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email \n configuration.
\nTo look up the email delivery limit for the default option, see Limits in in the \n Developer Guide.
\nThe default FROM address is no-reply@verificationemail.com
. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address \n for the SourceArn
parameter.
If EmailSendingAccount is COGNITO_DEFAULT, you can't use the following parameters:
\nEmailVerificationMessage
\nEmailVerificationSubject
\nInviteMessageTemplate.EmailMessage
\nInviteMessageTemplate.EmailSubject
\nVerificationMessageTemplate.EmailMessage
\nVerificationMessageTemplate.EmailMessageByLink
\nVerificationMessageTemplate.EmailSubject,
\nVerificationMessageTemplate.EmailSubjectByLink
\nDEVELOPER EmailSendingAccount is required.
\nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this \n option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
\nIf you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn
parameter.
Before Amazon Cognito can email your users, it requires additional permissions to call\n Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito\n creates a service-linked role, which is a type of role,\n in your Amazon Web Services account. This role contains the permissions that\n allow to access Amazon SES and send email messages with your address. For more\n information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.
\nSpecifies whether Amazon Cognito uses its built-in functionality to send your users email\n messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\n values:
\nWhen Amazon Cognito emails your users, it uses its built-in email functionality.\n When you use the default option, Amazon Cognito allows only a limited number of\n emails each day for your user pool. For typical production environments, the\n default email limit is less than the required delivery volume. To achieve a\n higher delivery volume, specify DEVELOPER to use your Amazon SES email\n configuration.
\nTo look up the email delivery limit for the default option, see Limits in in the Developer Guide.
\nThe default FROM address is no-reply@verificationemail.com
.\n To customize the FROM address, provide the Amazon Resource Name (ARN) of an\n Amazon SES verified email address for the SourceArn
\n parameter.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito\n calls Amazon SES on your behalf to send email from your verified email address.\n When you use this option, the email delivery limits are the same limits that\n apply to your Amazon SES verified email address in your Amazon Web Services account.
\nIf you use this option, provide the ARN of an Amazon SES verified email address\n for the SourceArn
parameter.
Before Amazon Cognito can email your users, it requires additional permissions to\n call Amazon SES on your behalf. When you update your user pool with this option,\n Amazon Cognito creates a service-linked role, which is a type of\n role, in your Amazon Web Services account. This role contains the permissions\n that allow to access Amazon SES and send email messages with your address. For\n more information about the service-linked role that Amazon Cognito creates, see\n Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.
\nEither the sender’s email address or the sender’s name with their email address. For example, testuser@example.com
or \n Test User
. This address appears before the body of the email.
Either the sender’s email address or the sender’s name with their email address. For\n example, testuser@example.com
or Test User\n
. This address appears before the body of the\n email.
The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.
\nAmazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you\n created your user pool, and in alternate Regions in some cases. For more information\n on the supported Regions, see Email settings for Amazon Cognito user pools.
\nThe email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.
\nAmazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where\n you created your user pool, and in alternate Regions in some cases. For more\n information on the supported Regions, see Email settings for Amazon Cognito user pools.
\nThis exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
", + "smithy.api#documentation": "This exception is thrown when there is a code mismatch and the service fails to\n configure the software token TOTP multi-factor authentication (MFA).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6204,7 +6246,7 @@ "CompromisedCredentialsDetected": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "Indicates whether compromised credentials were detected during an authentication event.
" + "smithy.api#documentation": "Indicates whether compromised credentials were detected during an authentication\n event.
" } } }, @@ -6315,6 +6357,9 @@ "input": { "target": "com.amazonaws.cognitoidentityprovider#ForgetDeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" @@ -6354,7 +6399,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token for the forgotten device request.
" + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose registered device you want to\n forget.
" } }, "DeviceKey": { @@ -6423,7 +6468,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the \n Username
parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the \n specified AccountRecoverySetting. For more information, \n see Recovering User Accounts \n in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, \n an InvalidParameterException
is thrown. To use the confirmation code for resetting the password, \n call ConfirmForgotPassword.\n
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCalling this API causes a message to be sent to the end user with a confirmation code\n that is required to change the user's password. For the Username
parameter,\n you can use the username or user alias. The method used to send the confirmation code is\n sent according to the specified AccountRecoverySetting. For more information, see Recovering\n User Accounts in the Amazon Cognito Developer Guide. If\n neither a verified phone number nor a verified email exists, an\n InvalidParameterException
is thrown. To use the confirmation code for\n resetting the password, call ConfirmForgotPassword.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nA keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "The user name of the user for whom you want to enter a code to reset a forgotten password.
", + "smithy.api#documentation": "The user name of the user for whom you want to enter a code to reset a forgotten\n password.
", "smithy.api#required": {} } }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { - "smithy.api#documentation": "The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword
\n calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for\n ForgotPassword
calls.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, and user migration. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your ForgotPassword request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: pre sign-up,\n custom message, and user migration. When\n Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your ForgotPassword request. In your function code in Lambda, you can\n process the clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe code delivery details returned by the server in response to the request to reset a password.
" + "smithy.api#documentation": "The code delivery details returned by the server in response to the request to reset a\n password.
" } } }, "traits": { - "smithy.api#documentation": "Respresents the response from the server regarding the request to reset a password.
" + "smithy.api#documentation": "Represents the response from the server regarding the request to reset a\n password.
" } }, "com.amazonaws.cognitoidentityprovider#GenerateSecret": { @@ -6516,7 +6561,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.
" + "smithy.api#documentation": "Gets the header information for the comma-separated value (CSV) file to be used as\n input for the user import job.
" } }, "com.amazonaws.cognitoidentityprovider#GetCSVHeaderRequest": { @@ -6531,7 +6576,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the request to get the header information of the CSV file for the user import job.
" + "smithy.api#documentation": "Represents the request to get the header information of the CSV file for the user\n import job.
" } }, "com.amazonaws.cognitoidentityprovider#GetCSVHeaderResponse": { @@ -6540,7 +6585,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are to be imported\n into.
" + "smithy.api#documentation": "The user pool ID for the user pool that the users are to be imported into.
" } }, "CSVHeader": { @@ -6551,7 +6596,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to get the header information of the CSV file for the user import job.
" + "smithy.api#documentation": "Represents the response from the server to the request to get the header information\n of the CSV file for the user import job.
" } }, "com.amazonaws.cognitoidentityprovider#GetDevice": { @@ -6608,7 +6653,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
" + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose device information you want\n to request.
" } } }, @@ -6716,7 +6761,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the specified identity provider.
" + "smithy.api#documentation": "Gets the specified IdP.
" } }, "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifierRequest": { @@ -6732,7 +6777,7 @@ "IdpIdentifier": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifierType", "traits": { - "smithy.api#documentation": "The identity provider ID.
", + "smithy.api#documentation": "The IdP identifier.
", "smithy.api#required": {} } } @@ -6744,7 +6789,7 @@ "IdentityProvider": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderType", "traits": { - "smithy.api#documentation": "The identity provider object.
", + "smithy.api#documentation": "The IdP object.
", "smithy.api#required": {} } } @@ -6828,7 +6873,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, \n but there is an existing pool level customization (the app clientId
is ALL
), then that information is returned. If nothing is present, then an empty shape is returned.
Gets the user interface (UI) Customization information for a particular app client's\n app UI, if any such information exists for the client. If nothing is set for the\n particular client, but there is an existing pool level customization (the app\n clientId
is ALL
), then that information is returned. If\n nothing is present, then an empty shape is returned.
Gets the user attribute verification code for the specified attribute name.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nGenerates a user attribute verification code for the specified attribute name. Sends a\n message to a user with a code that they must return in a VerifyUserAttribute\n request.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe access token returned by the server response to get the user attribute verification code.
", + "smithy.api#documentation": "A non-expired access token for the user whose attribute verification code you want to\n generate.
", "smithy.api#required": {} } }, "AttributeName": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", "traits": { - "smithy.api#documentation": "The attribute name returned by the server response to get the user attribute verification code.
", + "smithy.api#documentation": "The attribute name returned by the server response to get the user attribute\n verification code.
", "smithy.api#required": {} } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\n \nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode \n API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it \n passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data \n that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, \n you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes\n the function that is assigned to the custom message trigger. When\n Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata
attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your\n GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for\n your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe code delivery details returned by the server in response to the request to get the user attribute verification code.
" + "smithy.api#documentation": "The code delivery details returned by the server in response to the request to get the\n user attribute verification code.
" } } }, "traits": { - "smithy.api#documentation": "The verification code response returned by the server response to get the user attribute verification code.
" + "smithy.api#documentation": "The verification code response returned by the server response to get the user\n attribute verification code.
" } }, "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfig": { @@ -7066,7 +7111,7 @@ "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "The multi-factor (MFA) configuration. Valid values include:
\n \n\n OFF
MFA won't be used for any users.
\n ON
MFA is required for all users to sign in.
\n OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
The multi-factor (MFA) configuration. Valid values include:
\n\n OFF
MFA won't be used for any users.
\n ON
MFA is required for all users to sign in.
\n OPTIONAL
MFA will be required only for individual users who have\n an MFA factor activated.
The access token returned by the server response to get information about the user.
", + "smithy.api#documentation": "A non-expired access token for the user whose information you want to query.
", "smithy.api#required": {} } } @@ -7099,14 +7144,14 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the attribute name.
An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
\n This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time \n password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
" + "smithy.api#documentation": "\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about\n time-based one-time password (TOTP) software token MFA configurations. To look up\n information about either type of MFA configuration, use UserMFASettingList\n instead.
" } }, "PreferredMfaSetting": { @@ -7118,12 +7163,12 @@ "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { - "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA
and SOFTWARE_TOKEN_MFA
.
Represents the response from the server from the request to get information about the user.
" + "smithy.api#documentation": "Represents the response from the server from the request to get information about the\n user.
" } }, "com.amazonaws.cognitoidentityprovider#GlobalSignOut": { @@ -7158,7 +7203,7 @@ } ], "traits": { - "smithy.api#documentation": "Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and ID tokens remain valid until their expiry. Access and Id tokens expire \n one hour after they're issued.
" + "smithy.api#documentation": "Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito\n has issued to a user. The user's current access and ID tokens remain valid until their\n expiry. By default, access and ID tokens expire one hour after Amazon Cognito issues them. A user\n can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie\n validity period of 1 hour.
" } }, "com.amazonaws.cognitoidentityprovider#GlobalSignOutRequest": { @@ -7167,7 +7212,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user who you want to sign out.
", "smithy.api#required": {} } } @@ -7191,7 +7236,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
", + "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters a group that already exists in the user\n pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7242,7 +7287,7 @@ "Precedence": { "target": "com.amazonaws.cognitoidentityprovider#PrecedenceType", "traits": { - "smithy.api#documentation": "A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in \n the user pool. Zero is the highest precedence value. Groups with lower Precedence
values take precedence over groups with \n higher ornull Precedence
values. If a user belongs to two or more groups, it is the group with the lowest precedence \n value whose role ARN is given in the user's tokens for the cognito:roles
and cognito:preferred_role
claims.
Two groups can have the same Precedence
value. If this happens, neither group takes precedence over the other. If two \n groups with the same Precedence
have the same role ARN, that role is used in the cognito:preferred_role
claim \n in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role
claim isn't set in \n users' tokens.
The default Precedence
value is null.
A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence
values take precedence over\n groups with higher ornull Precedence
values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles
and\n cognito:preferred_role
claims.
Two groups can have the same Precedence
value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence
have the same role ARN, that role is used in the\n cognito:preferred_role
claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role
claim isn't\n set in users' tokens.
The default Precedence
value is null.
The identity provider name.
" + "smithy.api#documentation": "The IdP name.
" } }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { - "smithy.api#documentation": "The identity provider type.
" + "smithy.api#documentation": "The IdP type.
" } }, "ProviderDetails": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for each identity provider type.
\nFor Google and Login with Amazon:
\nclient_id
\nclient_secret
\nauthorize_scopes
\nFor Facebook:
\nclient_id
\nclient_secret
\nauthorize_scopes
\napi_version
\nFor Sign in with Apple:
\nclient_id
\nteam_id
\nkey_id
\nprivate_key
\nauthorize_scopes
\nFor OIDC providers:
\nclient_id
\nclient_secret
\nattributes_request_method
\noidc_issuer
\nauthorize_scopes
\nauthorize_url if not available from discovery URL specified by oidc_issuer key\n
\ntoken_url if not available from discovery URL specified by oidc_issuer key\n
\nattributes_url if not available from discovery URL specified by oidc_issuer key\n
\njwks_uri if not available from discovery URL specified by oidc_issuer key\n
\nattributes_url_add_attributes a read-only property that is set automatically\n
\nFor SAML providers:
\nMetadataFile or MetadataURL
\nIDPSignOut optional\n
\nThe IdP details. The following list describes the provider detail keys for each IdP\n type.
\nFor Google and Login with Amazon:
\nclient_id
\nclient_secret
\nauthorize_scopes
\nFor Facebook:
\nclient_id
\nclient_secret
\nauthorize_scopes
\napi_version
\nFor Sign in with Apple:
\nclient_id
\nteam_id
\nkey_id
\nprivate_key
\n\n You can submit a private_key when you add or update an IdP.\n Describe operations don't return the private key.\n
\nauthorize_scopes
\nFor OIDC providers:
\nclient_id
\nclient_secret
\nattributes_request_method
\noidc_issuer
\nauthorize_scopes
\nThe following keys are only present if Amazon Cognito didn't discover them at\n the oidc_issuer
URL.
authorize_url
\ntoken_url
\nattributes_url
\njwks_uri
\nAmazon Cognito sets the value of the following keys automatically. They are\n read-only.
\nattributes_url_add_attributes
\nFor SAML providers:
\nMetadataFile or MetadataURL
\nIDPSignout optional\n
\nA mapping of identity provider attributes to standard and custom user pool attributes.
" + "smithy.api#documentation": "A mapping of IdP attributes to standard and custom user pool attributes.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { - "smithy.api#documentation": "A list of identity provider identifiers.
" + "smithy.api#documentation": "A list of IdP identifiers.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "The date the identity provider was last modified.
" + "smithy.api#documentation": "The date the IdP was last modified.
" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { - "smithy.api#documentation": "The date the identity provider was created.
" + "smithy.api#documentation": "The date the IdP was created.
" } } }, "traits": { - "smithy.api#documentation": "A container for information about an identity provider.
" + "smithy.api#documentation": "A container for information about an IdP.
" } }, "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType": { @@ -7473,7 +7518,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Initiates the authentication flow.
\n\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nInitiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth
. For more information, see Adding user pool sign-in through a third party.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe authentication flow for this call to run. The API action will depend on this value. For example:
\n\n REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new tokens.
\n USER_SRP_AUTH
takes in USERNAME
and SRP_A
and returns the SRP variables to be used for next challenge execution.
\n USER_PASSWORD_AUTH
takes in USERNAME
and PASSWORD
and returns the next challenge or tokens.
Valid values include:
\n \n\n USER_SRP_AUTH
: Authentication flow for the Secure Remote Password (SRP) protocol.
\n REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
\n CUSTOM_AUTH
: Custom authentication flow.
\n USER_PASSWORD_AUTH
: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration \n Lambda if it doesn't find the USERNAME in the user pool.
\n ADMIN_NO_SRP_AUTH
isn't a valid value.
The authentication flow for this call to run. The API action will depend on this\n value. For example:
\n\n REFRESH_TOKEN_AUTH
takes in a valid refresh token and returns new\n tokens.
\n USER_SRP_AUTH
takes in USERNAME
and\n SRP_A
and returns the SRP variables to be used for next\n challenge execution.
\n USER_PASSWORD_AUTH
takes in USERNAME
and\n PASSWORD
and returns the next challenge or tokens.
Valid values include:
\n\n USER_SRP_AUTH
: Authentication flow for the Secure Remote Password\n (SRP) protocol.
\n REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication\n flow for refreshing the access token and ID token by supplying a valid refresh\n token.
\n CUSTOM_AUTH
: Custom authentication flow.
\n USER_PASSWORD_AUTH
: Non-SRP authentication flow; user name and\n password are passed directly. If a user migration Lambda trigger is set, this\n flow will invoke the user migration Lambda if it doesn't find the user name in\n the user pool.
\n ADMIN_NO_SRP_AUTH
isn't a valid value.
The authentication parameters. These are inputs corresponding to the AuthFlow
that you're invoking. The required values depend on the value of AuthFlow
:
For USER_SRP_AUTH
: USERNAME
(required), SRP_A
(required), SECRET_HASH
(required if the app client is configured with a client secret), \n DEVICE_KEY
.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN
: REFRESH_TOKEN
(required), SECRET_HASH
(required if the app client is configured with a client secret), \n DEVICE_KEY
.
For CUSTOM_AUTH
: USERNAME
(required), SECRET_HASH
(if app client is configured with client secret), DEVICE_KEY
. To start the \n authentication flow with password verification, include ChallengeName: SRP_A
and SRP_A: (The SRP_A Value)
.
The authentication parameters. These are inputs corresponding to the\n AuthFlow
that you're invoking. The required values depend on the value\n of AuthFlow
:
For USER_SRP_AUTH
: USERNAME
(required),\n SRP_A
(required), SECRET_HASH
(required if the app\n client is configured with a client secret), DEVICE_KEY
.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN
: REFRESH_TOKEN
\n (required), SECRET_HASH
(required if the app client is configured\n with a client secret), DEVICE_KEY
.
For CUSTOM_AUTH
: USERNAME
(required),\n SECRET_HASH
(if app client is configured with client secret),\n DEVICE_KEY
. To start the authentication flow with password\n verification, include ChallengeName: SRP_A
and SRP_A: (The\n SRP_A Value)
.
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various \n triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nVerify auth challenge
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\n \nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for certain custom\n workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are\n specified for various triggers. The ClientMetadata value is passed as input to the\n functions for only the following triggers:
\nPre signup
\nPre authentication
\nUser migration
\nWhen Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which\n the function receives as input. This payload contains a validationData
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in\n your InitiateAuth request. In your function code in Lambda, you can process the\n validationData
value to enhance your workflow for your specific\n needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the\n following triggers, but it doesn't provide the ClientMetadata value as input:
\nPost authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nVerify auth challenge
\nFor more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth
calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for\n InitiateAuth
calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } } }, @@ -7529,25 +7574,25 @@ "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { - "smithy.api#documentation": "The name of the challenge that you're responding to with this call. This name is\n returned in the AdminInitiateAuth
response if you must pass another\n challenge.
Valid values include the following:
\nAll of the following challenges require USERNAME
and\n SECRET_HASH
(if applicable) in the parameters.
\n SMS_MFA
: Next challenge is to supply an\n SMS_MFA_CODE
, delivered via SMS.
\n PASSWORD_VERIFIER
: Next challenge is to supply\n PASSWORD_CLAIM_SIGNATURE
,\n PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after\n the client-side SRP calculations.
\n CUSTOM_CHALLENGE
: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued.
\n DEVICE_SRP_AUTH
: If device tracking was activated on your user\n pool and the previous challenges were passed, this challenge is returned so that\n Amazon Cognito can start tracking this device.
\n DEVICE_PASSWORD_VERIFIER
: Similar to\n PASSWORD_VERIFIER
, but for devices only.
\n NEW_PASSWORD_REQUIRED
: For users who are required to change their\n passwords after successful first login. This challenge should be passed with\n NEW_PASSWORD
and any other required attributes.
\n MFA_SETUP
: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from\n InitiateAuth
as an input to\n AssociateSoftwareToken
. Use the session returned by\n VerifySoftwareToken
as an input to\n RespondToAuthChallenge
with challenge name\n MFA_SETUP
to complete sign-in. To set up SMS MFA, an\n administrator should help the user to add a phone number to their account, and\n then the user should call InitiateAuth
again to restart\n sign-in.
The name of the challenge that you're responding to with this call. This name is\n returned in the AdminInitiateAuth
response if you must pass another\n challenge.
Valid values include the following:
\nAll of the following challenges require USERNAME
and\n SECRET_HASH
(if applicable) in the parameters.
\n SMS_MFA
: Next challenge is to supply an\n SMS_MFA_CODE
, delivered via SMS.
\n PASSWORD_VERIFIER
: Next challenge is to supply\n PASSWORD_CLAIM_SIGNATURE
,\n PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after\n the client-side SRP calculations.
\n CUSTOM_CHALLENGE
: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued.
\n DEVICE_SRP_AUTH
: If device tracking was activated on your user\n pool and the previous challenges were passed, this challenge is returned so that\n Amazon Cognito can start tracking this device.
\n DEVICE_PASSWORD_VERIFIER
: Similar to\n PASSWORD_VERIFIER
, but for devices only.
\n NEW_PASSWORD_REQUIRED
: For users who are required to change their\n passwords after successful first login.
Respond to this challenge with NEW_PASSWORD
and any required\n attributes that Amazon Cognito returned in the requiredAttributes
parameter.\n You can also set values for attributes that aren't required by your user pool\n and that your app client can write. For more information, see RespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in the requiredAttributes
parameter, \nthen use the UpdateUserAttributes
API operation to modify the value of any additional attributes.
\n MFA_SETUP
: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFA_CAN_SETUP
value.
To set up software token MFA, use the session returned here from\n InitiateAuth
as an input to\n AssociateSoftwareToken
. Use the session returned by\n VerifySoftwareToken
as an input to\n RespondToAuthChallenge
with challenge name\n MFA_SETUP
to complete sign-in. To set up SMS MFA, an\n administrator should help the user to add a phone number to their account, and\n then the user should call InitiateAuth
again to restart\n sign-in.
The session that should pass both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. This session \n should be passed as it is to the next RespondToAuthChallenge
API call.
The session that should pass both ways in challenge-response calls to the service. If\n the caller must pass another challenge, they return a session with other challenge\n parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The challenge parameters. These are returned in the InitiateAuth
response if you must pass another challenge. The responses in this parameter should be used to compute inputs to \n the next call (RespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if applicable).
The challenge parameters. These are returned in the InitiateAuth
response\n if you must pass another challenge. The responses in this parameter should be used to\n compute inputs to the next call (RespondToAuthChallenge
).
All challenges require USERNAME
and SECRET_HASH
(if\n applicable).
The result of the authentication response. This result is only returned if the caller doesn't need to pass another challenge. If the caller does need to pass another challenge before it gets \n tokens, ChallengeName
, ChallengeParameters
, and Session
are returned.
The result of the authentication response. This result is only returned if the caller\n doesn't need to pass another challenge. If the caller does need to pass another\n challenge before it gets tokens, ChallengeName
,\n ChallengeParameters
, and Session
are returned.
The message returned when you have an unverified email address or the identity policy isn't set on an email address that Amazon Cognito can access.
" + "smithy.api#documentation": "The message returned when you have an unverified email address or the identity policy\n isn't set on an email address that Amazon Cognito can access.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
", + "smithy.api#documentation": "This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP\n status code: 400.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7595,7 +7640,7 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when Amazon Cognito hrows an invalid Lambda response exception.
" + "smithy.api#documentation": "The message returned when Amazon Cognito throws an invalid Lambda response\n exception.
" } } }, @@ -7624,12 +7669,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when the Amazon Cognito service throws an invalid parameter exception.
" + "smithy.api#documentation": "The message returned when the Amazon Cognito service throws an invalid parameter\n exception.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
", + "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service encounters an invalid\n parameter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7656,12 +7701,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when the invalid SMS role access policy exception is thrown.
" + "smithy.api#documentation": "The message returned when the invalid SMS role access policy exception is\n thrown.
" } } }, "traits": { - "smithy.api#documentation": "This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
", + "smithy.api#documentation": "This exception is returned when the role provided for SMS configuration doesn't have\n permission to publish using Amazon SNS.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7672,12 +7717,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when the role trust relationship for the SMS message is not valid.
" + "smithy.api#documentation": "The message returned when the role trust relationship for the SMS message is not\n valid.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com
or the \n external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
This exception is thrown when the trust relationship is not valid for the role\n provided for SMS configuration. This can happen if you don't trust\n cognito-idp.amazonaws.com
or the external ID provided in the role does\n not match what is provided in the SMS configuration for the user pool.
The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to \n CustomEmailSender
and CustomSMSSender
.
The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito\n uses the key to encrypt codes and temporary passwords sent to\n CustomEmailSender
and CustomSMSSender
.
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
", + "smithy.api#documentation": "This exception is thrown when a user exceeds the limit for a requested Amazon Web Services\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7838,7 +7883,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the devices.
" + "smithy.api#documentation": "Lists the sign-in devices that Amazon Cognito has registered to the current user.
" } }, "com.amazonaws.cognitoidentityprovider#ListDevicesRequest": { @@ -7847,7 +7892,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access tokens for the request to list devices.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose list of devices you want to\n view.
", "smithy.api#required": {} } }, @@ -7942,7 +7987,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } } @@ -7959,7 +8004,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } } @@ -7990,7 +8035,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists information about all identity providers for a user pool.
", + "smithy.api#documentation": "Lists information about all IdPs for a user pool.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8012,7 +8057,7 @@ "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#ListProvidersLimitType", "traits": { - "smithy.api#documentation": "The maximum number of identity providers to return.
" + "smithy.api#documentation": "The maximum number of IdPs to return.
" } }, "NextToken": { @@ -8029,7 +8074,7 @@ "Providers": { "target": "com.amazonaws.cognitoidentityprovider#ProvidersListType", "traits": { - "smithy.api#documentation": "A list of identity provider objects.
", + "smithy.api#documentation": "A list of IdP objects.
", "smithy.api#required": {} } }, @@ -8169,7 +8214,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the tags that are assigned to an Amazon Cognito user pool.
\nA tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
\nYou can use this action up to 10 times per second, per account.
" + "smithy.api#documentation": "Lists the tags that are assigned to an Amazon Cognito user pool.
\nA tag is a label that you can apply to user pools to categorize and manage them in\n different ways, such as by purpose, owner, environment, or other criteria.
\nYou can use this action up to 10 times per second, per account.
" } }, "com.amazonaws.cognitoidentityprovider#ListTagsForResourceRequest": { @@ -8244,7 +8289,7 @@ "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to ListUserImportJobs
, which can be used to return the next set of import jobs in the list.
An identifier that was returned from the previous call to\n ListUserImportJobs
, which can be used to return the next set of import\n jobs in the list.
An identifier that can be used to return the next set of user import jobs in the list.
" + "smithy.api#documentation": "An identifier that can be used to return the next set of user import jobs in the\n list.
" } } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to list the user import jobs.
" + "smithy.api#documentation": "Represents the response from the server to the request to list the user import\n jobs.
" } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolClients": { @@ -8320,13 +8365,13 @@ "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimit", "traits": { - "smithy.api#documentation": "The maximum number of results you want the request to return when listing the user pool clients.
" + "smithy.api#documentation": "The maximum number of results you want the request to return when listing the user\n pool clients.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } }, @@ -8346,7 +8391,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } }, @@ -8392,13 +8437,13 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType", "traits": { - "smithy.api#documentation": "The maximum number of results you want the request to return when listing the user pools.
", + "smithy.api#documentation": "The maximum number of results you want the request to return when listing the user\n pools.
", "smithy.api#required": {} } } @@ -8419,7 +8464,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } }, @@ -8523,7 +8568,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } } @@ -8540,7 +8585,7 @@ "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that you can use in a later request to return the next set of items in\n the list.
" } } } @@ -8558,7 +8603,7 @@ "AttributesToGet": { "target": "com.amazonaws.cognitoidentityprovider#SearchedAttributeNamesListType", "traits": { - "smithy.api#documentation": "An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
" + "smithy.api#documentation": "An array of strings, where each string is the name of a user attribute to be returned\n for each user in the search results. If the array is null, all attributes are\n returned.
" } }, "Limit": { @@ -8570,13 +8615,13 @@ "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } }, "Filter": { "target": "com.amazonaws.cognitoidentityprovider#UserFilterType", "traits": { - "smithy.api#documentation": "A filter string of the form \"AttributeName \n Filter-Type \"AttributeValue\"\". Quotation \n marks within the filter string must be escaped using the backslash (\\) character. For example, \"family_name
= \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for example, \"given_name
= \\\"Jon\\\"\". For a prefix (\"starts with\") match, use ^=, for example, \n \"given_name
^= \\\"Jon\\\"\".
\n AttributeValue: The attribute value that must be matched for each user.
\nIf the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
\n\n username
(case-sensitive)
\n email
\n
\n phone_number
\n
\n name
\n
\n given_name
\n
\n family_name
\n
\n preferred_username
\n
\n cognito:user_status
(called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console) (case-sensitive)
\n
\n sub
\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches no more than 1 attribute. For an advanced search, \n use a client-side filter with the --query
parameter of the list-users
action in the CLI. When you use a \n client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero \n results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then \n review the combined result.\n
For more information about server-side and client-side filtering, \n see FilteringCLI output \n in the Command Line Interface User Guide.\n
\nFor more information, \n see Searching for Users \n Using the ListUsers API \n and Examples of Using \n the ListUsers API in the Amazon Cognito Developer Guide.
" + "smithy.api#documentation": "A filter string of the form \"AttributeName\n Filter-Type \"AttributeValue\"\". Quotation marks\n within the filter string must be escaped using the backslash (\\) character. For example,\n \"family_name
= \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for.\n You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for example,\n \"given_name
= \\\"Jon\\\"\". For a prefix (\"starts with\") match, use\n ^=, for example, \"given_name
^= \\\"Jon\\\"\".
\n AttributeValue: The attribute value that must be matched\n for each user.
\nIf the filter string is empty, ListUsers
returns all users in the user\n pool.
You can only search for the following standard attributes:
\n\n username
(case-sensitive)
\n email
\n
\n phone_number
\n
\n name
\n
\n given_name
\n
\n family_name
\n
\n preferred_username
\n
\n cognito:user_status
(called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console)\n (case-sensitive)
\n
\n sub
\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query
parameter of the list-users
action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.
\nFor more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.
" } } }, @@ -8596,7 +8641,7 @@ "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { - "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
" + "smithy.api#documentation": "An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.
" } } }, @@ -8625,12 +8670,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when Amazon Cognito throws an MFA method not found exception.
" + "smithy.api#documentation": "The message returned when Amazon Cognito throws an MFA method not found\n exception.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
", + "smithy.api#documentation": "This exception is thrown when Amazon Cognito can't find a multi-factor authentication\n (MFA) method.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8647,13 +8692,13 @@ "DeliveryMedium": { "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType", "traits": { - "smithy.api#documentation": "The delivery medium to send the MFA code. You can use this parameter to set only the SMS
delivery medium value.
The delivery medium to send the MFA code. You can use this parameter to set only the\n SMS
delivery medium value.
The attribute name of the MFA option type. The only valid value is phone_number
.
The attribute name of the MFA option type. The only valid value is\n phone_number
.
The message template for email messages. EmailMessage is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
" } }, "EmailSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "The subject line for email messages. EmailSubject is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
" } } }, @@ -8747,7 +8792,7 @@ "From": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The email address that is sending the email. The address must be either individually verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
" + "smithy.api#documentation": "The email address that is sending the email. The address must be either individually\n verified with Amazon Simple Email Service, or from a domain that has been verified with Amazon SES.
" } }, "ReplyTo": { @@ -8759,7 +8804,7 @@ "SourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. This identity permits Amazon Cognito to send for the email address specified in the \n From
parameter.
The Amazon Resource Name (ARN) of the identity that is associated with the sending\n authorization policy. This identity permits Amazon Cognito to send for the email address\n specified in the From
parameter.
The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.
" + "smithy.api#documentation": "The multi-factor authentication (MFA) email template used when MFA is challenged as\n part of a detected risk.
" } } }, @@ -8897,37 +8942,37 @@ "MinimumLength": { "target": "com.amazonaws.cognitoidentityprovider#PasswordPolicyMinLengthType", "traits": { - "smithy.api#documentation": "The minimum length of the password in the policy that you have set. This value can't be less than 6.
" + "smithy.api#documentation": "The minimum length of the password in the policy that you have set. This value can't\n be less than 6.
" } }, "RequireUppercase": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
" + "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to\n use at least one uppercase letter in their password.
" } }, "RequireLowercase": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
" + "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to\n use at least one lowercase letter in their password.
" } }, "RequireNumbers": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
" + "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to\n use at least one number in their password.
" } }, "RequireSymbols": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
" + "smithy.api#documentation": "In the password policy that you have set, refers to whether you have required users to\n use at least one symbol in their password.
" } }, "TemporaryPasswordValidityDays": { "target": "com.amazonaws.cognitoidentityprovider#TemporaryPasswordValidityDaysType", "traits": { - "smithy.api#documentation": "The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.
\nWhen you set TemporaryPasswordValidityDays
for a user pool, you can no longer set the deprecated UnusedAccountValidityDays
value for that user pool.
The number of days a temporary password is valid in the password policy. If the user\n doesn't sign in during this time, an administrator must reset their password.
\nWhen you set TemporaryPasswordValidityDays
for a user pool, you can\n no longer set a value for the legacy UnusedAccountValidityDays
\n parameter in that user pool.
The identity provider name.
" + "smithy.api#documentation": "The IdP name.
" } }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { - "smithy.api#documentation": "The identity provider type.
" + "smithy.api#documentation": "The IdP type.
" } }, "LastModifiedDate": { @@ -9058,7 +9103,7 @@ } }, "traits": { - "smithy.api#documentation": "A container for identity provider details.
" + "smithy.api#documentation": "A container for IdP details.
" } }, "com.amazonaws.cognitoidentityprovider#ProviderDetailsType": { @@ -9084,7 +9129,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 3, "max": 32 }, "smithy.api#pattern": "^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$" @@ -9108,12 +9153,12 @@ "ProviderAttributeValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The value of the provider attribute to link to, such as xxxxx_account
.
The value of the provider attribute to link to, such as\n xxxxx_account
.
A container for information about an identity provider for a user pool.
" + "smithy.api#documentation": "A container for information about an IdP for a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#ProvidersListType": { @@ -9184,7 +9229,7 @@ "Priority": { "target": "com.amazonaws.cognitoidentityprovider#PriorityType", "traits": { - "smithy.api#documentation": "A positive integer specifying priority of a method with 1 being the highest priority.
", + "smithy.api#documentation": "A positive integer specifying priority of a method with 1 being the highest\n priority.
", "smithy.api#required": {} } }, @@ -9282,7 +9327,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nResends the confirmation (for confirmation of registration) to a specific user in the\n user pool.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nA keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { - "smithy.api#documentation": "The username
attribute of the user to whom you want to resend a confirmation code.
The username
attribute of the user to whom you want to resend a\n confirmation code.
The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode
calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for\n ResendConfirmationCode
calls.
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is\n assigned to the custom message trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is\n assigned to the custom message trigger. When Amazon Cognito invokes this\n function, it passes a JSON payload, which the function receives as input. This payload\n contains a clientMetadata
attribute, which provides the data that you\n assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe code delivery details returned by the server in response to the request to resend the confirmation code.
" + "smithy.api#documentation": "The code delivery details returned by the server in response to the request to resend\n the confirmation code.
" } } }, "traits": { - "smithy.api#documentation": "The response from the server when Amazon Cognito makes the request to resend a confirmation code.
" + "smithy.api#documentation": "The response from the server when Amazon Cognito makes the request to resend a confirmation\n code.
" } }, "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException": { @@ -9352,12 +9397,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a resource not found exception.
" + "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a resource not found\n exception.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service can't find the requested resource.
", + "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service can't find the requested\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -9545,7 +9590,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Responds to the authentication challenge.
\n\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nResponds to the authentication challenge.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe session that should be passed both ways in challenge-response calls to the service. If InitiateAuth
or RespondToAuthChallenge
API call determines \n that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge
\n API call.
The session that should be passed both ways in challenge-response calls to the\n service. If InitiateAuth
or RespondToAuthChallenge
API call\n determines that the caller must pass another challenge, they return a session with other\n challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The challenge responses. These are inputs corresponding to the value of ChallengeName
, for example:
\n SECRET_HASH
(if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA
).
\n SMS_MFA
: SMS_MFA_CODE
, USERNAME
.
\n PASSWORD_VERIFIER
: PASSWORD_CLAIM_SIGNATURE
, PASSWORD_CLAIM_SECRET_BLOCK
, TIMESTAMP
, USERNAME
.
\n PASSWORD_VERIFIER
requires DEVICE_KEY
when signing in with a remembered device.
\n NEW_PASSWORD_REQUIRED
: NEW_PASSWORD
, any other required attributes, USERNAME
.
\n SOFTWARE_TOKEN_MFA
: USERNAME
and SOFTWARE_TOKEN_MFA_CODE
are required attributes.
\n DEVICE_SRP_AUTH
requires USERNAME
, DEVICE_KEY
, SRP_A
(and SECRET_HASH
).
\n DEVICE_PASSWORD_VERIFIER
requires everything that PASSWORD_VERIFIER
requires, plus DEVICE_KEY
.
\n MFA_SETUP
requires USERNAME
, plus you must use the session value returned by VerifySoftwareToken
in the Session
parameter.
The challenge responses. These are inputs corresponding to the value of\n ChallengeName
, for example:
\n SECRET_HASH
(if app client is configured with client secret) applies\n to all of the inputs that follow (including SOFTWARE_TOKEN_MFA
).
\n SMS_MFA
: SMS_MFA_CODE
, USERNAME
.
\n PASSWORD_VERIFIER
: PASSWORD_CLAIM_SIGNATURE
,\n PASSWORD_CLAIM_SECRET_BLOCK
, TIMESTAMP
,\n USERNAME
.
\n PASSWORD_VERIFIER
requires DEVICE_KEY
when you\n sign in with a remembered device.
\n NEW_PASSWORD_REQUIRED
: NEW_PASSWORD
,\n USERNAME
, SECRET_HASH
(if app client is configured\n with client secret). To set any required attributes that Amazon Cognito returned as\n requiredAttributes
in the InitiateAuth
response,\n add a userAttributes.attributename\n
parameter.\n This parameter can also set values for writable attributes that aren't required\n by your user pool.
In a NEW_PASSWORD_REQUIRED
challenge response, you can't modify a required attribute that already has a value. \nIn RespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in the requiredAttributes
parameter, \nthen use the UpdateUserAttributes
API operation to modify the value of any additional attributes.
\n SOFTWARE_TOKEN_MFA
: USERNAME
and\n SOFTWARE_TOKEN_MFA_CODE
are required attributes.
\n DEVICE_SRP_AUTH
requires USERNAME
,\n DEVICE_KEY
, SRP_A
(and\n SECRET_HASH
).
\n DEVICE_PASSWORD_VERIFIER
requires everything that\n PASSWORD_VERIFIER
requires, plus\n DEVICE_KEY
.
\n MFA_SETUP
requires USERNAME
, plus you must use the\n session value returned by VerifySoftwareToken
in the\n Session
parameter.
The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge
calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for\n RespondToAuthChallenge
calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito \n invokes any functions that are assigned to the following triggers: post authentication, pre token generation, \n define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito \n invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
\n attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in \n Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration \n doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool\n triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any\n functions that are assigned to the following triggers: post\n authentication, pre token generation,\n define auth challenge, create auth\n challenge, and verify auth challenge. When Amazon Cognito\n invokes any of these functions, it passes a JSON payload, which the function receives as\n input. This payload contains a clientMetadata
attribute, which provides the\n data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge\n request. In your function code in Lambda, you can process the\n clientMetadata
value to enhance your workflow for your specific\n needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe session that should be passed both ways in challenge-response calls to the service. If the caller must pass another challenge, they return a session with other challenge parameters. \n This session should be passed as it is to the next RespondToAuthChallenge
API call.
The session that should be passed both ways in challenge-response calls to the\n service. If the caller must pass another challenge, they return a session with other\n challenge parameters. This session should be passed as it is to the next\n RespondToAuthChallenge
API call.
The result returned by the server in response to the request to respond to the authentication challenge.
" + "smithy.api#documentation": "The result returned by the server in response to the request to respond to the\n authentication challenge.
" } } }, @@ -9662,7 +9707,7 @@ } ], "traits": { - "smithy.api#documentation": "Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can't use the revoked token to access Amazon Cognito authenticated APIs.
" + "smithy.api#documentation": "Revokes all of the access tokens generated by the specified refresh token. After the\n token is revoked, you can't use the revoked token to access Amazon Cognito authenticated\n APIs.
" } }, "com.amazonaws.cognitoidentityprovider#RevokeTokenRequest": { @@ -9685,7 +9730,7 @@ "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { - "smithy.api#documentation": "The secret for the client ID. This is required only if the client ID has a secret.
" + "smithy.api#documentation": "The secret for the client ID. This is required only if the client ID has a\n secret.
" } } } @@ -9712,13 +9757,13 @@ "CompromisedCredentialsRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsRiskConfigurationType", "traits": { - "smithy.api#documentation": "The compromised credentials risk configuration object, including the EventFilter
and the EventAction
.
The compromised credentials risk configuration object, including the\n EventFilter
and the EventAction
.
The account takeover risk configuration object, including the NotifyConfiguration
object and Actions
to take if there is an account takeover.
The account takeover risk configuration object, including the\n NotifyConfiguration
object and Actions
to take if there is\n an account takeover.
Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation, a compact representation of an IP address and its routing prefix.
" + "smithy.api#documentation": "Overrides the risk decision to always block the pre-authentication requests. The IP\n range is in CIDR notation, a compact representation of an IP address and its routing\n prefix.
" } }, "SkippedIPRangeList": { "target": "com.amazonaws.cognitoidentityprovider#SkippedIPRangeListType", "traits": { - "smithy.api#documentation": "Risk detection isn't performed on the IP addresses in this range list. The IP range is in CIDR notation.
" + "smithy.api#documentation": "Risk detection isn't performed on the IP addresses in this range list. The IP range is\n in CIDR notation.
" } } }, @@ -9822,7 +9867,7 @@ "Enabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is \n turned on and the device has been trusted.
" + "smithy.api#documentation": "Specifies whether SMS text message MFA is activated. If an MFA type is activated for a\n user, the user will be prompted for MFA during all sign-in attempts, unless device\n tracking is turned on and the device has been trusted.
" } }, "PreferredMfa": { @@ -9833,7 +9878,7 @@ } }, "traits": { - "smithy.api#documentation": "The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type \n is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you \n would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
" + "smithy.api#documentation": "The type used for enabling SMS multi-factor authentication (MFA) at the user level.\n Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts,\n unless device tracking is turned on and the device has been trusted. If you would like\n MFA to be applied selectively based on the assessed risk level of sign-in attempts,\n deactivate MFA for users and turn on Adaptive Authentication for the user pool.
" } }, "com.amazonaws.cognitoidentityprovider#SchemaAttributeType": { @@ -9855,21 +9900,21 @@ "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "You should use WriteAttributes \n in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute
.
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access \n token. For example, DeveloperOnlyAttribute
can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
You should use WriteAttributes in the user pool client to control how attributes can\n be mutated for new use cases instead of using\n DeveloperOnlyAttribute
.
Specifies whether the attribute type is developer only. This attribute can only be\n modified by an administrator. Users won't be able to modify this attribute using their\n access token. For example, DeveloperOnlyAttribute
can be modified using\n AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
\nFor any user pool attribute that is mapped to an identity provider attribute, you must set this parameter to true
. Amazon Cognito updates mapped attributes when users \n sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, \n see Specifying Identity Provider Attribute Mappings for \n Your User Pool.
Specifies whether the value of the attribute can be changed.
\nFor any user pool attribute that is mapped to an IdP attribute, you must set this\n parameter to true
. Amazon Cognito updates mapped attributes when users sign in to\n your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error\n when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User\n Pool.
Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
" + "smithy.api#documentation": "Specifies whether a user pool attribute is required. If the attribute is required and\n the user doesn't provide a value, registration or sign-in will fail.
" } }, "NumberAttributeConstraints": { @@ -10016,7 +10061,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures actions on detected risks. To delete the risk configuration for UserPoolId
or ClientId
, pass null values for all four configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns
keyAdvancedSecurityMode
.
Configures actions on detected risks. To delete the risk configuration for\n UserPoolId
or ClientId
, pass null values for all four\n configuration types.
To activate Amazon Cognito advanced security features, update the user pool to include the\n UserPoolAddOns
keyAdvancedSecurityMode
.
The app client ID. If ClientId
is null, then the risk configuration is mapped to userPoolId
. When the client ID is null, the same risk configuration is applied \n to all the clients in the userPool.
Otherwise, ClientId
is mapped to the client. When the client ID isn't null, the user pool configuration is overridden and the risk configuration for the client is used instead.
The app client ID. If ClientId
is null, then the risk configuration is\n mapped to userPoolId
. When the client ID is null, the same risk\n configuration is applied to all the clients in the userPool.
Otherwise, ClientId
is mapped to the client. When the client ID isn't\n null, the user pool configuration is overridden and the risk configuration for the\n client is used instead.
Sets the user interface (UI) customization information for a user pool's built-in app UI.
\nYou can specify app UI customization settings for a single client (with a specific clientId
) or for all clients (by setting the clientId
\n to ALL
). If you specify ALL
, the default configuration is used for every client that has no previously set UI customization. If you specify UI \n customization settings for a particular client, it will no longer return to the ALL
configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
\nSets the user interface (UI) customization information for a user pool's built-in app\n UI.
\nYou can specify app UI customization settings for a single client (with a specific\n clientId
) or for all clients (by setting the clientId
to\n ALL
). If you specify ALL
, the default configuration is\n used for every client that has no previously set UI customization. If you specify UI\n customization settings for a particular client, it will no longer return to the\n ALL
configuration.
To use this API, your user pool must have a domain associated with it. Otherwise,\n there is no place to host the app's pages, and the service will throw an\n error.
\nSet the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. \n Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. \n If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an \n MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and \n the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate \n MFA for users and turn on Adaptive Authentication for the user pool.
" + "smithy.api#documentation": "Set the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
" } }, "com.amazonaws.cognitoidentityprovider#SetUserMFAPreferenceRequest": { @@ -10191,7 +10236,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token for the user.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose MFA preference you want to\n set.
", "smithy.api#required": {} } } @@ -10261,7 +10306,7 @@ "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who\n have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor\n Authentication (MFA) to a user pool. Valid values include:
\n \n\n OFF
MFA won't be used for any users.
\n ON
MFA is required for all users to sign in.
\n OPTIONAL
MFA will be required only for individual users who have an MFA factor activated.
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who\n have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor\n Authentication (MFA) to a user pool. Valid values include:
\n\n OFF
MFA won't be used for any users.
\n ON
MFA is required for all users to sign in.
\n OPTIONAL
MFA will be required only for individual users who have\n an MFA factor activated.
The MFA configuration. Valid values include:
\n \n\n OFF
MFA won't be used for any users.
\n ON
MFA is required for all users to sign in.
\n OPTIONAL
MFA will be required only for individual users who have an MFA factor enabled.
The MFA configuration. Valid values include:
\n\n OFF
MFA won't be used for any users.
\n ON
MFA is required for all users to sign in.
\n OPTIONAL
MFA will be required only for individual users who have\n an MFA factor enabled.
\n This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. \n To configure either type of MFA, use SetUserMFAPreference instead.
", + "smithy.api#documentation": "\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
", "smithy.api#optionalAuth": {} } }, @@ -10332,14 +10377,14 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token for the set user settings request.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose user settings you want to\n configure.
", "smithy.api#required": {} } }, "MFAOptions": { "target": "com.amazonaws.cognitoidentityprovider#MFAOptionListType", "traits": { - "smithy.api#documentation": "You can use this parameter only to set an SMS configuration that uses SMS for delivery.
", + "smithy.api#documentation": "You can use this parameter only to set an SMS configuration that uses SMS for\n delivery.
", "smithy.api#required": {} } } @@ -10409,7 +10454,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Registers the user in the specified user pool and creates a user name, password, and user attributes.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nRegisters the user in the specified user pool and creates a user name, password, and\n user attributes.
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nA keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
" + "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message.
" } }, "Username": { @@ -10446,7 +10491,7 @@ "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { - "smithy.api#documentation": "An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the attribute name.
An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
The Amazon Pinpoint analytics metadata for collecting metrics for SignUp
calls.
The Amazon Pinpoint analytics metadata that contributes to your metrics for\n SignUp
calls.
Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito \n invokes any functions that are assigned to the following triggers: pre sign-up, custom message, \n and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function \n receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the \n ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata
\n value to enhance your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers.
\nYou create custom workflows by assigning Lambda functions to user pool triggers.\n When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the\n following triggers: pre sign-up, custom\n message, and post confirmation. When Amazon Cognito invokes\n any of these functions, it passes a JSON payload, which the function receives as input.\n This payload contains a clientMetadata
attribute, which provides the data\n that you assigned to the ClientMetadata parameter in your SignUp request. In your\n function code in Lambda, you can process the clientMetadata
value to enhance\n your workflow for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nA response from the server indicating that a user registration has been confirmed.
", + "smithy.api#documentation": "A response from the server indicating that a user registration has been\n confirmed.
", "smithy.api#required": {} } }, "CodeDeliveryDetails": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType", "traits": { - "smithy.api#documentation": "The code delivery details returned by the server response to the user registration request.
" + "smithy.api#documentation": "The code delivery details returned by the server response to the user registration\n request.
" } }, "UserSub": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The UUID of the authenticated user. This isn't the same as username
.
The UUID of the authenticated user. This isn't the same as\n username
.
The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are \n subject to a spending limit.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role\n in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS\n messages are subject to a spending limit.
", "smithy.api#required": {} } }, "ExternalId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "The external ID provides additional security for your IAM role. You can use an\n ExternalId
with the IAM role that you use with Amazon SNS to send SMS\n messages for your user pool. If you provide an ExternalId
, your Amazon Cognito user\n pool includes it in the request to assume your IAM role. You can configure the role\n trust policy to require that Amazon Cognito, and any principal, provide the\n ExternalID
. If you use the Amazon Cognito Management Console to create a role\n for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\n permissions and a trust policy that demonstrates use of the\n ExternalId
.
For more information about the ExternalId
of a role, \n see How to use an external ID when granting access to your Amazon Web Services resources to a \n third party\n
The external ID provides additional security for your IAM role. You can use an\n ExternalId
with the IAM role that you use with Amazon SNS to send SMS\n messages for your user pool. If you provide an ExternalId
, your Amazon Cognito user\n pool includes it in the request to assume your IAM role. You can configure the role\n trust policy to require that Amazon Cognito, and any principal, provide the\n ExternalID
. If you use the Amazon Cognito Management Console to create a role\n for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\n permissions and a trust policy that demonstrates use of the\n ExternalId
.
For more information about the ExternalId
of a role, see How to use an\n external ID when granting access to your Amazon Web Services resources to a third\n party\n
The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. \n If the message isn't included, and default message will be used.
" + "smithy.api#documentation": "The SMS authentication message that will be sent to users with the code they must sign\n in. The message must contain the ‘{####}’ placeholder, which is replaced with the code.\n If the message isn't included, and default message will be used.
" } }, "SmsConfiguration": { @@ -10583,7 +10628,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
", + "smithy.api#documentation": "This exception is thrown when the software token time-based one-time password (TOTP)\n multi-factor authentication (MFA) isn't activated for the user pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10618,7 +10663,7 @@ "Enabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned \n on and the device has been trusted.
" + "smithy.api#documentation": "Specifies whether software token MFA is activated. If an MFA type is activated for a\n user, the user will be prompted for MFA during all sign-in attempts, unless device\n tracking is turned on and the device has been trusted.
" } }, "PreferredMfa": { @@ -10629,7 +10674,7 @@ } }, "traits": { - "smithy.api#documentation": "The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking \n is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive \n Authentication for the user pool.
" + "smithy.api#documentation": "The type used for enabling software token MFA at the user level. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts,\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
" } }, "com.amazonaws.cognitoidentityprovider#StartUserImportJob": { @@ -10697,7 +10742,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to start the user import job.
" + "smithy.api#documentation": "Represents the response from the server to the request to start the user import\n job.
" } }, "com.amazonaws.cognitoidentityprovider#StatusType": { @@ -10753,7 +10798,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported\n into.
", + "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
", "smithy.api#required": {} } }, @@ -10780,7 +10825,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to stop the user import job.
" + "smithy.api#documentation": "Represents the response from the server to the request to stop the user import\n job.
" } }, "com.amazonaws.cognitoidentityprovider#StringAttributeConstraintsType": { @@ -10847,7 +10892,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
\nEach tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, \n one for testing and another for production, you might assign an Environment
tag key to both user pools. The value of this key might be Test
for \n one user pool, and Production
for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with \n your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
\nYou can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
" + "smithy.api#documentation": "Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to\n categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.
\nEach tag consists of a key and value, both of which you define. A key is a general\n category for more specific values. For example, if you have two versions of a user pool,\n one for testing and another for production, you might assign an Environment
\n tag key to both user pools. The value of this key might be Test
for one\n user pool, and Production
for the other.
Tags are useful for cost tracking and access control. You can activate your tags so\n that they appear on the Billing and Cost Management console, where you can track the\n costs associated with your user pools. In an Identity and Access Management policy, you can constrain\n permissions for user pools based on specific tags or tag values.
\nYou can use this action up to 5 times per second, per account. A user pool can have as\n many as 50 tags.
" } }, "com.amazonaws.cognitoidentityprovider#TagResourceRequest": { @@ -10927,24 +10972,24 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in AccessTokenValidity, defaulting to hours.
" + "smithy.api#documentation": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in\n AccessTokenValidity, defaulting to hours.
" } }, "IdToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in IdTokenValidity, defaulting to hours.
" + "smithy.api#documentation": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in\n IdTokenValidity, defaulting to hours.
" } }, "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in RefreshTokenValidity, defaulting to days.
" + "smithy.api#documentation": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in\n RefreshTokenValidity, defaulting to days.
" } } }, "traits": { - "smithy.api#documentation": "The data type for TokenValidityUnits that specifics the time measurements for token validity.
" + "smithy.api#documentation": "The data type TokenValidityUnits specifies the time units you use when you set the\n duration of ID, access, and refresh tokens.
" } }, "com.amazonaws.cognitoidentityprovider#TooManyFailedAttemptsException": { @@ -10953,12 +10998,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when Amazon Cognito returns a TooManyFailedAttempts
exception.
The message returned when Amazon Cognito returns a TooManyFailedAttempts
\n exception.
This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
", + "smithy.api#documentation": "This exception is thrown when the user has made too many failed attempts for a given\n action, such as sign-in.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10969,12 +11014,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a too many requests exception.
" + "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a too many requests\n exception.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the user has made too many requests for a given operation.
", + "smithy.api#documentation": "This exception is thrown when the user has made too many requests for a given\n operation.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -11026,7 +11071,7 @@ } }, "traits": { - "smithy.api#documentation": "A container for the UI customization information for a user pool's built-in app UI.
" + "smithy.api#documentation": "A container for the UI customization information for a user pool's built-in app\n UI.
" } }, "com.amazonaws.cognitoidentityprovider#UnauthorizedException": { @@ -11037,7 +11082,7 @@ } }, "traits": { - "smithy.api#documentation": "Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.
", + "smithy.api#documentation": "Exception that is thrown when the request isn't authorized. This can happen due to an\n invalid access token in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -11053,7 +11098,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
", + "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an unexpected exception with\n Lambda.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11079,7 +11124,7 @@ } }, "traits": { - "smithy.api#documentation": "Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.
", + "smithy.api#documentation": "Exception that is thrown when you attempt to perform an operation that isn't enabled\n for the user pool client.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11139,7 +11184,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account.
" + "smithy.api#documentation": "Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5\n times per second, per account.
" } }, "com.amazonaws.cognitoidentityprovider#UntagResourceRequest": { @@ -11197,7 +11242,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part \n of Amazon Cognito advanced security.
" + "smithy.api#documentation": "Provides the feedback for an authentication event, whether it was from a valid user or\n not. This feedback is used for improving the risk evaluation decision for the user pool\n as part of Amazon Cognito advanced security.
" } }, "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedbackRequest": { @@ -11291,7 +11336,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose device status you want to\n update.
", "smithy.api#required": {} } }, @@ -11375,13 +11420,13 @@ "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { - "smithy.api#documentation": "The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles
and cognito:preferred_role
claims in the token.
The new role Amazon Resource Name (ARN) for the group. This is used for setting the\n cognito:roles
and cognito:preferred_role
claims in the\n token.
The new precedence value for the group. For more information about this parameter, \n see CreateGroup.
" + "smithy.api#documentation": "The new precedence value for the group. For more information about this parameter, see\n CreateGroup.
" } } } @@ -11426,7 +11471,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates identity provider information for a user pool.
" + "smithy.api#documentation": "Updates IdP information for a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#UpdateIdentityProviderRequest": { @@ -11442,26 +11487,26 @@ "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { - "smithy.api#documentation": "The identity provider name.
", + "smithy.api#documentation": "The IdP name.
", "smithy.api#required": {} } }, "ProviderDetails": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { - "smithy.api#documentation": "The identity provider details to be updated, such as MetadataURL
and MetadataFile
.
The IdP details to be updated, such as MetadataURL
and\n MetadataFile
.
The identity provider attribute mapping to be changed.
" + "smithy.api#documentation": "The IdP attribute mapping to be changed.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { - "smithy.api#documentation": "A list of identity provider identifiers.
" + "smithy.api#documentation": "A list of IdP identifiers.
" } } } @@ -11472,7 +11517,7 @@ "IdentityProvider": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderType", "traits": { - "smithy.api#documentation": "The identity provider object.
", + "smithy.api#documentation": "The IdP object.
", "smithy.api#required": {} } } @@ -11504,7 +11549,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the name and scopes of resource server. All other fields are read-only.
\nIf you don't provide a value for an attribute, it is set to the default value.
\nUpdates the name and scopes of resource server. All other fields are read-only.
\nIf you don't provide a value for an attribute, it is set to the default\n value.
\nAn array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the attribute name.
An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom:
prefix to the\n attribute name.
If you have set an attribute to require verification before Amazon Cognito updates its value,\n this request doesn’t immediately update the value of that attribute. After your user\n receives and responds to a verification message to verify the new value, Amazon Cognito updates\n the attribute value. Your user can sign in and receive messages with the original \n attribute value until they verify the new value.
", "smithy.api#required": {} } }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token for the request to update user attributes.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose user attributes you want to\n update.
", "smithy.api#required": {} } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { - "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When\n you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned\n to the custom message trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your UpdateUserAttributes request. In your function code\n in Lambda, you can process the clientMetadata
value to enhance your workflow\n for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
\nStore the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool \n configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
\nA map of custom key-value pairs that you can provide as input for any custom workflows\n that this action initiates.
\nYou create custom workflows by assigning Lambda functions to user pool triggers. When\n you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned\n to the custom message trigger. When Amazon Cognito invokes this function, it\n passes a JSON payload, which the function receives as input. This payload contains a\n clientMetadata
attribute, which provides the data that you assigned to\n the ClientMetadata parameter in your UpdateUserAttributes request. In your function code\n in Lambda, you can process the clientMetadata
value to enhance your workflow\n for your specific needs.
For more information, see \nCustomizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
\n\nWhen you use the ClientMetadata parameter, remember that Amazon Cognito won't do the\n following:
\nStore the ClientMetadata value. This data is available only to Lambda\n triggers that are assigned to a user pool to support custom workflows. If\n your user pool configuration doesn't include triggers, the ClientMetadata\n parameter serves no purpose.
\nValidate the ClientMetadata value.
\nEncrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive\n information.
\nThe code delivery details list from the server for the request to update user attributes.
" + "smithy.api#documentation": "The code delivery details list from the server for the request to update user\n attributes.
" } } }, "traits": { - "smithy.api#documentation": "Represents the response from the server for the request to update user attributes.
" + "smithy.api#documentation": "Represents the response from the server for the request to update user\n attributes.
" } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPool": { @@ -11707,7 +11752,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using \n DescribeUserPool. \n If you don't provide a value for an attribute, it will be set to the default value.
\n\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user pool with the specified attributes. You can get a list of\n the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be\n set to the default value.\n
\n \nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using \n DescribeUserPoolClient.
\nIf you don't provide a value for an attribute, it will be set to the default value.
\nYou can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, \n see RevokeToken.
" + "smithy.api#documentation": "Updates the specified user pool app client with the specified attributes. You can get\n a list of the current user pool app client settings using DescribeUserPoolClient.
\nIf you don't provide a value for an attribute, it will be set to the default\n value.
\nYou can also use this operation to enable token revocation for user pool clients. For\n more information about revoking tokens, see RevokeToken.
" } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClientRequest": { @@ -11754,7 +11799,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool where you want to update the user pool client.
", + "smithy.api#documentation": "The user pool ID for the user pool where you want to update the user pool\n client.
", "smithy.api#required": {} } }, @@ -11774,25 +11819,25 @@ "RefreshTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { - "smithy.api#documentation": "The time limit, in days, after which the refresh token is no longer valid and can't be used.
" + "smithy.api#documentation": "The refresh token time limit. After this limit expires, your user can't use \n their refresh token. To specify the time unit for RefreshTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and\n TokenValidityUnits
as days
, your user can refresh their session\n and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. \n You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the \n value with the default value of 30 days. Valid range is displayed below \n in seconds.
The time limit after which the access token is no longer valid and can't be used.
" + "smithy.api#documentation": "The access token time limit. After this limit expires, your user can't use \n their access token. To specify the time unit for AccessTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and\n TokenValidityUnits
to hours
, your user can authorize access with\n their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. \n Valid range is displayed below in seconds.
The time limit after which the ID token is no longer valid and can't be used.
" + "smithy.api#documentation": "The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and\n TokenValidityUnits
as hours
, your user can authenticate their \n session with their ID token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. \n Valid range is displayed below in seconds.
The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens is hours.
" + "smithy.api#documentation": "The units in which the validity times are represented. The default unit for\n RefreshToken is days, and the default for ID and access tokens is hours.
" } }, "ReadAttributes": { @@ -11810,67 +11855,67 @@ "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the \n ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values with the ALLOW_
prefix.
Valid values include:
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces the \n ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to \n verify passwords.
\n ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.
\n ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP \n protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.
The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_
prefix are no longer supported in favor of new names\n with the ALLOW_
prefix. Note that values with ALLOW_
prefix\n must be used only along with values with the ALLOW_
prefix.
Valid values include:
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces\n the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito\n receives the password in the request instead of using the Secure Remote Password\n (SRP) protocol to verify passwords.
\n ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH
: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh\n tokens.
A list of provider names for the identity providers that are supported on this client.
" + "smithy.api#documentation": "A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO
, Facebook
, Google
\n LoginWithAmazon
, and the names of your own SAML and OIDC providers.
A list of allowed redirect (callback) URLs for the identity providers.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a \n fragment component.
\nSee OAuth 2.0 - Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
\nApp callback URLs such as myapp://example
are also supported.
A list of allowed redirect (callback) URLs for the IdPs.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example
are also supported.
A list of allowed logout URLs for the identity providers.
" + "smithy.api#documentation": "A list of allowed logout URLs for the IdPs.
" } }, "DefaultRedirectURI": { "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a \n fragment component.
\nSee OAuth 2.0 - Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost
for testing purposes only.
App callback URLs such as myapp://example
are also supported.
The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost
for testing\n purposes only.
App callback URLs such as myapp://example
are also supported.
The allowed OAuth flows.
\nSet to code
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination \n of client and client_secret.
The allowed OAuth flows.
\nUse a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token
endpoint.
Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.
\nIssue the access token from the /oauth2/token
endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The allowed OAuth scopes. Possible values provided by OAuth are: phone
, \n email
, openid
, and profile
. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin
. Custom scopes created \n in Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are phone
,\n email
, openid
, and profile
. Possible values\n provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom scopes created\n in Resource Servers are also supported.
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
" + "smithy.api#documentation": "Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Amazon Cognito user pools.
" } }, "AnalyticsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint\n projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support\n sending events to Amazon Pinpoint projects within that same Region.
\nThe Amazon Pinpoint analytics configuration necessary to collect metrics for this user\n pool.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user\n pools support sending events to Amazon Pinpoint projects within that same Region.
\nErrors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the \n user pool. When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. \n Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs \n return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
\n\n ENABLED
- This prevents user existence-related errors.
\n LEGACY
- This represents the early \n behavior of Amazon Cognito where user existence related errors aren't prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account\n confirmation, and password recovery when the user doesn't exist in the user pool. When\n set to ENABLED
and the user doesn't exist, authentication returns an error\n indicating either the username or password was incorrect. Account confirmation and\n password recovery return a response indicating a code was sent to a simulated\n destination. When set to LEGACY
, those APIs return a\n UserNotFoundException
exception if the user doesn't exist in the user\n pool.
Valid values include:
\n\n ENABLED
- This prevents user existence-related errors.
\n LEGACY
- This represents the early behavior of Amazon Cognito where user\n existence related errors aren't prevented.
Activates or deactivates token revocation. For more information about revoking tokens, \n see RevokeToken.
" + "smithy.api#documentation": "Activates or deactivates token revocation. For more information about revoking tokens,\n see RevokeToken.
" } } }, @@ -11884,12 +11929,12 @@ "UserPoolClient": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientType", "traits": { - "smithy.api#documentation": "The user pool client value from the response from the server when you request to update the user pool client.
" + "smithy.api#documentation": "The user pool client value from the response from the server when you request to\n update the user pool client.
" } } }, "traits": { - "smithy.api#documentation": "Represents the response from the server to the request to update the user pool client.
" + "smithy.api#documentation": "Represents the response from the server to the request to update the user pool\n client.
" } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomain": { @@ -11918,7 +11963,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
\nYou can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
\nA custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you \n manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
\nUsually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, \n and your custom domain uses the new certificate automatically.
\nHowever, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide \n this ARN to Amazon Cognito.
\nWhen you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
\nAfter you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
\nFor more information about adding a custom domain to your user pool, \n see Using Your Own Domain for the Hosted UI.
" + "smithy.api#documentation": "Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user\n pool.
\nYou can use this operation to provide the Amazon Resource Name (ARN) of a new\n certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
\nA custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and\n sign-in pages for your application. When you set up a custom domain, you provide a\n certificate that you manage with Certificate Manager (ACM). When necessary, you can use this\n operation to change the certificate that you applied to your custom domain.
\nUsually, this is unnecessary following routine certificate renewal with ACM. When\n you renew your existing certificate in ACM, the ARN for your certificate remains the\n same, and your custom domain uses the new certificate automatically.
\nHowever, if you replace your existing certificate with a new one, ACM gives the new\n certificate a new ARN. To apply the new certificate to your custom domain, you must\n provide this ARN to Amazon Cognito.
\nWhen you add your new certificate in ACM, you must choose US East (N. Virginia) as\n the Amazon Web Services Region.
\nAfter you submit your request, Amazon Cognito requires up to 1 hour to distribute your new\n certificate to your custom domain.
\nFor more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
" } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainRequest": { @@ -11927,21 +11972,21 @@ "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com
.
This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
", + "smithy.api#documentation": "The domain name for the custom domain that hosts the sign-up and sign-in pages for\n your application. One example might be auth.example.com
.
This string can include only lowercase letters, numbers, and hyphens. Don't use a\n hyphen for the first or last character. Use periods to separate subdomain names.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The ID of the user pool that is associated with the custom domain whose certificate you're updating.
", + "smithy.api#documentation": "The ID of the user pool that is associated with the custom domain whose certificate\n you're updating.
", "smithy.api#required": {} } }, "CustomDomainConfig": { "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { - "smithy.api#documentation": "The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
", + "smithy.api#documentation": "The configuration for a custom domain that hosts the sign-up and sign-in pages for\n your application. Use this object to specify an SSL certificate that is managed by\n ACM.
", "smithy.api#required": {} } } @@ -11956,7 +12001,7 @@ "CloudFrontDomain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { - "smithy.api#documentation": "The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
" + "smithy.api#documentation": "The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user\n pool.
" } } }, @@ -11989,7 +12034,7 @@ "AutoVerifiedAttributes": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { - "smithy.api#documentation": "The attributes that are automatically verified when Amazon Cognito requests to update user pools.
" + "smithy.api#documentation": "The attributes that are automatically verified when Amazon Cognito requests to update user\n pools.
" } }, "SmsVerificationMessage": { @@ -12022,10 +12067,16 @@ "smithy.api#documentation": "The contents of the SMS authentication message.
" } }, + "UserAttributeUpdateSettings": { + "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", + "traits": { + "smithy.api#documentation": "" + } + }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "Can be one of the following values:
\n \n \n OFF
- MFA tokens aren't required and can't be specified during user registration.
\n ON
- MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can \n use the SetUserPoolMfaConfig API operation \n to turn MFA \"ON\" for existing user pools.
\n OPTIONAL
- Users have the option when registering to create an MFA token.
Possible values include:
\n\n OFF
- MFA tokens aren't required and can't be specified during user\n registration.
\n ON
- MFA tokens are required for all user registrations. You can\n only specify ON when you're initially creating a user pool. You can use the\n SetUserPoolMfaConfig API operation to turn MFA \"ON\" for existing\n user pools.
\n OPTIONAL
- Users have the option when registering to create an MFA\n token.
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, \n or other criteria.
" + "smithy.api#documentation": "The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.
" } }, "AdminCreateUserConfig": { @@ -12061,13 +12112,13 @@ "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { - "smithy.api#documentation": "Enables advanced security risk detection. Set the key AdvancedSecurityMode
to the value \"AUDIT\".
Enables advanced security risk detection. Set the key\n AdvancedSecurityMode
to the value \"AUDIT\".
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a \n preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user \n also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method \n where SMS is preferred through email.
The available verified method a user can use to recover their password when they call\n ForgotPassword
. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.
Represents the response from the server when you make a request to update the user pool.
" + "smithy.api#documentation": "Represents the response from the server when you make a request to update the user\n pool.
" + } + }, + "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType": { + "type": "structure", + "members": { + "AttributesRequireVerificationBeforeUpdate": { + "target": "com.amazonaws.cognitoidentityprovider#AttributesRequireVerificationBeforeUpdateType", + "traits": { + "smithy.api#documentation": "Requires that your user verifies their email address, phone number, or both before \n Amazon Cognito updates the value of that attribute. When you update a user attribute that has \n this option activated, Amazon Cognito sends a verification message to the new phone number or \n email address. Amazon Cognito doesn’t change the value of the attribute until your user responds \n to the verification message and confirms the new value.
\nYou can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified
or\n phone_number_verified
to true.
When AttributesRequireVerificationBeforeUpdate
is false, your user pool\n doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a\n user pool where AttributesRequireVerificationBeforeUpdate
is false, API\n operations that change attribute values can immediately update a user’s\n email
or phone_number
attribute.
The settings for updates to user attributes.
" } }, "com.amazonaws.cognitoidentityprovider#UserContextDataType": { @@ -12088,12 +12153,12 @@ "EncodedData": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" } } }, "traits": { - "smithy.api#documentation": "Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Information that your app generates about a user's AdminInitiateAuth
or\n AdminRespondToAuthChallenge
session. Amazon Cognito advanced security features\n calculate risk levels for user sessions based on this context data.
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
", + "smithy.api#documentation": "This exception is thrown when you're trying to modify a user pool while a user import\n job is in progress for that pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12198,7 +12263,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported\n into.
" + "smithy.api#documentation": "The user pool ID for the user pool that the users are being imported into.
" } }, "PreSignedUrl": { @@ -12228,13 +12293,13 @@ "Status": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobStatusType", "traits": { - "smithy.api#documentation": "The status of the user import job. One of the following:
\n \n\n Created
- The job was created but not started.
\n Pending
- A transition state. You have started the job, but it has not begun importing users yet.
\n InProgress
- The job has started, and users are being imported.
\n Stopping
- You have stopped the job, but the job has not stopped importing users yet.
\n Stopped
- You have stopped the job, and the job has stopped importing users.
\n Succeeded
- The job has completed successfully.
\n Failed
- The job has stopped due to an error.
\n Expired
- You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
The status of the user import job. One of the following:
\n\n Created
- The job was created but not started.
\n Pending
- A transition state. You have started the job, but it\n has not begun importing users yet.
\n InProgress
- The job has started, and users are being\n imported.
\n Stopping
- You have stopped the job, but the job has not stopped\n importing users yet.
\n Stopped
- You have stopped the job, and the job has stopped\n importing users.
\n Succeeded
- The job has completed successfully.
\n Failed
- The job has stopped due to an error.
\n Expired
- You created a job, but did not start the job within\n 24-48 hours. All data associated with the job was deleted, and the job can't be\n started.
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer Guide.
" + "smithy.api#documentation": "The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import\n job. For more information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer\n Guide.
" } }, "ImportedUsers": { @@ -12284,12 +12349,12 @@ "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { - "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a user validation exception with the Lambda service.
" + "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a user validation exception with\n the Lambda service.
" } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
", + "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service encounters a user validation exception\n with the Lambda service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12372,7 +12437,7 @@ "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { - "smithy.api#documentation": "The user pool ID for the user pool where you want to describe the user pool client.
" + "smithy.api#documentation": "The user pool ID for the user pool where you want to describe the user pool\n client.
" } }, "ClientName": { @@ -12434,25 +12499,25 @@ "RefreshTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { - "smithy.api#documentation": "The time limit, in days, after which the refresh token is no longer valid and can't be used.
" + "smithy.api#documentation": "The refresh token time limit. After this limit expires, your user can't use \n their refresh token. To specify the time unit for RefreshTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and\n TokenValidityUnits
as days
, your user can refresh their session\n and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. \n You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the \n value with the default value of 30 days. Valid range is displayed below \n in seconds.
The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and can't be used.
" + "smithy.api#documentation": "The access token time limit. After this limit expires, your user can't use \n their access token. To specify the time unit for AccessTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and\n TokenValidityUnits
to hours
, your user can authorize access with\n their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. \n Valid range is displayed below in seconds.
The time limit specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and can't be used.
" + "smithy.api#documentation": "The ID token time limit. After this limit expires, your user can't use \n their ID token. To specify the time unit for IdTokenValidity
as \n seconds
, minutes
, hours
, or days
, \n set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and\n TokenValidityUnits
as hours
, your user can authenticate their \n session with their ID token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. \n Valid range is displayed below in seconds.
The time units used to specify the token validity times of their respective token.
" + "smithy.api#documentation": "The time units used to specify the token validity times of each token type: ID,\n access, and refresh.
" } }, "ReadAttributes": { @@ -12470,68 +12535,68 @@ "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { - "smithy.api#documentation": "The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the \n ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values including the ALLOW_
prefix.
Valid values include:
\n \n\n ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces the \n ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to \n verify passwords.
\n ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.
\n ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP \n protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.
The authentication flows that are supported by the user pool clients. Flow names\n without the ALLOW_
prefix are no longer supported in favor of new names\n with the ALLOW_
prefix. Note that values with ALLOW_
prefix\n must be used only along with values including the ALLOW_
prefix.
Valid values include:
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH
. This setting replaces\n the ADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito\n receives the password in the request instead of using the Secure Remote Password\n (SRP) protocol to verify passwords.
\n ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH
: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh\n tokens.
A list of provider names for the identity providers that are supported on this client.
" + "smithy.api#documentation": "A list of provider names for the IdPs that this client supports. The following are\n supported: COGNITO
, Facebook
, Google
\n LoginWithAmazon
, and the names of your own SAML and OIDC providers.
A list of allowed redirect (callback) URLs for the identity providers.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a \n fragment component.
\nSee OAuth 2.0 - Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "A list of allowed redirect (callback) URLs for the IdPs.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" } }, "LogoutURLs": { "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { - "smithy.api#documentation": "A list of allowed logout URLs for the identity providers.
" + "smithy.api#documentation": "A list of allowed logout URLs for the IdPs.
" } }, "DefaultRedirectURI": { "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { - "smithy.api#documentation": "The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a \n fragment component.
\nSee OAuth 2.0 - Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
\nApp callback URLs such as myapp://example are also supported.
" + "smithy.api#documentation": "The default redirect URI. Must be in the CallbackURLs
list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
" } }, "AllowedOAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", "traits": { - "smithy.api#documentation": "The allowed OAuth flows.
\nSet to code
to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination \n of client and client_secret.
The allowed OAuth flows.
\nUse a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token
endpoint.
Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.
\nIssue the access token from the /oauth2/token
endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The allowed OAuth scopes. Possible values provided by OAuth are: \n phone
, email
, openid
, and profile
. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin
. \n Custom scopes created in Resource Servers are also supported.
The OAuth scopes that your app client supports. Possible values that OAuth provides\n are phone
, email
, openid
, and\n profile
. Possible values that Amazon Web Services provides are\n aws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that\n you create in Resource Servers.
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
" + "smithy.api#documentation": "Set to true if the client is allowed to follow the OAuth protocol when interacting\n with Amazon Cognito user pools.
" } }, "AnalyticsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType", "traits": { - "smithy.api#documentation": "The Amazon Pinpoint analytics configuration for the user pool client.
\nAmazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N.\n Virginia) us-east-1 Region, regardless of the Region where the user pool\n resides.
\nThe Amazon Pinpoint analytics configuration for the user pool client.
\nAmazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East\n (N. Virginia) us-east-1 Region, regardless of the Region where the user pool\n resides.
\nErrors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist \n in the user pool. When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password \n was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to \n LEGACY
, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
\n \n\n ENABLED
- This prevents user existence-related errors.
\n LEGACY
- This \n represents the old behavior of Cognito where user existence related errors aren't prevented.
Errors and responses that you want Amazon Cognito APIs to return during authentication, account\n confirmation, and password recovery when the user doesn't exist in the user pool. When\n set to ENABLED
and the user doesn't exist, authentication returns an error\n indicating either the username or password was incorrect. Account confirmation and\n password recovery return a response indicating a code was sent to a simulated\n destination. When set to LEGACY
, those APIs return a\n UserNotFoundException
exception if the user doesn't exist in the user\n pool.
Valid values include:
\n\n ENABLED
- This prevents user existence-related errors.
\n LEGACY
- This represents the old behavior of Amazon Cognito where user\n existence related errors aren't prevented.
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about \n revoking tokens, see RevokeToken.
" + "smithy.api#documentation": "Indicates whether token revocation is activated for the user pool client. When you\n create a new user pool client, token revocation is activated by default. For more\n information about revoking tokens, see RevokeToken.
" } } }, @@ -12736,7 +12801,7 @@ "UsernameAttributes": { "target": "com.amazonaws.cognitoidentityprovider#UsernameAttributesListType", "traits": { - "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when they sign up.
" + "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when\n they sign up.
" } }, "SmsVerificationMessage": { @@ -12769,10 +12834,16 @@ "smithy.api#documentation": "The contents of the SMS authentication message.
" } }, + "UserAttributeUpdateSettings": { + "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", + "traits": { + "smithy.api#documentation": "" + } + }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { - "smithy.api#documentation": "Can be one of the following values:
\n \n \n OFF
- MFA tokens aren't required and can't be specified during user registration.
\n ON
- MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.
\n OPTIONAL
- Users have the option when registering to create an MFA token.
Can be one of the following values:
\n\n OFF
- MFA tokens aren't required and can't be specified during user\n registration.
\n ON
- MFA tokens are required for all user registrations. You can\n only specify required when you're initially creating a user pool.
\n OPTIONAL
- Users have the option when registering to create an MFA\n token.
The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, \n or other criteria.
" + "smithy.api#documentation": "The tags that are assigned to the user pool. A tag is a label that you can apply to\n user pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.
" } }, "SmsConfigurationFailure": { @@ -12814,7 +12885,7 @@ "EmailConfigurationFailure": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "Deprecated. Review error codes from API requests with\n EventSource:cognito-idp.amazonaws.com
in CloudTrail for\n information about problems with user pool email configuration.
Deprecated. Review error codes from API requests with\n EventSource:cognito-idp.amazonaws.com
in CloudTrail for\n information about problems with user pool email configuration.
A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An \n example of a custom domain name might be auth.example.com
.
For more information about adding a custom domain to your user pool, \n see Using Your Own Domain for the Hosted UI.
" + "smithy.api#documentation": "A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use\n a custom domain to host the sign-up and sign-in pages for your application. An example\n of a custom domain name might be auth.example.com
.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
" } }, "AdminCreateUserConfig": { @@ -12844,7 +12915,7 @@ "UsernameConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { - "smithy.api#documentation": "Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False
, users can sign in using either \"username\" \n or \"Username\". This configuration is immutable once it has been set. For more information, \n see UsernameConfigurationType.
Case sensitivity of the username input for the selected sign-in option. For example,\n when case sensitivity is set to False
, users can sign in using either\n \"username\" or \"Username\". This configuration is immutable once it has been set. For more\n information, see UsernameConfigurationType.
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a \n preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user \n also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method \n where SMS is preferred through email.
The available verified method a user can use to recover their password when they call\n ForgotPassword
. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.
The user status. This can be one of the following:
\n \nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nARCHIVED - User is no longer active.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a \n new value before doing anything else.
\nThe user status. This can be one of the following:
\nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nEXTERNAL_PROVIDER - User signed in with a third-party IdP.
\nARCHIVED - User is no longer active.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset\n their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a\n temporary password, but on first sign-in, the user must change their password to\n a new value before doing anything else.
\nThe user type.
" + "smithy.api#documentation": "A user profile in a Amazon Cognito user pool.
" } }, "com.amazonaws.cognitoidentityprovider#UsernameAttributeType": { @@ -12976,7 +13047,7 @@ "CaseSensitive": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { - "smithy.api#documentation": "Specifies whether username case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs.
\nValid values include:
\nEnables case sensitivity for all username input. When this option is set\n to True
, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this\n option is set to False
, users can sign in using either\n \"username\" or \"Username\". This option also enables both\n preferred_username
and email
alias to be case\n insensitive, in addition to the username
attribute.
Specifies whether user name case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs.
\nValid values include:
\nEnables case sensitivity for all username input. When this option is set\n to True
, users must sign in using the exact capitalization of\n their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this\n option is set to False
, users can sign in using either\n \"username\" or \"Username\". This option also enables both\n preferred_username
and email
alias to be case\n insensitive, in addition to the username
attribute.
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
", + "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters a user name that already\n exists in the user pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13024,31 +13095,31 @@ "SmsMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { - "smithy.api#documentation": "The SMS message template.
" + "smithy.api#documentation": "The template for SMS messages that Amazon Cognito sends to your users.
" } }, "EmailMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "The email message template. EmailMessage is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "The template for email messages that Amazon Cognito sends to your users. You can set an\n EmailMessage
template only if the value of EmailSendingAccount is DEVELOPER
. When your EmailSendingAccount is DEVELOPER
, your user pool sends email\n messages with your own Amazon SES configuration.
The subject line for the email message template. EmailSubject is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "The subject line for the email message template. You can set an\n EmailSubject
template only if the value of EmailSendingAccount is DEVELOPER
. When your EmailSendingAccount is DEVELOPER
, your user pool sends email\n messages with your own Amazon SES configuration.
The email message template for sending a confirmation link to the user. EmailMessageByLink is allowed only if \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "The email message template for sending a confirmation link to the user. You can set an\n EmailMessageByLink
template only if the value of EmailSendingAccount is DEVELOPER
. When your EmailSendingAccount is DEVELOPER
, your user pool sends email\n messages with your own Amazon SES configuration.
The subject line for the email message template for sending a confirmation link to the user. EmailSubjectByLink is allowed only \n EmailSendingAccount is DEVELOPER.
" + "smithy.api#documentation": "The subject line for the email message template for sending a confirmation link to the\n user. You can set an EmailSubjectByLink
template only if the value of\n EmailSendingAccount is DEVELOPER
. When your EmailSendingAccount is DEVELOPER
, your user pool sends email\n messages with your own Amazon SES configuration.
Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as \"verified\" if successful. The request takes an access \n token or a session string, but not both.
" + "smithy.api#documentation": "Use this API to register a user's entered time-based one-time password (TOTP) code and\n mark the user's software token MFA status as \"verified\" if successful. The request takes\n an access token or a session string, but not both.
" } }, "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenRequest": { @@ -13139,19 +13210,19 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token.
" + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose software token you want to\n verify.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the service.
" + "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the\n service.
" } }, "UserCode": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFAUserCodeType", "traits": { - "smithy.api#documentation": "The one- time password computed using the secret code returned by \n AssociateSoftwareToken.
", + "smithy.api#documentation": "The one- time password computed using the secret code returned by AssociateSoftwareToken.
", "smithy.api#required": {} } }, @@ -13175,7 +13246,7 @@ "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { - "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the service.
" + "smithy.api#documentation": "The session that should be passed both ways in challenge-response calls to the\n service.
" } } } @@ -13204,6 +13275,9 @@ "target": "com.amazonaws.cognitoidentityprovider#VerifyUserAttributeResponse" }, "errors": [ + { + "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" + }, { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, @@ -13240,7 +13314,7 @@ ], "traits": { "smithy.api#auth": [], - "smithy.api#documentation": "Verifies the specified user attributes in the user pool.
", + "smithy.api#documentation": "Verifies the specified user attributes in the user pool.
\n\n If your user pool requires verification before Amazon Cognito updates the attribute value, \n VerifyUserAttribute updates the affected attribute to its pending value. For more information, \n see \n UserAttributeUpdateSettingsType.\n
", "smithy.api#optionalAuth": {} } }, @@ -13250,7 +13324,7 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { - "smithy.api#documentation": "The access token of the request to verify user attributes.
", + "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose user attributes you want to\n verify.
", "smithy.api#required": {} } }, @@ -13277,7 +13351,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "A container representing the response from the server from the request to verify user attributes.
" + "smithy.api#documentation": "A container representing the response from the server from the request to verify user\n attributes.
" } }, "com.amazonaws.cognitoidentityprovider#WrappedBooleanType": { diff --git a/aws/sdk/aws-models/comprehend.json b/aws/sdk/aws-models/comprehend.json index a63ca42840d..84047f72b94 100644 --- a/aws/sdk/aws-models/comprehend.json +++ b/aws/sdk/aws-models/comprehend.json @@ -334,7 +334,7 @@ "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { - "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", + "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, @@ -728,7 +728,7 @@ "EndpointArn": { "target": "com.amazonaws.comprehend#DocumentClassifierEndpointArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint.
", + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see Managing endpoints.
", "smithy.api#required": {} } } @@ -1100,7 +1100,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The language of the input documents.
", + "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", "smithy.api#required": {} } } @@ -1289,7 +1289,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model
" + "smithy.api#documentation": "Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model \n For information about endpoints, see Managing endpoints.
" } }, "com.amazonaws.comprehend#CreateEndpointRequest": { @@ -1445,7 +1445,7 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.
" } }, "ModelKmsKeyId": { @@ -1488,6 +1488,9 @@ "target": "com.amazonaws.comprehend#CustomerInputString" }, "traits": { + "smithy.api#length": { + "min": 1 + }, "smithy.api#sensitive": {} } }, @@ -1565,7 +1568,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.
" + "smithy.api#documentation": "Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.\n For information about endpoints, see Managing endpoints.
" } }, "com.amazonaws.comprehend#DeleteEndpointRequest": { @@ -1847,7 +1850,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.
" + "smithy.api#documentation": "Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.\n For information about endpoints, see Managing endpoints.
" } }, "com.amazonaws.comprehend#DescribeEndpointRequest": { @@ -2423,7 +2426,7 @@ "EndpointArn": { "target": "com.amazonaws.comprehend#EntityRecognizerEndpointArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.
\nIf you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.
" + "smithy.api#documentation": "The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.
\nIf you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.
\nFor information about endpoints, see Managing endpoints.
" } } } @@ -2540,7 +2543,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The language of the input documents.
", + "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", "smithy.api#required": {} } } @@ -2811,7 +2814,7 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.
" } } }, @@ -2933,7 +2936,7 @@ } }, "traits": { - "smithy.api#documentation": "The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see how-document-classification-training-data.
" + "smithy.api#documentation": "The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see prep-classifier-data.
" } }, "com.amazonaws.comprehend#DocumentClassifierMode": { @@ -3055,7 +3058,7 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" } }, "Mode": { @@ -3354,7 +3357,7 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.
" } } }, @@ -3477,7 +3480,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies information about the specified endpoint.
" + "smithy.api#documentation": "Specifies information about the specified endpoint.\n For information about endpoints, see Managing endpoints.
" } }, "com.amazonaws.comprehend#EndpointPropertiesList": { @@ -5164,7 +5167,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of all existing endpoints that you've created.
" + "smithy.api#documentation": "Gets a list of all existing endpoints that you've created.\n For information about endpoints, see Managing endpoints.
" } }, "com.amazonaws.comprehend#ListEndpointsRequest": { @@ -6446,6 +6449,62 @@ { "value": "ALL", "name": "ALL" + }, + { + "value": "LICENSE_PLATE", + "name": "LICENSE_PLATE" + }, + { + "value": "VEHICLE_IDENTIFICATION_NUMBER", + "name": "VEHICLE_IDENTIFICATION_NUMBER" + }, + { + "value": "UK_NATIONAL_INSURANCE_NUMBER", + "name": "UK_NATIONAL_INSURANCE_NUMBER" + }, + { + "value": "CA_SOCIAL_INSURANCE_NUMBER", + "name": "CA_SOCIAL_INSURANCE_NUMBER" + }, + { + "value": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", + "name": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + }, + { + "value": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", + "name": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + }, + { + "value": "IN_PERMANENT_ACCOUNT_NUMBER", + "name": "IN_PERMANENT_ACCOUNT_NUMBER" + }, + { + "value": "IN_NREGA", + "name": "IN_NREGA" + }, + { + "value": "INTERNATIONAL_BANK_ACCOUNT_NUMBER", + "name": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + }, + { + "value": "SWIFT_CODE", + "name": "SWIFT_CODE" + }, + { + "value": "UK_NATIONAL_HEALTH_SERVICE_NUMBER", + "name": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + }, + { + "value": "CA_HEALTH_NUMBER", + "name": "CA_HEALTH_NUMBER" + }, + { + "value": "IN_AADHAAR", + "name": "IN_AADHAAR" + }, + { + "value": "IN_VOTER_NUMBER", + "name": "IN_VOTER_NUMBER" } ] } @@ -6942,7 +7001,7 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your document classification job. For more information, see\n Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your document classification job. For more information, see\n Amazon\n VPC.
" } }, "Tags": { @@ -7406,7 +7465,7 @@ "VpcConfig": { "target": "com.amazonaws.comprehend#VpcConfig", "traits": { - "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your key phrases detection job. For more information, see\n Amazon\n VPC.
" + "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your key phrases detection job. For more information, see\n Amazon\n VPC.
" } }, "Tags": { @@ -7515,7 +7574,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The language of the input documents.
", + "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", "smithy.api#required": {} } }, @@ -7734,7 +7793,7 @@ "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { - "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", + "smithy.api#documentation": "The language of the input documents. Currently, English is the only valid language.
", "smithy.api#required": {} } }, @@ -8180,7 +8239,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a sentiment detection job in progress.
\nIf the job state is IN_PROGRESS
the job is marked for termination and put\n into the STOP_REQUESTED
state. If the job completes before it can be stopped, it\n is put into the COMPLETED
state; otherwise the job is be stopped and put into the\n STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the\n StopDominantLanguageDetectionJob
operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" + "smithy.api#documentation": "Stops a sentiment detection job in progress.
\nIf the job state is IN_PROGRESS
, the job is marked for termination and put\n into the STOP_REQUESTED
state. If the job completes before it can be stopped, it\n is put into the COMPLETED
state; otherwise the job is be stopped and put into the\n STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the\n StopDominantLanguageDetectionJob
operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" } }, "com.amazonaws.comprehend#StopSentimentDetectionJobRequest": { @@ -8232,7 +8291,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a targeted sentiment detection job in progress.
\nIf the job state is IN_PROGRESS
the job is marked for termination and put\n into the STOP_REQUESTED
state. If the job completes before it can be stopped, it\n is put into the COMPLETED
state; otherwise the job is be stopped and put into the\n STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the\n StopDominantLanguageDetectionJob
operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" + "smithy.api#documentation": "Stops a targeted sentiment detection job in progress.
\nIf the job state is IN_PROGRESS
, the job is marked for termination and put\n into the STOP_REQUESTED
state. If the job completes before it can be stopped, it\n is put into the COMPLETED
state; otherwise the job is be stopped and put into the\n STOPPED
state.
If the job is in the COMPLETED
or FAILED
state when you call the\n StopDominantLanguageDetectionJob
operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" } }, "com.amazonaws.comprehend#StopTargetedSentimentDetectionJobRequest": { @@ -8952,7 +9011,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates information about the specified endpoint.
" + "smithy.api#documentation": "Updates information about the specified endpoint.\n For information about endpoints, see Managing endpoints.
" } }, "com.amazonaws.comprehend#UpdateEndpointRequest": { diff --git a/aws/sdk/aws-models/datasync.json b/aws/sdk/aws-models/datasync.json index dc4bc0a1a1f..574346b0ef6 100644 --- a/aws/sdk/aws-models/datasync.json +++ b/aws/sdk/aws-models/datasync.json @@ -267,7 +267,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an endpoint for an Amazon EFS file system.
" + "smithy.api#documentation": "Creates an endpoint for an Amazon EFS file system that DataSync\n can access for a transfer. For more information, see Creating a location for Amazon EFS.
" } }, "com.amazonaws.datasync#CreateLocationEfsRequest": { @@ -276,27 +276,45 @@ "Subdirectory": { "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { - "smithy.api#documentation": "A subdirectory in the location’s path. This subdirectory in the EFS file system is used\n to read data from the EFS source location or write data to the EFS destination. By default,\n DataSync uses the root directory.
\n\n Subdirectory
must be specified with forward slashes. For example,\n /path/to/folder
.
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.
\nYou must specify a value with forward slashes (for example,\n /path/to/folder
).
The Amazon Resource Name (ARN) for the Amazon EFS file system.
", + "smithy.api#documentation": "Specifies the ARN for the Amazon EFS file system.
", "smithy.api#required": {} } }, "Ec2Config": { "target": "com.amazonaws.datasync#Ec2Config", "traits": { - "smithy.api#documentation": "The subnet and security group that the Amazon EFS file system uses. The security group\n that you provide needs to be able to communicate with the security group on the mount target\n in the subnet specified.
\nThe exact relationship between security group M (of the mount target) and security\n group S (which you provide for DataSync to use at this stage) is as follows:
\nSecurity group M (which you associate with the mount target) must allow inbound\n access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security\n group S. You can enable inbound connections either by IP address (CIDR range) or security\n group.
\nSecurity group S (provided to DataSync to access EFS) should have a rule that\n enables outbound connections to the NFS port on one of the file system’s mount targets.\n You can enable outbound connections either by IP address (CIDR range) or security\n group.
\n \nFor information about security groups and mount targets, see Security\n Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User\n Guide.\n
\nSpecifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "The key-value pair that represents a tag that you want to add to the resource. The\n value can be an empty string. This value helps you manage, filter, and search for your\n resources. We recommend that you create a name tag for your location.
" + "smithy.api#documentation": "Specifies the key-value pair that represents a tag that you want to add to the\n resource. The value can be an empty string. This value helps you manage, filter, and search\n for your resources. We recommend that you create a name tag for your location.
" + } + }, + "AccessPointArn": { + "target": "com.amazonaws.datasync#EfsAccessPointArn", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
" + } + }, + "FileSystemAccessRoleArn": { + "target": "com.amazonaws.datasync#IamRoleArn", + "traits": { + "smithy.api#documentation": "Specifies an Identity and Access Management (IAM) role that DataSync\n assumes when mounting the Amazon EFS file system.
" + } + }, + "InTransitEncryption": { + "target": "com.amazonaws.datasync#EfsInTransitEncryption", + "traits": { + "smithy.api#documentation": "Specifies whether you want DataSync to use TLS encryption when transferring data to or from your Amazon EFS file system.
\nIf you specify an access point using AccessPointArn
or an IAM\n role using FileSystemAccessRoleArn
, you must set this parameter to\n TLS1_2
.
The Amazon Resource Name (ARN) of the Amazon EFS file system location that is\n created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EFS file system location that you\n create.
" } } }, @@ -1313,7 +1331,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns metadata, such as the path information about an Amazon EFS location.
" + "smithy.api#documentation": "Returns metadata about your DataSync location for an Amazon EFS file system.
" } }, "com.amazonaws.datasync#DescribeLocationEfsRequest": { @@ -1322,7 +1340,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EFS location to describe.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.
", "smithy.api#required": {} } } @@ -1337,13 +1355,13 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EFS location that was described.
" + "smithy.api#documentation": "The ARN of the Amazon EFS file system location.
" } }, "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "The URL of the EFS location that was described.
" + "smithy.api#documentation": "The URL of the Amazon EFS file system location.
" } }, "Ec2Config": { @@ -1352,7 +1370,25 @@ "CreationTime": { "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "The time that the EFS location was created.
" + "smithy.api#documentation": "The time that the location was created.
" + } + }, + "AccessPointArn": { + "target": "com.amazonaws.datasync#EfsAccessPointArn", + "traits": { + "smithy.api#documentation": "The ARN of the access point that DataSync uses to access the Amazon EFS file system.
" + } + }, + "FileSystemAccessRoleArn": { + "target": "com.amazonaws.datasync#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
" + } + }, + "InTransitEncryption": { + "target": "com.amazonaws.datasync#EfsInTransitEncryption", + "traits": { + "smithy.api#documentation": "Whether DataSync uses TLS encryption when transferring data to or from your Amazon EFS file system.
" } } }, @@ -2258,20 +2294,20 @@ "SubnetArn": { "target": "com.amazonaws.datasync#Ec2SubnetArn", "traits": { - "smithy.api#documentation": "The ARN of the subnet that DataSync uses to access the target EFS file\n system.
", + "smithy.api#documentation": "Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.
\nThe subnet must be located:
\nIn the same virtual private cloud (VPC) as the Amazon EFS file system.
\nIn the same Availability Zone as at least one mount target for the Amazon EFS file\n system.
\nYou don't need to specify a subnet that includes a file system mount target.
\nThe Amazon Resource Names (ARNs) of the security groups that are configured for the\n Amazon EC2 resource.
", + "smithy.api#documentation": "Specifies the Amazon Resource Names (ARNs) of the security groups associated with an\n Amazon EFS file system's mount target.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The subnet that DataSync uses to access target EFS file system. The\n subnet must have at least one mount target for that file system. The security group that you\n provide needs to be able to communicate with the security group on the mount target in the\n subnet specified.
" + "smithy.api#documentation": "The subnet and security groups that DataSync uses to access your Amazon EFS file system.
" } }, "com.amazonaws.datasync#Ec2SecurityGroupArn": { @@ -2306,6 +2342,16 @@ "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$" } }, + "com.amazonaws.datasync#EfsAccessPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$" + } + }, "com.amazonaws.datasync#EfsFilesystemArn": { "type": "string", "traits": { @@ -2316,6 +2362,21 @@ "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$" } }, + "com.amazonaws.datasync#EfsInTransitEncryption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "TLS1_2", + "name": "TLS1_2" + } + ] + } + }, "com.amazonaws.datasync#EfsSubdirectory": { "type": "string", "traits": { @@ -2932,6 +2993,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Agents", "pageSize": "MaxResults" } } @@ -2997,6 +3059,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Locations", "pageSize": "MaxResults" } } @@ -3068,6 +3131,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Tags", "pageSize": "MaxResults" } } @@ -3140,6 +3204,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TaskExecutions", "pageSize": "MaxResults" } } @@ -3211,6 +3276,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Tasks", "pageSize": "MaxResults" } } diff --git a/aws/sdk/aws-models/discovery.json b/aws/sdk/aws-models/discovery.json index 176bd87a753..8330690fddb 100644 --- a/aws/sdk/aws-models/discovery.json +++ b/aws/sdk/aws-models/discovery.json @@ -31,6 +31,24 @@ "shapes": { "com.amazonaws.applicationdiscoveryservice#AWSPoseidonService_V2015_11_01": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Application Discovery Service", + "arnNamespace": "discovery", + "cloudFormationName": "ApplicationDiscoveryService", + "cloudTrailEventSource": "applicationdiscoveryservice.amazonaws.com", + "endpointPrefix": "discovery" + }, + "aws.auth#sigv4": { + "name": "discovery" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Web Services Application Discovery Service helps you plan application migration projects. It\n automatically identifies servers, virtual machines (VMs), and network dependencies in your\n on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ. \n Application Discovery Service offers three ways of performing discovery and\n collecting data about your on-premises servers:
\n\n\n Agentless discovery is recommended for environments\n that use VMware vCenter Server. This mode doesn't require you to install an agent on each\n host. It does not work in non-VMware environments.
\n\nAgentless discovery gathers server information regardless of the operating\n systems, which minimizes the time required for initial on-premises infrastructure\n assessment.
\nAgentless discovery doesn't collect information about network dependencies, only\n agent-based discovery collects that information.
\n\n Agent-based discovery collects a richer set of data\n than agentless discovery by using the Amazon Web Services Application Discovery Agent, which you install\n on one or more hosts in your data center.
\n\nThe agent captures infrastructure and application information, including an\n inventory of running processes, system performance information, resource utilization,\n and network dependencies.
\nThe information collected by agents is secured at rest and in transit to the\n Application Discovery Service database in the cloud.
\n\n Amazon Web Services Partner Network (APN) solutions integrate with\n Application Discovery Service, enabling you to import details of your on-premises\n environment directly into Migration Hub without using the discovery connector or discovery\n agent.
\n\nThird-party application discovery tools can query Amazon Web Services Application Discovery\n Service, and they can write to the Application Discovery Service database using the\n public API.
\nIn this way, you can import data into Migration Hub and view it, so that you can\n associate applications with servers and track migrations.
\n\n Recommendations\n
\nWe recommend that you use agent-based discovery for non-VMware environments, and\n whenever you want to collect information about network dependencies. You can run agent-based\n and agentless discovery simultaneously. Use agentless discovery to complete the initial\n infrastructure assessment quickly, and then install agents on select hosts to collect\n additional information.
\n\n\n Working With This Guide\n
\n\nThis API reference provides descriptions, syntax, and usage examples for each of the\n actions and data types for Application Discovery Service. The topic for each action shows the\n API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services\n SDKs.
\n\nRemember that you must set your Migration Hub home region before you call any of\n these APIs.
\nYou must make API calls for write actions (create, notify, associate, disassociate,\n import, or put) while in your home region, or a HomeRegionNotSetException
\n error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside\n of your home region.
\nAlthough it is unlikely, the Migration Hub home region could change. If you call\n APIs outside the home region, an InvalidInputException
is returned.
You must call GetHomeRegion
to obtain the latest Migration Hub home\n region.
This guide is intended for use with the Amazon Web Services Application\n Discovery Service User Guide.
\n\nAll data is handled according to the Amazon Web Services \n Privacy Policy. You can operate Application Discovery Service offline to inspect\n collected data before it is shared with the service.
\nAWS Application Discovery Service helps you plan application migration projects. It\n automatically identifies servers, virtual machines (VMs), and network dependencies in your\n on-premises data centers. For more information, see the AWS Application Discovery Service\n FAQ. Application Discovery Service offers three ways of performing discovery and\n collecting data about your on-premises servers:
\n\n\n Agentless discovery is recommended for environments\n that use VMware vCenter Server. This mode doesn't require you to install an agent on each\n host. It does not work in non-VMware environments.
\n\nAgentless discovery gathers server information regardless of the operating\n systems, which minimizes the time required for initial on-premises infrastructure\n assessment.
\nAgentless discovery doesn't collect information about network dependencies, only\n agent-based discovery collects that information.
\n\n Agent-based discovery collects a richer set of data\n than agentless discovery by using the AWS Application Discovery Agent, which you install\n on one or more hosts in your data center.
\n\nThe agent captures infrastructure and application information, including an\n inventory of running processes, system performance information, resource utilization,\n and network dependencies.
\nThe information collected by agents is secured at rest and in transit to the\n Application Discovery Service database in the cloud.
\n\n AWS Partner Network (APN) solutions integrate with\n Application Discovery Service, enabling you to import details of your on-premises\n environment directly into Migration Hub without using the discovery connector or discovery\n agent.
\n\nThird-party application discovery tools can query AWS Application Discovery\n Service, and they can write to the Application Discovery Service database using the\n public API.
\nIn this way, you can import data into Migration Hub and view it, so that you can\n associate applications with servers and track migrations.
\n\n Recommendations\n
\nWe recommend that you use agent-based discovery for non-VMware environments, and\n whenever you want to collect information about network dependencies. You can run agent-based\n and agentless discovery simultaneously. Use agentless discovery to complete the initial\n infrastructure assessment quickly, and then install agents on select hosts to collect\n additional information.
\n\n\n Working With This Guide\n
\n\nThis API reference provides descriptions, syntax, and usage examples for each of the\n actions and data types for Application Discovery Service. The topic for each action shows the\n API request parameters and the response. Alternatively, you can use one of the AWS SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see AWS\n SDKs.
\n\nRemember that you must set your Migration Hub home region before you call any of\n these APIs.
\nYou must make API calls for write actions (create, notify, associate, disassociate,\n import, or put) while in your home region, or a HomeRegionNotSetException
\n error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside\n of your home region.
\nAlthough it is unlikely, the Migration Hub home region could change. If you call\n APIs outside the home region, an InvalidInputException
is returned.
You must call GetHomeRegion
to obtain the latest Migration Hub home\n region.
This guide is intended for use with the AWS Application\n Discovery Service User Guide.
\n\nAll data is handled according to the AWS\n Privacy Policy. You can operate Application Discovery Service offline to inspect\n collected data before it is shared with the service.
\nInformation about agents or connectors associated with the user’s AWS account.\n Information includes agent or connector IDs, IP addresses, media access control (MAC)\n addresses, agent or connector health, hostname where the agent or connector resides, and agent\n version for each agent.
" + "smithy.api#documentation": "Information about agents or connectors associated with the user’s Amazon Web Services account.\n Information includes agent or connector IDs, IP addresses, media access control (MAC)\n addresses, agent or connector health, hostname where the agent or connector resides, and agent\n version for each agent.
" } }, "com.amazonaws.applicationdiscoveryservice#AgentNetworkInfo": { @@ -300,8 +307,25 @@ "target": "com.amazonaws.applicationdiscoveryservice#AgentInfo" } }, + "com.amazonaws.applicationdiscoveryservice#ApplicationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^(^$|[\\s\\S]*\\S[\\s\\S]*)$" + } + }, "com.amazonaws.applicationdiscoveryservice#ApplicationId": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^\\S+$" + } }, "com.amazonaws.applicationdiscoveryservice#ApplicationIdsList": { "type": "list", @@ -309,6 +333,16 @@ "target": "com.amazonaws.applicationdiscoveryservice#ApplicationId" } }, + "com.amazonaws.applicationdiscoveryservice#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 127 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, "com.amazonaws.applicationdiscoveryservice#AssociateConfigurationItemsToApplication": { "type": "operation", "input": { @@ -369,7 +403,7 @@ } }, "traits": { - "smithy.api#documentation": "The AWS user account does not have permission to perform the action. Check the IAM\n policy associated with this account.
", + "smithy.api#documentation": "The Amazon Web Services user account does not have permission to perform the action. Check the IAM\n policy associated with this account.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -400,7 +434,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes one or more import tasks, each identified by their import ID. Each import task has\n a number of records that can identify servers or applications.
\n\nAWS Application Discovery Service has built-in matching logic that will identify when\n discovered servers match existing entries that you've previously discovered, the information\n for the already-existing discovered server is updated. When you delete an import task that\n contains records that were used to match, the information in those matched records that comes\n from the deleted records will also be deleted.
" + "smithy.api#documentation": "Deletes one or more import tasks, each identified by their import ID. Each import task has\n a number of records that can identify servers or applications.
\n\nAmazon Web Services Application Discovery Service has built-in matching logic that will identify when\n discovered servers match existing entries that you've previously discovered, the information\n for the already-existing discovered server is updated. When you delete an import task that\n contains records that were used to match, the information in those matched records that comes\n from the deleted records will also be deleted.
" } }, "com.amazonaws.applicationdiscoveryservice#BatchDeleteImportDataError": { @@ -499,7 +533,14 @@ } }, "com.amazonaws.applicationdiscoveryservice#Condition": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^\\S+$" + } }, "com.amazonaws.applicationdiscoveryservice#Configuration": { "type": "map", @@ -511,7 +552,14 @@ } }, "com.amazonaws.applicationdiscoveryservice#ConfigurationId": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^\\S*$" + } }, "com.amazonaws.applicationdiscoveryservice#ConfigurationIdList": { "type": "list", @@ -599,7 +647,14 @@ "type": "string" }, "com.amazonaws.applicationdiscoveryservice#ConfigurationsExportId": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^\\S*$" + } }, "com.amazonaws.applicationdiscoveryservice#ConflictErrorException": { "type": "structure", @@ -632,7 +687,7 @@ "statusDetail": { "target": "com.amazonaws.applicationdiscoveryservice#StringMax255", "traits": { - "smithy.api#documentation": "Contains information about any errors that have occurred. This data type can have the\n following values:
\n\nACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon\n Athena. Contact your AWS administrator for help. For more information, see Setting Up AWS Application Discovery Service in the Application Discovery\n Service User Guide.
\nDELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data\n Firehose delivery streams. Reduce the number of streams or request a limit increase and\n try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide.
\nFIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because\n your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data\n Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by\n Attaching Policies in the Application Discovery Service User Guide.
\nFIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state\n because your IAM User is missing one or more of the Kinesis data delivery\n streams.
\nINTERNAL_FAILURE - The Data Exploration feature is in an error state because of an\n internal failure. Try again later. If this problem persists, contact AWS\n Support.
\nS3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the\n number of Amazon S3 buckets or request a limit increase and try again. For more\n information, see Bucket\n Restrictions and Limitations in the Amazon Simple Storage Service Developer\n Guide.
\nS3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You\n must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
\nContains information about any errors that have occurred. This data type can have the\n following values:
\n\nACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon\n Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery\n Service User Guide.
\nDELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data\n Firehose delivery streams. Reduce the number of streams or request a limit increase and\n try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide.
\nFIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because\n your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data\n Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by\n Attaching Policies in the Application Discovery Service User Guide.
\nFIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state\n because your IAM User is missing one or more of the Kinesis data delivery\n streams.
\nINTERNAL_FAILURE - The Data Exploration feature is in an error state because of an\n internal failure. Try again later. If this problem persists, contact Amazon Web Services\n Support.
\nLAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions\n to start continuous export. For more information, see \n Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the\n Amazon Web Services Lake Formation Developer Guide.
\nYou can use one of the following two ways to resolve this issue.
\nIf you don’t want to use the Lake Formation permission model, you can change\n the default Data Catalog settings to use only Amazon Web Services Identity and Access Management\n (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation\n Developer Guide.
\nYou can give the service-linked IAM roles\n AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and\n AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For\n more information, see \n Granting Database Permissions in the Lake Formation\n Developer Guide.
\nAWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant\n database creator permissions, which gives the role database creation ability and\n implicit permissions for any created tables. For more information, see \n Implicit Lake Formation Permissions in the Lake\n Formation Developer Guide.
\nAWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all\n tables in the database.
\nS3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the\n number of S3 buckets or request a limit increase and try again. For more\n information, see Bucket\n Restrictions and Limitations in the Amazon Simple Storage Service Developer\n Guide.
\nS3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You\n must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
\nName of the application to be created.
", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.applicationdiscoveryservice#String", + "target": "com.amazonaws.applicationdiscoveryservice#ApplicationDescription", "traits": { "smithy.api#documentation": "Description of the application to be created.
" } @@ -804,7 +859,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates one or more tags for configuration items. Tags are metadata that help you\n categorize IT assets. This API accepts a list of multiple configuration items.
" + "smithy.api#documentation": "Creates one or more tags for configuration items. Tags are metadata that help you\n categorize IT assets. This API accepts a list of multiple configuration items.
\n\nDo not store sensitive information (like personal data) in tags.
\nInventory data for installed discovery connectors.
" } }, + "com.amazonaws.applicationdiscoveryservice#CustomerMeCollectorInfo": { + "type": "structure", + "members": { + "activeMeCollectors": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "\n The number of active Migration Evaluator collectors.\n
", + "smithy.api#required": {} + } + }, + "healthyMeCollectors": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "\n The number of healthy Migration Evaluator collectors.\n
", + "smithy.api#required": {} + } + }, + "denyListedMeCollectors": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "\n The number of deny-listed Migration Evaluator collectors.\n
", + "smithy.api#required": {} + } + }, + "shutdownMeCollectors": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "\n The number of Migration Evaluator collectors with SHUTDOWN
status.\n
\n The number of unhealthy Migration Evaluator collectors.\n
", + "smithy.api#required": {} + } + }, + "totalMeCollectors": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "\n The total number of Migration Evaluator collectors.\n
", + "smithy.api#required": {} + } + }, + "unknownMeCollectors": { + "target": "com.amazonaws.applicationdiscoveryservice#Integer", + "traits": { + "smithy.api#documentation": "\n The number of unknown Migration Evaluator collectors.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The inventory data for installed Migration Evaluator collectors.\n
" + } + }, "com.amazonaws.applicationdiscoveryservice#DataSource": { "type": "string", "traits": { @@ -1098,7 +1210,7 @@ "agentIds": { "target": "com.amazonaws.applicationdiscoveryservice#AgentIds", "traits": { - "smithy.api#documentation": "The agent or the Connector IDs for which you want information. If you specify no IDs,\n the system returns information about all agents/Connectors associated with your AWS user\n account.
" + "smithy.api#documentation": "The agent or the Connector IDs for which you want information. If you specify no IDs,\n the system returns information about all agents/Connectors associated with your Amazon Web Services user\n account.
" } }, "filters": { @@ -1164,7 +1276,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves attributes for a list of configuration item IDs.
\n\nAll of the supplied IDs must be for the same asset type from one of the\n following:
\nserver
\napplication
\nprocess
\nconnection
\nOutput fields are specific to the asset type specified. For example, the output for a\n server configuration item includes a list of attributes about the\n server, such as host name, operating system, number of network cards, etc.
\nFor a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the AWS Application\n Discovery Service User Guide.
\nRetrieves attributes for a list of configuration item IDs.
\n\nAll of the supplied IDs must be for the same asset type from one of the\n following:
\nserver
\napplication
\nprocess
\nconnection
\nOutput fields are specific to the asset type specified. For example, the output for a\n server configuration item includes a list of attributes about the\n server, such as host name, operating system, number of network cards, etc.
\nFor a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application\n Discovery Service User Guide.
\n\n DescribeExportConfigurations
is deprecated. Use DescribeImportTasks, instead.
\n DescribeExportConfigurations
is deprecated. Use DescribeExportTasks, instead.
A single ExportFilter
name. Supported filters:\n agentId
.
A single ExportFilter
name. Supported filters:\n agentIds
.
A single agentId
for a Discovery Agent. An agentId
can be\n found using the DescribeAgents action. Typically an ADS agentId
is in the form\n o-0123456789abcdef0
.
A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action. Typically an ADS agent ID is in the form\n o-0123456789abcdef0
.
A filter that can use conditional operators.
\nFor more information about filters, see Querying Discovered\n Configuration Items in the AWS Application Discovery Service User\n Guide.
" + "smithy.api#documentation": "A filter that can use conditional operators.
\nFor more information about filters, see Querying Discovered\n Configuration Items in the Amazon Web Services Application Discovery Service User\n Guide.
" } }, "com.amazonaws.applicationdiscoveryservice#FilterName": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } }, "com.amazonaws.applicationdiscoveryservice#FilterValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^(^$|[\\s\\S]*\\S[\\s\\S]*)$" + } }, "com.amazonaws.applicationdiscoveryservice#FilterValues": { "type": "list", @@ -1972,6 +2098,12 @@ "traits": { "smithy.api#documentation": "Details about discovered connectors, including connector status and health.
" } + }, + "meCollectorSummary": { + "target": "com.amazonaws.applicationdiscoveryservice#CustomerMeCollectorInfo", + "traits": { + "smithy.api#documentation": "\n Details about Migration Evaluator collectors, including collector status and health.\n
" + } } } }, @@ -2045,7 +2177,7 @@ "importTaskId": { "target": "com.amazonaws.applicationdiscoveryservice#ImportTaskIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for a specific import task. These IDs aren't globally unique, but they are\n unique within an AWS account.
" + "smithy.api#documentation": "The unique ID for a specific import task. These IDs aren't globally unique, but they are\n unique within an Amazon Web Services account.
" } }, "clientRequestToken": { @@ -2186,7 +2318,14 @@ } }, "com.amazonaws.applicationdiscoveryservice#ImportTaskIdentifier": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + }, + "smithy.api#pattern": "^\\S*$" + } }, "com.amazonaws.applicationdiscoveryservice#ImportTaskList": { "type": "list", @@ -2200,7 +2339,8 @@ "smithy.api#length": { "min": 1, "max": 100 - } + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" } }, "com.amazonaws.applicationdiscoveryservice#ImportURL": { @@ -2209,7 +2349,8 @@ "smithy.api#length": { "min": 1, "max": 4000 - } + }, + "smithy.api#pattern": "^\\S+:\\/\\/\\S+\\/[\\s\\S]*\\S[\\s\\S]*$" } }, "com.amazonaws.applicationdiscoveryservice#Integer": { @@ -2286,7 +2427,7 @@ "filters": { "target": "com.amazonaws.applicationdiscoveryservice#Filters", "traits": { - "smithy.api#documentation": "You can filter the request using various logical operators and a\n key-value format. For example:
\n\n {\"key\": \"serverType\", \"value\": \"webServer\"}
\n
For a complete list of filter options and guidance about using them with this action,\n see Using the ListConfigurations Action in the AWS Application Discovery\n Service User Guide.
" + "smithy.api#documentation": "You can filter the request using various logical operators and a\n key-value format. For example:
\n\n {\"key\": \"serverType\", \"value\": \"webServer\"}
\n
For a complete list of filter options and guidance about using them with this action,\n see Using the ListConfigurations Action in the Amazon Web Services Application Discovery\n Service User Guide.
" } }, "maxResults": { @@ -2304,7 +2445,7 @@ "orderBy": { "target": "com.amazonaws.applicationdiscoveryservice#OrderByList", "traits": { - "smithy.api#documentation": "Certain filter criteria return output that can be sorted in ascending or descending\n order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery\n Service User Guide.
" + "smithy.api#documentation": "Certain filter criteria return output that can be sorted in ascending or descending\n order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the Amazon Web Services Application Discovery\n Service User Guide.
" } } } @@ -2488,7 +2629,7 @@ "type": "structure", "members": { "fieldName": { - "target": "com.amazonaws.applicationdiscoveryservice#String", + "target": "com.amazonaws.applicationdiscoveryservice#OrderByElementFieldName", "traits": { "smithy.api#documentation": "The field on which to order.
", "smithy.api#required": {} @@ -2505,6 +2646,16 @@ "smithy.api#documentation": "A field and direction for ordered output.
" } }, + "com.amazonaws.applicationdiscoveryservice#OrderByElementFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + } + }, "com.amazonaws.applicationdiscoveryservice#OrderByList": { "type": "list", "member": { @@ -2677,7 +2828,7 @@ "agentIds": { "target": "com.amazonaws.applicationdiscoveryservice#AgentIds", "traits": { - "smithy.api#documentation": "The IDs of the agents or connectors from which to start collecting data. If you send a\n request to an agent/connector ID that you do not have permission to contact, according to your\n AWS account, the service does not throw an exception. Instead, it returns the error in the\n Description field. If you send a request to multiple agents/connectors\n and you do not have permission to contact some of those agents/connectors, the system does not\n throw an exception. Instead, the system shows Failed
in the\n Description field.
The IDs of the agents or connectors from which to start collecting data. If you send a\n request to an agent/connector ID that you do not have permission to contact, according to your\n Amazon Web Services account, the service does not throw an exception. Instead, it returns the error in the\n Description field. If you send a request to multiple agents/connectors\n and you do not have permission to contact some of those agents/connectors, the system does not\n throw an exception. Instead, the system shows Failed
in the\n Description field.
Begins the export of discovered data to an S3 bucket.
\n If you specify agentIds
in a filter, the task exports up to 72 hours of\n detailed data collected by the identified Application Discovery Agent, including network,\n process, and performance details. A time range for exported agent data may be set by using\n startTime
and endTime
. Export of detailed agent data is limited to\n five concurrently running exports.
If you do not include an agentIds
filter, summary data is exported that\n includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery\n Agents. Export of summary data is limited to two exports per day.
Begins the export of discovered data to an S3 bucket.
\n If you specify agentIds
in a filter, the task exports up to 72 hours of\n detailed data collected by the identified Application Discovery Agent, including network,\n process, and performance details. A time range for exported agent data may be set by using\n startTime
and endTime
. Export of detailed agent data is limited to\n five concurrently running exports.
If you do not include an agentIds
filter, summary data is exported that\n includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery\n Agents. Export of summary data is limited to two exports per day.
Starts an import task, which allows you to import details of your on-premises environment\n directly into AWS Migration Hub without having to use the Application Discovery Service (ADS)\n tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform\n migration assessment and planning directly from your imported data, including the ability to\n group your devices as applications and track their migration status.
\n\nTo start an import request, do this:
\n\nDownload the specially formatted comma separated value (CSV) import template, which\n you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
\nFill out the template with your server and application data.
\nUpload your import file to an Amazon S3 bucket, and make a note of it's Object URL.\n Your import file must be in the CSV format.
\nUse the console or the StartImportTask
command with the AWS CLI or one of\n the AWS SDKs to import the records from your file.
For more information, including step-by-step procedures, see Migration Hub\n Import in the AWS Application Discovery Service User\n Guide.
\n\nThere are limits to the number of import tasks you can create (and delete) in an AWS\n account. For more information, see AWS Application\n Discovery Service Limits in the AWS Application Discovery Service User\n Guide.
\nStarts an import task, which allows you to import details of your on-premises environment\n directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS)\n tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform\n migration assessment and planning directly from your imported data, including the ability to\n group your devices as applications and track their migration status.
\n\nTo start an import request, do this:
\n\nDownload the specially formatted comma separated value (CSV) import template, which\n you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
\nFill out the template with your server and application data.
\nUpload your import file to an Amazon S3 bucket, and make a note of it's Object URL.\n Your import file must be in the CSV format.
\nUse the console or the StartImportTask
command with the Amazon Web Services CLI or one of\n the Amazon Web Services SDKs to import the records from your file.
For more information, including step-by-step procedures, see Migration Hub\n Import in the Amazon Web Services Application Discovery Service User\n Guide.
\n\nThere are limits to the number of import tasks you can create (and delete) in an Amazon Web Services\n account. For more information, see Amazon Web Services Application\n Discovery Service Limits in the Amazon Web Services Application Discovery Service User\n Guide.
\nThe URL for your import file that you've uploaded to Amazon S3.
\n\nIf you're using the AWS CLI, this URL is structured as follows:\n s3://BucketName/ImportFileName.CSV
\n
The URL for your import file that you've uploaded to Amazon S3.
\n\nIf you're using the Amazon Web Services CLI, this URL is structured as follows:\n s3://BucketName/ImportFileName.CSV
\n
Metadata that help you categorize IT assets.
" + "smithy.api#documentation": "Metadata that help you categorize IT assets.
\nDo not store sensitive information (like personal data) in tags.
\nNew name of the application to be updated.
" } }, "description": { - "target": "com.amazonaws.applicationdiscoveryservice#String", + "target": "com.amazonaws.applicationdiscoveryservice#ApplicationDescription", "traits": { "smithy.api#documentation": "New description of the application to be updated.
" } diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index a3906537105..3ba777c8494 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -11811,7 +11811,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an\n instance. When you launch an instance using RunInstances, you can\n specify a launch template instead of providing the launch parameters in the request. For\n more information, see Launching an instance from a\n launch template in the Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a launch template.
\nA launch template contains the parameters to launch an\n instance. When you launch an instance using RunInstances, you can\n specify a launch template instead of providing the launch parameters in the request. For\n more information, see Launch an instance from a\n launch template in the Amazon Elastic Compute Cloud User Guide.
\nIf you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateLaunchTemplateRequest": { @@ -11826,7 +11826,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.
\nConstraint: Maximum 128 ASCII characters.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" } }, "LaunchTemplateName": { @@ -11888,7 +11888,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateVersionResult" }, "traits": { - "smithy.api#documentation": "Creates a new version for a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nFor more information, see Managing launch template versionsin the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Creates a new version for a launch template. You can specify an existing version of\n launch template from which to base the new version.
\nLaunch template versions are numbered in the order in which they are created. You\n cannot specify, change, or replace the numbering of launch template versions.
\nLaunch templates are immutable; after you create a launch template, you can't modify it. \n Instead, you can create a new version of the launch template that includes any changes you require.
\nFor more information, see Modify a launch template (manage launch template versions)in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateLaunchTemplateVersionRequest": { @@ -11903,7 +11903,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.
\nConstraint: Maximum 128 ASCII characters.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" } }, "LaunchTemplateId": { @@ -14089,7 +14089,7 @@ "target": "com.amazonaws.ec2#CreateTrafficMirrorTargetResult" }, "traits": { - "smithy.api#documentation": "Creates a target for your Traffic Mirror session.
\nA Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and\n the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in\n different VPCs connected via VPC peering or a transit gateway.
\nA Traffic Mirror target can be a network interface, or a Network Load Balancer.
\nTo use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
" + "smithy.api#documentation": "Creates a target for your Traffic Mirror session.
\nA Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and\n the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in\n different VPCs connected via VPC peering or a transit gateway.
\nA Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
\nTo use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
" } }, "com.amazonaws.ec2#CreateTrafficMirrorTargetRequest": { @@ -14132,6 +14132,12 @@ "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "smithy.api#idempotencyToken": {} } + }, + "GatewayLoadBalancerEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "The ID of the Gateway Load Balancer endpoint.
" + } } } }, @@ -43197,6 +43203,14 @@ "smithy.api#documentation": "The user data.
", "smithy.api#xmlName": "userData" } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiStop", + "smithy.api#documentation": "To enable the instance for Amazon Web Services Stop Protection, set this parameter to\n true
; otherwise, set it to false
.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.
" + "smithy.api#documentation": "Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more\n information, see What is Amazon Web Services Nitro Enclaves?\n in the Amazon Web Services Nitro Enclaves User Guide.
" } }, "com.amazonaws.ec2#LaunchTemplateErrorCode": { @@ -50935,7 +50997,7 @@ } }, "traits": { - "smithy.api#documentation": "Indicates whether the instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites.
" + "smithy.api#documentation": "Indicates whether the instance is configured for hibernation. This parameter is valid\n only if the instance meets the hibernation\n prerequisites.
" } }, "com.amazonaws.ec2#LaunchTemplateHttpTokensState": { @@ -54534,6 +54596,12 @@ "smithy.api#documentation": "A new value for the attribute. Use only with the kernel
,\n ramdisk
, userData
, disableApiTermination
, or\n instanceInitiatedShutdownBehavior
attribute.
Indicates whether an instance is enabled for stop protection. \n For more information, see Stop Protection.
\n " + } } } }, @@ -55287,7 +55355,7 @@ "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n Idempotency.
\nConstraint: Maximum 128 ASCII characters.
" + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. For more information, see Ensuring\n idempotency.
\nConstraint: Maximum 128 ASCII characters.
" } }, "LaunchTemplateId": { @@ -64265,7 +64333,7 @@ "KernelId": { "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "The ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User Provided\n Kernels in the Amazon Elastic Compute Cloud User\n Guide.
\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe instance type. For more information, see Instance Types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceTypes
, you can't specify\n InstanceRequirements
.
The instance type. For more information, see Instance types in the\n Amazon Elastic Compute Cloud User Guide.
\nIf you specify InstanceTypes
, you can't specify\n InstanceRequirements
.
The ID of the RAM disk.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User Provided\n Kernels in the Amazon Elastic Compute Cloud User\n Guide.
\nThe ID of the RAM disk.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon Elastic Compute Cloud User Guide.
\nThe user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance\n at Launch (Linux) or Adding User Data (Windows).
\n\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" + "smithy.api#documentation": "The user data to make available to the instance. You must provide base64-encoded text.\n User data is limited to 16 KB. For more information, see Run commands on your Linux instance\n at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
\n\nIf you are creating the launch template for use with Batch, the user\n data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
" } }, "TagSpecifications": { @@ -64417,7 +64485,7 @@ "HibernationOptions": { "target": "com.amazonaws.ec2#LaunchTemplateHibernationOptionsRequest", "traits": { - "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Indicates whether an instance is enabled for hibernation. This parameter is valid only\n if the instance meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon Elastic Compute Cloud User Guide.
" } }, "MetadataOptions": { @@ -64449,6 +64517,12 @@ "traits": { "smithy.api#documentation": "The maintenance options for the instance.
" } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to enable the instance for stop protection. For more information,\n see Stop\n Protection.
" + } } }, "traits": { @@ -66653,6 +66727,14 @@ "smithy.api#documentation": "The maintenance options for your instance.
", "smithy.api#xmlName": "maintenanceOptions" } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiStop", + "smithy.api#documentation": "Indicates whether the instance is enabled for stop protection. \n For more information, see Stop Protection.
", + "smithy.api#xmlName": "disableApiStop" + } } }, "traits": { @@ -68034,6 +68116,12 @@ "traits": { "smithy.api#documentation": "The maintenance and recovery options for the instance.
" } + }, + "DisableApiStop": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n Protection.\n
" + } } } }, @@ -74446,6 +74534,14 @@ "smithy.api#documentation": "The tags assigned to the Traffic Mirror target.
", "smithy.api#xmlName": "tagSet" } + }, + "GatewayLoadBalancerEndpointId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerEndpointId", + "smithy.api#documentation": "The ID of the Gateway Load Balancer endpoint.
", + "smithy.api#xmlName": "gatewayLoadBalancerEndpointId" + } } }, "traits": { @@ -74484,6 +74580,10 @@ { "value": "network-load-balancer", "name": "network_load_balancer" + }, + { + "value": "gateway-load-balancer-endpoint", + "name": "gateway_load_balancer_endpoint" } ] } @@ -77801,7 +77901,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "The error code that indicates why the parameter or parameter combination is not valid.\n For more information about error codes, see Error\n Codes.
", + "smithy.api#documentation": "The error code that indicates why the parameter or parameter combination is not valid.\n For more information about error codes, see Error\n codes.
", "smithy.api#xmlName": "code" } }, @@ -77809,7 +77909,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Message", - "smithy.api#documentation": "The error message that describes why the parameter or parameter combination is not\n valid. For more information about error messages, see Error\n Codes.
", + "smithy.api#documentation": "The error message that describes why the parameter or parameter combination is not\n valid. For more information about error messages, see Error\n codes.
", "smithy.api#xmlName": "message" } } diff --git a/aws/sdk/aws-models/elasticache.json b/aws/sdk/aws-models/elasticache.json index 0d34cdf7178..fee4e6ef348 100644 --- a/aws/sdk/aws-models/elasticache.json +++ b/aws/sdk/aws-models/elasticache.json @@ -727,7 +727,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the compute and memory capacity node type for the cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n \t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\t\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
Specifies the destination, format and type of the logs.
" } + }, + "TransitEncryptionEnabled": { + "target": "com.amazonaws.elasticache#BooleanOptional", + "traits": { + "smithy.api#documentation": "A flag that enables in-transit encryption when set to true.\n \n You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true when you create a cluster.
\n Required:\n Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12
or later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): \n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\n\t\t\t\t\t \t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): \n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\n\t\t\t\t\t \t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\n\t\t\t\t\t\t\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\t\n\t\t\t\t\t\t\t\t \t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward)\tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\n\t\t\t\t\t \t\t\t \t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.
\n\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward)\tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\n\t\t\t\t\t \t\t\t \t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache nodes.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache nodes.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types: (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t\t\tCurrent generation:
\n\n\t\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\t\n cache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t \n\t\t \n\t\tCurrent generation:
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t cache.r6g.large
,\n\t\t cache.r6g.xlarge
,\n\t\t cache.r6g.2xlarge
,\n\t\t cache.r6g.4xlarge
,\n\t\t cache.r6g.8xlarge
,\n\t\t cache.r6g.12xlarge
,\n\t\t cache.r6g.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
For region availability, see Supported Node Types\n
\nFor region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
\n \nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\n\t\tGeneral purpose:
\n\t\t\t\tCurrent generation:
\n\t\t\t\t\t \n\t\t\t\t\t\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\t\n cache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n\t\t\t\t\t\t\t\n\t\t\t\t\t
For region availability, see Supported Node Types\n
\n\n M5 node types:\n \t\t\t\t\t\t cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n \t\t\t\t\t\t\n \t\t\t\t\t\t\n \t\t\t\t\t\t
\n M4 node types:\n \t\t\t\t\t\t cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n\t\t\t\t\t
\n T3 node types:\n\t\t\t\t\t cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n\t\t\t\t\t cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended)
\n\t\t\t\t\t\t\n T1 node types:\n\t\t\t\t\t cache.t1.micro
\n
\n M1 node types:\n\t\t\t\t\t\t cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n \t\t\t\t\t\t cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\n\n\t\t\t\tPrevious generation: (not recommended)
\n\t\t\t\n C1 node types:\n\t\t\t cache.c1.xlarge
\n
Memory optimized with data tiering:
\n\t\tCurrent generation:
\n\t\t \n\t\t\n R6gd node types (available only for Redis engine version 6.2 onward).
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t \n\t\t cache.r6gd.xlarge
,\n\t\t cache.r6gd.2xlarge
,\n\t\t cache.r6gd.4xlarge
,\n\t\t cache.r6gd.8xlarge
,\n\t\t cache.r6gd.12xlarge
,\n\t\t cache.r6gd.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
Memory optimized:
\n\t\t \n\t\t \n\t\tCurrent generation:
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\t\t \n\t\t \n\t\t \n\t\t\t\n\t\t cache.r6g.large
,\n\t\t cache.r6g.xlarge
,\n\t\t cache.r6g.2xlarge
,\n\t\t cache.r6g.4xlarge
,\n\t\t cache.r6g.8xlarge
,\n\t\t cache.r6g.12xlarge
,\n\t\t cache.r6g.16xlarge
\n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t \n\t\t
For region availability, see Supported Node Types\n
\nFor region availability, see Supported Node Types\n
\n\n R5 node types:\n \t\t\t\t\t cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n \t\t\t\t\t cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended)
\n\n M2 node types:\t\t\t\t\t\t\n \t\t\t\t\t cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n \t\t\t\t\t cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\n\t\tAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The ID of the application.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The EMR release version associated with the application.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "The type of application, such as Spark or Hive.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#ApplicationState", + "traits": { + "smithy.api#documentation": "The state of the application.
", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The state details of the application.
" + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "The initial capacity of the application.
" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "The maximum capacity of the application. This is cumulative across all workers at any\n given point in time during the lifespan of the application is created. No new resources\n will be created once any one of the defined limits is hit.
" + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the application run was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the application run was last updated.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the application.
" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically start on job submission.
" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of time being idle.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for customer VPC connectivity for the application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an application. EMR Serverless uses applications to run jobs.
" + } + }, + "com.amazonaws.emrserverless#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#ApplicationSummary" + } + }, + "com.amazonaws.emrserverless#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._/#-]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId" + } + }, + "create": { + "target": "com.amazonaws.emrserverless#CreateApplication" + }, + "read": { + "target": "com.amazonaws.emrserverless#GetApplication" + }, + "update": { + "target": "com.amazonaws.emrserverless#UpdateApplication" + }, + "delete": { + "target": "com.amazonaws.emrserverless#DeleteApplication" + }, + "list": { + "target": "com.amazonaws.emrserverless#ListApplications" + }, + "operations": [ + { + "target": "com.amazonaws.emrserverless#StartApplication" + }, + { + "target": "com.amazonaws.emrserverless#StopApplication" + } + ] + }, + "com.amazonaws.emrserverless#ApplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + } + ] + } + }, + "com.amazonaws.emrserverless#ApplicationStateSet": { + "type": "set", + "member": { + "target": "com.amazonaws.emrserverless#ApplicationState" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + } + } + }, + "com.amazonaws.emrserverless#ApplicationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The EMR release version associated with the application.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "The type of application, such as Spark or Hive.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#ApplicationState", + "traits": { + "smithy.api#documentation": "The state of the application.
", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The state details of the application.
" + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the application was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the application was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of attributes associated with an application.
" + } + }, + "com.amazonaws.emrserverless#AutoStartConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enables the application to automatically start on job submission. Defaults to true.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically start on job submission.
" + } + }, + "com.amazonaws.emrserverless#AutoStopConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.
" + } + }, + "idleTimeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.
", + "smithy.api#range": { + "min": 1, + "max": 10080 + } + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of time being idle.
" + } + }, + "com.amazonaws.emrserverless#AwsToledoWebService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "EMR Serverless", + "arnNamespace": "emr-serverless" + }, + "aws.auth#sigv4": { + "name": "emr-serverless" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amz-apigw-id" + ] + }, + "smithy.api#documentation": "Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides\n a serverless runtime environment that simplifies running analytics applications using the\n latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless,\n you don’t have to configure, optimize, secure, or operate clusters to run applications with\n these frameworks.
\nThe API reference to Amazon EMR Serverless is emr-serverless
. The\n emr-serverless
prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR Serverless. For example,\n aws emr-serverless start-job-run
.
It is the prefix before IAM policy actions for Amazon EMR Serverless. For example,\n \"Action\": [\"emr-serverless:StartJobRun\"]
. For more information, see\n Policy actions for Amazon EMR Serverless.
It is the prefix used in Amazon EMR Serverless service endpoints. For example,\n emr-serverless.us-east-2.amazonaws.com
.
Cancels a job run.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#CancelJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application on which the job run will be canceled.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run to cancel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#CancelJobRunResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The output contains the application ID on which the job run is cancelled.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The output contains the ID of the cancelled job run.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._-]+$" + } + }, + "com.amazonaws.emrserverless#Configuration": { + "type": "structure", + "members": { + "classification": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#documentation": "The classification within a configuration.
", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.emrserverless#SensitivePropertiesMap", + "traits": { + "smithy.api#documentation": "A set of properties specified within a configuration classification.
" + } + }, + "configurations": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "A list of additional configurations to apply within a configuration object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration specification to be used when provisioning an application. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.
" + } + }, + "com.amazonaws.emrserverless#ConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#Configuration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrserverless#ConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "The override configurations for the application.
" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "The override configurations for monitoring.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration specification to be used to override existing configurations.
" + } + }, + "com.amazonaws.emrserverless#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the\n resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.emrserverless#CpuSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$" + } + }, + "com.amazonaws.emrserverless#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#ConflictException" + }, + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/applications" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#CreateApplicationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The EMR release version associated with the application.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "The type of application you want to start, such as Spark or Hive.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "The client idempotency token of the application to create. Its value must be unique for\n each request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "The capacity to initialize when the application is created.
" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "The maximum capacity to allocate when the application is created. This is cumulative\n across all workers at any given point in time, not just when an application is created. No\n new resources will be created once any one of the defined limits is hit.
" + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the application.
" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically start on job submission.
" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of time being idle.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for customer VPC connectivity.
" + } + } + } + }, + "com.amazonaws.emrserverless#CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The output contains the application ID.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "The output contains the name of the application.
" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "The output contains the ARN of the application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#Date": { + "type": "timestamp" + }, + "com.amazonaws.emrserverless#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an application. An application has to be in a stopped or created state in order\n to be deleted.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#DeleteApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application that will be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#DeleteApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#DiskSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" + } + }, + "com.amazonaws.emrserverless#Duration": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.emrserverless#EncryptionKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.emrserverless#EngineType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.emrserverless#EntryPointArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#EntryPointArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#EntryPointArgument" + } + }, + "com.amazonaws.emrserverless#EntryPointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Displays detailed information about a specified application.
", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#GetApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application that will be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#GetApplicationResponse": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.emrserverless#Application", + "traits": { + "smithy.api#documentation": "The output displays information about the specified application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#GetJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Displays detailed information about a job run.
", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#GetJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application on which the job run is submitted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#GetJobRunResponse": { + "type": "structure", + "members": { + "jobRun": { + "target": "com.amazonaws.emrserverless#JobRun", + "traits": { + "smithy.api#documentation": "The output displays information about the job run.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#Hive": { + "type": "structure", + "members": { + "query": { + "target": "com.amazonaws.emrserverless#Query", + "traits": { + "smithy.api#documentation": "The query for the Hive job run.
", + "smithy.api#required": {} + } + }, + "initQueryFile": { + "target": "com.amazonaws.emrserverless#InitScriptPath", + "traits": { + "smithy.api#documentation": "The query file for the Hive job run.
" + } + }, + "parameters": { + "target": "com.amazonaws.emrserverless#HiveCliParameters", + "traits": { + "smithy.api#documentation": "The parameters for the Hive job run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configurations for the Hive job driver.
" + } + }, + "com.amazonaws.emrserverless#HiveCliParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#IAMRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + } + }, + "com.amazonaws.emrserverless#InitScriptPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#InitialCapacityConfig": { + "type": "structure", + "members": { + "workerCount": { + "target": "com.amazonaws.emrserverless#WorkerCounts", + "traits": { + "smithy.api#documentation": "The number of workers in the initial capacity configuration.
", + "smithy.api#required": {} + } + }, + "workerConfiguration": { + "target": "com.amazonaws.emrserverless#WorkerResourceConfig", + "traits": { + "smithy.api#documentation": "The resource configuration of the initial capacity configuration.
", + "smithy.api#recommended": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The initial capacity configuration per worker.
" + } + }, + "com.amazonaws.emrserverless#InitialCapacityConfigMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrserverless#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request processing failed because of an error or failure with the service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.emrserverless#JobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#JobDriver": { + "type": "union", + "members": { + "sparkSubmit": { + "target": "com.amazonaws.emrserverless#SparkSubmit", + "traits": { + "smithy.api#documentation": "The job driver parameters specified for Spark.
" + } + }, + "hive": { + "target": "com.amazonaws.emrserverless#Hive", + "traits": { + "smithy.api#documentation": "The job driver parameters specified for Hive.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The driver that the job runs on.
" + } + }, + "com.amazonaws.emrserverless#JobRun": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application the job is running on.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The optional job run name. This doesn't have to be unique.
" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "The execution role ARN of the job run.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "The user who created the job run.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the job run was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the job run was updated.
", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The execution role ARN of the job run.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "The state of the job run.
", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The state details of the job run.
", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The EMR release version associated with the application your job is running on.
", + "smithy.api#required": {} + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrserverless#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "The configuration settings that are used to override default configuration.
" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrserverless#JobDriver", + "traits": { + "smithy.api#documentation": "The job driver for the job run.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the job run.
" + } + }, + "totalResourceUtilization": { + "target": "com.amazonaws.emrserverless#TotalResourceUtilization", + "traits": { + "smithy.api#documentation": "The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated,\n rounded up to the nearest second.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration" + }, + "totalExecutionDurationSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED
, FAILED
, or CANCELLED
state.
Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an EMR Serverless application.
" + } + }, + "com.amazonaws.emrserverless#JobRunId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrserverless#JobRunResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId" + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId" + } + }, + "create": { + "target": "com.amazonaws.emrserverless#StartJobRun" + }, + "read": { + "target": "com.amazonaws.emrserverless#GetJobRun" + }, + "delete": { + "target": "com.amazonaws.emrserverless#CancelJobRun" + }, + "list": { + "target": "com.amazonaws.emrserverless#ListJobRuns" + } + }, + "com.amazonaws.emrserverless#JobRunState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SCHEDULED", + "name": "SCHEDULED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLING", + "name": "CANCELLING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.emrserverless#JobRunStateSet": { + "type": "set", + "member": { + "target": "com.amazonaws.emrserverless#JobRunState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8 + } + } + }, + "com.amazonaws.emrserverless#JobRunSummary": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application the job is running on.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "id": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The optional job run name. This doesn't have to be unique.
" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "The ARN of the job run.
", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "The user who created the job run.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the job run was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The date and time when the job run was last updated.
", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The execution role ARN of the job run.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "The state of the job run.
", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The state details of the job run.
", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "The EMR release version associated with the application your job is running on.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#JobRunType", + "traits": { + "smithy.api#documentation": "The type of job run, such as Spark or Hive.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of attributes associated with a job run.
" + } + }, + "com.amazonaws.emrserverless#JobRunType": { + "type": "string" + }, + "com.amazonaws.emrserverless#JobRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#JobRunSummary" + } + }, + "com.amazonaws.emrserverless#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists applications based on a set of parameters.
", + "smithy.api#http": { + "method": "GET", + "uri": "/applications" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "applications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of application results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of applications that can be listed.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "states": { + "target": "com.amazonaws.emrserverless#ApplicationStateSet", + "traits": { + "smithy.api#documentation": "An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
", + "smithy.api#httpQuery": "states" + } + } + } + }, + "com.amazonaws.emrserverless#ListApplicationsResponse": { + "type": "structure", + "members": { + "applications": { + "target": "com.amazonaws.emrserverless#ApplicationList", + "traits": { + "smithy.api#documentation": "The output lists the specified applications.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "The output displays the token for the next set of application results. This is required\n for pagination and is available as a response of the previous request.
" + } + } + } + }, + "com.amazonaws.emrserverless#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists job runs based on a set of parameters.
", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobRuns" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListJobRunsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application for which to list the job run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of job run results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of job runs that can be listed.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "createdAtAfter": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The lower bound of the option to filter by creation date and time.
", + "smithy.api#httpQuery": "createdAtAfter" + } + }, + "createdAtBefore": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "The upper bound of the option to filter by creation date and time.
", + "smithy.api#httpQuery": "createdAtBefore" + } + }, + "states": { + "target": "com.amazonaws.emrserverless#JobRunStateSet", + "traits": { + "smithy.api#documentation": "An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
", + "smithy.api#httpQuery": "states" + } + } + } + }, + "com.amazonaws.emrserverless#ListJobRunsResponse": { + "type": "structure", + "members": { + "jobRuns": { + "target": "com.amazonaws.emrserverless#JobRuns", + "traits": { + "smithy.api#documentation": "The output lists information about the specified job runs.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "The output displays the token for the next set of job run results. This is required for\n pagination and is available as a response of the previous request.
" + } + } + } + }, + "com.amazonaws.emrserverless#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags assigned to the resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + } + }, + "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enables managed logging and defaults to true. If set to false, managed logging will be turned off.
" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key ARN to encrypt the logs stored in managed log persistence.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The managed log persistence configuration for a job run.
" + } + }, + "com.amazonaws.emrserverless#MaximumAllowedResources": { + "type": "structure", + "members": { + "cpu": { + "target": "com.amazonaws.emrserverless#CpuSize", + "traits": { + "smithy.api#documentation": "The maximum allowed CPU for an application.
", + "smithy.api#required": {} + } + }, + "memory": { + "target": "com.amazonaws.emrserverless#MemorySize", + "traits": { + "smithy.api#documentation": "The maximum allowed resources for an application.
", + "smithy.api#required": {} + } + }, + "disk": { + "target": "com.amazonaws.emrserverless#DiskSize", + "traits": { + "smithy.api#documentation": "The maximum allowed disk for an application.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The maximum allowed cumulative resources for an application. No new resources will be\n created once the limit is hit.
" + } + }, + "com.amazonaws.emrserverless#MemorySize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$" + } + }, + "com.amazonaws.emrserverless#MonitoringConfiguration": { + "type": "structure", + "members": { + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#S3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon S3 configuration for monitoring log publishing.
" + } + }, + "managedPersistenceMonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "The managed log persistence configuration for a job run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration setting for monitoring.
" + } + }, + "com.amazonaws.emrserverless#NetworkConfiguration": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.emrserverless#SubnetIds", + "traits": { + "smithy.api#documentation": "The array of subnet Ids for customer VPC connectivity.
" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.emrserverless#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "The array of security group Ids for customer VPC connectivity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The network configuration for customer VPC connectivity.
" + } + }, + "com.amazonaws.emrserverless#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9_=-]+$" + } + }, + "com.amazonaws.emrserverless#Query": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#ReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._/-]+$" + } + }, + "com.amazonaws.emrserverless#RequestIdentityUserArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" + } + }, + "com.amazonaws.emrserverless#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+(\\/jobruns\\/[0-9a-zA-Z]+)?$" + } + }, + "com.amazonaws.emrserverless#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.emrserverless#S3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrserverless#UriString", + "traits": { + "smithy.api#documentation": "The Amazon S3 destination URI for log publishing.
" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 configuration for monitoring log publishing. You can configure your jobs\n to send log information to Amazon S3.
" + } + }, + "com.amazonaws.emrserverless#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#SecurityGroupString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.emrserverless#SecurityGroupString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+" + } + }, + "com.amazonaws.emrserverless#SensitivePropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#String1024" + }, + "value": { + "target": "com.amazonaws.emrserverless#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The maximum number of resources per account has been reached.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.emrserverless#SparkSubmit": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrserverless#EntryPointPath", + "traits": { + "smithy.api#documentation": "The entry point for the Spark submit job run.
", + "smithy.api#required": {} + } + }, + "entryPointArguments": { + "target": "com.amazonaws.emrserverless#EntryPointArguments", + "traits": { + "smithy.api#documentation": "The arguments for the Spark submit job run.
" + } + }, + "sparkSubmitParameters": { + "target": "com.amazonaws.emrserverless#SparkSubmitParameters", + "traits": { + "smithy.api#documentation": "The parameters for the Spark submit job run.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configurations for the Spark submit job driver.
" + } + }, + "com.amazonaws.emrserverless#SparkSubmitParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#StartApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StartApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StartApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a specified application and initializes initial capacity if configured.
", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/start" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StartApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application to start.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#StartApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#ConflictException" + }, + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a job run.
", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/jobruns" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StartJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application on which to run the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "The client idempotency token of the job run to start. Its value must be unique for each\n request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The execution role ARN for the job run.
", + "smithy.api#required": {} + } + }, + "jobDriver": { + "target": "com.amazonaws.emrserverless#JobDriver", + "traits": { + "smithy.api#documentation": "The job driver for the job run.
" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrserverless#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "The configuration overrides for the job run.
" + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the job run.
" + } + }, + "executionTimeoutMinutes": { + "target": "com.amazonaws.emrserverless#Duration", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.
" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "The optional job run name. This doesn't have to be unique.
" + } + } + } + }, + "com.amazonaws.emrserverless#StartJobRunResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "This output displays the application ID on which the job run was submitted.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "The output contains the ID of the started job run.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "The output lists the execution role ARN of the job run.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#StopApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StopApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StopApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a specified application and releases initial capacity if configured. All scheduled\n and running jobs must be completed or cancelled before stopping an application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/stop" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StopApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application to stop.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#StopApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#String1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.emrserverless#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.emrserverless#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#SubnetString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.emrserverless#SubnetString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+" + } + }, + "com.amazonaws.emrserverless#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]+$" + } + }, + "com.amazonaws.emrserverless#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.emrserverless#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#TagKey" + }, + "value": { + "target": "com.amazonaws.emrserverless#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.emrserverless#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag\n consists of a key and an optional value, both of which you define. Tags enable you to\n categorize your AWS resources by attributes such as purpose, owner, or environment. When\n you have many resources of the same type, you can quickly identify a specific resource\n based on the tags you've assigned to it.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.emrserverless#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]*$" + } + }, + "com.amazonaws.emrserverless#TotalResourceUtilization": { + "type": "structure", + "members": { + "vCPUHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The aggregated vCPU used per hour from the time job start executing till the time job is terminated.
" + } + }, + "memoryGBHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The aggregated memory used per hour from the time job start executing till the time job is terminated.
" + } + }, + "storageGBHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The aggregated storage used per hour from the time job start executing till the time job is terminated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated,\n rounded up to the nearest second.
" + } + }, + "com.amazonaws.emrserverless#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from resources.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.emrserverless#TagKeyList", + "traits": { + "smithy.api#documentation": "The keys of the tags to be removed.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a specified application. An application has to be in a stopped or created state\n in order to be updated.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/applications/{applicationId}" + } + } + }, + "com.amazonaws.emrserverless#UpdateApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "The ID of the application to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "The client idempotency token of the application to update. Its value must be unique for\n each request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "The capacity to initialize when the application is updated.
" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "The maximum capacity to allocate when the application is updated. This is cumulative\n across all workers at any given point in time during the lifespan of the application. No\n new resources will be created once any one of the defined limits is hit.
" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically start on job submission.
" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "The configuration for an application to automatically stop after a certain amount of time being idle.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration" + } + } + }, + "com.amazonaws.emrserverless#UpdateApplicationResponse": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.emrserverless#Application", + "traits": { + "smithy.api#documentation": "Information about the updated application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#UriString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" + } + }, + "com.amazonaws.emrserverless#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrserverless#WorkerCounts": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.emrserverless#WorkerResourceConfig": { + "type": "structure", + "members": { + "cpu": { + "target": "com.amazonaws.emrserverless#CpuSize", + "traits": { + "smithy.api#documentation": "The CPU requirements for every worker instance of the worker type.
", + "smithy.api#required": {} + } + }, + "memory": { + "target": "com.amazonaws.emrserverless#MemorySize", + "traits": { + "smithy.api#documentation": "The memory requirements for every worker instance of the worker type.
", + "smithy.api#required": {} + } + }, + "disk": { + "target": "com.amazonaws.emrserverless#DiskSize", + "traits": { + "smithy.api#documentation": "The disk requirements for every worker instance of the worker type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The cumulative configuration requirements for every worker instance of the worker\n type.
" + } + }, + "com.amazonaws.emrserverless#WorkerTypeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" + } + } + } +} diff --git a/aws/sdk/aws-models/finspace-data.json b/aws/sdk/aws-models/finspace-data.json index dd67dfc5e20..37d3e54f9ed 100644 --- a/aws/sdk/aws-models/finspace-data.json +++ b/aws/sdk/aws-models/finspace-data.json @@ -2608,6 +2608,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "changesets", "pageSize": "maxResults" } } @@ -2698,6 +2699,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "dataViews", "pageSize": "maxResults" } } @@ -2785,6 +2787,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "datasets", "pageSize": "maxResults" } } @@ -2864,6 +2867,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "permissionGroups", "pageSize": "maxResults" } } @@ -2937,6 +2941,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "users", "pageSize": "maxResults" } } @@ -3229,7 +3234,7 @@ } }, "traits": { - "smithy.api#documentation": "Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.
\nThe following is a list of valid dataset permissions that you can apply:\n \n
\n\n ViewDatasetDetails
\n
\n ReadDatasetDetails
\n
\n AddDatasetData
\n
\n CreateSnapshot
\n
\n EditDatasetMetadata
\n
\n DeleteDataset
\n
For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
" + "smithy.api#documentation": "Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.
\nThe following is a list of valid dataset permissions that you can apply:\n \n
\n\n ViewDatasetDetails
\n
\n ReadDatasetDetails
\n
\n AddDatasetData
\n
\n CreateDataView
\n
\n EditDatasetMetadata
\n
\n DeleteDataset
\n
For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
" } }, "com.amazonaws.finspacedata#ResourcePermissionsList": { diff --git a/aws/sdk/aws-models/forecast.json b/aws/sdk/aws-models/forecast.json index 50182d1a4b6..aea7d46449c 100644 --- a/aws/sdk/aws-models/forecast.json +++ b/aws/sdk/aws-models/forecast.json @@ -42,12 +42,12 @@ "Configuration": { "target": "com.amazonaws.forecast#Configuration", "traits": { - "smithy.api#documentation": "\n Weather Index\n
\nTo enable the Weather Index, do not specify a value for\n Configuration
.
\n Holidays\n
\nTo enable Holidays, set CountryCode
to one of the following two-letter country\n codes:
\"AL\" - ALBANIA
\n\"AR\" - ARGENTINA
\n\"AT\" - AUSTRIA
\n\"AU\" - AUSTRALIA
\n\"BA\" - BOSNIA HERZEGOVINA
\n\"BE\" - BELGIUM
\n\"BG\" - BULGARIA
\n\"BO\" - BOLIVIA
\n\"BR\" - BRAZIL
\n\"BY\" - BELARUS
\n\"CA\" - CANADA
\n\"CL\" - CHILE
\n\"CO\" - COLOMBIA
\n\"CR\" - COSTA RICA
\n\"HR\" - CROATIA
\n\"CZ\" - CZECH REPUBLIC
\n\"DK\" - DENMARK
\n\"EC\" - ECUADOR
\n\"EE\" - ESTONIA
\n\"ET\" - ETHIOPIA
\n\"FI\" - FINLAND
\n\"FR\" - FRANCE
\n\"DE\" - GERMANY
\n\"GR\" - GREECE
\n\"HU\" - HUNGARY
\n\"IS\" - ICELAND
\n\"IN\" - INDIA
\n\"IE\" - IRELAND
\n\"IT\" - ITALY
\n\"JP\" - JAPAN
\n\"KZ\" - KAZAKHSTAN
\n\"KR\" - KOREA
\n\"LV\" - LATVIA
\n\"LI\" - LIECHTENSTEIN
\n\"LT\" - LITHUANIA
\n\"LU\" - LUXEMBOURG
\n\"MK\" - MACEDONIA
\n\"MT\" - MALTA
\n\"MX\" - MEXICO
\n\"MD\" - MOLDOVA
\n\"ME\" - MONTENEGRO
\n\"NL\" - NETHERLANDS
\n\"NZ\" - NEW ZEALAND
\n\"NI\" - NICARAGUA
\n\"NG\" - NIGERIA
\n\"NO\" - NORWAY
\n\"PA\" - PANAMA
\n\"PY\" - PARAGUAY
\n\"PE\" - PERU
\n\"PL\" - POLAND
\n\"PT\" - PORTUGAL
\n\"RO\" - ROMANIA
\n\"RU\" - RUSSIA
\n\"RS\" - SERBIA
\n\"SK\" - SLOVAKIA
\n\"SI\" - SLOVENIA
\n\"ZA\" - SOUTH AFRICA
\n\"ES\" - SPAIN
\n\"SE\" - SWEDEN
\n\"CH\" - SWITZERLAND
\n\"UA\" - UKRAINE
\n\"AE\" - UNITED ARAB EMIRATES
\n\"US\" - UNITED STATES
\n\"UK\" - UNITED KINGDOM
\n\"UY\" - URUGUAY
\n\"VE\" - VENEZUELA
\n\n Weather Index\n
\nTo enable the Weather Index, do not specify a value for\n Configuration
.
\n Holidays\n
\n\n\n Holidays\n
\nTo enable Holidays, set CountryCode
to one of the following two-letter\n country codes:
\"AL\" - ALBANIA
\n\"AR\" - ARGENTINA
\n\"AT\" - AUSTRIA
\n\"AU\" - AUSTRALIA
\n\"BA\" - BOSNIA HERZEGOVINA
\n\"BE\" - BELGIUM
\n\"BG\" - BULGARIA
\n\"BO\" - BOLIVIA
\n\"BR\" - BRAZIL
\n\"BY\" - BELARUS
\n\"CA\" - CANADA
\n\"CL\" - CHILE
\n\"CO\" - COLOMBIA
\n\"CR\" - COSTA RICA
\n\"HR\" - CROATIA
\n\"CZ\" - CZECH REPUBLIC
\n\"DK\" - DENMARK
\n\"EC\" - ECUADOR
\n\"EE\" - ESTONIA
\n\"ET\" - ETHIOPIA
\n\"FI\" - FINLAND
\n\"FR\" - FRANCE
\n\"DE\" - GERMANY
\n\"GR\" - GREECE
\n\"HU\" - HUNGARY
\n\"IS\" - ICELAND
\n\"IN\" - INDIA
\n\"IE\" - IRELAND
\n\"IT\" - ITALY
\n\"JP\" - JAPAN
\n\"KZ\" - KAZAKHSTAN
\n\"KR\" - KOREA
\n\"LV\" - LATVIA
\n\"LI\" - LIECHTENSTEIN
\n\"LT\" - LITHUANIA
\n\"LU\" - LUXEMBOURG
\n\"MK\" - MACEDONIA
\n\"MT\" - MALTA
\n\"MX\" - MEXICO
\n\"MD\" - MOLDOVA
\n\"ME\" - MONTENEGRO
\n\"NL\" - NETHERLANDS
\n\"NZ\" - NEW ZEALAND
\n\"NI\" - NICARAGUA
\n\"NG\" - NIGERIA
\n\"NO\" - NORWAY
\n\"PA\" - PANAMA
\n\"PY\" - PARAGUAY
\n\"PE\" - PERU
\n\"PL\" - POLAND
\n\"PT\" - PORTUGAL
\n\"RO\" - ROMANIA
\n\"RU\" - RUSSIA
\n\"RS\" - SERBIA
\n\"SK\" - SLOVAKIA
\n\"SI\" - SLOVENIA
\n\"ZA\" - SOUTH AFRICA
\n\"ES\" - SPAIN
\n\"SE\" - SWEDEN
\n\"CH\" - SWITZERLAND
\n\"UA\" - UKRAINE
\n\"AE\" - UNITED ARAB EMIRATES
\n\"US\" - UNITED STATES
\n\"UK\" - UNITED KINGDOM
\n\"UY\" - URUGUAY
\n\"VE\" - VENEZUELA
\nDescribes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.
\n\n Weather Index\n
\nThe Amazon Forecast Weather Index is a built-in dataset that incorporates historical and\n projected weather information into your model. The Weather Index supplements your\n datasets with over two years of historical weather data and up to 14 days of projected\n weather data. For more information, see Amazon Forecast\n Weather Index.
\n\n Holidays\n
\nHolidays is a built-in dataset that incorporates national holiday information into\n your model. It provides native support for the holiday calendars of 66 countries. To\n view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays\n Featurization.
" + "smithy.api#documentation": "Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.
\n\n Weather Index\n
\nThe Amazon Forecast Weather Index is a built-in dataset that incorporates historical and\n projected weather information into your model. The Weather Index supplements your\n datasets with over two years of historical weather data and up to 14 days of projected\n weather data. For more information, see Amazon Forecast\n Weather Index.
\n\n Holidays\n
\nHolidays is a built-in dataset that incorporates national holiday information into\n your model. It provides native support for the holiday calendars of 66 countries. To\n view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays\n Featurization.
" } }, "com.amazonaws.forecast#AdditionalDatasets": { @@ -105,6 +105,9 @@ { "target": "com.amazonaws.forecast#CreateForecastExportJob" }, + { + "target": "com.amazonaws.forecast#CreateMonitor" + }, { "target": "com.amazonaws.forecast#CreatePredictor" }, @@ -132,6 +135,9 @@ { "target": "com.amazonaws.forecast#DeleteForecastExportJob" }, + { + "target": "com.amazonaws.forecast#DeleteMonitor" + }, { "target": "com.amazonaws.forecast#DeletePredictor" }, @@ -165,6 +171,9 @@ { "target": "com.amazonaws.forecast#DescribeForecastExportJob" }, + { + "target": "com.amazonaws.forecast#DescribeMonitor" + }, { "target": "com.amazonaws.forecast#DescribePredictor" }, @@ -195,6 +204,12 @@ { "target": "com.amazonaws.forecast#ListForecasts" }, + { + "target": "com.amazonaws.forecast#ListMonitorEvaluations" + }, + { + "target": "com.amazonaws.forecast#ListMonitors" + }, { "target": "com.amazonaws.forecast#ListPredictorBacktestExportJobs" }, @@ -204,6 +219,9 @@ { "target": "com.amazonaws.forecast#ListTagsForResource" }, + { + "target": "com.amazonaws.forecast#ResumeResource" + }, { "target": "com.amazonaws.forecast#StopResource" }, @@ -253,7 +271,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the method used to transform attributes.
\nThe following is an example using the RETAIL domain:
\n\n {
\n
\n \"AttributeName\": \"demand\",
\n
\n \"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\":\n \"zero\"}
\n
\n }
\n
Provides information about the method used to transform attributes.
\nThe following is an example using the RETAIL domain:
\n\n {
\n
\n \"AttributeName\": \"demand\",
\n
\n \"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\":\n \"zero\"}
\n
\n }
\n
The initial accuracy metrics for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you\n use your predictor and the metrics change.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.
" + } + }, + "com.amazonaws.forecast#BaselineMetric": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "Value": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "The value for the metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An individual metric that you can use for comparison as you evaluate your monitoring results.
" + } + }, + "com.amazonaws.forecast#BaselineMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#BaselineMetric" + } + }, "com.amazonaws.forecast#Boolean": { "type": "boolean", "traits": { @@ -432,7 +490,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Forecast predictor.
\nAmazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.
\n\n Creating new predictors\n
\nThe following parameters are required when creating a new predictor:
\n\n PredictorName
- A unique name for the predictor.
\n DatasetGroupArn
- The ARN of the dataset group used to train the\n predictor.
\n ForecastFrequency
- The granularity of your forecasts (hourly,\n daily, weekly, etc).
\n ForecastHorizon
- The number of time steps being\n forecasted.
When creating a new predictor, do not specify a value for\n ReferencePredictorArn
.
\n Upgrading and retraining predictors\n
\nThe following parameters are required when retraining or upgrading a predictor:
\n\n PredictorName
- A unique name for the predictor.
\n ReferencePredictorArn
- The ARN of the predictor to retrain or\n upgrade.
When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn
and PredictorName
.
Creates an Amazon Forecast predictor.
\nAmazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain\n existing predictors.
\n\n\n Creating new predictors\n
\n\nThe following parameters are required when creating a new predictor:
\n\n PredictorName
- A unique name for the predictor.
\n DatasetGroupArn
- The ARN of the dataset group used to train the\n predictor.
\n ForecastFrequency
- The granularity of your forecasts (hourly,\n daily, weekly, etc).
\n ForecastHorizon
- The number of time-steps that the model\n predicts. The forecast horizon is also called the prediction length.
When creating a new predictor, do not specify a value for\n ReferencePredictorArn
.
\n Upgrading and retraining predictors\n
\nThe following parameters are required when retraining or upgrading a predictor:
\n\n PredictorName
- A unique name for the predictor.
\n ReferencePredictorArn
- The ARN of the predictor to retrain or\n upgrade.
When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn
and PredictorName
.
The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length.
" + "smithy.api#documentation": "The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length.
\nThe maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the\n TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then\n the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the\n TARGET_TIME_SERIES dataset length.
\nIf you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you\n cannot update the forecast horizon parameter. You can meet this requirement by providing\n longer time-series in the dataset.
" } }, "ForecastTypes": { @@ -501,6 +559,18 @@ "traits": { "smithy.api#documentation": "Optional metadata to help you categorize and organize your predictors. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.
\nThe following restrictions apply to tags:
\nFor each resource, each tag key must be unique and each tag key must have one\n value.
\nMaximum number of tags per resource: 50.
\nMaximum key length: 128 Unicode characters in UTF-8.
\nMaximum value length: 256 Unicode characters in UTF-8.
\nAccepted characters: all letters and numbers, spaces representable in UTF-8,\n and + - = . _ : / @. If your tagging schema is used across other services and\n resources, the character restrictions of those services also apply.
\nKey prefixes cannot include any upper or lowercase combination of\n aws:
or AWS:
. Values can have this prefix. If a\n tag value has aws
as its prefix but the key does not, Forecast\n considers it to be a user tag and will count against the limit of 50 tags. Tags\n with only the key prefix of aws
do not count against your tags per\n resource limit. You cannot edit or delete tag keys with this prefix.
The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.
\nPredictor monitoring allows you to see how your predictor's performance changes over time.\n For more information, see Predictor Monitoring.
" + } + }, + "TimeAlignmentBoundary": { + "target": "com.amazonaws.forecast#TimeAlignmentBoundary", + "traits": { + "smithy.api#documentation": "The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair. \n For more information on specifying a time boundary, see Specifying a Time Boundary.\n If you\n don't provide a time boundary, Forecast uses a set of Default Time Boundaries.
" + } } } }, @@ -535,7 +605,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Forecast dataset. The information about the dataset that you provide helps\n Forecast understand how to consume the data for model training. This includes the\n following:
\n\n \n DataFrequency
\n - How frequently your historical\n time-series data is collected.
\n \n Domain
\n and\n \n DatasetType
\n - Each dataset has an associated dataset\n domain and a type within the domain. Amazon Forecast provides a list of predefined domains and\n types within each domain. For each unique dataset domain and type within the domain,\n Amazon Forecast requires your data to include a minimum set of predefined fields.
\n \n Schema
\n - A schema specifies the fields in the dataset,\n including the field name and data type.
After creating a dataset, you import your training data into it and add the dataset to a\n dataset group. You use the dataset group to create a predictor. For more information, see\n howitworks-datasets-groups.
\nTo get a list of all your datasets, use the ListDatasets\n operation.
\nFor example Forecast datasets, see the Amazon Forecast Sample GitHub\n repository.
\nThe Status
of a dataset must be ACTIVE
before you can import\n training data. Use the DescribeDataset operation to get the status.
Creates an Amazon Forecast dataset. The information about the dataset that you provide helps\n Forecast understand how to consume the data for model training. This includes the\n following:
\n\n \n DataFrequency
\n - How frequently your historical\n time-series data is collected.
\n \n Domain
\n and\n \n DatasetType
\n - Each dataset has an associated dataset\n domain and a type within the domain. Amazon Forecast provides a list of predefined domains and\n types within each domain. For each unique dataset domain and type within the domain,\n Amazon Forecast requires your data to include a minimum set of predefined fields.
\n \n Schema
\n - A schema specifies the fields in the dataset,\n including the field name and data type.
After creating a dataset, you import your training data into it and add the dataset to a\n dataset group. You use the dataset group to create a predictor. For more information, see\n Importing datasets.
\nTo get a list of all your datasets, use the ListDatasets operation.
\nFor example Forecast datasets, see the Amazon Forecast Sample GitHub\n repository.
\nThe Status
of a dataset must be ACTIVE
before you can import\n training data. Use the DescribeDataset operation to get\n the status.
Creates a dataset group, which holds a collection of related datasets. You can add\n datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
\nAfter creating a dataset group and adding datasets, you use the dataset group when you\n create a predictor. For more information, see howitworks-datasets-groups.
\nTo get a list of all your datasets groups, use the ListDatasetGroups\n operation.
\nThe Status
of a dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
Creates a dataset group, which holds a collection of related datasets. You can add\n datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
\nAfter creating a dataset group and adding datasets, you use the dataset group when you\n create a predictor. For more information, see Dataset groups.
\nTo get a list of all your datasets groups, use the ListDatasetGroups\n operation.
\nThe Status
of a dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
The domain associated with the dataset group. When you add a dataset to a dataset group,\n this value and the value specified for the Domain
parameter of the CreateDataset operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in training data that you import to a dataset. For example, if you choose\n the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires that item_id
,\n timestamp
, and demand
fields are present in your data. For more\n information, see howitworks-datasets-groups.
The domain associated with the dataset group. When you add a dataset to a dataset group,\n this value and the value specified for the Domain
parameter of the CreateDataset\n operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in training data that you import to a dataset. For example, if you choose\n the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires that item_id
,\n timestamp
, and demand
fields are present in your data. For more\n information, see Dataset groups.
Imports your training data to an Amazon Forecast dataset. You provide the location of your\n training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset\n that you want to import the data to.
\nYou must specify a DataSource object that includes an AWS Identity and Access Management (IAM)\n role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and\n processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.
\nThe training data must be in CSV format. The delimiter must be a comma (,).
\nYou can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3\n bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000\n files.
\n\n\nBecause dataset imports are not aggregated, your most recent dataset import is the one\n that is used when training a predictor or generating a forecast. Make sure that your most\n recent dataset import contains all of the data you want to model off of, and not just the new\n data collected since the previous import.
\n\n\nTo get a list of all your dataset import jobs, filtered by specified criteria, use the\n ListDatasetImportJobs operation.
" + "smithy.api#documentation": "Imports your training data to an Amazon Forecast dataset. You provide the location of your\n training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset\n that you want to import the data to.
\nYou must specify a DataSource object that includes an\n AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy\n of your data and processes it in an internal AWS system. For more information, see Set up\n permissions.
\nThe training data must be in CSV format. The delimiter must be a comma (,).
\nYou can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3\n bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000\n files.
\n\n\nBecause dataset imports are not aggregated, your most recent dataset import is the one\n that is used when training a predictor or generating a forecast. Make sure that your most\n recent dataset import contains all of the data you want to model off of, and not just the new\n data collected since the previous import.
\n\n\nTo get a list of all your dataset import jobs, filtered by specified criteria, use the\n ListDatasetImportJobs operation.
" } }, "com.amazonaws.forecast#CreateDatasetImportJobRequest": { @@ -658,7 +728,7 @@ "DataSource": { "target": "com.amazonaws.forecast#DataSource", "traits": { - "smithy.api#documentation": "The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.
\nIf encryption is used, DataSource
must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig
parameter of the CreateDataset operation.
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.
\nIf encryption is used, DataSource
must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig
parameter of the CreateDataset\n operation.
The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires item_id
, timestamp
,\n and demand
fields to be present in your data. For more information, see howitworks-datasets-groups.
The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires item_id
, timestamp
,\n and demand
fields to be present in your data. For more information, see Importing\n datasets.
The schema for the dataset. The schema attributes and their order must match the fields in\n your data. The dataset Domain
and DatasetType
that you choose\n determine the minimum required fields in your training data. For information about the\n required fields for a specific dataset domain and type, see howitworks-domains-ds-types.
The schema for the dataset. The schema attributes and their order must match the fields in\n your data. The dataset Domain
and DatasetType
that you choose\n determine the minimum required fields in your training data. For information about the\n required fields for a specific dataset domain and type, see Dataset Domains and Dataset\n Types.
Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)
\nCreates an Amazon Forecast Explainability.
\nExplainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.
\nTo enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.
\nCreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.
\n\n CreateExplainability with a Predictor ARN\n
\nYou can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor
in CreateAutoPredictor, that\n predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName
- A unique name for the Explainability.
\n ResourceArn
- The Arn of the predictor.
\n TimePointGranularity
- Must be set to “ALL”.
\n TimeSeriesGranularity
- Must be set to “ALL”.
Do not specify a value for the following parameters:
\n\n DataSource
- Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n Schema
- Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n StartDateTime
- Only valid when TimePointGranularity is\n “SPECIFIC”.
\n EndDateTime
- Only valid when TimePointGranularity is\n “SPECIFIC”.
\n CreateExplainability with a Forecast ARN\n
\nYou can specify a maximum of 50 time series and 500 time points.
\nThe following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName
- A unique name for the Explainability.
\n ResourceArn
- The Arn of the forecast.
\n TimePointGranularity
- Either “ALL” or “SPECIFIC”.
\n TimeSeriesGranularity
- Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n DataSource
- The S3 location of the CSV file specifying your time\n series.
\n Schema
- The Schema defines the attributes and attribute types\n listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n StartDateTime
- The first timestamp in the range of time\n points.
\n EndDateTime
- The last timestamp in the range of time\n points.
Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)
\nCreates an Amazon Forecast Explainability.
\nExplainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.
\nTo enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.
\nCreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.
\n\n CreateExplainability with a Predictor ARN\n
\nYou can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor
in CreateAutoPredictor, that\n predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName
- A unique name for the Explainability.
\n ResourceArn
- The Arn of the predictor.
\n TimePointGranularity
- Must be set to “ALL”.
\n TimeSeriesGranularity
- Must be set to “ALL”.
Do not specify a value for the following parameters:
\n\n DataSource
- Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n Schema
- Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n StartDateTime
- Only valid when TimePointGranularity is\n “SPECIFIC”.
\n EndDateTime
- Only valid when TimePointGranularity is\n “SPECIFIC”.
\n CreateExplainability with a Forecast ARN\n
\nYou can specify a maximum of 50 time series and 500 time points.
\nThe following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName
- A unique name for the Explainability.
\n ResourceArn
- The Arn of the forecast.
\n TimePointGranularity
- Either “ALL” or “SPECIFIC”.
\n TimeSeriesGranularity
- Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n DataSource
- The S3 location of the CSV file specifying your time\n series.
\n Schema
- The Schema defines the attributes and attribute types\n listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n StartDateTime
- The first timestamp in the range of time\n points.
\n EndDateTime
- The last timestamp in the range of time\n points.
Create an Expainability visualization that is viewable within the AWS console.
" + "smithy.api#documentation": "Create an Explainability visualization that is viewable within the AWS console.
" } }, "StartDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "If TimePointGranularity
is set to SPECIFIC
, define the first\n point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
" + "smithy.api#documentation": "If TimePointGranularity
is set to SPECIFIC
, define the first\n point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:\n 2015-01-01T20:00:00)
" } }, "EndDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "If TimePointGranularity
is set to SPECIFIC
, define the last\n time point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
" + "smithy.api#documentation": "If TimePointGranularity
is set to SPECIFIC
, define the last\n time point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:\n 2015-01-01T20:00:00)
" } }, "Tags": { @@ -1055,7 +1125,7 @@ "ForecastTypes": { "target": "com.amazonaws.forecast#ForecastTypes", "traits": { - "smithy.api#documentation": "The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"]
.
The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial).\n
The default quantiles are the quantiles you specified during predictor creation.\n If you didn't specify quantiles, the default values are [\"0.1\", \"0.5\", \"0.9\"]
.\n
Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time.\n For more information, see Predictor Monitoring.\n
" + } + }, + "com.amazonaws.forecast#CreateMonitorRequest": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "The name of the monitor resource.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor to monitor.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "A list of tags to apply to the monitor resource.
" + } + } + } + }, + "com.amazonaws.forecast#CreateMonitorResponse": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource.
" + } + } + } + }, "com.amazonaws.forecast#CreatePredictor": { "type": "operation", "input": { @@ -1368,12 +1503,12 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime
is the current time of the ListDatasetGroups
\n call.
When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime
is the current time of the ListDatasetGroups
\n call.
Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the\n DescribeDatasetGroup operation, and provide the\n DatasetGroupArn
.
Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To\n get the complete set of properties, call the DescribeDatasetGroup\n operation, and provide the DatasetGroupArn
.
Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the\n DescribeDatasetImportJob operation, and provide the\n DatasetImportJobArn
.
Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the\n DescribeDatasetImportJob operation, and provide the\n DatasetImportJobArn
.
When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the ListDatasets
call.\n After a CreateDatasetImportJob operation has finished,\n LastModificationTime
is when the import job completed or failed.
When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the ListDatasets
call.\n After a CreateDatasetImportJob operation has finished, LastModificationTime
is\n when the import job completed or failed.
Provides a summary of the dataset properties used in the ListDatasets\n operation. To get the complete set of properties, call the DescribeDataset\n operation, and provide the DatasetArn
.
Provides a summary of the dataset properties used in the ListDatasets operation. To get the\n complete set of properties, call the DescribeDataset operation, and\n provide the DatasetArn
.
Deletes an Amazon Forecast dataset that was created using the CreateDataset\n operation. You can only delete datasets that have a status of ACTIVE
or\n CREATE_FAILED
. To get the status use the DescribeDataset\n operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset.\n In order to update the dataset group, use the \n operation, omitting the deleted dataset's ARN.
\nDeletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can\n only delete datasets that have a status of ACTIVE
or CREATE_FAILED
.\n To get the status use the DescribeDataset operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset.\n In order to update the dataset group, use the UpdateDatasetGroup operation,\n omitting the deleted dataset's ARN.
\nDeletes a dataset group created using the CreateDatasetGroup operation.\n You can only delete dataset groups that have a status of ACTIVE
,\n CREATE_FAILED
, or UPDATE_FAILED
. To get the status, use the DescribeDatasetGroup operation.
This operation deletes only the dataset group, not the datasets in the group.
", + "smithy.api#documentation": "Deletes a dataset group created using the CreateDatasetGroup operation.\n You can only delete dataset groups that have a status of ACTIVE
,\n CREATE_FAILED
, or UPDATE_FAILED
. To get the status, use the DescribeDatasetGroup operation.
This operation deletes only the dataset group, not the datasets in the group.
", "smithy.api#idempotent": {} } }, @@ -1566,6 +1752,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteDatasetImportJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1578,7 +1767,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a dataset import job created using the CreateDatasetImportJob\n operation. You can delete only dataset import jobs that have a status of ACTIVE
\n or CREATE_FAILED
. To get the status, use the DescribeDatasetImportJob operation.
Deletes a dataset import job created using the CreateDatasetImportJob\n operation. You can delete only dataset import jobs that have a status of ACTIVE
\n or CREATE_FAILED
. To get the status, use the DescribeDatasetImportJob\n operation.
Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE
, ACTIVE_STOPPED
, CREATE_FAILED
, or CREATE_STOPPED
.
The Amazon Resource Name (ARN) of the monitor resource to delete.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.forecast#DeletePredictor": { "type": "operation", "input": { "target": "com.amazonaws.forecast#DeletePredictorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1764,6 +2004,9 @@ "input": { "target": "com.amazonaws.forecast#DeletePredictorBacktestExportJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1809,6 +2052,9 @@ "input": { "target": "com.amazonaws.forecast#DeleteResourceTreeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -1906,7 +2152,7 @@ "ForecastDimensions": { "target": "com.amazonaws.forecast#ForecastDimensions", "traits": { - "smithy.api#documentation": "An array of dimension (field) names that specify the attributes used to group your time series.
" + "smithy.api#documentation": "An array of dimension (field) names that specify the attributes used to group your\n time series.
" } }, "DatasetImportJobArns": { @@ -1939,7 +2185,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "The status of the predictor. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the predictor. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
Provides the status and ARN of the Predictor Explainability.
" } + }, + "MonitorInfo": { + "target": "com.amazonaws.forecast#MonitorInfo", + "traits": { + "smithy.api#documentation": "A object with the Amazon Resource Name (ARN) and status of the monitor resource.
" + } + }, + "TimeAlignmentBoundary": { + "target": "com.amazonaws.forecast#TimeAlignmentBoundary", + "traits": { + "smithy.api#documentation": "The time boundary Forecast uses when aggregating data.
" + } } } }, @@ -1991,7 +2249,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an Amazon Forecast dataset created using the CreateDataset\n operation.
\nIn addition to listing the parameters specified in the CreateDataset
request,\n this operation includes the following dataset properties:
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
Describes an Amazon Forecast dataset created using the CreateDataset operation.
\nIn addition to listing the parameters specified in the CreateDataset
request,\n this operation includes the following dataset properties:
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
Describes a dataset group created using the CreateDatasetGroup\n operation.
\nIn addition to listing the parameters provided in the CreateDatasetGroup
\n request, this operation includes the following properties:
\n DatasetArns
- The datasets belonging to the group.
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
Describes a dataset group created using the CreateDatasetGroup\n operation.
\nIn addition to listing the parameters provided in the CreateDatasetGroup
\n request, this operation includes the following properties:
\n DatasetArns
- The datasets belonging to the group.
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
The status of the dataset group. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply when you call the UpdateDatasetGroup operation.
The Status
of the dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor.
The status of the dataset group. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply when you call the UpdateDatasetGroup\n operation.
The Status
of the dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor.
When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime
is the current time of the\n DescribeDatasetGroup
call.
When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime
is the current time of the\n DescribeDatasetGroup
call.
Describes a dataset import job created using the CreateDatasetImportJob\n operation.
\nIn addition to listing the parameters provided in the CreateDatasetImportJob
\n request, this operation includes the following properties:
\n CreationTime
\n
\n LastModificationTime
\n
\n DataSize
\n
\n FieldStatistics
\n
\n Status
\n
\n Message
- If an error occurred, information about the error.
Describes a dataset import job created using the CreateDatasetImportJob\n operation.
\nIn addition to listing the parameters provided in the CreateDatasetImportJob
\n request, this operation includes the following properties:
\n CreationTime
\n
\n LastModificationTime
\n
\n DataSize
\n
\n FieldStatistics
\n
\n Status
\n
\n Message
- If an error occurred, information about the error.
The status of the dataset. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset\n import job. For example, when the import job status is CREATE_IN_PROGRESS
, the\n status of the dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import\n training data.
The status of the dataset. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset import job.\n For example, when the import job status is CREATE_IN_PROGRESS
, the status of the\n dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import\n training data.
When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the DescribeDataset
\n call. After a CreateDatasetImportJob operation has finished,\n LastModificationTime
is when the import job completed or failed.
When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the DescribeDataset
\n call. After a CreateDatasetImportJob\n operation has finished, LastModificationTime
is when the import job completed or\n failed.
The status of the Explainability export. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability export. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability resource. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability resource. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.
\nDescribes a predictor created using the CreatePredictor\n operation.
\nIn addition to listing the properties provided in the CreatePredictor
\n request, this operation lists the following properties:
\n DatasetImportJobArns
- The dataset import jobs used to import training\n data.
\n AutoMLAlgorithmArns
- If AutoML is performed, the algorithms that were\n evaluated.
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
\n Message
- If an error occurred, information about the error.
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
\nIn addition to listing the properties provided by the user in the\n CreatePredictorBacktestExportJob
request, this operation lists the\n following properties:
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
\n Message
(if an error occurred)
Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:
\n\n Baseline
\n
\n CreationTime
\n
\n LastEvaluationTime
\n
\n LastEvaluationState
\n
\n LastModificationTime
\n
\n Message
\n
\n Status
\n
The Amazon Resource Name (ARN) of the predictor backtest export job.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource to describe.
", "smithy.api#required": {} } } } }, - "com.amazonaws.forecast#DescribePredictorBacktestExportJobResponse": { + "com.amazonaws.forecast#DescribeMonitorResponse": { "type": "structure", "members": { - "PredictorBacktestExportJobArn": { - "target": "com.amazonaws.forecast#Arn", + "MonitorName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor backtest export job.
" + "smithy.api#documentation": "The name of the monitor.
" } }, - "PredictorBacktestExportJobName": { - "target": "com.amazonaws.forecast#Name", + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The name of the predictor backtest export job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource described.
" } }, - "PredictorArn": { + "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the auto predictor being monitored.
" } }, - "Destination": { - "target": "com.amazonaws.forecast#DataDestination" + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "The status of the monitor resource.
" + } }, - "Message": { - "target": "com.amazonaws.forecast#Message", + "LastEvaluationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "Information about any errors that may have occurred during the backtest export.
" + "smithy.api#documentation": "The timestamp of the latest evaluation completed by the monitor.
" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "LastEvaluationState": { + "target": "com.amazonaws.forecast#EvaluationState", "traits": { - "smithy.api#documentation": "The status of the predictor backtest export job. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The state of the monitor's latest evaluation.
" + } + }, + "Baseline": { + "target": "com.amazonaws.forecast#Baseline", + "traits": { + "smithy.api#documentation": "Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.
" + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "An error message, if any, for the monitor.
" } }, "CreationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "When the predictor backtest export job was created.
" + "smithy.api#documentation": "The timestamp for when the monitor resource was created.
" } }, "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The last time the resource was modified. The timestamp depends on the status of the\n job:
\n\n CREATE_PENDING
- The CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n CREATE_STOPPING
- The current timestamp.
\n CREATE_STOPPED
- When the job stopped.
\n ACTIVE
or CREATE_FAILED
- When the job finished or\n failed.
The timestamp of the latest modification to the monitor.
" + } + }, + "EstimatedEvaluationTimeRemainingInMinutes": { + "target": "com.amazonaws.forecast#Long", + "traits": { + "smithy.api#documentation": "The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
" } } } }, - "com.amazonaws.forecast#DescribePredictorRequest": { - "type": "structure", - "members": { - "PredictorArn": { - "target": "com.amazonaws.forecast#Arn", + "com.amazonaws.forecast#DescribePredictor": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DescribePredictorRequest" + }, + "output": { + "target": "com.amazonaws.forecast#DescribePredictorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.
\nDescribes a predictor created using the CreatePredictor\n operation.
\nIn addition to listing the properties provided in the CreatePredictor
\n request, this operation lists the following properties:
\n DatasetImportJobArns
- The dataset import jobs used to import training\n data.
\n AutoMLAlgorithmArns
- If AutoML is performed, the algorithms that were\n evaluated.
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
\n Message
- If an error occurred, information about the error.
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
\nIn addition to listing the properties provided by the user in the\n CreatePredictorBacktestExportJob
request, this operation lists the\n following properties:
\n CreationTime
\n
\n LastModificationTime
\n
\n Status
\n
\n Message
(if an error occurred)
The Amazon Resource Name (ARN) of the predictor backtest export job.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#DescribePredictorBacktestExportJobResponse": { + "type": "structure", + "members": { + "PredictorBacktestExportJobArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor backtest export job.
" + } + }, + "PredictorBacktestExportJobName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "The name of the predictor backtest export job.
" + } + }, + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor.
" + } + }, + "Destination": { + "target": "com.amazonaws.forecast#DataDestination" + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "Information about any errors that may have occurred during the backtest export.
" + } + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "The status of the predictor backtest export job. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
When the predictor backtest export job was created.
" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The last time the resource was modified. The timestamp depends on the status of the\n job:
\n\n CREATE_PENDING
- The CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n CREATE_STOPPING
- The current timestamp.
\n CREATE_STOPPED
- When the job stopped.
\n ACTIVE
or CREATE_FAILED
- When the job finished or\n failed.
The Amazon Resource Name (ARN) of the predictor that you want information about.
", "smithy.api#required": {} @@ -2928,6 +3290,15 @@ } } }, + "com.amazonaws.forecast#Detail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.forecast#Domain": { "type": "string", "traits": { @@ -3078,6 +3449,15 @@ "smithy.api#documentation": "The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.
" } }, + "com.amazonaws.forecast#EvaluationState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.forecast#EvaluationType": { "type": "string", "traits": { @@ -3118,7 +3498,7 @@ } }, "traits": { - "smithy.api#documentation": "The ExplainabilityConfig data type defines the number of time series and time points\n included in CreateExplainability.
\nIf you provide a predictor ARN for ResourceArn
, you must set both\n TimePointGranularity
and TimeSeriesGranularity
to “ALL”.\n When creating Predictor Explainability, Amazon Forecast considers all time series and\n time points.
If you provide a forecast ARN for ResourceArn
, you can set TimePointGranularity
and\n TimeSeriesGranularity
to either “ALL” or “Specific”.
The ExplainabilityConfig data type defines the number of time series and time points\n included in CreateExplainability.
\nIf you provide a predictor ARN for ResourceArn
, you must set both\n TimePointGranularity
and TimeSeriesGranularity
to “ALL”.\n When creating Predictor Explainability, Amazon Forecast considers all time series and\n time points.
If you provide a forecast ARN for ResourceArn
, you can set\n TimePointGranularity
and TimeSeriesGranularity
to either\n “ALL” or “Specific”.
The status of the Explainability export. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability export. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The status of the Explainability. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n CREATE_STOPPING
, CREATE_STOPPED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
Returns a list of dataset groups created using the CreateDatasetGroup\n operation. For each dataset group, this operation returns a summary of its properties,\n including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by\n using the dataset group ARN with the DescribeDatasetGroup operation.
", + "smithy.api#documentation": "Returns a list of dataset groups created using the CreateDatasetGroup operation.\n For each dataset group, this operation returns a summary of its properties, including its\n Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the\n dataset group ARN with the DescribeDatasetGroup\n operation.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -3883,7 +4273,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a\n summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the\n complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter\n objects.
", + "smithy.api#documentation": "Returns a list of dataset import jobs created using the CreateDatasetImportJob\n operation. For each import job, this operation returns a summary of its properties, including\n its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the\n ARN with the DescribeDatasetImportJob\n operation. You can filter the list by providing an array of Filter objects.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -3911,7 +4301,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the datasets that match the statement from the list, respectively. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the datasets that match the statement, specify\n IS
. To exclude matching datasets, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n DatasetArn
and Status
.
\n Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the\n following filter:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]
\n
An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the datasets that match the statement from the list, respectively. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the datasets that match the statement, specify\n IS
. To exclude matching datasets, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n DatasetArn
and Status
.
\n Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the\n following filter:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]
\n
Returns a list of datasets created using the CreateDataset operation.\n For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is\n returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
", + "smithy.api#documentation": "Returns a list of datasets created using the CreateDataset operation. For each\n dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned.\n To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4009,7 +4399,13 @@ ], "traits": { "smithy.api#documentation": "Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for\n each Explainability. You can filter the list using an array of Filter\n objects.
\nTo retrieve the complete set of properties for a particular Explainability resource,\n use the ARN with the DescribeExplainability operation.
", - "smithy.api#idempotent": {} + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Explainabilities", + "pageSize": "MaxResults" + } } }, "com.amazonaws.forecast#ListExplainabilitiesRequest": { @@ -4070,7 +4466,13 @@ ], "traits": { "smithy.api#documentation": "Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary\n for each Explainability export. You can filter the list using an array of Filter objects.
\nTo retrieve the complete set of properties for a particular Explainability export, use\n the ARN with the DescribeExplainability operation.
", - "smithy.api#idempotent": {} + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ExplainabilityExports", + "pageSize": "MaxResults" + } } }, "com.amazonaws.forecast#ListExplainabilityExportsRequest": { @@ -4247,13 +4649,13 @@ } } }, - "com.amazonaws.forecast#ListPredictorBacktestExportJobs": { + "com.amazonaws.forecast#ListMonitorEvaluations": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#ListPredictorBacktestExportJobsRequest" + "target": "com.amazonaws.forecast#ListMonitorEvaluationsRequest" }, "output": { - "target": "com.amazonaws.forecast#ListPredictorBacktestExportJobsResponse" + "target": "com.amazonaws.forecast#ListMonitorEvaluationsResponse" }, "errors": [ { @@ -4261,66 +4663,76 @@ }, { "target": "com.amazonaws.forecast#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" } ], "traits": { - "smithy.api#documentation": "Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a\n summary for each backtest export job. You can filter the list using an array of Filter objects.
\nTo retrieve the complete set of properties for a particular backtest export job, use\n the ARN with the DescribePredictorBacktestExportJob operation.
", + "smithy.api#documentation": "Returns a list of the monitoring evaluation results and predictor events collected by\n the monitor resource during different windows of time.
\nFor information about monitoring see predictor-monitoring. For\n more information about retrieving monitoring results see Viewing Monitoring Results.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "PredictorBacktestExportJobs", + "items": "PredictorMonitorEvaluations", "pageSize": "MaxResults" } } }, - "com.amazonaws.forecast#ListPredictorBacktestExportJobsRequest": { + "com.amazonaws.forecast#ListMonitorEvaluationsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next request.\n Tokens expire after 24 hours.
" + "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" + "smithy.api#documentation": "The maximum number of monitoring results to return.
" + } + }, + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource to get results from.
", + "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to\n include or exclude the predictor backtest export jobs that match the statement from the\n list. The match statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are\n IS
and IS_NOT
. To include the predictor backtest\n export jobs that match the statement, specify IS
. To exclude\n matching predictor backtest export jobs, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n PredictorArn
and Status
.
\n Value
- The value to match.
An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are\n IS
and IS_NOT
.
\n Key
- The name of the parameter to filter on. The only valid value is \n EvaluationState
.
\n Value
- The value to match. Valid values are only SUCCESS
or FAILURE
.
For example, to list only successful monitor evaluations, you would specify:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"EvaluationState\", \"Value\": \"SUCCESS\" } ]
\n
An array of objects that summarize the properties of each predictor backtest export\n job.
" + "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request. Tokens expire after 24 hours.
" } }, - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", + "PredictorMonitorEvaluations": { + "target": "com.amazonaws.forecast#PredictorMonitorEvaluations", "traits": { - "smithy.api#documentation": "Returns this token if the response is truncated. To retrieve the next set of results,\n use the token in the next request.
" + "smithy.api#documentation": "The monitoring results and predictor events collected by the monitor resource during different windows of time.
\nFor information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.
" } } } }, - "com.amazonaws.forecast#ListPredictors": { + "com.amazonaws.forecast#ListMonitors": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#ListPredictorsRequest" + "target": "com.amazonaws.forecast#ListMonitorsRequest" }, "output": { - "target": "com.amazonaws.forecast#ListPredictorsResponse" + "target": "com.amazonaws.forecast#ListMonitorsResponse" }, "errors": [ { @@ -4331,105 +4743,239 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of predictors created using the CreateAutoPredictor or\n CreatePredictor operations. For each predictor, this operation returns a\n summary of its properties, including its Amazon Resource Name (ARN).
\nYou can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You\n can filter the list using an array of Filter objects.
", + "smithy.api#documentation": "Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You\n can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "Predictors", + "items": "Monitors", "pageSize": "MaxResults" } } }, - "com.amazonaws.forecast#ListPredictorsRequest": { + "com.amazonaws.forecast#ListMonitorsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" + "smithy.api#documentation": "The maximum number of monitors to include in the response.
" } }, "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the predictors that match the statement from the list, respectively. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the predictors that match the statement, specify\n IS
. To exclude matching predictors, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n DatasetGroupArn
and Status
.
\n Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]
\n
An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are\n IS
and IS_NOT
.
\n Key
- The name of the parameter to filter on. The only valid value is \n Status
.
\n Value
- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]
\n
An array of objects that summarize each predictor's properties.
" + "smithy.api#documentation": "An array of objects that summarize each monitor's properties.
" } }, "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" + "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" } } } }, - "com.amazonaws.forecast#ListTagsForResource": { + "com.amazonaws.forecast#ListPredictorBacktestExportJobs": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#ListTagsForResourceRequest" + "target": "com.amazonaws.forecast#ListPredictorBacktestExportJobsRequest" }, "output": { - "target": "com.amazonaws.forecast#ListTagsForResourceResponse" + "target": "com.amazonaws.forecast#ListPredictorBacktestExportJobsResponse" }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" }, { - "target": "com.amazonaws.forecast#ResourceNotFoundException" + "target": "com.amazonaws.forecast#InvalidNextTokenException" } ], "traits": { - "smithy.api#documentation": "Lists the tags for an Amazon Forecast resource.
" + "smithy.api#documentation": "Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a\n summary for each backtest export job. You can filter the list using an array of Filter objects.
\nTo retrieve the complete set of properties for a particular backtest export job, use\n the ARN with the DescribePredictorBacktestExportJob operation.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PredictorBacktestExportJobs", + "pageSize": "MaxResults" + } } }, - "com.amazonaws.forecast#ListTagsForResourceRequest": { + "com.amazonaws.forecast#ListPredictorBacktestExportJobsRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.forecast#Arn", + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next request.\n Tokens expire after 24 hours.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.forecast#MaxResults", + "traits": { + "smithy.api#documentation": "The number of items to return in the response.
" + } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to\n include or exclude the predictor backtest export jobs that match the statement from the\n list. The match statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are\n IS
and IS_NOT
. To include the predictor backtest\n export jobs that match the statement, specify IS
. To exclude\n matching predictor backtest export jobs, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n PredictorArn
and Status
.
\n Value
- The value to match.
The tags for the resource.
" + "smithy.api#documentation": "An array of objects that summarize the properties of each predictor backtest export\n job.
" + } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "Returns this token if the response is truncated. To retrieve the next set of results,\n use the token in the next request.
" } } } }, - "com.amazonaws.forecast#LocalDateTime": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 19 + "com.amazonaws.forecast#ListPredictors": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ListPredictorsRequest" + }, + "output": { + "target": "com.amazonaws.forecast#ListPredictorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of predictors created using the CreateAutoPredictor or\n CreatePredictor operations. For each predictor, this operation returns a\n summary of its properties, including its Amazon Resource Name (ARN).
\nYou can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You\n can filter the list using an array of Filter objects.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Predictors", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.forecast#ListPredictorsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" + } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the predictors that match the statement from the list, respectively. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the predictors that match the statement, specify\n IS
. To exclude matching predictors, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n DatasetGroupArn
and Status
.
\n Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]
\n
An array of objects that summarize each predictor's properties.
" + } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" + } + } + } + }, + "com.amazonaws.forecast#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.forecast#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for an Amazon Forecast resource.
" + } + }, + "com.amazonaws.forecast#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + } + }, + "com.amazonaws.forecast#LocalDateTime": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 19 }, "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$" } @@ -4453,6 +4999,41 @@ "com.amazonaws.forecast#Message": { "type": "string" }, + "com.amazonaws.forecast#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.forecast#MetricResult": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.forecast#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
" + } + }, + "MetricValue": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "The value for the metric.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the Baseline to see how your predictor's performance is changing.
\nFor more information about metrics generated by Forecast see Evaluating Predictor Accuracy\n
" + } + }, + "com.amazonaws.forecast#MetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#MetricResult" + } + }, "com.amazonaws.forecast#Metrics": { "type": "structure", "members": { @@ -4488,6 +5069,172 @@ "smithy.api#documentation": "Provides metrics that are used to evaluate the performance of a predictor. This object is\n part of the WindowSummary object.
" } }, + "com.amazonaws.forecast#MonitorConfig": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "The name of the monitor resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration details for the predictor monitor.
" + } + }, + "com.amazonaws.forecast#MonitorDataSource": { + "type": "structure", + "members": { + "DatasetImportJobArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.
" + } + }, + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.
" + } + }, + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor resource you are monitoring.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The source of the data the monitor used during the evaluation.
" + } + }, + "com.amazonaws.forecast#MonitorInfo": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource.
" + } + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "The status of the monitor. States include:
\n\n ACTIVE
\n
\n ACTIVE_STOPPING
, ACTIVE_STOPPED
\n
\n UPDATE_IN_PROGRESS
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
\n
Provides information about the monitor resource.
" + } + }, + "com.amazonaws.forecast#MonitorSummary": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource.
" + } + }, + "MonitorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "The name of the monitor resource.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the predictor being monitored.
" + } + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "The status of the monitor. States include:
\n\n ACTIVE
\n
\n ACTIVE_STOPPING
, ACTIVE_STOPPED
\n
\n UPDATE_IN_PROGRESS
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
\n
When the monitor resource was created.
" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The last time the monitor resource was modified. The timestamp depends on the status of the\n job:
\n\n CREATE_PENDING
- The CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n STOPPED
- When the resource stopped.
\n ACTIVE
or CREATE_FAILED
- When the monitor creation finished or\n failed.
Provides a summary of the monitor properties used in the ListMonitors operation. To get a complete set of properties,\n call the DescribeMonitor operation, and provide the listed\n MonitorArn
.
The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you\n use your predictor and the metrics change.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.
" + } + }, "com.amazonaws.forecast#PredictorEvaluationResults": { "type": "list", "member": { "target": "com.amazonaws.forecast#EvaluationResult" } }, + "com.amazonaws.forecast#PredictorEvent": { + "type": "structure", + "members": { + "Detail": { + "target": "com.amazonaws.forecast#Detail", + "traits": { + "smithy.api#documentation": "The type of event. For example, Retrain
. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the Datetime
are from the previous predictor. Any new metrics are for the newly retrained predictor.
The timestamp for when the event occurred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about a predictor event, such as a retraining.
" + } + }, "com.amazonaws.forecast#PredictorExecution": { "type": "structure", "members": { @@ -4686,6 +5467,86 @@ } } }, + "com.amazonaws.forecast#PredictorMonitorEvaluation": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to monitor.
" + } + }, + "MonitorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource.
" + } + }, + "EvaluationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the monitor evaluation was started.
" + } + }, + "EvaluationState": { + "target": "com.amazonaws.forecast#EvaluationState", + "traits": { + "smithy.api#documentation": "The status of the monitor evaluation. The state can be SUCCESS
or FAILURE
.
The timestamp that indicates the start of the window that is used for monitor evaluation.
" + } + }, + "WindowEndDatetime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp that indicates the end of the window that is used for monitor evaluation.
" + } + }, + "PredictorEvent": { + "target": "com.amazonaws.forecast#PredictorEvent", + "traits": { + "smithy.api#documentation": "Provides details about a predictor event, such as a retraining.
" + } + }, + "MonitorDataSource": { + "target": "com.amazonaws.forecast#MonitorDataSource", + "traits": { + "smithy.api#documentation": "The source of the data the monitor resource used during the evaluation.
" + } + }, + "MetricResults": { + "target": "com.amazonaws.forecast#MetricResults", + "traits": { + "smithy.api#documentation": "A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.
" + } + }, + "NumItemsEvaluated": { + "target": "com.amazonaws.forecast#Long", + "traits": { + "smithy.api#documentation": "The number of items considered during the evaluation.
" + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "Information about any errors that may have occurred during the monitor evaluation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the results of a monitor evaluation.
" + } + }, + "com.amazonaws.forecast#PredictorMonitorEvaluations": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#PredictorMonitorEvaluation" + } + }, "com.amazonaws.forecast#PredictorSummary": { "type": "structure", "members": { @@ -4813,6 +5674,45 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.forecast#ResumeResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ResumeResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#LimitExceededException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Resumes a stopped monitor resource.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#ResumeResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor resource to resume.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.forecast#S3Config": { "type": "structure", "members": { @@ -4900,12 +5800,12 @@ "AttributeType": { "target": "com.amazonaws.forecast#AttributeType", "traits": { - "smithy.api#documentation": "The data type of the field.
" + "smithy.api#documentation": "The data type of the field.
\nFor a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
" } } }, "traits": { - "smithy.api#documentation": "An attribute of a schema, which defines a dataset field. A schema attribute is required\n for every field in a dataset. The Schema object contains an array of\n SchemaAttribute
objects.
An attribute of a schema, which defines a dataset field. A schema attribute is required\n for every field in a dataset. The Schema object contains an array of\n SchemaAttribute
objects.
The number of distinct values in the field. If the response value is -1, refer to\n CountDistinctLong
.
The number of distinct values in the field. If the response value is -1, refer to\n CountDistinctLong
.
The number of null values in the field. If the response value is -1, refer to\n CountNullLong
.
The number of null values in the field. If the response value is -1, refer to\n CountNullLong
.
The number of NAN (not a number) values in the field. If the response value is -1, refer to\n CountNanLong
.
The number of NAN (not a number) values in the field. If the response value is -1, refer\n to CountNanLong
.
Provides statistics for each data field imported into to an Amazon Forecast dataset with\n the CreateDatasetImportJob operation.
" + "smithy.api#documentation": "Provides statistics for each data field imported into to an Amazon Forecast dataset with\n the CreateDatasetImportJob operation.
" } }, "com.amazonaws.forecast#Status": { @@ -5029,6 +5929,9 @@ "input": { "target": "com.amazonaws.forecast#StopResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.forecast#InvalidInputException" @@ -5259,6 +6162,38 @@ "target": "com.amazonaws.forecast#WindowSummary" } }, + "com.amazonaws.forecast#TimeAlignmentBoundary": { + "type": "structure", + "members": { + "Month": { + "target": "com.amazonaws.forecast#Month", + "traits": { + "smithy.api#documentation": "The month to use for time alignment during aggregation. The month must be in uppercase.
" + } + }, + "DayOfMonth": { + "target": "com.amazonaws.forecast#DayOfMonth", + "traits": { + "smithy.api#documentation": "The day of the month to use for time alignment during aggregation.
" + } + }, + "DayOfWeek": { + "target": "com.amazonaws.forecast#DayOfWeek", + "traits": { + "smithy.api#documentation": "The day of week to use for time alignment during aggregation. The day must be in uppercase.
" + } + }, + "Hour": { + "target": "com.amazonaws.forecast#Hour", + "traits": { + "smithy.api#documentation": "The hour of day to use for time alignment during aggregation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you\n don't provide a time boundary, Forecast uses a set of Default Time Boundaries.\n
\n\nFor more information about aggregation,\n see Data Aggregation for Different Forecast Frequencies.\n For more information setting a custom time boundary,\n see Specifying a Time Boundary.\n \n
" + } + }, "com.amazonaws.forecast#TimePointGranularity": { "type": "string", "traits": { @@ -5405,7 +6340,7 @@ } ], "traits": { - "smithy.api#documentation": "Replaces the datasets in a dataset group with the specified datasets.
\nThe Status
of the dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor. Use the DescribeDatasetGroup\n operation to get the status.
Replaces the datasets in a dataset group with the specified datasets.
\nThe Status
of the dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor. Use the DescribeDatasetGroup\n operation to get the status.
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.
\nThis operation requires a client request token in the request that Amazon FSx\n uses to ensure idempotent creation. This means that calling the operation multiple times\n with the same client request token has no effect. By using the idempotent operation, you\n can retry a CreateFileSystem
operation without the risk of creating an\n extra file system. This approach can be useful when an initial call fails in a way that\n makes it unclear whether a file system was created. Examples are if a transport-level\n timeout occurred, or your connection was reset. If you use the same client request token\n and the initial call created a file system, the client receives a success message as\n long as the parameters are the same.
The 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.
\nThis operation requires a client request token in the request that Amazon FSx\n uses to ensure idempotent creation. This means that calling the operation multiple times\n with the same client request token has no effect. By using the idempotent operation, you\n can retry a CreateFileSystem
operation without the risk of creating an\n extra file system. This approach can be useful when an initial call fails in a way that\n makes it unclear whether a file system was created. Examples are if a transport-level\n timeout occurred, or your connection was reset. If you use the same client request token\n and the initial call created a file system, the client receives a success message as\n long as the parameters are the same.
The 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.
The Lustre logging configuration used when creating an Amazon FSx for Lustre\n file system. When logging is enabled, Lustre logs error and warning events for data repositories\n associated with your file system to Amazon CloudWatch Logs.
" } + }, + "RootSquashConfiguration": { + "target": "com.amazonaws.fsx#LustreRootSquashConfiguration", + "traits": { + "smithy.api#documentation": "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.
" + } } }, "traits": { @@ -1607,7 +1613,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OntapDeploymentType", "traits": { - "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type to use in creating\n the file system.
\n\n MULTI_AZ_1
- (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability.
\n SINGLE_AZ_1
- A file system configured for Single-AZ\n redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.
", + "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type to use in creating\n the file system.
\n\n MULTI_AZ_1
- (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability.
\n SINGLE_AZ_1
- A file system configured for Single-AZ\n redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing a file system deployment type.
", "smithy.api#required": {} } }, @@ -4043,6 +4049,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "StorageVirtualMachines", "pageSize": "MaxResults" } } @@ -4108,6 +4115,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Volumes", "pageSize": "MaxResults" } } @@ -5212,7 +5220,7 @@ "WeeklyMaintenanceStartTime": { "target": "com.amazonaws.fsx#WeeklyTime", "traits": { - "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and\n ending with Sunday.
" + "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. Here, d
is the weekday number, from 1 through 7, beginning with Monday and\n ending with Sunday.
The Lustre logging configuration. Lustre logging writes the enabled log\n events for your file system to Amazon CloudWatch Logs.
" } + }, + "RootSquashConfiguration": { + "target": "com.amazonaws.fsx#LustreRootSquashConfiguration", + "traits": { + "smithy.api#documentation": "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.
" + } } }, "traits": { @@ -5323,6 +5337,58 @@ "smithy.api#documentation": "The Lustre logging configuration used when creating or updating an\n Amazon FSx for Lustre file system. Lustre logging writes the enabled\n logging events for your file system to Amazon CloudWatch Logs.
\nError and warning events can be logged from the following data\n repository operations:
\nAutomatic export
\nData repository tasks
\nTo learn more about Lustre logging, see \n Logging to Amazon CloudWatch Logs.
" } }, + "com.amazonaws.fsx#LustreNoSquashNid": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 43 + }, + "smithy.api#pattern": "^([0-9\\[\\]\\-]*\\.){3}([0-9\\[\\]\\-]*)@tcp$" + } + }, + "com.amazonaws.fsx#LustreNoSquashNids": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#LustreNoSquashNid" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.fsx#LustreRootSquash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 21 + }, + "smithy.api#pattern": "^([0-9]{1,10}):([0-9]{1,10})$" + } + }, + "com.amazonaws.fsx#LustreRootSquashConfiguration": { + "type": "structure", + "members": { + "RootSquash": { + "target": "com.amazonaws.fsx#LustreRootSquash", + "traits": { + "smithy.api#documentation": "You enable root squash by setting a user ID (UID) and group ID (GID) for the file\n system in the format UID:GID
(for example, 365534:65534
).\n The UID and GID values can range from 0
to 4294967294
:
A non-zero value for UID and GID enables root squash. The UID and GID\n values can be different, but each must be a non-zero value.
\nA value of 0
(zero) for UID and GID indicates root,\n and therefore disables root squash.
When root squash is enabled, the user ID and group ID of a root user accessing\n the file system are re-mapped to the UID and GID you provide.
" + } + }, + "NoSquashNids": { + "target": "com.amazonaws.fsx#LustreNoSquashNids", + "traits": { + "smithy.api#documentation": "When root squash is enabled, you can optionally specify an array of NIDs of clients\n for which root squash does not apply. A client NID is a Lustre Network Identifier used\n to uniquely identify a client. You can specify the NID as either a single address or a\n range of addresses:
\nA single address is described in standard Lustre NID format by specifying\n the client’s IP address followed by the Lustre network ID (for example,\n 10.0.1.6@tcp
).
An address range is described using a dash to separate the range (for example,\n 10.0.[2-10].[1-255]@tcp
).
The configuration for Lustre root squash used to restrict root-level access\n from clients that try to access your FSx for Lustre file system as root.\n Use the RootSquash
parameter to enable root squash. To learn more\n about Lustre root squash,\n see Lustre root squash.
You can also use the NoSquashNids
parameter to provide an array of clients\n who are not affected by the root squash setting. These clients will access the file system as root,\n with unrestricted privileges.
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 Amazon 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 ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For Amazon 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 StorageCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For Amazon FSx for NetApp ONTAP file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n FsxAdminPassword
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For the Amazon FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays
\n
\n CopyTagsToBackups
\n
\n CopyTagsToVolumes
\n
\n DailyAutomaticBackupStartTime
\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 Amazon 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 ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For Amazon 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 LustreRootSquashConfiguration
\n
\n StorageCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For Amazon FSx for NetApp ONTAP file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays
\n
\n DailyAutomaticBackupStartTime
\n
\n DiskIopsConfiguration
\n
\n FsxAdminPassword
\n
\n StorageCapacity
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
For the Amazon FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays
\n
\n CopyTagsToBackups
\n
\n CopyTagsToVolumes
\n
\n DailyAutomaticBackupStartTime
\n
\n ThroughputCapacity
\n
\n WeeklyMaintenanceStartTime
\n
The Lustre logging configuration used when updating an Amazon FSx for Lustre\n file system. When logging is enabled, Lustre logs error and warning events for\n data repositories associated with your file system to Amazon CloudWatch Logs.
" } + }, + "RootSquashConfiguration": { + "target": "com.amazonaws.fsx#LustreRootSquashConfiguration", + "traits": { + "smithy.api#documentation": "The Lustre root squash configuration used when updating 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.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/gamesparks.json b/aws/sdk/aws-models/gamesparks.json index 3b75c100323..5779d90749b 100644 --- a/aws/sdk/aws-models/gamesparks.json +++ b/aws/sdk/aws-models/gamesparks.json @@ -481,6 +481,26 @@ "smithy.api#pattern": "^\\S(.*\\S)?$" } }, + "com.amazonaws.gamesparks#DeploymentResult": { + "type": "structure", + "members": { + "ResultCode": { + "target": "com.amazonaws.gamesparks#ResultCode", + "traits": { + "smithy.api#documentation": "The type of deployment result.
" + } + }, + "Message": { + "target": "com.amazonaws.gamesparks#Message", + "traits": { + "smithy.api#documentation": "Details about the deployment result.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of the deployment.
" + } + }, "com.amazonaws.gamesparks#DeploymentState": { "type": "string", "traits": { @@ -2589,6 +2609,9 @@ } } }, + "com.amazonaws.gamesparks#Message": { + "type": "string" + }, "com.amazonaws.gamesparks#NextToken": { "type": "string", "traits": { @@ -2670,6 +2693,25 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.gamesparks#ResultCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "INVALID_ROLE_FAILURE", + "name": "INVALID_ROLE_FAILURE" + }, + { + "value": "UNSPECIFIED_FAILURE", + "name": "UNSPECIFIED_FAILURE" + } + ] + } + }, "com.amazonaws.gamesparks#RoleARN": { "type": "string", "traits": { @@ -2941,6 +2983,12 @@ "traits": { "smithy.api#documentation": "The timestamp of when the deployment was last updated.
" } + }, + "DeploymentResult": { + "target": "com.amazonaws.gamesparks#DeploymentResult", + "traits": { + "smithy.api#documentation": "The result of the deployment.
" + } } }, "traits": { @@ -2985,6 +3033,12 @@ "traits": { "smithy.api#documentation": "The timestamp of when the deployment was last updated.
" } + }, + "DeploymentResult": { + "target": "com.amazonaws.gamesparks#DeploymentResult", + "traits": { + "smithy.api#documentation": "The result of the deployment.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/glue.json b/aws/sdk/aws-models/glue.json index e05cd87b645..e55a4fa8a51 100644 --- a/aws/sdk/aws-models/glue.json +++ b/aws/sdk/aws-models/glue.json @@ -673,6 +673,15 @@ "target": "com.amazonaws.glue#Action" } }, + "com.amazonaws.glue#AdditionalOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#EnclosedInStringProperty" + }, + "value": { + "target": "com.amazonaws.glue#EnclosedInStringProperty" + } + }, "com.amazonaws.glue#AdditionalPlanOptionsMap": { "type": "map", "key": { @@ -682,6 +691,143 @@ "target": "com.amazonaws.glue#GenericString" } }, + "com.amazonaws.glue#AggFunction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "avg", + "name": "avg" + }, + { + "value": "countDistinct", + "name": "countDistinct" + }, + { + "value": "count", + "name": "count" + }, + { + "value": "first", + "name": "first" + }, + { + "value": "last", + "name": "last" + }, + { + "value": "kurtosis", + "name": "kurtosis" + }, + { + "value": "max", + "name": "max" + }, + { + "value": "min", + "name": "min" + }, + { + "value": "skewness", + "name": "skewness" + }, + { + "value": "stddev_samp", + "name": "stddev_samp" + }, + { + "value": "stddev_pop", + "name": "stddev_pop" + }, + { + "value": "sum", + "name": "sum" + }, + { + "value": "sumDistinct", + "name": "sumDistinct" + }, + { + "value": "var_samp", + "name": "var_samp" + }, + { + "value": "var_pop", + "name": "var_pop" + } + ] + } + }, + "com.amazonaws.glue#Aggregate": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "Specifies the fields and rows to use as inputs for the aggregate transform.
", + "smithy.api#required": {} + } + }, + "Groups": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "Specifies the fields to group by.
", + "smithy.api#required": {} + } + }, + "Aggs": { + "target": "com.amazonaws.glue#AggregateOperations", + "traits": { + "smithy.api#documentation": "Specifies the aggregate functions to be performed on specified fields.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
" + } + }, + "com.amazonaws.glue#AggregateOperation": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "Specifies the column on the data set on which the aggregation function will be applied.
", + "smithy.api#required": {} + } + }, + "AggFunc": { + "target": "com.amazonaws.glue#AggFunction", + "traits": { + "smithy.api#documentation": "Specifies the aggregation function to apply.
\nPossible aggregation functions include: avg countDistinct, count, first, last, kurtosis, max, min, skewness, \n stddev_samp, stddev_pop, sum, sumDistinct, var_samp, var_pop
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the set of parameters needed to perform aggregation in the aggregate transform.
" + } + }, + "com.amazonaws.glue#AggregateOperations": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#AggregateOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, "com.amazonaws.glue#AlreadyExistsException": { "type": "structure", "members": { @@ -697,6 +843,90 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#ApplyMapping": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Mapping": { + "target": "com.amazonaws.glue#Mappings", + "traits": { + "smithy.api#documentation": "Specifies the mapping of data property keys in the data source to data property keys in the data target.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
" + } + }, + "com.amazonaws.glue#AthenaConnectorSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the connection that is associated with the connector.
", + "smithy.api#required": {} + } + }, + "ConnectorName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of a connector that assists with accessing the data store in Glue Studio.
", + "smithy.api#required": {} + } + }, + "ConnectionType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The type of connection, such as marketplace.athena or custom.athena, designating a connection to an Amazon Athena data store.
", + "smithy.api#required": {} + } + }, + "ConnectionTable": { + "target": "com.amazonaws.glue#EnclosedInStringPropertyWithQuote", + "traits": { + "smithy.api#documentation": "The name of the table in the data source.
" + } + }, + "SchemaName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the Cloudwatch log group to read from. For example, /aws-glue/jobs/output
.
Specifies the data schema for the custom Athena source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a connector to an Amazon Athena data source.
" + } + }, "com.amazonaws.glue#AttemptCount": { "type": "integer" }, @@ -800,6 +1030,42 @@ "target": "com.amazonaws.glue#BackfillError" } }, + "com.amazonaws.glue#BasicCatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of your data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database that contains the table you want to use as the target. This database must already exist in the Data Catalog.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The table that defines the schema of your output data. This table must already exist in the Data Catalog.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that uses a Glue Data Catalog table.
" + } + }, "com.amazonaws.glue#BatchCreatePartition": { "type": "operation", "input": { @@ -2271,6 +2537,55 @@ } } }, + "com.amazonaws.glue#BoxedBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.glue#BoxedDoubleFraction": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.glue#BoxedLong": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.glue#BoxedNonNegativeInt": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.glue#BoxedNonNegativeLong": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.glue#BoxedPositiveInt": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.glue#CancelMLTaskRun": { "type": "operation", "input": { @@ -2489,48 +2804,206 @@ "smithy.api#documentation": "A structure containing migration status information.
" } }, - "com.amazonaws.glue#CatalogTablesList": { - "type": "list", - "member": { - "target": "com.amazonaws.glue#NameString" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.glue#CatalogTarget": { + "com.amazonaws.glue#CatalogKafkaSource": { "type": "structure", "members": { - "DatabaseName": { - "target": "com.amazonaws.glue#NameString", + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "The name of the database to be synchronized.
", + "smithy.api#documentation": "The name of the data store.
", "smithy.api#required": {} } }, - "Tables": { - "target": "com.amazonaws.glue#CatalogTablesList", + "WindowSize": { + "target": "com.amazonaws.glue#BoxedPositiveInt", "traits": { - "smithy.api#documentation": "A list of the tables to be synchronized.
", + "smithy.api#box": {}, + "smithy.api#documentation": "The amount of time to spend processing each micro batch.
" + } + }, + "DetectSchema": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", "smithy.api#required": {} } }, - "ConnectionName": { - "target": "com.amazonaws.glue#ConnectionName", + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog
connection type paired with a NETWORK
Connection type.
The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "StreamingOptions": { + "target": "com.amazonaws.glue#KafkaStreamingSourceOptions", + "traits": { + "smithy.api#documentation": "Specifies the streaming options.
" + } + }, + "DataPreviewOptions": { + "target": "com.amazonaws.glue#StreamingDataPreviewOptions", + "traits": { + "smithy.api#documentation": "Specifies options related to data preview for viewing a sample of your data.
" } } }, "traits": { - "smithy.api#documentation": "Specifies an Glue Data Catalog target.
" + "smithy.api#documentation": "Specifies an Apache Kafka data store in the Data Catalog.
" } }, - "com.amazonaws.glue#CatalogTargetList": { - "type": "list", - "member": { + "com.amazonaws.glue#CatalogKinesisSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "WindowSize": { + "target": "com.amazonaws.glue#BoxedPositiveInt", + "traits": { + "smithy.api#documentation": "The amount of time to spend processing each micro batch.
" + } + }, + "DetectSchema": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "StreamingOptions": { + "target": "com.amazonaws.glue#KinesisStreamingSourceOptions", + "traits": { + "smithy.api#documentation": "Additional options for the Kinesis streaming data source.
" + } + }, + "DataPreviewOptions": { + "target": "com.amazonaws.glue#StreamingDataPreviewOptions", + "traits": { + "smithy.api#documentation": "Additional options for data preview.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a Kinesis data source in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#CatalogSchemaChangePolicy": { + "type": "structure", + "members": { + "EnableUpdateCatalog": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Whether to use the specified update behavior when the crawler finds a changed schema.
" + } + }, + "UpdateBehavior": { + "target": "com.amazonaws.glue#UpdateCatalogBehavior", + "traits": { + "smithy.api#documentation": "The update behavior when the crawler finds a changed schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A policy that specifies update behavior for the crawler.
" + } + }, + "com.amazonaws.glue#CatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a data store in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#CatalogTablesList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.glue#CatalogTarget": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the database to be synchronized.
", + "smithy.api#required": {} + } + }, + "Tables": { + "target": "com.amazonaws.glue#CatalogTablesList", + "traits": { + "smithy.api#documentation": "A list of the tables to be synchronized.
", + "smithy.api#required": {} + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog
connection type paired with a NETWORK
Connection type.
Specifies an Glue Data Catalog target.
" + } + }, + "com.amazonaws.glue#CatalogTargetList": { + "type": "list", + "member": { "target": "com.amazonaws.glue#CatalogTarget" } }, @@ -2681,196 +3154,510 @@ "com.amazonaws.glue#CodeGenArgValue": { "type": "string" }, - "com.amazonaws.glue#CodeGenEdge": { + "com.amazonaws.glue#CodeGenConfigurationNode": { "type": "structure", "members": { - "Source": { - "target": "com.amazonaws.glue#CodeGenIdentifier", + "AthenaConnectorSource": { + "target": "com.amazonaws.glue#AthenaConnectorSource", "traits": { - "smithy.api#documentation": "The ID of the node at which the edge starts.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies a connector to an Amazon Athena data source.
" } }, - "Target": { - "target": "com.amazonaws.glue#CodeGenIdentifier", + "JDBCConnectorSource": { + "target": "com.amazonaws.glue#JDBCConnectorSource", "traits": { - "smithy.api#documentation": "The ID of the node at which the edge ends.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies a connector to a JDBC data source.
" } }, - "TargetParameter": { - "target": "com.amazonaws.glue#CodeGenArgName", + "SparkConnectorSource": { + "target": "com.amazonaws.glue#SparkConnectorSource", "traits": { - "smithy.api#documentation": "The target of the edge.
" + "smithy.api#documentation": "Specifies a connector to an Apache Spark data source.
" } - } - }, - "traits": { - "smithy.api#documentation": "Represents a directional edge in a directed acyclic graph (DAG).
" - } - }, - "com.amazonaws.glue#CodeGenIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 }, - "smithy.api#pattern": "^[A-Za-z_][A-Za-z0-9_]*$" - } - }, - "com.amazonaws.glue#CodeGenNode": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.glue#CodeGenIdentifier", + "CatalogSource": { + "target": "com.amazonaws.glue#CatalogSource", "traits": { - "smithy.api#documentation": "A node identifier that is unique within the node's graph.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies a data store in the Glue Data Catalog.
" } }, - "NodeType": { - "target": "com.amazonaws.glue#CodeGenNodeType", + "RedshiftSource": { + "target": "com.amazonaws.glue#RedshiftSource", "traits": { - "smithy.api#documentation": "The type of node that this is.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies an Amazon Redshift data store.
" } }, - "Args": { - "target": "com.amazonaws.glue#CodeGenNodeArgs", + "S3CatalogSource": { + "target": "com.amazonaws.glue#S3CatalogSource", "traits": { - "smithy.api#documentation": "Properties of the node, in the form of name-value pairs.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies an Amazon S3 data store in the Glue Data Catalog.
" } }, - "LineNumber": { - "target": "com.amazonaws.glue#Integer", + "S3CsvSource": { + "target": "com.amazonaws.glue#S3CsvSource", "traits": { - "smithy.api#documentation": "The line number of the node.
" + "smithy.api#documentation": "Specifies a command-separated value (CSV) data store stored in Amazon S3.
" } - } - }, - "traits": { - "smithy.api#documentation": "Represents a node in a directed acyclic graph (DAG)
" - } - }, - "com.amazonaws.glue#CodeGenNodeArg": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.glue#CodeGenArgName", + }, + "S3JsonSource": { + "target": "com.amazonaws.glue#S3JsonSource", "traits": { - "smithy.api#documentation": "The name of the argument or property.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies a JSON data store stored in Amazon S3.
" } }, - "Value": { - "target": "com.amazonaws.glue#CodeGenArgValue", + "S3ParquetSource": { + "target": "com.amazonaws.glue#S3ParquetSource", "traits": { - "smithy.api#documentation": "The value of the argument or property.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies an Apache Parquet data store stored in Amazon S3.
" } }, - "Param": { - "target": "com.amazonaws.glue#Boolean", + "RelationalCatalogSource": { + "target": "com.amazonaws.glue#RelationalCatalogSource" + }, + "DynamoDBCatalogSource": { + "target": "com.amazonaws.glue#DynamoDBCatalogSource" + }, + "JDBCConnectorTarget": { + "target": "com.amazonaws.glue#JDBCConnectorTarget", "traits": { - "smithy.api#documentation": "True if the value is used as a parameter.
" + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
" } - } - }, - "traits": { - "smithy.api#documentation": "An argument or property of a node.
" - } - }, - "com.amazonaws.glue#CodeGenNodeArgs": { - "type": "list", - "member": { - "target": "com.amazonaws.glue#CodeGenNodeArg" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.glue#CodeGenNodeType": { - "type": "string" - }, - "com.amazonaws.glue#Column": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.glue#NameString", + }, + "SparkConnectorTarget": { + "target": "com.amazonaws.glue#SparkConnectorTarget", "traits": { - "smithy.api#documentation": "The name of the Column
.
Specifies a target that uses an Apache Spark connector.
" } }, - "Type": { - "target": "com.amazonaws.glue#ColumnTypeString", + "CatalogTarget": { + "target": "com.amazonaws.glue#BasicCatalogTarget", "traits": { - "smithy.api#documentation": "The data type of the Column
.
Specifies a target that uses a Glue Data Catalog table.
" } }, - "Comment": { - "target": "com.amazonaws.glue#CommentString", + "RedshiftTarget": { + "target": "com.amazonaws.glue#RedshiftTarget", "traits": { - "smithy.api#documentation": "A free-form text comment.
" + "smithy.api#documentation": "Specifies a target that uses Amazon Redshift.
" } }, - "Parameters": { - "target": "com.amazonaws.glue#ParametersMap", + "S3CatalogTarget": { + "target": "com.amazonaws.glue#S3CatalogTarget", "traits": { - "smithy.api#documentation": "These key-value pairs define properties associated with the column.
" + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
" } - } - }, - "traits": { - "smithy.api#documentation": "A column in a Table
.
The name of the column that failed.
" + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
" } }, - "Error": { - "target": "com.amazonaws.glue#ErrorDetail", + "S3DirectTarget": { + "target": "com.amazonaws.glue#S3DirectTarget", "traits": { - "smithy.api#documentation": "An error message with the reason for the failure of an operation.
" + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3.
" } - } - }, - "traits": { - "smithy.api#documentation": "Encapsulates a column name that failed and the reason for failure.
" - } - }, - "com.amazonaws.glue#ColumnErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.glue#ColumnError" - } - }, - "com.amazonaws.glue#ColumnImportance": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.glue#NameString", + }, + "ApplyMapping": { + "target": "com.amazonaws.glue#ApplyMapping", "traits": { - "smithy.api#documentation": "The name of a column.
" + "smithy.api#documentation": "Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
" } }, - "Importance": { - "target": "com.amazonaws.glue#GenericBoundedDouble", + "SelectFields": { + "target": "com.amazonaws.glue#SelectFields", "traits": { - "smithy.api#documentation": "The column importance score for the column, as a decimal.
" + "smithy.api#documentation": "Specifies a transform that chooses the data property keys that you want to keep.
" } - } + }, + "DropFields": { + "target": "com.amazonaws.glue#DropFields", + "traits": { + "smithy.api#documentation": "Specifies a transform that chooses the data property keys that you want to drop.
" + } + }, + "RenameField": { + "target": "com.amazonaws.glue#RenameField", + "traits": { + "smithy.api#documentation": "Specifies a transform that renames a single data property key.
" + } + }, + "Spigot": { + "target": "com.amazonaws.glue#Spigot", + "traits": { + "smithy.api#documentation": "Specifies a transform that writes samples of the data to an Amazon S3 bucket.
" + } + }, + "Join": { + "target": "com.amazonaws.glue#Join", + "traits": { + "smithy.api#documentation": "Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
" + } + }, + "SplitFields": { + "target": "com.amazonaws.glue#SplitFields", + "traits": { + "smithy.api#documentation": "Specifies a transform that splits data property keys into two DynamicFrames
. The output is a collection of DynamicFrames
: one with selected data property keys, and one with the remaining data property keys.
Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
\n
Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
" + } + }, + "Filter": { + "target": "com.amazonaws.glue#Filter", + "traits": { + "smithy.api#documentation": "Specifies a transform that splits a dataset into two, based on a filter condition.
" + } + }, + "CustomCode": { + "target": "com.amazonaws.glue#CustomCode", + "traits": { + "smithy.api#documentation": "Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
" + } + }, + "SparkSQL": { + "target": "com.amazonaws.glue#SparkSQL", + "traits": { + "smithy.api#documentation": "Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame
.
Specifies a direct Amazon Kinesis data source.
" + } + }, + "DirectKafkaSource": { + "target": "com.amazonaws.glue#DirectKafkaSource", + "traits": { + "smithy.api#documentation": "Specifies an Apache Kafka data store.
" + } + }, + "CatalogKinesisSource": { + "target": "com.amazonaws.glue#CatalogKinesisSource", + "traits": { + "smithy.api#documentation": "Specifies a Kinesis data source in the Glue Data Catalog.
" + } + }, + "CatalogKafkaSource": { + "target": "com.amazonaws.glue#CatalogKafkaSource", + "traits": { + "smithy.api#documentation": "Specifies an Apache Kafka data store in the Data Catalog.
" + } + }, + "DropNullFields": { + "target": "com.amazonaws.glue#DropNullFields", + "traits": { + "smithy.api#documentation": "Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are \"null\", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
" + } + }, + "Merge": { + "target": "com.amazonaws.glue#Merge", + "traits": { + "smithy.api#documentation": "Specifies a transform that merges a DynamicFrame
with a staging DynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
Specifies a transform that combines the rows from two or more datasets into a single result.
" + } + }, + "PIIDetection": { + "target": "com.amazonaws.glue#PIIDetection", + "traits": { + "smithy.api#documentation": "Specifies a transform that identifies, removes or masks PII data.
" + } + }, + "Aggregate": { + "target": "com.amazonaws.glue#Aggregate", + "traits": { + "smithy.api#documentation": "Specifies a transform that groups rows by chosen fields and computes the aggregated value by specified function.
" + } + }, + "DropDuplicates": { + "target": "com.amazonaws.glue#DropDuplicates", + "traits": { + "smithy.api#documentation": "Specifies a transform that removes rows of repeating data from a data set.
" + } + }, + "GovernedCatalogTarget": { + "target": "com.amazonaws.glue#GovernedCatalogTarget", + "traits": { + "smithy.api#documentation": "Specifies a data target that writes to a goverened catalog.
" + } + }, + "GovernedCatalogSource": { + "target": "com.amazonaws.glue#GovernedCatalogSource", + "traits": { + "smithy.api#documentation": "Specifies a data source in a goverened Data Catalog.
" + } + }, + "MicrosoftSQLServerCatalogSource": { + "target": "com.amazonaws.glue#MicrosoftSQLServerCatalogSource", + "traits": { + "smithy.api#documentation": "Specifies a Microsoft SQL server data source in the Glue Data Catalog.
" + } + }, + "MySQLCatalogSource": { + "target": "com.amazonaws.glue#MySQLCatalogSource", + "traits": { + "smithy.api#documentation": "Specifies a MySQL data source in the Glue Data Catalog.
" + } + }, + "OracleSQLCatalogSource": { + "target": "com.amazonaws.glue#OracleSQLCatalogSource", + "traits": { + "smithy.api#documentation": "Specifies an Oracle data source in the Glue Data Catalog.
" + } + }, + "PostgreSQLCatalogSource": { + "target": "com.amazonaws.glue#PostgreSQLCatalogSource", + "traits": { + "smithy.api#documentation": "Specifies a PostgresSQL data source in the Glue Data Catalog.
" + } + }, + "MicrosoftSQLServerCatalogTarget": { + "target": "com.amazonaws.glue#MicrosoftSQLServerCatalogTarget", + "traits": { + "smithy.api#documentation": "Specifies a target that uses Microsoft SQL.
" + } + }, + "MySQLCatalogTarget": { + "target": "com.amazonaws.glue#MySQLCatalogTarget", + "traits": { + "smithy.api#documentation": "Specifies a target that uses MySQL.
" + } + }, + "OracleSQLCatalogTarget": { + "target": "com.amazonaws.glue#OracleSQLCatalogTarget", + "traits": { + "smithy.api#documentation": "Specifies a target that uses Oracle SQL.
" + } + }, + "PostgreSQLCatalogTarget": { + "target": "com.amazonaws.glue#PostgreSQLCatalogTarget", + "traits": { + "smithy.api#documentation": "Specifies a target that uses Postgres SQL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n CodeGenConfigurationNode
enumerates all valid Node types. One and only one of its member variables can be populated.
The ID of the node at which the edge starts.
", + "smithy.api#required": {} + } + }, + "Target": { + "target": "com.amazonaws.glue#CodeGenIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the node at which the edge ends.
", + "smithy.api#required": {} + } + }, + "TargetParameter": { + "target": "com.amazonaws.glue#CodeGenArgName", + "traits": { + "smithy.api#documentation": "The target of the edge.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a directional edge in a directed acyclic graph (DAG).
" + } + }, + "com.amazonaws.glue#CodeGenIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z_][A-Za-z0-9_]*$" + } + }, + "com.amazonaws.glue#CodeGenNode": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#CodeGenIdentifier", + "traits": { + "smithy.api#documentation": "A node identifier that is unique within the node's graph.
", + "smithy.api#required": {} + } + }, + "NodeType": { + "target": "com.amazonaws.glue#CodeGenNodeType", + "traits": { + "smithy.api#documentation": "The type of node that this is.
", + "smithy.api#required": {} + } + }, + "Args": { + "target": "com.amazonaws.glue#CodeGenNodeArgs", + "traits": { + "smithy.api#documentation": "Properties of the node, in the form of name-value pairs.
", + "smithy.api#required": {} + } + }, + "LineNumber": { + "target": "com.amazonaws.glue#Integer", + "traits": { + "smithy.api#documentation": "The line number of the node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a node in a directed acyclic graph (DAG)
" + } + }, + "com.amazonaws.glue#CodeGenNodeArg": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#CodeGenArgName", + "traits": { + "smithy.api#documentation": "The name of the argument or property.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.glue#CodeGenArgValue", + "traits": { + "smithy.api#documentation": "The value of the argument or property.
", + "smithy.api#required": {} + } + }, + "Param": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#documentation": "True if the value is used as a parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An argument or property of a node.
" + } + }, + "com.amazonaws.glue#CodeGenNodeArgs": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#CodeGenNodeArg" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.glue#CodeGenNodeType": { + "type": "string" + }, + "com.amazonaws.glue#Column": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of the Column
.
The data type of the Column
.
A free-form text comment.
" + } + }, + "Parameters": { + "target": "com.amazonaws.glue#ParametersMap", + "traits": { + "smithy.api#documentation": "These key-value pairs define properties associated with the column.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A column in a Table
.
The name of the column that failed.
" + } + }, + "Error": { + "target": "com.amazonaws.glue#ErrorDetail", + "traits": { + "smithy.api#documentation": "An error message with the reason for the failure of an operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Encapsulates a column name that failed and the reason for failure.
" + } + }, + "com.amazonaws.glue#ColumnErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ColumnError" + } + }, + "com.amazonaws.glue#ColumnImportance": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The name of a column.
" + } + }, + "Importance": { + "target": "com.amazonaws.glue#GenericBoundedDouble", + "traits": { + "smithy.api#documentation": "The column importance score for the column, as a decimal.
" + } + } }, "traits": { "smithy.api#documentation": "A structure containing the column name and column importance score for a column.
\n\t\n\tColumn importance helps you understand how columns contribute to your model, by identifying which columns in your records are more important than others.
" @@ -3176,6 +3963,21 @@ ] } }, + "com.amazonaws.glue#CompressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "gzip", + "name": "GZIP" + }, + { + "value": "bzip2", + "name": "BZIP2" + } + ] + } + }, "com.amazonaws.glue#ConcurrentModificationException": { "type": "structure", "members": { @@ -5022,6 +5824,12 @@ "traits": { "smithy.api#documentation": "The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
\n\tFor the Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
" + } } } }, @@ -6359,6 +7167,48 @@ "smithy.api#pattern": "^[^\\r\\n]$" } }, + "com.amazonaws.glue#CustomCode": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#ManyInputs", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.glue#ExtendedString", + "traits": { + "smithy.api#documentation": "The custom code that is used to perform the data transformation.
", + "smithy.api#required": {} + } + }, + "ClassName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name defined for the custom code node class.
", + "smithy.api#required": {} + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "Specifies the data schema for the custom code transform.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that uses custom code you provide to perform the data transformation. The output is a collection of DynamicFrames.
" + } + }, "com.amazonaws.glue#CustomEntityType": { "type": "structure", "members": { @@ -6620,6 +7470,28 @@ "com.amazonaws.glue#DatabaseName": { "type": "string" }, + "com.amazonaws.glue#Datatype": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#GenericLimitedString", + "traits": { + "smithy.api#documentation": "The datatype of the value.
", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.glue#GenericLimitedString", + "traits": { + "smithy.api#documentation": "A label assigned to the datatype.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure representing the datatype of the value.
" + } + }, "com.amazonaws.glue#DateColumnStatisticsData": { "type": "structure", "members": { @@ -8281,46 +9153,280 @@ } } }, + "com.amazonaws.glue#DirectKafkaSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "StreamingOptions": { + "target": "com.amazonaws.glue#KafkaStreamingSourceOptions", + "traits": { + "smithy.api#documentation": "Specifies the streaming options.
" + } + }, + "WindowSize": { + "target": "com.amazonaws.glue#BoxedPositiveInt", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The amount of time to spend processing each micro batch.
" + } + }, + "DetectSchema": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" + } + }, + "DataPreviewOptions": { + "target": "com.amazonaws.glue#StreamingDataPreviewOptions", + "traits": { + "smithy.api#documentation": "Specifies options related to data preview for viewing a sample of your data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an Apache Kafka data store.
" + } + }, + "com.amazonaws.glue#DirectKinesisSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "WindowSize": { + "target": "com.amazonaws.glue#BoxedPositiveInt", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The amount of time to spend processing each micro batch.
" + } + }, + "DetectSchema": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "Whether to automatically determine the schema from the incoming data.
" + } + }, + "StreamingOptions": { + "target": "com.amazonaws.glue#KinesisStreamingSourceOptions", + "traits": { + "smithy.api#documentation": "Additional options for the Kinesis streaming data source.
" + } + }, + "DataPreviewOptions": { + "target": "com.amazonaws.glue#StreamingDataPreviewOptions", + "traits": { + "smithy.api#documentation": "Additional options for data preview.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a direct Amazon Kinesis data source.
" + } + }, + "com.amazonaws.glue#DirectSchemaChangePolicy": { + "type": "structure", + "members": { + "EnableUpdateCatalog": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Whether to use the specified update behavior when the crawler finds a changed schema.
" + } + }, + "UpdateBehavior": { + "target": "com.amazonaws.glue#UpdateCatalogBehavior", + "traits": { + "smithy.api#documentation": "The update behavior when the crawler finds a changed schema.
" + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies the table in the database that the schema change policy applies to.
" + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies the database that the schema change policy applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A policy that specifies update behavior for the crawler.
" + } + }, "com.amazonaws.glue#Double": { "type": "double" }, - "com.amazonaws.glue#DoubleColumnStatisticsData": { + "com.amazonaws.glue#DoubleColumnStatisticsData": { + "type": "structure", + "members": { + "MinimumValue": { + "target": "com.amazonaws.glue#Double", + "traits": { + "smithy.api#documentation": "The lowest value in the column.
" + } + }, + "MaximumValue": { + "target": "com.amazonaws.glue#Double", + "traits": { + "smithy.api#documentation": "The highest value in the column.
" + } + }, + "NumberOfNulls": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of null values in the column.
", + "smithy.api#required": {} + } + }, + "NumberOfDistinctValues": { + "target": "com.amazonaws.glue#NonNegativeLong", + "traits": { + "smithy.api#documentation": "The number of distinct values in a column.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines column statistics supported for floating-point number data columns.
" + } + }, + "com.amazonaws.glue#DoubleValue": { + "type": "double" + }, + "com.amazonaws.glue#DropDuplicates": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.glue#LimitedPathList", + "traits": { + "smithy.api#documentation": "The name of the columns to be merged or removed if repeating.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that removes rows of repeating data from a data set.
" + } + }, + "com.amazonaws.glue#DropFields": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Paths": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "A JSON path to a variable in the data structure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that chooses the data property keys that you want to drop.
" + } + }, + "com.amazonaws.glue#DropNullFields": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "NullCheckBoxList": { + "target": "com.amazonaws.glue#NullCheckBoxList", + "traits": { + "smithy.api#documentation": "A structure that represents whether certain values are recognized as null values for removal.
" + } + }, + "NullTextList": { + "target": "com.amazonaws.glue#NullValueFields", + "traits": { + "smithy.api#documentation": "A structure that specifies a list of NullValueField structures that represent a custom null value such as zero or other value being used as a null placeholder unique to the dataset.
\n\nThe DropNullFields
transform removes custom null values only if both the value of the null placeholder and the datatype match the data.
Specifies a transform that removes columns from the dataset if all values in the column are 'null'. By default, Glue Studio will recognize null objects, but some values such as empty strings, strings that are \"null\", -1 integers or other placeholders such as zeros, are not automatically recognized as nulls.
" + } + }, + "com.amazonaws.glue#DynamoDBCatalogSource": { "type": "structure", "members": { - "MinimumValue": { - "target": "com.amazonaws.glue#Double", - "traits": { - "smithy.api#documentation": "The lowest value in the column.
" - } - }, - "MaximumValue": { - "target": "com.amazonaws.glue#Double", + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "The highest value in the column.
" + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} } }, - "NumberOfNulls": { - "target": "com.amazonaws.glue#NonNegativeLong", + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "The number of null values in the column.
", + "smithy.api#documentation": "The name of the database to read from.
", "smithy.api#required": {} } }, - "NumberOfDistinctValues": { - "target": "com.amazonaws.glue#NonNegativeLong", + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "The number of distinct values in a column.
", + "smithy.api#documentation": "The name of the table in the database to read from.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines column statistics supported for floating-point number data columns.
" + "smithy.api#documentation": "Specifies a DynamoDB data source in the Glue Data Catalog.
" } }, - "com.amazonaws.glue#DoubleValue": { - "type": "double" - }, "com.amazonaws.glue#DynamoDBTarget": { "type": "structure", "members": { @@ -8394,6 +9500,30 @@ ] } }, + "com.amazonaws.glue#EnclosedInStringProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#EnclosedInStringProperty" + } + }, + "com.amazonaws.glue#EnclosedInStringPropertiesMinOne": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#EnclosedInStringProperty" + } + }, + "com.amazonaws.glue#EnclosedInStringProperty": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\S\\r\\n\"'])*$" + } + }, + "com.amazonaws.glue#EnclosedInStringPropertyWithQuote": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\S\\r\\n])*$" + } + }, "com.amazonaws.glue#EncryptionAtRest": { "type": "structure", "members": { @@ -8609,9 +9739,170 @@ "smithy.api#documentation": "Specifies configuration properties for an exporting labels task run.
" } }, + "com.amazonaws.glue#ExtendedString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, "com.amazonaws.glue#FieldType": { "type": "string" }, + "com.amazonaws.glue#FillMissingValues": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "ImputedPath": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "A JSON path to a variable in the data structure for the dataset that is imputed.
", + "smithy.api#required": {} + } + }, + "FilledPath": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "A JSON path to a variable in the data structure for the dataset that is filled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that locates records in the dataset that have missing values and adds a new field with a value determined by imputation. The input data set is used to train the machine learning model that determines what the missing value should be.
" + } + }, + "com.amazonaws.glue#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "LogicalOperator": { + "target": "com.amazonaws.glue#FilterLogicalOperator", + "traits": { + "smithy.api#documentation": "The operator used to filter rows by comparing the key value to a specified value.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.glue#FilterExpressions", + "traits": { + "smithy.api#documentation": "Specifies a filter expression.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that splits a dataset into two, based on a filter condition.
" + } + }, + "com.amazonaws.glue#FilterExpression": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.glue#FilterOperation", + "traits": { + "smithy.api#documentation": "The type of operation to perform in the expression.
", + "smithy.api#required": {} + } + }, + "Negated": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Whether the expression is to be negated.
" + } + }, + "Values": { + "target": "com.amazonaws.glue#FilterValues", + "traits": { + "smithy.api#documentation": "A list of filter values.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a filter expression.
" + } + }, + "com.amazonaws.glue#FilterExpressions": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#FilterExpression" + } + }, + "com.amazonaws.glue#FilterLogicalOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AND", + "name": "AND" + }, + { + "value": "OR", + "name": "OR" + } + ] + } + }, + "com.amazonaws.glue#FilterOperation": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQ", + "name": "EQ" + }, + { + "value": "LT", + "name": "LT" + }, + { + "value": "GT", + "name": "GT" + }, + { + "value": "LTE", + "name": "LTE" + }, + { + "value": "GTE", + "name": "GTE" + }, + { + "value": "REGEX", + "name": "REGEX" + }, + { + "value": "ISNULL", + "name": "ISNULL" + } + ] + } + }, "com.amazonaws.glue#FilterString": { "type": "string", "traits": { @@ -8622,6 +9913,49 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.glue#FilterValue": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.glue#FilterValueType", + "traits": { + "smithy.api#documentation": "The type of filter value.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "The value to be associated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a single entry in the list of values for a FilterExpression
.
A structure for returning a resource policy.
" } }, + "com.amazonaws.glue#GlueRecordType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" + }, + { + "value": "INT", + "name": "INT" + }, + { + "value": "FLOAT", + "name": "FLOAT" + }, + { + "value": "LONG", + "name": "LONG" + }, + { + "value": "BIGDECIMAL", + "name": "BIGDECIMAL" + }, + { + "value": "BYTE", + "name": "BYTE" + }, + { + "value": "SHORT", + "name": "SHORT" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + } + ] + } + }, "com.amazonaws.glue#GlueResourceArn": { "type": "string", "traits": { @@ -13208,6 +14595,69 @@ "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):glue:" } }, + "com.amazonaws.glue#GlueSchema": { + "type": "structure", + "members": { + "Columns": { + "target": "com.amazonaws.glue#GlueStudioSchemaColumnList", + "traits": { + "smithy.api#documentation": "Specifies the column definitions that make up a Glue schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a user-defined schema when a schema cannot be determined by AWS Glue.
" + } + }, + "com.amazonaws.glue#GlueSchemas": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#GlueSchema" + } + }, + "com.amazonaws.glue#GlueStudioColumnNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.glue#GlueStudioPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#EnclosedInStringProperties" + } + }, + "com.amazonaws.glue#GlueStudioSchemaColumn": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#GlueStudioColumnNameString", + "traits": { + "smithy.api#documentation": "The name of the column in the Glue Studio schema.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.glue#ColumnTypeString", + "traits": { + "smithy.api#documentation": "The hive type for this column in the Glue Studio schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a single column in a Glue schema definition.
" + } + }, + "com.amazonaws.glue#GlueStudioSchemaColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#GlueStudioSchemaColumn" + } + }, "com.amazonaws.glue#GlueTable": { "type": "structure", "members": { @@ -13264,6 +14714,95 @@ "smithy.api#pattern": "^\\w+\\.\\w+$" } }, + "com.amazonaws.glue#GovernedCatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database table to read from.
", + "smithy.api#required": {} + } + }, + "PartitionPredicate": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to \"\"
– empty by default.
Specifies additional connection options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the data store in the governed Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#GovernedCatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "Specifies native partitioning using a sequence of keys.
" + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#CatalogSchemaChangePolicy", + "traits": { + "smithy.api#documentation": "A policy that specifies update behavior for the governed catalog.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
" + } + }, "com.amazonaws.glue#GrokClassifier": { "type": "structure", "members": { @@ -13496,31 +15035,381 @@ "traits": { "smithy.api#documentation": "A message describing the problem.
" } - } - }, - "traits": { - "smithy.api#documentation": "The input provided was not valid.
", - "smithy.api#error": "client" + } + }, + "traits": { + "smithy.api#documentation": "The input provided was not valid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#InvalidStateException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An error that indicates your data is in an invalid state.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#IsVersionValid": { + "type": "boolean" + }, + "com.amazonaws.glue#JDBCConnectorOptions": { + "type": "structure", + "members": { + "FilterPredicate": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Extra condition clause to filter data from source. For example:
\n\t\n\t\n BillingCity='Mountain View'
\n
When using a query instead of a table name, you should validate that the query works with the specified filterPredicate
.
The name of an integer column that is used for partitioning. This option works only when it's included with lowerBound
, upperBound
, and numPartitions
. This option works the same way as in the Spark SQL JDBC reader.
The minimum value of partitionColumn
that is used to decide partition stride.
The maximum value of partitionColumn
that is used to decide partition stride.
The number of partitions. This value, along with lowerBound
(inclusive) and upperBound
(exclusive), form partition strides for generated WHERE
clause expressions that are used to split the partitionColumn
.
The name of the job bookmark keys on which to sort.
" + } + }, + "JobBookmarkKeysSortOrder": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies an ascending or descending sort order.
" + } + }, + "DataTypeMapping": { + "target": "com.amazonaws.glue#JDBCDataTypeMapping", + "traits": { + "smithy.api#documentation": "Custom data type mapping that builds a mapping from a JDBC data type to an Glue data type. For example, the option \"dataTypeMapping\":{\"FLOAT\":\"STRING\"}
maps data fields of JDBC type FLOAT
into the Java String
type by calling the ResultSet.getString()
method of the driver, and uses it to build the Glue record. The ResultSet
object is implemented by each driver, so the behavior is specific to the driver you use. Refer to the documentation for your JDBC driver to understand how the driver performs the conversions.
Additional connection options for the connector.
" + } + }, + "com.amazonaws.glue#JDBCConnectorSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the connection that is associated with the connector.
", + "smithy.api#required": {} + } + }, + "ConnectorName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of a connector that assists with accessing the data store in Glue Studio.
", + "smithy.api#required": {} + } + }, + "ConnectionType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data store.
", + "smithy.api#required": {} + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#JDBCConnectorOptions", + "traits": { + "smithy.api#documentation": "Additional connection options for the connector.
" + } + }, + "ConnectionTable": { + "target": "com.amazonaws.glue#EnclosedInStringPropertyWithQuote", + "traits": { + "smithy.api#documentation": "The name of the table in the data source.
" + } + }, + "Query": { + "target": "com.amazonaws.glue#SqlQuery", + "traits": { + "smithy.api#documentation": "The table or SQL query to get the data from. You can specify either ConnectionTable
or query
, but not both.
Specifies the data schema for the custom JDBC source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a connector to a JDBC data source.
" + } + }, + "com.amazonaws.glue#JDBCConnectorTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the connection that is associated with the connector.
", + "smithy.api#required": {} + } + }, + "ConnectionTable": { + "target": "com.amazonaws.glue#EnclosedInStringPropertyWithQuote", + "traits": { + "smithy.api#documentation": "The name of the table in the data target.
", + "smithy.api#required": {} + } + }, + "ConnectorName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of a connector that will be used.
", + "smithy.api#required": {} + } + }, + "ConnectionType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The type of connection, such as marketplace.jdbc or custom.jdbc, designating a connection to a JDBC data target.
", + "smithy.api#required": {} + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", + "traits": { + "smithy.api#documentation": "Additional connection options for the connector.
" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "Specifies the data schema for the JDBC target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
" + } + }, + "com.amazonaws.glue#JDBCDataType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARRAY", + "name": "ARRAY" + }, + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "BINARY", + "name": "BINARY" + }, + { + "value": "BIT", + "name": "BIT" + }, + { + "value": "BLOB", + "name": "BLOB" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "CHAR", + "name": "CHAR" + }, + { + "value": "CLOB", + "name": "CLOB" + }, + { + "value": "DATALINK", + "name": "DATALINK" + }, + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "DECIMAL", + "name": "DECIMAL" + }, + { + "value": "DISTINCT", + "name": "DISTINCT" + }, + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "FLOAT", + "name": "FLOAT" + }, + { + "value": "INTEGER", + "name": "INTEGER" + }, + { + "value": "JAVA_OBJECT", + "name": "JAVA_OBJECT" + }, + { + "value": "LONGNVARCHAR", + "name": "LONGNVARCHAR" + }, + { + "value": "LONGVARBINARY", + "name": "LONGVARBINARY" + }, + { + "value": "LONGVARCHAR", + "name": "LONGVARCHAR" + }, + { + "value": "NCHAR", + "name": "NCHAR" + }, + { + "value": "NCLOB", + "name": "NCLOB" + }, + { + "value": "NULL", + "name": "NULL" + }, + { + "value": "NUMERIC", + "name": "NUMERIC" + }, + { + "value": "NVARCHAR", + "name": "NVARCHAR" + }, + { + "value": "OTHER", + "name": "OTHER" + }, + { + "value": "REAL", + "name": "REAL" + }, + { + "value": "REF", + "name": "REF" + }, + { + "value": "REF_CURSOR", + "name": "REF_CURSOR" + }, + { + "value": "ROWID", + "name": "ROWID" + }, + { + "value": "SMALLINT", + "name": "SMALLINT" + }, + { + "value": "SQLXML", + "name": "SQLXML" + }, + { + "value": "STRUCT", + "name": "STRUCT" + }, + { + "value": "TIME", + "name": "TIME" + }, + { + "value": "TIME_WITH_TIMEZONE", + "name": "TIME_WITH_TIMEZONE" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" + }, + { + "value": "TIMESTAMP_WITH_TIMEZONE", + "name": "TIMESTAMP_WITH_TIMEZONE" + }, + { + "value": "TINYINT", + "name": "TINYINT" + }, + { + "value": "VARBINARY", + "name": "VARBINARY" + }, + { + "value": "VARCHAR", + "name": "VARCHAR" + } + ] } }, - "com.amazonaws.glue#InvalidStateException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.glue#MessageString", - "traits": { - "smithy.api#documentation": "A message describing the problem.
" - } - } + "com.amazonaws.glue#JDBCDataTypeMapping": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#JDBCDataType" }, - "traits": { - "smithy.api#documentation": "An error that indicates your data is in an invalid state.
", - "smithy.api#error": "client" + "value": { + "target": "com.amazonaws.glue#GlueRecordType" } }, - "com.amazonaws.glue#IsVersionValid": { - "type": "boolean" - }, "com.amazonaws.glue#JdbcTarget": { "type": "structure", "members": { @@ -13678,6 +15567,12 @@ "traits": { "smithy.api#documentation": "Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
\n \nFor more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
\n\t \n\tJobs that are created without specifying a Glue version default to Glue 0.9.
" } + }, + "CodeGenConfigurationNodes": { + "target": "com.amazonaws.glue#CodeGenConfigurationNodes", + "traits": { + "smithy.api#documentation": "The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
" + } } }, "traits": { @@ -14121,12 +16016,119 @@ "traits": { "smithy.api#documentation": "Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
\n \nFor more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
" } + }, + "CodeGenConfigurationNodes": { + "target": "com.amazonaws.glue#CodeGenConfigurationNodes", + "traits": { + "smithy.api#documentation": "The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
" + } } }, "traits": { "smithy.api#documentation": "Specifies information used to update an existing job definition. The previous job\n definition is completely overwritten by this information.
" } }, + "com.amazonaws.glue#Join": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#TwoInputs", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "JoinType": { + "target": "com.amazonaws.glue#JoinType", + "traits": { + "smithy.api#documentation": "Specifies the type of join to be performed on the datasets.
", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.glue#JoinColumns", + "traits": { + "smithy.api#documentation": "A list of the two columns to be joined.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that joins two datasets into one dataset using a comparison phrase on the specified data property keys. You can use inner, outer, left, right, left semi, and left anti joins.
" + } + }, + "com.amazonaws.glue#JoinColumn": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The column to be joined.
", + "smithy.api#required": {} + } + }, + "Keys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "The key of the column to be joined.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a column to be joined.
" + } + }, + "com.amazonaws.glue#JoinColumns": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#JoinColumn" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.glue#JoinType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "equijoin", + "name": "EQUIJOIN" + }, + { + "value": "left", + "name": "LEFT" + }, + { + "value": "right", + "name": "RIGHT" + }, + { + "value": "outer", + "name": "OUTER" + }, + { + "value": "leftsemi", + "name": "LEFT_SEMI" + }, + { + "value": "leftanti", + "name": "LEFT_ANTI" + } + ] + } + }, "com.amazonaws.glue#JsonClassifier": { "type": "structure", "members": { @@ -14173,6 +16175,104 @@ "com.amazonaws.glue#JsonValue": { "type": "string" }, + "com.amazonaws.glue#KafkaStreamingSourceOptions": { + "type": "structure", + "members": { + "BootstrapServers": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094
. This option must be specified in the API call or defined in the table metadata in the Data Catalog.
The protocol used to communicate with brokers. The possible values are \"SSL\"
or \"PLAINTEXT\"
.
The name of the connection.
" + } + }, + "TopicName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The topic name as specified in Apache Kafka. You must specify at least one of \"topicName\"
, \"assign\"
or \"subscribePattern\"
.
The specific TopicPartitions
to consume. You must specify at least one of \"topicName\"
, \"assign\"
or \"subscribePattern\"
.
A Java regex string that identifies the topic list to subscribe to. You must specify at least one of \"topicName\"
, \"assign\"
or \"subscribePattern\"
.
An optional classification.
" + } + }, + "Delimiter": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies the delimiter character.
" + } + }, + "StartingOffsets": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The starting position in the Kafka topic to read data from. The possible values are \"earliest\"
or \"latest\"
. The default value is \"latest\"
.
The end point when a batch query is ended. Possible values are either \"latest\"
or a JSON string that specifies an ending offset for each TopicPartition
.
The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512
.
The number of times to retry before failing to fetch Kafka offsets. The default value is 3
.
The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10
.
The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions
of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.
The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional options for streaming.
" + } + }, "com.amazonaws.glue#KeyList": { "type": "list", "member": { @@ -14227,6 +16327,122 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.glue#KinesisStreamingSourceOptions": { + "type": "structure", + "members": { + "EndpointUrl": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The URL of the Kinesis endpoint.
" + } + }, + "StreamName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the Kinesis data stream.
" + } + }, + "Classification": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "An optional classification.
" + } + }, + "Delimiter": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies the delimiter character.
" + } + }, + "StartingPosition": { + "target": "com.amazonaws.glue#StartingPosition", + "traits": { + "smithy.api#documentation": "The starting position in the Kinesis data stream to read data from. The possible values are \"latest\"
, \"trim_horizon\"
, or \"earliest\"
. The default value is \"latest\"
.
The maximum time spent in the job executor to fetch a record from the Kinesis data stream per shard, specified in milliseconds (ms). The default value is 1000
.
The maximum number of records to fetch per shard in the Kinesis data stream. The default value is 100000
.
The maximum number of records to fetch from the Kinesis data stream in each getRecords operation. The default value is 10000
.
Adds a time delay between two consecutive getRecords operations. The default value is \"False\"
. This option is only configurable for Glue version 2.0 and above.
The minimum time delay between two consecutive getRecords operations, specified in ms. The default value is 1000
. This option is only configurable for Glue version 2.0 and above.
The minimum time interval between two ListShards API calls for your script to consider resharding. The default value is 1s
.
The maximum number of retries for Kinesis Data Streams API requests. The default value is 3
.
The cool-off time period (specified in ms) before retrying the Kinesis Data Streams API call. The default value is 1000
.
The maximum cool-off time period (specified in ms) between two retries of a Kinesis Data Streams API call. The default value is 10000
.
Avoids creating an empty microbatch job by checking for unread data in the Kinesis data stream before the batch is started. The default value is \"False\"
.
The Amazon Resource Name (ARN) of the Kinesis data stream.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role to assume using AWS Security Token Service (AWS STS). This role must have permissions for describe or read record operations for the Kinesis data stream. You must use this parameter when accessing a data stream in a different account. Used in conjunction with \"awsSTSSessionName\"
.
An identifier for the session assuming the role using AWS STS. You must use this parameter when accessing a data stream in a different account. Used in conjunction with \"awsSTSRoleARN\"
.
Additional options for the Amazon Kinesis streaming data source.
" + } + }, "com.amazonaws.glue#KmsKeyArn": { "type": "string", "traits": { @@ -14389,6 +16605,18 @@ "com.amazonaws.glue#LatestSchemaVersionBoolean": { "type": "boolean" }, + "com.amazonaws.glue#LimitedPathList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#LimitedStringList" + } + }, + "com.amazonaws.glue#LimitedStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#GenericLimitedString" + } + }, "com.amazonaws.glue#LineageConfiguration": { "type": "structure", "members": { @@ -15628,6 +17856,17 @@ ] } }, + "com.amazonaws.glue#ManyInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NodeId" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.glue#MapValue": { "type": "map", "key": { @@ -15643,6 +17882,50 @@ } } }, + "com.amazonaws.glue#Mapping": { + "type": "structure", + "members": { + "ToKey": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "After the apply mapping, what the name of the column should be. Can be the same as FromPath
.
The table or column to be modified.
" + } + }, + "FromType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The type of the data to be modified.
" + } + }, + "ToType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The data type that the data is to be modified to.
" + } + }, + "Dropped": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "If true, then the column is removed.
" + } + }, + "Children": { + "target": "com.amazonaws.glue#Mappings", + "traits": { + "smithy.api#documentation": "Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping
, but its FromPath
will be the parent's FromPath
plus the FromPath
from this structure.
For the children part, suppose you have the structure:
\n\t\n\t\n {\n \"FromPath\": \"OuterStructure\",\n \"ToKey\": \"OuterStructure\",\n \"ToType\": \"Struct\",\n \"Dropped\": false,\n \"Chidlren\": [{\n \"FromPath\": \"inner\",\n \"ToKey\": \"inner\",\n \"ToType\": \"Double\",\n \"Dropped\": false,\n }]\n}
\n
You can specify a Mapping
that looks like:
\n {\n \"FromPath\": \"OuterStructure\",\n \"ToKey\": \"OuterStructure\",\n \"ToType\": \"Struct\",\n \"Dropped\": false,\n \"Chidlren\": [{\n \"FromPath\": \"inner\",\n \"ToKey\": \"inner\",\n \"ToType\": \"Double\",\n \"Dropped\": false,\n }]\n}
\n
Specifies the mapping of data property keys.
" + } + }, "com.amazonaws.glue#MappingEntry": { "type": "structure", "members": { @@ -15693,6 +17976,22 @@ "target": "com.amazonaws.glue#MappingEntry" } }, + "com.amazonaws.glue#Mappings": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Mapping" + } + }, + "com.amazonaws.glue#MaskValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[*A-Za-z0-9_-]*$" + } + }, "com.amazonaws.glue#MatchCriteria": { "type": "list", "member": { @@ -15721,6 +18020,42 @@ "com.amazonaws.glue#MaxRetries": { "type": "integer" }, + "com.amazonaws.glue#Merge": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#TwoInputs", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.glue#NodeId", + "traits": { + "smithy.api#documentation": "The source DynamicFrame
that will be merged with a staging DynamicFrame
.
The list of primary key fields to match records from the source and staging dynamic frames.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that merges a DynamicFrame
with a staging DynamicFrame
based on the specified primary keys to identify records. Duplicate records (records with the same primary keys) are not de-duplicated.
The name of the data source.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a Microsoft SQL server data source in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#MicrosoftSQLServerCatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that uses Microsoft SQL.
" + } + }, "com.amazonaws.glue#MillisecondsCount": { "type": "long" }, @@ -15850,6 +18250,71 @@ "target": "com.amazonaws.glue#MongoDBTarget" } }, + "com.amazonaws.glue#MySQLCatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a MySQL data source in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#MySQLCatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that uses MySQL.
" + } + }, "com.amazonaws.glue#NameString": { "type": "string", "traits": { @@ -15925,6 +18390,12 @@ "smithy.api#documentation": "A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
" } }, + "com.amazonaws.glue#NodeId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9_-]*$" + } + }, "com.amazonaws.glue#NodeIdList": { "type": "list", "member": { @@ -15937,6 +18408,12 @@ "target": "com.amazonaws.glue#Node" } }, + "com.amazonaws.glue#NodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF]|[^\\r\\n])*$" + } + }, "com.amazonaws.glue#NodeType": { "type": "string", "traits": { @@ -15964,6 +18441,14 @@ } } }, + "com.amazonaws.glue#NonNegativeInt": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.glue#NonNegativeInteger": { "type": "integer", "traits": { @@ -16003,6 +18488,66 @@ } } }, + "com.amazonaws.glue#NullCheckBoxList": { + "type": "structure", + "members": { + "IsEmpty": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies that an empty string is considered as a null value.
" + } + }, + "IsNullString": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies that a value spelling out the word 'null' is considered as a null value.
" + } + }, + "IsNegOne": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies that an integer value of -1 is considered as a null value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents whether certain values are recognized as null values for removal.
" + } + }, + "com.amazonaws.glue#NullValueField": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The value of the null placeholder.
", + "smithy.api#required": {} + } + }, + "Datatype": { + "target": "com.amazonaws.glue#Datatype", + "traits": { + "smithy.api#documentation": "The datatype of the value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a custom null value such as a zeros or other value being used as a null placeholder unique to the dataset.
" + } + }, + "com.amazonaws.glue#NullValueFields": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NullValueField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.glue#NullableBoolean": { "type": "boolean", "traits": { @@ -16018,22 +18563,99 @@ "com.amazonaws.glue#NullableInteger": { "type": "integer", "traits": { - "smithy.api#box": {} + "smithy.api#box": {} + } + }, + "com.amazonaws.glue#OneInput": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NodeId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.glue#OperationTimeoutException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The operation timed out.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.glue#OracleSQLCatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an Oracle data source in the Glue Data Catalog.
" } }, - "com.amazonaws.glue#OperationTimeoutException": { + "com.amazonaws.glue#OracleSQLCatalogTarget": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.glue#MessageString", + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "A message describing the problem.
" + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The operation timed out.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Specifies a target that uses Oracle SQL.
" } }, "com.amazonaws.glue#OrchestrationArgumentsMap": { @@ -16179,6 +18801,66 @@ "smithy.api#documentation": "A structure containing other metadata for a schema version belonging to the same metadata key.
" } }, + "com.amazonaws.glue#PIIDetection": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The node ID inputs to the transform.
", + "smithy.api#required": {} + } + }, + "PiiType": { + "target": "com.amazonaws.glue#PiiType", + "traits": { + "smithy.api#documentation": "Indicates the type of PIIDetection transform.
", + "smithy.api#required": {} + } + }, + "EntityTypesToDetect": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "Indicates the types of entities the PIIDetection transform will identify as PII data.
\n\n PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT,\n IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER,\n USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE\n
", + "smithy.api#required": {} + } + }, + "OutputColumnName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Indicates the output column name that will contain any entity type detected in that row.
" + } + }, + "SampleFraction": { + "target": "com.amazonaws.glue#BoxedDoubleFraction", + "traits": { + "smithy.api#documentation": "Indicates the fraction of the data to sample when scanning for PII entities.
" + } + }, + "ThresholdFraction": { + "target": "com.amazonaws.glue#BoxedDoubleFraction", + "traits": { + "smithy.api#documentation": "Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
" + } + }, + "MaskValue": { + "target": "com.amazonaws.glue#MaskValue", + "traits": { + "smithy.api#documentation": "Indicates the value that will replace the detected entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that identifies, removes or masks PII data.
" + } + }, "com.amazonaws.glue#PageSize": { "type": "integer", "traits": { @@ -16210,6 +18892,33 @@ } } }, + "com.amazonaws.glue#ParquetCompressionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "snappy", + "name": "SNAPPY" + }, + { + "value": "lzo", + "name": "LZO" + }, + { + "value": "gzip", + "name": "GZIP" + }, + { + "value": "uncompressed", + "name": "UNCOMPRESSED" + }, + { + "value": "none", + "name": "NONE" + } + ] + } + }, "com.amazonaws.glue#Partition": { "type": "structure", "members": { @@ -16589,6 +19298,29 @@ "smithy.api#documentation": "Specifies the physical requirements for a connection.
" } }, + "com.amazonaws.glue#PiiType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RowAudit", + "name": "RowAudit" + }, + { + "value": "RowMasking", + "name": "RowMasking" + }, + { + "value": "ColumnAudit", + "name": "ColumnAudit" + }, + { + "value": "ColumnMasking", + "name": "ColumnMasking" + } + ] + } + }, "com.amazonaws.glue#PolicyJsonString": { "type": "string", "traits": { @@ -16597,6 +19329,89 @@ } } }, + "com.amazonaws.glue#PollingTime": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 10 + } + } + }, + "com.amazonaws.glue#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.glue#PostgreSQLCatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a PostgresSQL data source in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#PostgreSQLCatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that uses Postgres SQL.
" + } + }, "com.amazonaws.glue#Predecessor": { "type": "structure", "members": { @@ -16698,6 +19513,16 @@ ] } }, + "com.amazonaws.glue#Prob": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.glue#PropertyPredicate": { "type": "structure", "members": { @@ -17139,6 +19964,29 @@ } } }, + "com.amazonaws.glue#QuoteChar": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "quote", + "name": "QUOTE" + }, + { + "value": "quillemet", + "name": "QUILLEMET" + }, + { + "value": "single_quote", + "name": "SINGLE_QUOTE" + }, + { + "value": "disabled", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.glue#RecordsCount": { "type": "long", "traits": { @@ -17178,6 +20026,101 @@ "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#RedshiftSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the Amazon Redshift data store.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database table to read from.
", + "smithy.api#required": {} + } + }, + "RedshiftTmpDir": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The Amazon S3 path where temporary data can be staged when copying out of the database.
" + } + }, + "TmpDirIAMRole": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The IAM role with permissions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an Amazon Redshift data store.
" + } + }, + "com.amazonaws.glue#RedshiftTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} + } + }, + "RedshiftTmpDir": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The Amazon S3 path where temporary data can be staged when copying out of the database.
" + } + }, + "TmpDirIAMRole": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The IAM role with permissions.
" + } + }, + "UpsertRedshiftOptions": { + "target": "com.amazonaws.glue#UpsertRedshiftTargetOptions", + "traits": { + "smithy.api#documentation": "The set of options to configure an upsert operation when writing to a Redshift target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that uses Amazon Redshift.
" + } + }, "com.amazonaws.glue#RegisterSchemaVersion": { "type": "operation", "input": { @@ -17337,6 +20280,35 @@ ] } }, + "com.amazonaws.glue#RelationalCatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to read from.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a Relational database data source in the Glue Data Catalog.
" + } + }, "com.amazonaws.glue#RemoveSchemaVersionMetadata": { "type": "operation", "input": { @@ -17443,6 +20415,42 @@ } } }, + "com.amazonaws.glue#RenameField": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "SourcePath": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "A JSON path to a variable in the data structure for the source data.
", + "smithy.api#required": {} + } + }, + "TargetPath": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "A JSON path to a variable in the data structure for the target data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that renames a single data property key.
" + } + }, "com.amazonaws.glue#ReplaceBoolean": { "type": "boolean" }, @@ -17635,133 +20643,434 @@ "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "The name of the workflow to resume.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the workflow to resume.
", + "smithy.api#required": {} + } + }, + "RunId": { + "target": "com.amazonaws.glue#IdString", + "traits": { + "smithy.api#documentation": "The ID of the workflow run to resume.
", + "smithy.api#required": {} + } + }, + "NodeIds": { + "target": "com.amazonaws.glue#NodeIdList", + "traits": { + "smithy.api#documentation": "A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#ResumeWorkflowRunResponse": { + "type": "structure", + "members": { + "RunId": { + "target": "com.amazonaws.glue#IdString", + "traits": { + "smithy.api#documentation": "The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
" + } + }, + "NodeIds": { + "target": "com.amazonaws.glue#NodeIdList", + "traits": { + "smithy.api#documentation": "A list of the node IDs for the nodes that were actually restarted.
" + } + } + } + }, + "com.amazonaws.glue#Role": { + "type": "string" + }, + "com.amazonaws.glue#RoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:iam::\\d{12}:role/" + } + }, + "com.amazonaws.glue#RoleString": { + "type": "string" + }, + "com.amazonaws.glue#RowTag": { + "type": "string" + }, + "com.amazonaws.glue#RunId": { + "type": "string" + }, + "com.amazonaws.glue#RunStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#RunStatementRequest" + }, + "output": { + "target": "com.amazonaws.glue#RunStatementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalSessionStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + }, + { + "target": "com.amazonaws.glue#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Executes the statement.
" + } + }, + "com.amazonaws.glue#RunStatementRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The Session Id of the statement to be run.
", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.glue#OrchestrationStatementCodeString", + "traits": { + "smithy.api#documentation": "The statement code to be run.
", + "smithy.api#required": {} + } + }, + "RequestOrigin": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "The origin of the request.
" + } + } + } + }, + "com.amazonaws.glue#RunStatementResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#IntegerValue", + "traits": { + "smithy.api#documentation": "Returns the Id of the statement that was run.
" + } + } + } + }, + "com.amazonaws.glue#S3CatalogSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database to read from.
", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The database table to read from.
", + "smithy.api#required": {} + } + }, + "PartitionPredicate": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. Set to \"\"
– empty by default.
Specifies additional connection options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an Amazon S3 data store in the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#S3CatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "Specifies native partitioning using a sequence of keys.
" + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the table in the database to write to.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the database to write to.
", + "smithy.api#required": {} + } + }, + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#CatalogSchemaChangePolicy", + "traits": { + "smithy.api#documentation": "A policy that specifies update behavior for the crawler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 using the Glue Data Catalog.
" + } + }, + "com.amazonaws.glue#S3CsvSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "Paths": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "A list of the Amazon S3 paths to read from.
", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.glue#CompressionType", + "traits": { + "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\"
and \"bzip\"
).
A string containing a JSON list of Unix-style glob patterns to exclude. For example, \"[\\\"**.pdf\\\"]\" excludes all PDF files.
" + } + }, + "GroupSize": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, \"groupFiles\"
must be set to \"inPartition\"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to \"inPartition\". To disable grouping when there are more than 50,000 files, set this parameter to \"none\"
.
If set to true, recursively reads files in all subdirectories under the specified paths.
" + } + }, + "MaxBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
" + } + }, + "MaxFilesInBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
" + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#S3DirectSourceAdditionalOptions", + "traits": { + "smithy.api#documentation": "Specifies additional connection options.
" + } + }, + "Separator": { + "target": "com.amazonaws.glue#Separator", + "traits": { + "smithy.api#documentation": "Specifies the delimiter character. The default is a comma: \",\", but any other character can be specified.
", + "smithy.api#required": {} + } + }, + "Escaper": { + "target": "com.amazonaws.glue#EnclosedInStringPropertyWithQuote", + "traits": { + "smithy.api#documentation": "Specifies a character to use for escaping. This option is used only when reading CSV files. The default value is none
. If enabled, the character which immediately follows is used as-is, except for a small set of well-known escapes (\\n
, \\r
, \\t
, and \\0
).
The ID of the workflow run to resume.
", + "smithy.api#documentation": "Specifies the character to use for quoting. The default is a double quote: '\"'
. Set this to -1
to turn off quoting entirely.
A list of the node IDs for the nodes you want to restart. The nodes that are to be restarted must have a run attempt in the original run.
", - "smithy.api#required": {} + "smithy.api#documentation": "A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False
, which allows for more aggressive file-splitting during parsing.
The new ID assigned to the resumed workflow run. Each resume of a workflow run will have a new run ID.
" + "smithy.api#documentation": "A Boolean value that specifies whether to treat the first line as a header. The default value is False
.
A list of the node IDs for the nodes that were actually restarted.
" + "smithy.api#documentation": "A Boolean value that specifies whether to write the header to output. The default value is True
.
A Boolean value that specifies whether to skip the first data line. The default value is False
.
A Boolean value that specifies whether to use the advanced SIMD CSV reader along with Apache Arrow based columnar memory formats. Only available in Glue version 3.0.
" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "Specifies the data schema for the S3 CSV source.
" } } - } - }, - "com.amazonaws.glue#Role": { - "type": "string" - }, - "com.amazonaws.glue#RoleArn": { - "type": "string", + }, "traits": { - "smithy.api#pattern": "^arn:aws:iam::\\d{12}:role/" + "smithy.api#documentation": "Specifies a command-separated value (CSV) data store stored in Amazon S3.
" } }, - "com.amazonaws.glue#RoleString": { - "type": "string" - }, - "com.amazonaws.glue#RowTag": { - "type": "string" - }, - "com.amazonaws.glue#RunId": { - "type": "string" - }, - "com.amazonaws.glue#RunStatement": { - "type": "operation", - "input": { - "target": "com.amazonaws.glue#RunStatementRequest" - }, - "output": { - "target": "com.amazonaws.glue#RunStatementResponse" - }, - "errors": [ - { - "target": "com.amazonaws.glue#AccessDeniedException" - }, - { - "target": "com.amazonaws.glue#EntityNotFoundException" - }, - { - "target": "com.amazonaws.glue#IllegalSessionStateException" - }, - { - "target": "com.amazonaws.glue#InternalServiceException" - }, - { - "target": "com.amazonaws.glue#InvalidInputException" + "com.amazonaws.glue#S3DirectSourceAdditionalOptions": { + "type": "structure", + "members": { + "BoundedSize": { + "target": "com.amazonaws.glue#BoxedLong", + "traits": { + "smithy.api#documentation": "Sets the upper limit for the target size of the dataset in bytes that will be processed.
" + } }, - { - "target": "com.amazonaws.glue#OperationTimeoutException" + "BoundedFiles": { + "target": "com.amazonaws.glue#BoxedLong", + "traits": { + "smithy.api#documentation": "Sets the upper limit for the target number of files that will be processed.
" + } }, - { - "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + "EnableSamplePath": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Sets option to enable a sample path.
" + } }, - { - "target": "com.amazonaws.glue#ValidationException" + "SamplePath": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "If enabled, specifies the sample path.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Executes the statement.
" + "smithy.api#documentation": "Specifies additional connection options for the Amazon S3 data store.
" } }, - "com.amazonaws.glue#RunStatementRequest": { + "com.amazonaws.glue#S3DirectTarget": { "type": "structure", "members": { - "SessionId": { - "target": "com.amazonaws.glue#NameString", + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "The Session Id of the statement to be run.
", + "smithy.api#documentation": "The name of the data target.
", "smithy.api#required": {} } }, - "Code": { - "target": "com.amazonaws.glue#OrchestrationStatementCodeString", + "Inputs": { + "target": "com.amazonaws.glue#OneInput", "traits": { - "smithy.api#documentation": "The statement code to be run.
", + "smithy.api#documentation": "The nodes that are inputs to the data target.
", "smithy.api#required": {} } }, - "RequestOrigin": { - "target": "com.amazonaws.glue#OrchestrationNameString", + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", "traits": { - "smithy.api#documentation": "The origin of the request.
" + "smithy.api#documentation": "Specifies native partitioning using a sequence of keys.
" } - } - } - }, - "com.amazonaws.glue#RunStatementResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.glue#IntegerValue", + }, + "Path": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "Returns the Id of the statement that was run.
" + "smithy.api#documentation": "A single Amazon S3 path to write to.
", + "smithy.api#required": {} + } + }, + "Compression": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\"
and \"bzip\"
).
Specifies the data output format for the target.
", + "smithy.api#required": {} + } + }, + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#DirectSchemaChangePolicy", + "traits": { + "smithy.api#documentation": "A policy that specifies update behavior for the crawler.
" } } + }, + "traits": { + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3.
" } }, "com.amazonaws.glue#S3Encryption": { @@ -17806,7 +21115,238 @@ "value": "SSE-S3", "name": "SSES3" } - ] + ] + } + }, + "com.amazonaws.glue#S3GlueParquetTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} + } + }, + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "Specifies native partitioning using a sequence of keys.
" + } + }, + "Path": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "A single Amazon S3 path to write to.
", + "smithy.api#required": {} + } + }, + "Compression": { + "target": "com.amazonaws.glue#ParquetCompressionType", + "traits": { + "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\"
and \"bzip\"
).
A policy that specifies update behavior for the crawler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
" + } + }, + "com.amazonaws.glue#S3JsonSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "Paths": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "A list of the Amazon S3 paths to read from.
", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.glue#CompressionType", + "traits": { + "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\"
and \"bzip\"
).
A string containing a JSON list of Unix-style glob patterns to exclude. For example, \"[\\\"**.pdf\\\"]\" excludes all PDF files.
" + } + }, + "GroupSize": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, \"groupFiles\"
must be set to \"inPartition\"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to \"inPartition\". To disable grouping when there are more than 50,000 files, set this parameter to \"none\"
.
If set to true, recursively reads files in all subdirectories under the specified paths.
" + } + }, + "MaxBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
" + } + }, + "MaxFilesInBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
" + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#S3DirectSourceAdditionalOptions", + "traits": { + "smithy.api#documentation": "Specifies additional connection options.
" + } + }, + "JsonPath": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "A JsonPath string defining the JSON data.
" + } + }, + "Multiline": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False
, which allows for more aggressive file-splitting during parsing.
Specifies the data schema for the S3 JSON source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a JSON data store stored in Amazon S3.
" + } + }, + "com.amazonaws.glue#S3ParquetSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the data store.
", + "smithy.api#required": {} + } + }, + "Paths": { + "target": "com.amazonaws.glue#EnclosedInStringProperties", + "traits": { + "smithy.api#documentation": "A list of the Amazon S3 paths to read from.
", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.glue#ParquetCompressionType", + "traits": { + "smithy.api#documentation": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\"
and \"bzip\"
).
A string containing a JSON list of Unix-style glob patterns to exclude. For example, \"[\\\"**.pdf\\\"]\" excludes all PDF files.
" + } + }, + "GroupSize": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, \"groupFiles\"
must be set to \"inPartition\"
for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to \"inPartition\". To disable grouping when there are more than 50,000 files, set this parameter to \"none\"
.
If set to true, recursively reads files in all subdirectories under the specified paths.
" + } + }, + "MaxBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
" + } + }, + "MaxFilesInBand": { + "target": "com.amazonaws.glue#BoxedNonNegativeInt", + "traits": { + "smithy.api#documentation": "This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
" + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#S3DirectSourceAdditionalOptions", + "traits": { + "smithy.api#documentation": "Specifies additional connection options.
" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "Specifies the data schema for the S3 Parquet source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an Apache Parquet data store stored in Amazon S3.
" + } + }, + "com.amazonaws.glue#S3SourceAdditionalOptions": { + "type": "structure", + "members": { + "BoundedSize": { + "target": "com.amazonaws.glue#BoxedLong", + "traits": { + "smithy.api#documentation": "Sets the upper limit for the target size of the dataset in bytes that will be processed.
" + } + }, + "BoundedFiles": { + "target": "com.amazonaws.glue#BoxedLong", + "traits": { + "smithy.api#documentation": "Sets the upper limit for the target number of files that will be processed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies additional connection options for the Amazon S3 data store.
" } }, "com.amazonaws.glue#S3Target": { @@ -18360,382 +21900,716 @@ "smithy.api#documentation": "A continuation token, included if this is a continuation call.
" } }, - "Filters": { - "target": "com.amazonaws.glue#SearchPropertyPredicates", + "Filters": { + "target": "com.amazonaws.glue#SearchPropertyPredicates", + "traits": { + "smithy.api#documentation": "A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
\n\t\n\tThe Comparator
member of the PropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name
, a fuzzy match algorithm is used. The Key
field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value
member of PropertyPredicate
. For example, if Key=Name
and Value=link
, tables named customer-link
and xx-link-yy
are returned, but xxlinkyy
is not returned.
A string used for a text search.
\n\tSpecifying a value in quotes filters based on an exact match to the value.
" + } + }, + "SortCriteria": { + "target": "com.amazonaws.glue#SortCriteria", + "traits": { + "smithy.api#documentation": "A list of criteria for sorting the results by a field name, in an ascending or descending order.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of tables to return in a single response.
" + } + }, + "ResourceShareType": { + "target": "com.amazonaws.glue#ResourceShareType", + "traits": { + "smithy.api#documentation": "Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN
or ALL
.
If set to FOREIGN
, will search the tables shared with your account.
If set to ALL
, will search the tables shared with your account, as well as the tables in yor local account.
A continuation token, present if the current list segment is not the last.
" + } + }, + "TableList": { + "target": "com.amazonaws.glue#TableList", + "traits": { + "smithy.api#documentation": "A list of the requested Table
objects. The SearchTables
response returns only the tables that you have access to.
The name of the security configuration.
" + } + }, + "CreatedTimeStamp": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "The time at which this security configuration was created.
" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.glue#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "The encryption configuration associated with this security configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a security configuration.
" + } + }, + "com.amazonaws.glue#SecurityConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#SecurityConfiguration" + } + }, + "com.amazonaws.glue#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.glue#Segment": { + "type": "structure", + "members": { + "SegmentNumber": { + "target": "com.amazonaws.glue#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "The zero-based index number of the segment. For example, if the total number of segments\n is 4, SegmentNumber
values range from 0 through 3.
The total number of segments.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a non-overlapping region of a table's partitions, allowing\n multiple requests to be run in parallel.
" + } + }, + "com.amazonaws.glue#SelectFields": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Paths": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "A JSON path to a variable in the data structure.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that chooses the data property keys that you want to keep.
" + } + }, + "com.amazonaws.glue#SelectFromCollection": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Index": { + "target": "com.amazonaws.glue#NonNegativeInt", + "traits": { + "smithy.api#documentation": "The index for the DynamicFrame to be selected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a transform that chooses one DynamicFrame
from a collection of DynamicFrames
. The output is the selected DynamicFrame
\n
Name of the SerDe.
" + } + }, + "SerializationLibrary": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Usually the class that implements the SerDe. An example is\n org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
.
These key-value pairs define initialization parameters for the SerDe.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a serialization/deserialization program (SerDe) that serves as an\n extractor and loader.
" + } + }, + "com.amazonaws.glue#Session": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "The ID of the session.
" + } + }, + "CreatedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "The time and date when the session was created.
" + } + }, + "Status": { + "target": "com.amazonaws.glue#SessionStatus", + "traits": { + "smithy.api#documentation": "The session status.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "The error message displayed during the session.
" + } + }, + "Description": { + "target": "com.amazonaws.glue#DescriptionString", + "traits": { + "smithy.api#documentation": "The description of the session.
" + } + }, + "Role": { + "target": "com.amazonaws.glue#OrchestrationRoleArn", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
" + } + }, + "Command": { + "target": "com.amazonaws.glue#SessionCommand", + "traits": { + "smithy.api#documentation": "The command object.See SessionCommand.
" + } + }, + "DefaultArguments": { + "target": "com.amazonaws.glue#OrchestrationArgumentsMap", + "traits": { + "smithy.api#documentation": "A map array of key-value pairs. Max is 75 pairs.
" + } + }, + "Connections": { + "target": "com.amazonaws.glue#ConnectionsList", "traits": { - "smithy.api#documentation": "A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
\n\t\n\tThe Comparator
member of the PropertyPredicate
struct is used only for time fields, and can be omitted for other field types. Also, when comparing string values, such as when Key=Name
, a fuzzy match algorithm is used. The Key
field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #, etc. into tokens. Then each token is exact-match compared with the Value
member of PropertyPredicate
. For example, if Key=Name
and Value=link
, tables named customer-link
and xx-link-yy
are returned, but xxlinkyy
is not returned.
The number of connections used for the session.
" } }, - "SearchText": { - "target": "com.amazonaws.glue#ValueString", + "Progress": { + "target": "com.amazonaws.glue#DoubleValue", "traits": { - "smithy.api#documentation": "A string used for a text search.
\n\tSpecifying a value in quotes filters based on an exact match to the value.
" + "smithy.api#documentation": "The code execution progress of the session.
" } }, - "SortCriteria": { - "target": "com.amazonaws.glue#SortCriteria", + "MaxCapacity": { + "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "A list of criteria for sorting the results by a field name, in an ascending or descending order.
" + "smithy.api#documentation": "The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
" } }, - "MaxResults": { - "target": "com.amazonaws.glue#PageSize", + "SecurityConfiguration": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "The maximum number of tables to return in a single response.
" + "smithy.api#documentation": "The name of the SecurityConfiguration structure to be used with the session.
" } }, - "ResourceShareType": { - "target": "com.amazonaws.glue#ResourceShareType", + "GlueVersion": { + "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN
or ALL
.
If set to FOREIGN
, will search the tables shared with your account.
If set to ALL
, will search the tables shared with your account, as well as the tables in yor local account.
The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. \n The GlueVersion must be greater than 2.0.
" } } + }, + "traits": { + "smithy.api#documentation": "The period in which a remote Spark runtime environment is running.
" } }, - "com.amazonaws.glue#SearchTablesResponse": { + "com.amazonaws.glue#SessionCommand": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.glue#Token", + "Name": { + "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "A continuation token, present if the current list segment is not the last.
" + "smithy.api#documentation": "Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.
" } }, - "TableList": { - "target": "com.amazonaws.glue#TableList", + "PythonVersion": { + "target": "com.amazonaws.glue#PythonVersionString", "traits": { - "smithy.api#documentation": "A list of the requested Table
objects. The SearchTables
response returns only the tables that you have access to.
Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
" } } + }, + "traits": { + "smithy.api#documentation": "The SessionCommand
that runs the job.
The name of the security configuration.
" + "smithy.api#documentation": "A list of names of columns that contain skewed values.
" } }, - "CreatedTimeStamp": { - "target": "com.amazonaws.glue#TimestampValue", + "SkewedColumnValues": { + "target": "com.amazonaws.glue#ColumnValueStringList", "traits": { - "smithy.api#documentation": "The time at which this security configuration was created.
" + "smithy.api#documentation": "A list of values that appear so frequently as to be considered\n skewed.
" } }, - "EncryptionConfiguration": { - "target": "com.amazonaws.glue#EncryptionConfiguration", + "SkewedColumnValueLocationMaps": { + "target": "com.amazonaws.glue#LocationMap", "traits": { - "smithy.api#documentation": "The encryption configuration associated with this security configuration.
" + "smithy.api#documentation": "A mapping of skewed values to the columns that contain them.
" } } }, "traits": { - "smithy.api#documentation": "Specifies a security configuration.
" + "smithy.api#documentation": "Specifies skewed values in a table. Skewed values are those that occur with very high\n frequency.
" } }, - "com.amazonaws.glue#SecurityConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.glue#SecurityConfiguration" + "com.amazonaws.glue#Sort": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASCENDING" + }, + { + "value": "DESC", + "name": "DESCENDING" + } + ] } }, - "com.amazonaws.glue#SecurityGroupIdList": { + "com.amazonaws.glue#SortCriteria": { "type": "list", "member": { - "target": "com.amazonaws.glue#NameString" + "target": "com.amazonaws.glue#SortCriterion" }, "traits": { "smithy.api#length": { "min": 0, - "max": 50 + "max": 1 } } }, - "com.amazonaws.glue#Segment": { + "com.amazonaws.glue#SortCriterion": { "type": "structure", "members": { - "SegmentNumber": { - "target": "com.amazonaws.glue#NonNegativeInteger", + "FieldName": { + "target": "com.amazonaws.glue#ValueString", "traits": { - "smithy.api#documentation": "The zero-based index number of the segment. For example, if the total number of segments\n is 4, SegmentNumber
values range from 0 through 3.
The name of the field on which to sort.
" } }, - "TotalSegments": { - "target": "com.amazonaws.glue#TotalSegmentsInteger", + "Sort": { + "target": "com.amazonaws.glue#Sort", "traits": { - "smithy.api#documentation": "The total number of segments.
", - "smithy.api#required": {} + "smithy.api#documentation": "An ascending or descending sort.
" } } }, "traits": { - "smithy.api#documentation": "Defines a non-overlapping region of a table's partitions, allowing\n multiple requests to be run in parallel.
" + "smithy.api#documentation": "Specifies a field to sort by and a sort order.
" } }, - "com.amazonaws.glue#SerDeInfo": { + "com.amazonaws.glue#SortDirectionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DESCENDING", + "name": "DESCENDING" + }, + { + "value": "ASCENDING", + "name": "ASCENDING" + } + ] + } + }, + "com.amazonaws.glue#SparkConnectorSource": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.glue#NameString", + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "Name of the SerDe.
" + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} } }, - "SerializationLibrary": { - "target": "com.amazonaws.glue#NameString", + "ConnectionName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "Usually the class that implements the SerDe. An example is\n org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe
.
The name of the connection that is associated with the connector.
", + "smithy.api#required": {} } }, - "Parameters": { - "target": "com.amazonaws.glue#ParametersMap", + "ConnectorName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "These key-value pairs define initialization parameters for the SerDe.
" + "smithy.api#documentation": "The name of a connector that assists with accessing the data store in Glue Studio.
", + "smithy.api#required": {} + } + }, + "ConnectionType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
", + "smithy.api#required": {} + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", + "traits": { + "smithy.api#documentation": "Additional connection options for the connector.
" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "Specifies data schema for the custom spark source.
" } } }, "traits": { - "smithy.api#documentation": "Information about a serialization/deserialization program (SerDe) that serves as an\n extractor and loader.
" + "smithy.api#documentation": "Specifies a connector to an Apache Spark data source.
" } }, - "com.amazonaws.glue#Session": { + "com.amazonaws.glue#SparkConnectorTarget": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.glue#NameString", - "traits": { - "smithy.api#documentation": "The ID of the session.
" - } - }, - "CreatedOn": { - "target": "com.amazonaws.glue#TimestampValue", + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "The time and date when the session was created.
" + "smithy.api#documentation": "The name of the data target.
", + "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.glue#SessionStatus", + "Inputs": { + "target": "com.amazonaws.glue#OneInput", "traits": { - "smithy.api#documentation": "The session status.
" + "smithy.api#documentation": "The nodes that are inputs to the data target.
", + "smithy.api#required": {} } }, - "ErrorMessage": { - "target": "com.amazonaws.glue#DescriptionString", + "ConnectionName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "The error message displayed during the session.
" + "smithy.api#documentation": "The name of a connection for an Apache Spark connector.
", + "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.glue#DescriptionString", + "ConnectorName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "The description of the session.
" + "smithy.api#documentation": "The name of an Apache Spark connector.
", + "smithy.api#required": {} } }, - "Role": { - "target": "com.amazonaws.glue#OrchestrationRoleArn", + "ConnectionType": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
" + "smithy.api#documentation": "The type of connection, such as marketplace.spark or custom.spark, designating a connection to an Apache Spark data store.
", + "smithy.api#required": {} } }, - "Command": { - "target": "com.amazonaws.glue#SessionCommand", + "AdditionalOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", "traits": { - "smithy.api#documentation": "The command object.See SessionCommand.
" + "smithy.api#documentation": "Additional connection options for the connector.
" } }, - "DefaultArguments": { - "target": "com.amazonaws.glue#OrchestrationArgumentsMap", + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", "traits": { - "smithy.api#documentation": "A map array of key-value pairs. Max is 75 pairs.
" + "smithy.api#documentation": "Specifies the data schema for the custom spark target.
" } - }, - "Connections": { - "target": "com.amazonaws.glue#ConnectionsList", + } + }, + "traits": { + "smithy.api#documentation": "Specifies a target that uses an Apache Spark connector.
" + } + }, + "com.amazonaws.glue#SparkSQL": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "The number of connections used for the session.
" + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} } }, - "Progress": { - "target": "com.amazonaws.glue#DoubleValue", + "Inputs": { + "target": "com.amazonaws.glue#ManyInputs", "traits": { - "smithy.api#documentation": "The code execution progress of the session.
" + "smithy.api#documentation": "The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
", + "smithy.api#required": {} } }, - "MaxCapacity": { - "target": "com.amazonaws.glue#NullableDouble", + "SqlQuery": { + "target": "com.amazonaws.glue#SqlQuery", "traits": { - "smithy.api#documentation": "The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
" + "smithy.api#documentation": "A SQL query that must use Spark SQL syntax and return a single data set.
", + "smithy.api#required": {} } }, - "SecurityConfiguration": { - "target": "com.amazonaws.glue#NameString", + "SqlAliases": { + "target": "com.amazonaws.glue#SqlAliases", "traits": { - "smithy.api#documentation": "The name of the SecurityConfiguration structure to be used with the session.
" + "smithy.api#documentation": "A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named \"MyDataSource\". If you specify From
as MyDataSource, and Alias
as SqlName, then in your SQL you can do:
\n select *\nfrom SqlName
\n
and that gets data from MyDataSource.
", + "smithy.api#required": {} } }, - "GlueVersion": { - "target": "com.amazonaws.glue#GlueVersionString", + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", "traits": { - "smithy.api#documentation": "The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. \n The GlueVersion must be greater than 2.0.
" + "smithy.api#documentation": "Specifies the data schema for the SparkSQL transform.
" } } }, "traits": { - "smithy.api#documentation": "The period in which a remote Spark runtime environment is running.
" + "smithy.api#documentation": "Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single DynamicFrame
.
Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.
" + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} } }, - "PythonVersion": { - "target": "com.amazonaws.glue#PythonVersionString", + "Inputs": { + "target": "com.amazonaws.glue#OneInput", "traits": { - "smithy.api#documentation": "Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
" + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} + } + }, + "Path": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "A path in Amazon S3 where the transform will write a subset of records from the dataset to a JSON file in an Amazon S3 bucket.
", + "smithy.api#required": {} + } + }, + "Topk": { + "target": "com.amazonaws.glue#Topk", + "traits": { + "smithy.api#documentation": "Specifies a number of records to write starting from the beginning of the dataset.
" + } + }, + "Prob": { + "target": "com.amazonaws.glue#Prob", + "traits": { + "smithy.api#documentation": "The probability (a decimal value with a maximum value of 1) of picking any given record. A value of 1 indicates that each row read from the dataset should be included in the sample output.
" } } }, "traits": { - "smithy.api#documentation": "The SessionCommand
that runs the job.
Specifies a transform that writes samples of the data to an Amazon S3 bucket.
" } }, - "com.amazonaws.glue#SkewedInfo": { + "com.amazonaws.glue#SplitFields": { "type": "structure", "members": { - "SkewedColumnNames": { - "target": "com.amazonaws.glue#NameStringList", + "Name": { + "target": "com.amazonaws.glue#NodeName", "traits": { - "smithy.api#documentation": "A list of names of columns that contain skewed values.
" + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} } }, - "SkewedColumnValues": { - "target": "com.amazonaws.glue#ColumnValueStringList", + "Inputs": { + "target": "com.amazonaws.glue#OneInput", "traits": { - "smithy.api#documentation": "A list of values that appear so frequently as to be considered\n skewed.
" + "smithy.api#documentation": "The data inputs identified by their node names.
", + "smithy.api#required": {} } }, - "SkewedColumnValueLocationMaps": { - "target": "com.amazonaws.glue#LocationMap", + "Paths": { + "target": "com.amazonaws.glue#GlueStudioPathList", "traits": { - "smithy.api#documentation": "A mapping of skewed values to the columns that contain them.
" + "smithy.api#documentation": "A JSON path to a variable in the data structure.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies skewed values in a table. Skewed values are those that occur with very high\n frequency.
" - } - }, - "com.amazonaws.glue#Sort": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASC", - "name": "ASCENDING" - }, - { - "value": "DESC", - "name": "DESCENDING" - } - ] - } - }, - "com.amazonaws.glue#SortCriteria": { - "type": "list", - "member": { - "target": "com.amazonaws.glue#SortCriterion" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } + "smithy.api#documentation": "Specifies a transform that splits data property keys into two DynamicFrames
. The output is a collection of DynamicFrames
: one with selected data property keys, and one with the remaining data property keys.
The name of the field on which to sort.
" + "smithy.api#documentation": "A table, or a column in a table.
", + "smithy.api#required": {} } }, - "Sort": { - "target": "com.amazonaws.glue#Sort", + "Alias": { + "target": "com.amazonaws.glue#EnclosedInStringPropertyWithQuote", "traits": { - "smithy.api#documentation": "An ascending or descending sort.
" + "smithy.api#documentation": "A temporary name given to a table, or a column in a table.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies a field to sort by and a sort order.
" + "smithy.api#documentation": "Represents a single entry in the list of values for SqlAliases
.
The batch condition that started the workflow run. Either the number of events in the batch size arrived,\n in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow\n member is non-zero.
" } }, + "com.amazonaws.glue#StartingPosition": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "latest", + "name": "LATEST" + }, + { + "value": "trim_horizon", + "name": "TRIM_HORIZON" + }, + { + "value": "earliest", + "name": "EARLIEST" + } + ] + } + }, "com.amazonaws.glue#Statement": { "type": "structure", "members": { @@ -19856,6 +23749,26 @@ "smithy.api#documentation": "Describes the physical storage of table data.
" } }, + "com.amazonaws.glue#StreamingDataPreviewOptions": { + "type": "structure", + "members": { + "PollingTime": { + "target": "com.amazonaws.glue#PollingTime", + "traits": { + "smithy.api#documentation": "The polling time in milliseconds.
" + } + }, + "RecordPollingLimit": { + "target": "com.amazonaws.glue#PositiveLong", + "traits": { + "smithy.api#documentation": "The limit to the number of records polled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies options related to data preview for viewing a sample of your data.
" + } + }, "com.amazonaws.glue#StringColumnStatisticsData": { "type": "structure", "members": { @@ -20336,6 +24249,33 @@ } } }, + "com.amazonaws.glue#TargetFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "json", + "name": "JSON" + }, + { + "value": "csv", + "name": "CSV" + }, + { + "value": "avro", + "name": "AVRO" + }, + { + "value": "orc", + "name": "ORC" + }, + { + "value": "parquet", + "name": "PARQUET" + } + ] + } + }, "com.amazonaws.glue#TaskRun": { "type": "structure", "members": { @@ -20601,6 +24541,16 @@ "com.amazonaws.glue#Token": { "type": "string" }, + "com.amazonaws.glue#Topk": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.glue#TotalSegmentsInteger": { "type": "integer", "traits": { @@ -21026,6 +24976,18 @@ "smithy.api#documentation": "A structure used to provide information used to update a trigger. This object updates the\n previous trigger definition by overwriting it completely.
" } }, + "com.amazonaws.glue#TwoInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NodeId" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, "com.amazonaws.glue#TypeString": { "type": "string", "traits": { @@ -21066,6 +25028,50 @@ "target": "com.amazonaws.glue#UnfilteredPartition" } }, + "com.amazonaws.glue#Union": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "The name of the transform node.
", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#TwoInputs", + "traits": { + "smithy.api#documentation": "The node ID inputs to the transform.
", + "smithy.api#required": {} + } + }, + "UnionType": { + "target": "com.amazonaws.glue#UnionType", + "traits": { + "smithy.api#documentation": "Indicates the type of Union transform.
\n\t\n\tSpecify ALL
to join all rows from data sources to the resulting DynamicFrame. The resulting union does not remove duplicate rows.
Specify DISTINCT
to remove duplicate rows in the resulting DynamicFrame.
Specifies a transform that combines the rows from two or more datasets into a single result.
" + } + }, + "com.amazonaws.glue#UnionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "DISTINCT", + "name": "DISTINCT" + } + ] + } + }, "com.amazonaws.glue#UntagResource": { "type": "operation", "input": { @@ -21198,6 +25204,21 @@ } } }, + "com.amazonaws.glue#UpdateCatalogBehavior": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPDATE_IN_DATABASE", + "name": "UPDATE_IN_DATABASE" + }, + { + "value": "LOG", + "name": "LOG" + } + ] + } + }, "com.amazonaws.glue#UpdateClassifier": { "type": "operation", "input": { @@ -22595,6 +26616,32 @@ "com.amazonaws.glue#UpdatedTimestamp": { "type": "string" }, + "com.amazonaws.glue#UpsertRedshiftTargetOptions": { + "type": "structure", + "members": { + "TableLocation": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The physical location of the Redshift table.
" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "The name of the connection to use to write to Redshift.
" + } + }, + "UpsertKeys": { + "target": "com.amazonaws.glue#EnclosedInStringPropertiesMinOne", + "traits": { + "smithy.api#documentation": "The keys used to determine whether to perform an update or insert.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The options to configure an upsert operation when writing to a Redshift target .
" + } + }, "com.amazonaws.glue#UriString": { "type": "string" }, diff --git a/aws/sdk/aws-models/grafana.json b/aws/sdk/aws-models/grafana.json index 7012c34316b..109d90979ba 100644 --- a/aws/sdk/aws-models/grafana.json +++ b/aws/sdk/aws-models/grafana.json @@ -8,9 +8,7 @@ "aws.api#service": { "sdkId": "grafana", "arnNamespace": "grafana", - "cloudFormationName": "AWSGrafanaControlPlane", - "cloudTrailEventSource": "EVENT_SOURCE_VALUE", - "endpointPrefix": "grafana" + "cloudTrailEventSource": "EVENT_SOURCE_VALUE" }, "aws.auth#sigv4": { "name": "grafana" @@ -18,20 +16,21 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ - "x-amz-content-sha256", - "x-amzn-trace-id", - "x-amz-user-agent", "*", "content-type", - "x-amzn-platform-id" + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" ], "additionalExposedHeaders": [ - "x-amzn-trace-id", + "cache-control", "x-amzn-errortype", "x-amzn-requestid", "x-amzn-errormessage", - "x-amz-apigw-id,date", - "cache-control" + "x-amzn-trace-id", + "x-amzn-requestid", + "x-amz-apigw-id,date" ] }, "smithy.api#documentation": "Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to \n instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. \n Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool \n that is popular for its extensible data support.
\nWith Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In\n a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to\n build, package, or deploy any hardware to run Grafana servers.
", @@ -50,6 +49,9 @@ } ], "resources": [ + { + "target": "com.amazonaws.grafana#ApiKey" + }, { "target": "com.amazonaws.grafana#Authentication" }, @@ -85,13 +87,13 @@ "traits": { "smithy.api#enum": [ { - "value": "CURRENT_ACCOUNT", "name": "CURRENT_ACCOUNT", + "value": "CURRENT_ACCOUNT", "documentation": "Indicates that the customer is using Grafana to monitor resources in their current account." }, { - "value": "ORGANIZATION", "name": "ORGANIZATION", + "value": "ORGANIZATION", "documentation": "Indicates that the customer is using Grafana to monitor resources in organizational units." } ] @@ -112,6 +114,42 @@ "target": "com.amazonaws.grafana#AllowedOrganization" } }, + "com.amazonaws.grafana#ApiKey": { + "type": "resource", + "identifiers": { + "workspaceId": { + "target": "com.amazonaws.grafana#WorkspaceId" + } + }, + "operations": [ + { + "target": "com.amazonaws.grafana#CreateWorkspaceApiKey" + }, + { + "target": "com.amazonaws.grafana#DeleteWorkspaceApiKey" + } + ], + "traits": { + "aws.api#arn": { + "template": "workspaces/{workspaceId}/apikeys" + } + } + }, + "com.amazonaws.grafana#ApiKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.grafana#ApiKeyToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.grafana#AssertionAttribute": { "type": "string", "traits": { @@ -193,9 +231,9 @@ "traits": { "smithy.api#documentation": "Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise\n incurs additional fees. For more information, see Upgrade a workspace to\n Grafana Enterprise.
", "smithy.api#http": { + "code": 202, "method": "POST", - "uri": "/workspaces/{workspaceId}/licenses/{licenseType}", - "code": 202 + "uri": "/workspaces/{workspaceId}/licenses/{licenseType}" } } }, @@ -249,10 +287,7 @@ ], "traits": { "aws.api#arn": { - "template": "workspaces/{workspaceId}/authentication", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "workspaces/{workspaceId}/authentication" } } }, @@ -288,13 +323,13 @@ "traits": { "smithy.api#enum": [ { - "value": "AWS_SSO", "name": "AWS_SSO", + "value": "AWS_SSO", "documentation": "Indicates that AMG workspace has AWS SSO enabled as its authentication provider." }, { - "value": "SAML", "name": "SAML", + "value": "SAML", "documentation": "Indicates that the AMG workspace has SAML enabled as its authentication provider." } ] @@ -409,13 +444,117 @@ "traits": { "smithy.api#documentation": "Creates a workspace. In a workspace, you can create Grafana\n dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to\n build, package, or deploy any hardware to run the Grafana server.
\nDon't use CreateWorkspace
to modify an existing workspace. Instead, \n use UpdateWorkspace.
Creates an API key for the workspace. This key can be used to authenticate \n requests sent to the workspace's HTTP API. See \n https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html \n for available APIs and example requests.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/workspaces/{workspaceId}/apikeys" + } + } + }, + "com.amazonaws.grafana#CreateWorkspaceApiKeyRequest": { + "type": "structure", + "members": { + "keyName": { + "target": "com.amazonaws.grafana#ApiKeyName", + "traits": { + "smithy.api#documentation": "Specifies the name of the key to create. Key names must be unique to the workspace.
", + "smithy.api#required": {} + } + }, + "keyRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Specifies the permission level of the key.
\nValid Values: VIEWER
| EDITOR
| ADMIN
\n
Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.
", + "smithy.api#range": { + "min": 1, + "max": 2592000 + }, + "smithy.api#required": {} + } + }, + "workspaceId": { + "target": "com.amazonaws.grafana#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace in which to create an API key.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.grafana#CreateWorkspaceApiKeyResponse": { + "type": "structure", + "members": { + "keyName": { + "target": "com.amazonaws.grafana#ApiKeyName", + "traits": { + "smithy.api#documentation": "The name of the key that was created.
", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.grafana#ApiKeyToken", + "traits": { + "smithy.api#documentation": "The key token that was created. Use this value as a bearer token to \n authenticate HTTP requests to the workspace.
", + "smithy.api#required": {} + } + }, + "workspaceId": { + "target": "com.amazonaws.grafana#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace that the key is valid for.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.grafana#CreateWorkspaceRequest": { "type": "structure", "members": { @@ -520,43 +659,43 @@ "traits": { "smithy.api#enum": [ { - "value": "AMAZON_OPENSEARCH_SERVICE", "name": "AMAZON_OPENSEARCH_SERVICE", + "value": "AMAZON_OPENSEARCH_SERVICE", "documentation": "Amazon OpenSearch Service" }, { - "value": "CLOUDWATCH", "name": "CLOUDWATCH", + "value": "CLOUDWATCH", "documentation": "CloudWatch Logs" }, { - "value": "PROMETHEUS", "name": "PROMETHEUS", + "value": "PROMETHEUS", "documentation": "Managed Prometheus" }, { - "value": "XRAY", "name": "XRAY", + "value": "XRAY", "documentation": "X-Ray" }, { - "value": "TIMESTREAM", "name": "TIMESTREAM", + "value": "TIMESTREAM", "documentation": "Timestream" }, { - "value": "SITEWISE", "name": "SITEWISE", + "value": "SITEWISE", "documentation": "IoT SiteWise" }, { - "value": "ATHENA", "name": "ATHENA", + "value": "ATHENA", "documentation": "Amazon Athena" }, { - "value": "REDSHIFT", "name": "REDSHIFT", + "value": "REDSHIFT", "documentation": "Redshift" } ] @@ -599,13 +738,90 @@ "traits": { "smithy.api#documentation": "Deletes an Amazon Managed Grafana workspace.
", "smithy.api#http": { + "code": 202, "method": "DELETE", - "uri": "/workspaces/{workspaceId}", - "code": 202 + "uri": "/workspaces/{workspaceId}" }, "smithy.api#idempotent": {} } }, + "com.amazonaws.grafana#DeleteWorkspaceApiKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.grafana#DeleteWorkspaceApiKeyRequest" + }, + "output": { + "target": "com.amazonaws.grafana#DeleteWorkspaceApiKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.grafana#AccessDeniedException" + }, + { + "target": "com.amazonaws.grafana#ConflictException" + }, + { + "target": "com.amazonaws.grafana#InternalServerException" + }, + { + "target": "com.amazonaws.grafana#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.grafana#ThrottlingException" + }, + { + "target": "com.amazonaws.grafana#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an API key for a workspace.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/workspaces/{workspaceId}/apikeys/{keyName}" + } + } + }, + "com.amazonaws.grafana#DeleteWorkspaceApiKeyRequest": { + "type": "structure", + "members": { + "keyName": { + "target": "com.amazonaws.grafana#ApiKeyName", + "traits": { + "smithy.api#documentation": "The name of the API key to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "workspaceId": { + "target": "com.amazonaws.grafana#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.grafana#DeleteWorkspaceApiKeyResponse": { + "type": "structure", + "members": { + "keyName": { + "target": "com.amazonaws.grafana#ApiKeyName", + "traits": { + "smithy.api#documentation": "The name of the API key that was deleted.
", + "smithy.api#required": {} + } + }, + "workspaceId": { + "target": "com.amazonaws.grafana#WorkspaceId", + "traits": { + "smithy.api#documentation": "The ID of the workspace where the key was deleted.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.grafana#DeleteWorkspaceRequest": { "type": "structure", "members": { @@ -659,9 +875,9 @@ "traits": { "smithy.api#documentation": "Displays information about one Amazon Managed Grafana workspace.
", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces/{workspaceId}", - "code": 200 + "uri": "/workspaces/{workspaceId}" }, "smithy.api#readonly": {} } @@ -694,9 +910,9 @@ "traits": { "smithy.api#documentation": "Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces/{workspaceId}/authentication", - "code": 200 + "uri": "/workspaces/{workspaceId}/authentication" }, "smithy.api#readonly": {} } @@ -789,9 +1005,9 @@ "traits": { "smithy.api#documentation": "Removes the Grafana Enterprise license from a workspace.
", "smithy.api#http": { + "code": 202, "method": "DELETE", - "uri": "/workspaces/{workspaceId}/licenses/{licenseType}", - "code": 202 + "uri": "/workspaces/{workspaceId}/licenses/{licenseType}" } } }, @@ -933,10 +1149,7 @@ ], "traits": { "aws.api#arn": { - "template": "workspaces/{workspaceId}/licenses/{licenseType}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "workspaces/{workspaceId}/licenses/{licenseType}" } } }, @@ -945,13 +1158,13 @@ "traits": { "smithy.api#enum": [ { - "value": "ENTERPRISE", "name": "ENTERPRISE", + "value": "ENTERPRISE", "documentation": "Grafana Enterprise License." }, { - "value": "ENTERPRISE_FREE_TRIAL", "name": "ENTERPRISE_FREE_TRIAL", + "value": "ENTERPRISE_FREE_TRIAL", "documentation": "Grafana Enterprise Free Trial License." } ] @@ -985,15 +1198,15 @@ "traits": { "smithy.api#documentation": "Lists the users and groups who have the Grafana Admin
and \n Editor
roles in this workspace. If you use this \n operation without specifying userId
or groupId
, the operation returns\n the roles of all users\n and groups. If you specify a userId
or a groupId
, only the roles\n for that user or group are returned. If you do this, you can specify only one userId
or \n one groupId
.
The ListTagsForResource
operation returns the tags that \n are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn
. \n Currently, the only resource that can be tagged is a workspace.
Returns a list of Amazon Managed Grafana workspaces in the account, with some information\n about each workspace. For more complete information about one workspace, use DescribeWorkspace.
", "smithy.api#http": { + "code": 200, "method": "GET", - "uri": "/workspaces", - "code": 200 + "uri": "/workspaces" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "workspaces", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "workspaces" }, "smithy.api#readonly": {} } @@ -1211,8 +1423,8 @@ "traits": { "smithy.api#enum": [ { - "value": "SNS", "name": "SNS", + "value": "SNS", "documentation": "AWS Simple Notification Service" } ] @@ -1269,10 +1481,7 @@ ], "traits": { "aws.api#arn": { - "template": "workspaces/{workspaceId}/permissions/{permissionId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "workspaces/{workspaceId}/permissions/{permissionId}" } } }, @@ -1309,13 +1518,13 @@ "traits": { "smithy.api#enum": [ { - "value": "CUSTOMER_MANAGED", "name": "CUSTOMER_MANAGED", + "value": "CUSTOMER_MANAGED", "documentation": "Customer Managed" }, { - "value": "SERVICE_MANAGED", "name": "SERVICE_MANAGED", + "value": "SERVICE_MANAGED", "documentation": "Service Managed" } ] @@ -1357,14 +1566,19 @@ "traits": { "smithy.api#enum": [ { - "value": "ADMIN", "name": "ADMIN", + "value": "ADMIN", "documentation": "Role Admin." }, { - "value": "EDITOR", "name": "EDITOR", + "value": "EDITOR", "documentation": "Role Editor." + }, + { + "name": "VIEWER", + "value": "VIEWER", + "documentation": "Role Viewer." } ] } @@ -1472,13 +1686,13 @@ "traits": { "smithy.api#enum": [ { - "value": "CONFIGURED", "name": "CONFIGURED", + "value": "CONFIGURED", "documentation": "Indicates that SAML on an AMG workspace is enabled and has been configured." }, { - "value": "NOT_CONFIGURED", "name": "NOT_CONFIGURED", + "value": "NOT_CONFIGURED", "documentation": "Indicates that SAML on an AMG workspace is enabled but has not been configured." } ] @@ -1599,8 +1813,7 @@ "smithy.api#documentation": "The TagResource
operation associates tags with an Amazon Managed Grafana resource. \n Currently, the only resource that can be tagged is workspaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated\n with the resource. If you specify a tag key that is already associated with the resource, the new tag \n value that you specify replaces the previous value for that tag.
", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" } } }, @@ -1703,8 +1916,7 @@ "smithy.api#documentation": "The UntagResource
operation removes the association of the tag with the Amazon Managed Grafana resource. \n
Updates which users in a workspace have the Grafana Admin
or Editor
roles.
Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any \n optional parameters, the existing values of those parameters are not changed.
\nTo modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, \n use UpdateWorkspaceAuthentication.
\nTo modify which users in the workspace have the Admin
and Editor
Grafana roles, \n use UpdatePermissions.
Use this operation to define the identity provider (IdP) that this workspace\n authenticates users from, using SAML. You can also map SAML assertion attributes to\n workspace user information and define which groups in the assertion attribute are to have\n the Admin
and Editor
roles in the workspace.
The state of the component.
" + "smithy.api#documentation": "The state of the component version.
" } }, "message": { "target": "com.amazonaws.greengrassv2#NonEmptyString", "traits": { - "smithy.api#documentation": "A message that communicates details, such as errors, about the status of the component.
" + "smithy.api#documentation": "A message that communicates details, such as errors, about the status of the component\n version.
" } }, "errors": { "target": "com.amazonaws.greengrassv2#StringMap", "traits": { - "smithy.api#documentation": "A dictionary of errors that communicate why the component is in an error state. For\n example, if IoT Greengrass can't access an artifact for the component, then errors
contains\n the artifact's URI as a key, and the error message as the value for that key.
A dictionary of errors that communicate why the component version is in an error state.\n For example, if IoT Greengrass can't access an artifact for the component version, then\n errors
contains the artifact's URI as a key, and the error message as the value\n for that key.
The vendor guidance state for the component version. This state indicates whether\n the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
\n\n ACTIVE
– This component version is available and recommended for use.
\n DISCONTINUED
– This component version has been discontinued by its publisher.\n You can deploy this component version, but we recommend that you use a different version of this component.
\n DELETED
– This component version has been deleted by its publisher, so you can't\n deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
A message that communicates details about the vendor guidance state\n of the component version. This message communicates why a component version is discontinued or deleted.
" } } }, "traits": { - "smithy.api#documentation": "Contains the status of a component in the IoT Greengrass service.
" + "smithy.api#documentation": "Contains the status of a component version in the IoT Greengrass service.
" } }, "com.amazonaws.greengrassv2#Component": { @@ -481,7 +493,7 @@ "com.amazonaws.greengrassv2#ComponentARN": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):components:[^:]+$" + "smithy.api#pattern": "^arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+$" } }, "com.amazonaws.greengrassv2#ComponentCandidate": { @@ -536,7 +548,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 65536 + "max": 10485760 } } }, @@ -695,8 +707,7 @@ "smithy.api#length": { "min": 1, "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_.]+$" + } } }, "com.amazonaws.greengrassv2#ComponentPlatform": { @@ -754,7 +765,7 @@ "com.amazonaws.greengrassv2#ComponentVersionARN": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):components:[^:]+:versions:[^:]+$" + "smithy.api#pattern": "^arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):components:[^:]+:versions:[^:]+$" } }, "com.amazonaws.greengrassv2#ComponentVersionList": { @@ -804,8 +815,7 @@ "smithy.api#length": { "min": 1, "max": 64 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-.+]+$" + } } }, "com.amazonaws.greengrassv2#ComponentVisibilityScope": { @@ -995,7 +1005,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a component. Components are software that run on Greengrass core devices. After you\n develop and test a component on your core device, you can use this operation to upload your\n component to IoT Greengrass. Then, you can deploy the component to other core devices.
\nYou can use this operation to do the following:
\n\n Create components from recipes\n
\nCreate a component from a recipe, which is a file that defines the component's\n metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For\n more information, see IoT Greengrass component recipe\n reference in the IoT Greengrass V2 Developer Guide.
\nTo create a component from a recipe, specify inlineRecipe
when you call\n this operation.
\n Create components from Lambda functions\n
\nCreate a component from an Lambda function that runs on IoT Greengrass. This creates a recipe\n and artifacts from the Lambda function's deployment package. You can use this operation to\n migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.
\nThis function only accepts Lambda functions that use the following runtimes:
\nPython 2.7 – python2.7
\n
Python 3.7 – python3.7
\n
Python 3.8 – python3.8
\n
Java 8 – java8
\n
Node.js 10 – nodejs10.x
\n
Node.js 12 – nodejs12.x
\n
To create a component from a Lambda function, specify lambdaFunction
\n when you call this operation.
IoT Greengrass currently supports Lambda functions on only Linux core devices.
\nCreates a component. Components are software that run on Greengrass core devices. After you\n develop and test a component on your core device, you can use this operation to upload your\n component to IoT Greengrass. Then, you can deploy the component to other core devices.
\nYou can use this operation to do the following:
\n\n Create components from recipes\n
\nCreate a component from a recipe, which is a file that defines the component's\n metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For\n more information, see IoT Greengrass component recipe\n reference in the IoT Greengrass V2 Developer Guide.
\nTo create a component from a recipe, specify inlineRecipe
when you call\n this operation.
\n Create components from Lambda functions\n
\nCreate a component from an Lambda function that runs on IoT Greengrass. This creates a recipe\n and artifacts from the Lambda function's deployment package. You can use this operation to\n migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.
\nThis function only accepts Lambda functions that use the following runtimes:
\nPython 2.7 – python2.7
\n
Python 3.7 – python3.7
\n
Python 3.8 – python3.8
\n
Python 3.9 – python3.9
\n
Java 8 – java8
\n
Java 11 – java11
\n
Node.js 10 – nodejs10.x
\n
Node.js 12 – nodejs12.x
\n
Node.js 14 – nodejs14.x
\n
To create a component from a Lambda function, specify lambdaFunction
\n when you call this operation.
IoT Greengrass currently supports Lambda functions on only Linux core devices.
\nDeletes a deployment. To delete an active deployment, you must first cancel it. For more\n information, see CancelDeployment.
\nDeleting a deployment doesn't affect core devices that run that deployment, because core\n devices store the deployment's configuration on the device. Additionally, core devices can\n roll back to a previous deployment that has been deleted.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/greengrass/v2/deployments/{deploymentId}", + "code": 204 + } + } + }, + "com.amazonaws.greengrassv2#DeleteDeploymentRequest": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the deployment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.greengrassv2#Deployment": { "type": "structure", "members": { @@ -1684,7 +1753,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 100 } } @@ -1857,7 +1926,7 @@ "com.amazonaws.greengrassv2#GenericV2ARN": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:greengrass:[^:]+:(aws|[0-9]+):(components|deployments|coreDevices):.+$" + "smithy.api#pattern": "^arn:[^:]*:greengrass:[^:]*:(aws|[0-9]+):(components|deployments|coreDevices):" } }, "com.amazonaws.greengrassv2#GetComponent": { @@ -1965,7 +2034,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the pre-signed URL to download a public component artifact. Core devices call this\n operation to identify the URL that they can use to download an artifact to install.
", + "smithy.api#documentation": "Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this\n operation to identify the URL that they can use to download an artifact to install.
", "smithy.api#http": { "method": "GET", "uri": "/greengrass/v2/components/{arn}/artifacts/{artifactName+}", @@ -1979,7 +2048,7 @@ "arn": { "target": "com.amazonaws.greengrassv2#ComponentVersionARN", "traits": { - "smithy.api#documentation": "The ARN of the component version. Specify the ARN of a public component version.
", + "smithy.api#documentation": "The ARN of the component version. Specify the ARN of a public or a Lambda component version.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2089,7 +2158,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves metadata for a Greengrass core device.
", + "smithy.api#documentation": "Retrieves metadata for a Greengrass core device.
\nIoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core\n software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then\n the reported status of that device might not reflect its current status. The status timestamp\n indicates when the device status was last updated.
\nCore devices send status updates at the following times:
\nWhen the IoT Greengrass Core software starts
\nWhen the core device receives a deployment from the Amazon Web Services Cloud
\nWhen the status of any component on the core device becomes BROKEN
\n
At a regular interval\n that you can configure, which defaults to 24 hours
\nThe ARN of the component version.
", + "smithy.api#documentation": "The ARN of the component.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3368,6 +3442,9 @@ { "target": "com.amazonaws.greengrassv2#InternalServerException" }, + { + "target": "com.amazonaws.greengrassv2#ResourceNotFoundException" + }, { "target": "com.amazonaws.greengrassv2#ThrottlingException" }, @@ -3385,6 +3462,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "components", "pageSize": "maxResults" } } @@ -3456,7 +3534,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a paginated list of Greengrass core devices.
", + "smithy.api#documentation": "Retrieves a paginated list of Greengrass core devices.
\nIoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core\n software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then\n the reported status of that device might not reflect its current status. The status timestamp\n indicates when the device status was last updated.
\nCore devices send status updates at the following times:
\nWhen the IoT Greengrass Core software starts
\nWhen the core device receives a deployment from the Amazon Web Services Cloud
\nWhen the status of any component on the core device becomes BROKEN
\n
At a regular interval\n that you can configure, which defaults to 24 hours
\nThe ARN of the IoT thing group by which to filter. If you specify this parameter, the\n list includes only core devices that are members of this thing group.
", + "smithy.api#documentation": "The ARN of the IoT thing group by which to filter. If you specify this parameter,\n the list includes only core devices that have successfully deployed a deployment that targets\n the thing group. When you remove a core device from a thing group, the list continues to\n include that core device.
", "smithy.api#httpQuery": "thingGroupArn" } }, @@ -3552,6 +3631,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "deployments", "pageSize": "maxResults" } } @@ -3642,6 +3722,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "effectiveDeployments", "pageSize": "maxResults" } } @@ -3717,7 +3798,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a paginated list of the components that a Greengrass core device runs.
", + "smithy.api#documentation": "Retrieves a paginated list of the components that a Greengrass core device runs.\n This list doesn't include components that are deployed from local deployments or\n components that are deployed as dependencies of other components.
\nIoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core\n software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then\n the reported status of that device might not reflect its current status. The status timestamp\n indicates when the device status was last updated.
\nCore devices send status updates at the following times:
\nWhen the IoT Greengrass Core software starts
\nWhen the core device receives a deployment from the Amazon Web Services Cloud
\nWhen the status of any component on the core device becomes BROKEN
\n
At a regular interval\n that you can configure, which defaults to 24 hours
\nThe platform to use to resolve compatible components.
", - "smithy.api#required": {} + "smithy.api#documentation": "The platform to use to resolve compatible components.
" } }, "componentCandidates": { "target": "com.amazonaws.greengrassv2#ComponentCandidateList", "traits": { - "smithy.api#documentation": "The list of components to resolve.
", - "smithy.api#required": {} + "smithy.api#documentation": "The list of components to resolve.
" } } } @@ -4007,6 +4087,18 @@ "traits": { "smithy.api#documentation": "The recipe of the component version.
" } + }, + "vendorGuidance": { + "target": "com.amazonaws.greengrassv2#VendorGuidance", + "traits": { + "smithy.api#documentation": "The vendor guidance state for the component version. This state indicates whether\n the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:
\n\n ACTIVE
– This component version is available and recommended for use.
\n DISCONTINUED
– This component version has been discontinued by its publisher.\n You can deploy this component version, but we recommend that you use a different version of this component.
\n DELETED
– This component version has been deleted by its publisher, so you can't\n deploy it. If you have any existing deployments that specify this component version, those deployments will fail.
A message that communicates details about the vendor guidance state\n of the component version. This message communicates why a component version is discontinued or deleted.
" + } } }, "traits": { @@ -4132,8 +4224,7 @@ "smithy.api#length": { "min": 1, "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } } }, "com.amazonaws.greengrassv2#TagKeyList": { @@ -4144,7 +4235,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 200 } } }, @@ -4159,7 +4250,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 50 + "max": 200 } } }, @@ -4227,13 +4318,13 @@ "com.amazonaws.greengrassv2#TargetARN": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:(thing|thinggroup)/.+$" + "smithy.api#pattern": "^arn:[^:]*:iot:[^:]*:[0-9]+:(thing|thinggroup)/.+$" } }, "com.amazonaws.greengrassv2#ThingGroupARN": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:iot:[^:]+:[0-9]+:thinggroup/.+$" + "smithy.api#pattern": "^arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+$" } }, "com.amazonaws.greengrassv2#ThrottlingException": { @@ -4475,6 +4566,25 @@ ] } }, + "com.amazonaws.greengrassv2#VendorGuidance": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DISCONTINUED", + "name": "DISCONTINUED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] + } + }, "com.amazonaws.greengrassv2#connectivityInfoList": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/iot.json b/aws/sdk/aws-models/iot.json index c81d9142977..68e0a0cfff2 100644 --- a/aws/sdk/aws-models/iot.json +++ b/aws/sdk/aws-models/iot.json @@ -848,6 +848,9 @@ "input": { "target": "com.amazonaws.iot#AcceptCertificateTransferRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" @@ -1711,6 +1714,9 @@ "input": { "target": "com.amazonaws.iot#AttachPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" @@ -1768,6 +1774,9 @@ "input": { "target": "com.amazonaws.iot#AttachPrincipalPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" @@ -3738,6 +3747,9 @@ "input": { "target": "com.amazonaws.iot#CancelCertificateTransferRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" @@ -3873,6 +3885,9 @@ "input": { "target": "com.amazonaws.iot#CancelJobExecutionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" @@ -5817,7 +5832,7 @@ "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { - "smithy.api#documentation": "Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.
" + "smithy.api#documentation": "Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.
\nWe recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. \n By using continuous jobs, devices that join the group receive the job execution even after the job has\n been created.
\nParameters of a managed template that you can specify to create the job document.
" + "smithy.api#documentation": "Parameters of an Amazon Web Services managed template that you can specify to create the job document.
\n\n documentParameters
can only be used when creating jobs from Amazon Web Services \n managed templates. This parameter can't be used with custom job templates or to \n create jobs from them.
The hash algorithm used to code sign the file.
" + "smithy.api#documentation": "The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256
or SHA1
, so you can pass either of them based on which was used for generating the signature.
The signature algorithm used to code sign the file.
" + "smithy.api#documentation": "The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA
or RSA
, so you can pass either of them based on which was used for generating the signature.
A map of key-value pairs that you can use as guidance to specify the inputs for creating \n a job from a managed template.
" + "smithy.api#documentation": "A map of key-value pairs that you can use as guidance to specify the inputs for creating \n a job from a managed template.
\n\n documentParameters
can only be used when creating jobs from Amazon Web Services \n managed templates. This parameter can't be used with custom job templates or to \n create jobs from them.
A map of key-value pairs containing the patterns that need to be replaced in a managed\n template job document schema. You can use the description of each key as a guidance to specify \n the inputs during runtime when creating a job.
" + "smithy.api#documentation": "A map of key-value pairs containing the patterns that need to be replaced in a managed\n template job document schema. You can use the description of each key as a guidance to specify \n the inputs during runtime when creating a job.
\n\n documentParameters
can only be used when creating jobs from Amazon Web Services \n managed templates. This parameter can't be used with custom job templates or to \n create jobs from them.
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a device when the thing representing\n the device is added to a target group, even after the job was completed by all things originally in the \n group.
" + "smithy.api#documentation": "Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a device when the thing representing\n the device is added to a target group, even after the job was completed by all things originally in the \n group.
\nWe recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. \n By using continuous jobs, devices that join the group receive the job execution even after the job has\n been created.
\nA key-value map that pairs the patterns that need to be replaced in a managed \n template job document schema. You can use the description of each key as a guidance \n to specify the inputs during runtime when creating a job.
" + "smithy.api#documentation": "A key-value map that pairs the patterns that need to be replaced in a managed \n template job document schema. You can use the description of each key as a guidance \n to specify the inputs during runtime when creating a job.
\n\n documentParameters
can only be used when creating jobs from Amazon Web Services \n managed templates. This parameter can't be used with custom job templates or to \n create jobs from them.
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.
" + "smithy.api#documentation": "Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.
\nWe recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. \n By using continuous jobs, devices that join the group receive the job execution even after the job has\n been created.
\nSpecifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.
", + "smithy.api#documentation": "Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.
\nWe recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. \n By using continuous jobs, devices that join the group receive the job execution even after the job has\n been created.
\nContains error messages associated with one of the following requests:
\n\n BatchDisableAlarm\n
\n\n BatchEnableAlarm\n
\n\n BatchResetAlarm\n
\n\n BatchSnoozeAlarm\n
\nDeletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detectors/delete", + "code": 200 + } + } + }, + "com.amazonaws.ioteventsdata#BatchDeleteDetectorErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.ioteventsdata#BatchDeleteDetectorErrorEntry" + } + }, + "com.amazonaws.ioteventsdata#BatchDeleteDetectorErrorEntry": { + "type": "structure", + "members": { + "messageId": { + "target": "com.amazonaws.ioteventsdata#MessageId", + "traits": { + "smithy.api#documentation": "The ID of the message that caused the error. (See the value of the \"messageId\"
in the detectors object of the DeleteDetectorRequest
.)
The error code.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.ioteventsdata#ErrorMessage", + "traits": { + "smithy.api#documentation": "A message that describes the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains error messages associated with the deletion request.
" + } + }, + "com.amazonaws.ioteventsdata#BatchDeleteDetectorRequest": { + "type": "structure", + "members": { + "detectors": { + "target": "com.amazonaws.ioteventsdata#DeleteDetectorRequests", + "traits": { + "smithy.api#documentation": "The list of one or more detectors to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ioteventsdata#BatchDeleteDetectorResponse": { + "type": "structure", + "members": { + "batchDeleteDetectorErrorEntries": { + "target": "com.amazonaws.ioteventsdata#BatchDeleteDetectorErrorEntries", + "traits": { + "smithy.api#documentation": "A list of errors associated with the request, or an empty array ([]
) if there are no errors. Each error entry contains a messageId
that helps you identify the entry that failed.
The ID to assign to the DeleteDetectorRequest
. Each \"messageId\"
must be unique within each batch sent.
The name of the detector model that was used to create the detector instance.
", + "smithy.api#required": {} + } + }, + "keyValue": { + "target": "com.amazonaws.ioteventsdata#KeyValue", + "traits": { + "smithy.api#documentation": "The value of the key used to identify the detector.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information used to delete the detector model.
" + } + }, + "com.amazonaws.ioteventsdata#DeleteDetectorRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.ioteventsdata#DeleteDetectorRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.ioteventsdata#DescribeAlarm": { "type": "operation", "input": { @@ -1397,6 +1522,9 @@ { "target": "com.amazonaws.ioteventsdata#BatchAcknowledgeAlarm" }, + { + "target": "com.amazonaws.ioteventsdata#BatchDeleteDetector" + }, { "target": "com.amazonaws.ioteventsdata#BatchDisableAlarm" }, diff --git a/aws/sdk/aws-models/ivschat.json b/aws/sdk/aws-models/ivschat.json index c8938e1a7ab..e8edc22818e 100644 --- a/aws/sdk/aws-models/ivschat.json +++ b/aws/sdk/aws-models/ivschat.json @@ -24,8 +24,7 @@ "sdkId": "ivschat", "arnNamespace": "ivschat", "cloudFormationName": "IVSChat", - "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", - "endpointPrefix": "ivschat" + "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE" }, "aws.auth#sigv4": { "name": "ivschat" @@ -33,23 +32,24 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ - "amz-sdk-invocation-id", - "amz-sdk-request", + "Content-Type", "X-Api-Key", "X-Amz-Content-Sha256", - "Content-Type", - "X-Amz-User-Agent" + "X-Amz-User-Agent", + "amz-sdk-invocation-id", + "amz-sdk-request" ], "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", "x-amzn-requestid", - "x-amzn-errormessage" + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amzn-requestid", + "x-amz-apigw-id", + "date" ] }, - "smithy.api#documentation": "\n Introduction\n
\nThe Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat\n resources. You also need to integrate with the Amazon IVS Chat Messaging\n API, to enable users to interact with chat rooms in real time.
\nThe API is an AWS regional service. For a list of supported regions and Amazon IVS Chat\n HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the\n AWS General Reference.
\n\n Notes on terminology:\n
\nYou create service applications using the Amazon IVS Chat API. We refer to these as\n applications.
\nYou create front-end client applications (browser and Android/iOS apps) using the\n Amazon IVS Chat Messaging API. We refer to these as clients.
\n\n Resources\n
\nThe following resource is part of Amazon IVS Chat:
\n\n Room — The central Amazon IVS Chat resource through\n which clients connect to and exchange chat messages. See the Room endpoints for more\n information.
\n\n API Access Security\n
\nYour Amazon IVS Chat applications (service applications and clients) must be authenticated\n and authorized to access Amazon IVS Chat resources. Note the differences between these\n concepts:
\n\n Authentication is about verifying identity. Requests to the\n Amazon IVS Chat API must be signed to verify your identity.
\n\n Authorization is about granting permissions. Your IAM roles need\n to have permissions for Amazon IVS Chat API requests.
\nUsers (viewers) connect to a room using secure access tokens that you create using the\n CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for\n every user’s chat session, passing identity and authorization information about the\n user.
\n\n Signing API Requests\n
\nHTTP API requests must be signed with an AWS SigV4 signature using your AWS security\n credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the\n underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API\n directly, it’s your responsibility to sign the requests.
\n\n\n\n\nYou generate a signature using valid AWS credentials for an IAM role that has permission\n to perform the requested action. For example, DeleteMessage requests must be made using an IAM\n role that has the ivschat:DeleteMessage
permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests\n (Amazon Web Services Signature Version 4) in the Amazon Web Services\n General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on\n the Security page of the Amazon IVS User Guide.
\n\n Messaging Endpoints\n
\n\n DeleteMessage — Sends an event to a specific room which\n directs clients to delete a specific message; that is, unrender it from view and delete it\n from the client’s chat history. This event’s EventName
is\n aws:DELETE_MESSAGE
. This replicates the DeleteMessage WebSocket operation\n in the Amazon IVS Chat Messaging API.
\n DisconnectUser — Disconnects all connections using a specified\n user ID from a room. This replicates the DisconnectUser WebSocket operation\n in the Amazon IVS Chat Messaging API.
\n\n SendEvent — Sends an event to a room. Use this within your\n application’s business logic to send events to clients of a room; e.g., to notify clients\n to change the way the chat UI is rendered.
\n\n Chat Token Endpoint\n
\n\n CreateChatToken — Creates an encrypted token that is used to\n establish an individual WebSocket connection to a room. The token is valid for one minute,\n and a connection (session) established with the token is valid for the specified\n duration.
\n\n Room Endpoints\n
\n\n CreateRoom — Creates a room that allows clients to connect and\n pass messages.
\n\n DeleteRoom — Deletes the specified room.
\n\n GetRoom — Gets the specified room.
\n\n ListRooms — Gets summary information about all your rooms in\n the AWS region where the API request is processed.
\n\n UpdateRoom — Updates a room’s configuration.
\n\n Tags Endpoints\n
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\nAll the above are HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.
", + "smithy.api#documentation": "\n Introduction\n
\nThe Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat\n resources. You also need to integrate with the Amazon IVS Chat Messaging\n API, to enable users to interact with chat rooms in real time.
\nThe API is an AWS regional service. For a list of supported regions and Amazon IVS Chat\n HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the\n AWS General Reference.
\n\n Notes on terminology:\n
\nYou create service applications using the Amazon IVS Chat API. We refer to these as\n applications.
\nYou create front-end client applications (browser and Android/iOS apps) using the\n Amazon IVS Chat Messaging API. We refer to these as clients.
\n\n Resources\n
\nThe following resource is part of Amazon IVS Chat:
\n\n Room — The central Amazon IVS Chat resource through\n which clients connect to and exchange chat messages. See the Room endpoints for more\n information.
\n\n API Access Security\n
\nYour Amazon IVS Chat applications (service applications and clients) must be authenticated\n and authorized to access Amazon IVS Chat resources. Note the differences between these\n concepts:
\n\n Authentication is about verifying identity. Requests to the\n Amazon IVS Chat API must be signed to verify your identity.
\n\n Authorization is about granting permissions. Your IAM roles need\n to have permissions for Amazon IVS Chat API requests.
\nUsers (viewers) connect to a room using secure access tokens that you create using the\n CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for\n every user’s chat session, passing identity and authorization information about the\n user.
\n\n Signing API Requests\n
\nHTTP API requests must be signed with an AWS SigV4 signature using your AWS security\n credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the\n underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API\n directly, it’s your responsibility to sign the requests.
\nYou generate a signature using valid AWS credentials for an IAM role that has permission\n to perform the requested action. For example, DeleteMessage requests must be made using an IAM\n role that has the ivschat:DeleteMessage
permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests\n (Amazon Web Services Signature Version 4) in the Amazon Web Services\n General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on\n the Security page of the Amazon IVS User Guide.
\n\n Messaging Endpoints\n
\n\n DeleteMessage — Sends an event to a specific room which\n directs clients to delete a specific message; that is, unrender it from view and delete it\n from the client’s chat history. This event’s EventName
is\n aws:DELETE_MESSAGE
. This replicates the \n DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
\n DisconnectUser — Disconnects all connections using a specified\n user ID from a room. This replicates the \n DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
\n\n SendEvent — Sends an event to a room. Use this within your\n application’s business logic to send events to clients of a room; e.g., to notify clients\n to change the way the chat UI is rendered.
\n\n Chat Token Endpoint\n
\n\n CreateChatToken — Creates an encrypted token that is used to\n establish an individual WebSocket connection to a room. The token is valid for one minute,\n and a connection (session) established with the token is valid for the specified\n duration.
\n\n Room Endpoints\n
\n\n CreateRoom — Creates a room that allows clients to connect and\n pass messages.
\n\n DeleteRoom — Deletes the specified room.
\n\n GetRoom — Gets the specified room.
\n\n ListRooms — Gets summary information about all your rooms in\n the AWS region where the API request is processed.
\n\n UpdateRoom — Updates a room’s configuration.
\n\n Tags Endpoints\n
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\nAll the above are HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.
", "smithy.api#title": "Amazon Interactive Video Service Chat" }, "version": "2020-07-14", @@ -185,8 +185,7 @@ "smithy.api#documentation": "Creates an encrypted token that is used to establish an individual WebSocket connection\n to a room. The token is valid for one minute, and a connection (session) established with\n the token is valid for the specified duration.
\nEncryption keys are owned by Amazon IVS Chat and never used directly by your\n application.
", "smithy.api#http": { "method": "POST", - "uri": "/CreateChatToken", - "code": 200 + "uri": "/CreateChatToken" } } }, @@ -282,8 +281,7 @@ "smithy.api#documentation": "Creates a room that allows clients to connect and pass messages.
", "smithy.api#http": { "method": "POST", - "uri": "/CreateRoom", - "code": 200 + "uri": "/CreateRoom" } } }, @@ -299,7 +297,7 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#documentation": "Maximum number of messages per second that a client can send to the room. Default:\n 10.
" + "smithy.api#documentation": "Maximum number of messages per second that can be sent to the room (by all clients).\n Default: 10.
" } }, "maximumMessageLength": { @@ -358,7 +356,7 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#documentation": "Maximum number of messages per second that a client can send to the room, from the\n request.
" + "smithy.api#documentation": "Maximum number of messages per second that can be sent to the room (by all clients),\n from the request.
" } }, "maximumMessageLength": { @@ -404,11 +402,10 @@ } ], "traits": { - "smithy.api#documentation": "Sends an event to a specific room which directs clients to delete a specific message;\n that is, unrender it from view and delete it from the client’s chat history. This event’s\n EventName
is aws:DELETE_MESSAGE
. This replicates the DeleteMessage WebSocket operation\n in the Amazon IVS Chat Messaging API.
Sends an event to a specific room which directs clients to delete a specific message;\n that is, unrender it from view and delete it from the client’s chat history. This event’s\n EventName
is aws:DELETE_MESSAGE
. This replicates the \n DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation\n in the Amazon IVS Chat Messaging API.
", + "smithy.api#documentation": "Disconnects all connections using a specified user ID from a room. This replicates the\n \n DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
", "smithy.api#http": { "method": "POST", - "uri": "/DisconnectUser", - "code": 200 + "uri": "/DisconnectUser" } } }, @@ -610,8 +609,7 @@ "smithy.api#documentation": "Gets the specified room.
", "smithy.api#http": { "method": "POST", - "uri": "/GetRoom", - "code": 200 + "uri": "/GetRoom" }, "smithy.api#readonly": {} } @@ -664,7 +662,7 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#documentation": "Maximum number of messages per second that a client can send to the room. Default:\n 10.
" + "smithy.api#documentation": "Maximum number of messages per second that can be sent to the room (by all clients). Default:\n 10.
" } }, "maximumMessageLength": { @@ -749,8 +747,7 @@ "smithy.api#documentation": "Gets summary information about all your rooms in the AWS region where the API request is\n processed. Results are sorted in descending order of updateTime
.
Gets information about AWS tags for the specified ARN.
", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -892,7 +888,7 @@ "fallbackResult": { "target": "com.amazonaws.ivschat#FallbackResult", "traits": { - "smithy.api#documentation": "Specifies the fallback behavior (whether the message is allowed or denied) if the handler\n does not return a valid response, encounters an error or times out. If allowed, the message is\n delivered with returned content to all users connected to the room. If denied, the message is\n not delivered to any user. Default: ALLOW
.
Specifies the fallback behavior (whether the message is allowed or denied) if the handler\n does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is\n delivered with returned content to all users connected to the room. If denied, the message is\n not delivered to any user. Default: ALLOW
.
Sends an event to a room. Use this within your application’s business logic to send\n events to clients of a room; e.g., to notify clients to change the way the chat UI is\n rendered.
", "smithy.api#http": { "method": "POST", - "uri": "/SendEvent", - "code": 200 + "uri": "/SendEvent" } } }, @@ -1264,8 +1259,7 @@ "smithy.api#documentation": "Adds or updates tags for the AWS resource with the specified ARN.
", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" } } }, @@ -1383,8 +1377,7 @@ "smithy.api#documentation": "Removes tags from the resource with the specified ARN.
", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -1426,6 +1419,9 @@ { "target": "com.amazonaws.ivschat#AccessDeniedException" }, + { + "target": "com.amazonaws.ivschat#PendingVerification" + }, { "target": "com.amazonaws.ivschat#ResourceNotFoundException" }, @@ -1437,8 +1433,7 @@ "smithy.api#documentation": "Updates a room’s configuration.
", "smithy.api#http": { "method": "POST", - "uri": "/UpdateRoom", - "code": 200 + "uri": "/UpdateRoom" } } }, @@ -1461,7 +1456,7 @@ "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#documentation": "The maximum number of messages per second that a client can send to the room. Default:\n 10.
" + "smithy.api#documentation": "Maximum number of messages per second that can be sent to the room (by all clients). Default:\n 10.
" } }, "maximumMessageLength": { @@ -1473,7 +1468,7 @@ "messageReviewHandler": { "target": "com.amazonaws.ivschat#MessageReviewHandler", "traits": { - "smithy.api#documentation": "Configuration information for optional review of messages. Specify an empty uri
string to disassociate a message review handler from the specified room.
Configuration information for optional review of messages. Specify an empty\n uri
string to disassociate a message review handler from the specified\n room.
Time of the room’s last update. This is an ISO 8601 timestamp; note\n that this is returned as a string.
" + "smithy.api#documentation": "Time of the room’s last update. This is an ISO 8601 timestamp; note that this\n is returned as a string.
" } }, "maximumMessageRatePerSecond": { "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", "traits": { - "smithy.api#documentation": "Maximum number of messages per second that a client can send to the room, from the\n request.
" + "smithy.api#documentation": "Maximum number of messages per second that can be sent to the room (by all clients), from the request.
" } }, "maximumMessageLength": { diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index 1b629f5081a..77759625425 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -2669,6 +2669,12 @@ "traits": { "smithy.api#documentation": "Provides the configuration information to connect to Quip as your \n data source.
" } + }, + "JiraConfiguration": { + "target": "com.amazonaws.kendra#JiraConfiguration", + "traits": { + "smithy.api#documentation": "Provides the configuration information to connect to Jira as your \n data source.
" + } } }, "traits": { @@ -3134,6 +3140,10 @@ { "value": "QUIP", "name": "QUIP" + }, + { + "value": "JIRA", + "name": "JIRA" } ] } @@ -6742,6 +6752,43 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.kendra#IssueSubEntity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMMENTS", + "name": "COMMENTS" + }, + { + "value": "ATTACHMENTS", + "name": "ATTACHMENTS" + }, + { + "value": "WORKLOGS", + "name": "WORKLOGS" + } + ] + } + }, + "com.amazonaws.kendra#IssueSubEntityFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#IssueSubEntity" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.kendra#IssueType": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#Issuer": { "type": "string", "traits": { @@ -6752,6 +6799,119 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.kendra#JiraAccountUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^https:\\/\\/[a-zA-Z0-9_\\-\\.]+(\\.atlassian\\.net\\/)$" + } + }, + "com.amazonaws.kendra#JiraConfiguration": { + "type": "structure", + "members": { + "JiraAccountUrl": { + "target": "com.amazonaws.kendra#JiraAccountUrl", + "traits": { + "smithy.api#documentation": "The URL of the Jira account. For example, company.attlassian.net or \n https://jira.company.com. You can find your Jira account URL in the URL of \n your profile page for Jira desktop.
", + "smithy.api#required": {} + } + }, + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Manager secret that \n contains the key-value pairs required to connect to your Jira \n data source. The secret must \n contain a JSON structure with the following keys:
\njira-id—The Active Directory user name, along with the \n Domain Name System (DNS) domain name. For example, \n user@corp.example.com.
\njiraCredentials—The password of the Jira account user.
\nSpecify to use the change log option to update your index.
" + } + }, + "Project": { + "target": "com.amazonaws.kendra#Project", + "traits": { + "smithy.api#documentation": "Specify which projects to crawl in your Jira data source. You can specify \n one or more Jira project IDs.
" + } + }, + "IssueType": { + "target": "com.amazonaws.kendra#IssueType", + "traits": { + "smithy.api#documentation": "Specify which issue types to crawl in your Jira data source. \n You can specify one or more of these options to crawl.
" + } + }, + "Status": { + "target": "com.amazonaws.kendra#JiraStatus", + "traits": { + "smithy.api#documentation": "Specify which statuses to crawl in your Jira data source. \n You can specify one or more of these options to crawl.
" + } + }, + "IssueSubEntityFilter": { + "target": "com.amazonaws.kendra#IssueSubEntityFilter", + "traits": { + "smithy.api#documentation": "Specify whether to crawl comments,\n attachments,\n and work logs. You can specify one or more of these options.
" + } + }, + "AttachmentFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map attributes \n or field names of Jira attachments to Amazon Kendra index field names. \n To create custom fields, use the UpdateIndex API before you map to Jira \n fields. For\n more information, see \n Mapping data source fields. The Jira data source field names \n must exist in your Jira custom metadata.
" + } + }, + "CommentFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map attributes \n or field names of Jira comments to Amazon Kendra index field names. \n To create custom fields, use the UpdateIndex API before you map to Jira \n fields. For\n more information, see \n Mapping data source fields. The Jira data source field names \n must exist in your Jira custom metadata.
" + } + }, + "IssueFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map attributes \n or field names of Jira issues to Amazon Kendra index field names. \n To create custom fields, use the UpdateIndex API before you map to Jira \n fields. For\n more information, see \n Mapping data source fields. The Jira data source field names \n must exist in your Jira custom metadata.
" + } + }, + "ProjectFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map attributes \n or field names of Jira projects to Amazon Kendra index field names. \n To create custom fields, use the UpdateIndex API before you map to Jira \n fields. For\n more information, see \n Mapping data source fields. The Jira data source field names \n must exist in your Jira custom metadata.
" + } + }, + "WorkLogFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "A list of DataSourceToIndexFieldMapping objects that map attributes \n or field names of Jira work logs to Amazon Kendra index field names. \n To create custom fields, use the UpdateIndex API before you map to Jira \n fields. For\n more information, see \n Mapping data source fields. The Jira data source field names \n must exist in your Jira custom metadata.
" + } + }, + "InclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "A list of regular expression patterns to include certain file paths,\n file\n names, and\n file types in your Jira data source. Files that match the patterns are included in the\n index. Files that don't match the patterns are excluded from the index. If a file\n matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes\n precedence and the file isn't included in the index.
" + } + }, + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "A list of regular expression patterns to exclude certain file paths,\n file names, and file types\n in your Jira data source. Files that match the patterns \n are excluded from the index. Files that don’t match the patterns are \n included in the index. If a file matches both an inclusion pattern \n and an exclusion pattern, the exclusion pattern takes precedence \n and the file isn't included in the index.
" + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information for an \n Amazon Virtual Private Cloud to connect to your Jira. Your Jira \n account must reside inside your VPC.
" + } + } + } + }, + "com.amazonaws.kendra#JiraStatus": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#JsonTokenTypeConfiguration": { "type": "structure", "members": { @@ -8310,6 +8470,12 @@ "target": "com.amazonaws.kendra#String" } }, + "com.amazonaws.kendra#Project": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#ProxyConfiguration": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/kms.json b/aws/sdk/aws-models/kms.json index 6808c455634..7bf7edf0d02 100644 --- a/aws/sdk/aws-models/kms.json +++ b/aws/sdk/aws-models/kms.json @@ -601,7 +601,7 @@ "Operations": { "target": "com.amazonaws.kms#GrantOperationList", "traits": { - "smithy.api#documentation": "A list of operations that the grant permits.
\nThis list must include only operations that are permitted in a grant. Also, the operation\n must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key\n that allows the GenerateDataKey operation. If you try, KMS returns a\n ValidationError
exception. For details, see Grant operations in the\n Key Management Service Developer Guide.
A list of operations that the grant permits.
\nThis list must include only operations that are permitted in a grant. Also, the operation\n must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an\n asymmetric KMS key that allows the GenerateDataKey operation. If you try,\n KMS returns a ValidationError
exception. For details, see Grant\n operations in the Key Management Service Developer Guide.
Creates a unique customer managed KMS key in your Amazon Web Services account and\n Region.
\nIn addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type.
\nKMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
\nTo create different types of KMS keys, use the following guidance:
\n\nTo create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for\n KeySpec
, SYMMETRIC_DEFAULT
, and the default value for\n KeyUsage
, ENCRYPT_DECRYPT
, create a symmetric encryption KMS key.
If you need a key for basic encryption and decryption or you \n are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
\n\n
To create an asymmetric KMS key, use the KeySpec
parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage
parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.
Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric \n KMS key never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key\n so it can be used outside of AWS KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). \n KMS keys with ECC key pairs can be used only to sign and verify messages. \n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
\n\n
To create an HMAC KMS key, set the KeySpec
parameter to a\n key spec value for HMAC KMS keys. Then set the KeyUsage
parameter to\n GENERATE_VERIFY_MAC
. You must set the key usage even though\n GENERATE_VERIFY_MAC
is the only valid key usage value for HMAC KMS keys.\n You can't change these properties after the KMS key is created.
HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use\n HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.
\nHMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC\n KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the\n CreateKey
operation returns an\n UnsupportedOperationException
. For a list of Regions in which HMAC KMS keys\n are supported, see HMAC keys in\n KMS in the Key Management Service Developer Guide.
\n
To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion
parameter with a value of True
. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.
You can create multi-Region KMS keys for all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't create multi-Region keys in a custom key store.
\nThis operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
\n\n
To import your own key material, begin by creating a symmetric encryption KMS key with no key\n material. To do this, use the Origin
parameter of CreateKey
\n with a value of EXTERNAL
. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n .
This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key\n material into any other type of KMS key.
\nTo create a multi-Region primary key with imported key material, use the\n Origin
parameter of CreateKey
with a value of\n EXTERNAL
and the MultiRegion
parameter with a value of\n True
. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
\n
To create a symmetric encryption KMS key in a custom key store, use the\n CustomKeyStoreId
parameter to specify the custom key store. You must also\n use the Origin
parameter with a value of AWS_CLOUDHSM
. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.
Custom key stores support only symmetric encryption KMS keys. You cannot create an\n HMAC KMS key or an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Custom key stores in KMS in\n the \n Key Management Service Developer Guide\n .
\n\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags
parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n KMS keys in the Key Management Service Developer Guide.
\n Related operations:\n
\n\n DescribeKey\n
\n\n ListKeys\n
\n\n ScheduleKeyDeletion\n
\nCreates a unique customer managed KMS key in your Amazon Web Services account and\n Region.
\nIn addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type.
\nKMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
\nTo create different types of KMS keys, use the following guidance:
\n\nTo create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for\n KeySpec
, SYMMETRIC_DEFAULT
, and the default value for\n KeyUsage
, ENCRYPT_DECRYPT
, create a symmetric encryption KMS key.
If you need a key for basic encryption and decryption or you \n are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
\n\n
To create an asymmetric KMS key, use the KeySpec
parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage
parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.
Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric \n KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key\n so it can be used outside of KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). \n KMS keys with ECC key pairs can be used only to sign and verify messages. \n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
\n\n
To create an HMAC KMS key, set the KeySpec
parameter to a\n key spec value for HMAC KMS keys. Then set the KeyUsage
parameter to\n GENERATE_VERIFY_MAC
. You must set the key usage even though\n GENERATE_VERIFY_MAC
is the only valid key usage value for HMAC KMS keys.\n You can't change these properties after the KMS key is created.
HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use\n HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.
\nHMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC\n KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the\n CreateKey
operation returns an\n UnsupportedOperationException
. For a list of Regions in which HMAC KMS keys\n are supported, see HMAC keys in\n KMS in the Key Management Service Developer Guide.
\n
To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion
parameter with a value of True
. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.
You can create multi-Region KMS keys for all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't create multi-Region keys in a custom key store.
\nThis operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
\n\n
To import your own key material, begin by creating a symmetric encryption KMS key with no key\n material. To do this, use the Origin
parameter of CreateKey
\n with a value of EXTERNAL
. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n .
This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key\n material into any other type of KMS key.
\nTo create a multi-Region primary key with imported key material, use the\n Origin
parameter of CreateKey
with a value of\n EXTERNAL
and the MultiRegion
parameter with a value of\n True
. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
\n
To create a symmetric encryption KMS key in a custom key store, use the\n CustomKeyStoreId
parameter to specify the custom key store. You must also\n use the Origin
parameter with a value of AWS_CLOUDHSM
. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.
Custom key stores support only symmetric encryption KMS keys. You cannot create an\n HMAC KMS key or an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Custom key stores in KMS in\n the \n Key Management Service Developer Guide\n .
\n\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags
parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n KMS keys in the Key Management Service Developer Guide.
\n Related operations:\n
\n\n DescribeKey\n
\n\n ListKeys\n
\n\n ScheduleKeyDeletion\n
\nThe key policy to attach to the KMS key.
\nIf you provide a key policy, it must meet the following criteria:
\nIf you don't set BypassPolicyLockoutSafetyCheck
to true, the key policy\n must allow the principal that is making the CreateKey
request to make a\n subsequent PutKeyPolicy request on the KMS key. This reduces the risk\n that the KMS key becomes unmanageable. For more information, refer to the scenario in the\n Default Key Policy section of the \n Key Management Service Developer Guide\n .
Each statement in the key policy must contain one or more principals. The principals\n in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services\n principal (for example, an IAM user or role), you might need to enforce a delay before\n including the new principal in a key policy because the new principal might not be\n immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services\n Identity and Access Management User Guide.
\nIf you do not provide a key policy, KMS attaches a default key policy to the KMS key.\n For more information, see Default Key Policy in the\n Key Management Service Developer Guide.
\nThe key policy size quota is 32 kilobytes (32768 bytes).
\nFor help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n Identity and Access Management User Guide\n .
" + "smithy.api#documentation": "The key policy to attach to the KMS key. If you do not specify a key policy, KMS attaches a default key policy to the KMS key.\n For more information, see Default key policy in the\n Key Management Service Developer Guide.
\nIf you provide a key policy, it must meet the following criteria:
\nIf you don't set BypassPolicyLockoutSafetyCheck
to True
, the key policy\n must allow the principal that is making the CreateKey
request to make a\n subsequent PutKeyPolicy request on the KMS key. This reduces the risk\n that the KMS key becomes unmanageable. For more information, refer to the scenario in the\n Default Key Policy section of the \n Key Management Service Developer Guide\n .
Each statement in the key policy must contain one or more principals. The principals\n in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services\n principal (for example, an IAM user or role), you might need to enforce a delay before\n including the new principal in a key policy because the new principal might not be\n immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services\n Identity and Access Management User Guide.
\nA key policy document must conform to the following rules.
\nUp to 32 kilobytes (32768 bytes)
\nMust be UTF-8 encoded
\nThe only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.
\nThe Sid
element in a key policy statement can include spaces. (Spaces are\n prohibited in the Sid
element of an IAM policy document.)
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n Identity and Access Management User Guide\n .
" } }, "Description": { @@ -704,7 +704,7 @@ "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT
. This parameter is optional when you are creating a symmetric\n encryption KMS key; otherwise, it is required. You\n can't change the KeyUsage
value after the KMS key is created.
Select only one valid value.
\nFor symmetric encryption KMS keys, omit the parameter or specify\n ENCRYPT_DECRYPT
.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC
.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT
or\n SIGN_VERIFY
.
For asymmetric KMS keys with ECC key material, specify\n SIGN_VERIFY
.
Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT
. This parameter is optional when you are creating a symmetric\n encryption KMS key; otherwise, it is required. You\n can't change the KeyUsage
value after the KMS key is created.
Select only one valid value.
\nFor symmetric encryption KMS keys, omit the parameter or specify\n ENCRYPT_DECRYPT
.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC
.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT
or\n SIGN_VERIFY
.
For asymmetric KMS keys with ECC key material, specify\n SIGN_VERIFY
.
Specifies the type of KMS key to create. The default value,\n SYMMETRIC_DEFAULT
, creates a KMS key with a 256-bit symmetric key for encryption\n and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in\n the \n Key Management Service Developer Guide\n .
The KeySpec
determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't\n change the KeySpec
after the KMS key is created. To further restrict the\n algorithms that can be used with the KMS key, use a condition key in its key policy or IAM\n policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .
\n Amazon Web Services services that\n are integrated with KMS use symmetric encryption KMS keys to protect your data.\n These services do not support asymmetric KMS keys or HMAC KMS keys.
\nKMS supports the following key specs for KMS keys:
\nSymmetric encryption key (default)
\n\n SYMMETRIC_DEFAULT
(AES-256-GCM)
HMAC keys (symmetric)
\n\n HMAC_224
\n
\n HMAC_256
\n
\n HMAC_384
\n
\n HMAC_512
\n
Asymmetric RSA key pairs
\n\n RSA_2048
\n
\n RSA_3072
\n
\n RSA_4096
\n
Asymmetric NIST-recommended elliptic curve key pairs
\n\n ECC_NIST_P256
(secp256r1)
\n ECC_NIST_P384
(secp384r1)
\n ECC_NIST_P521
(secp521r1)
Other asymmetric elliptic curve key pairs
\n\n ECC_SECG_P256K1
(secp256k1), commonly used for\n cryptocurrencies.
Specifies the type of KMS key to create. The default value,\n SYMMETRIC_DEFAULT
, creates a KMS key with a 256-bit symmetric key for encryption\n and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the \n Key Management Service Developer Guide\n .
The KeySpec
determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the cryptographic algorithms that the KMS key supports. You can't\n change the KeySpec
after the KMS key is created.\n To further restrict the algorithms that can be used with the KMS key, use a condition key in\n its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .
\n Amazon Web Services services that\n are integrated with KMS use symmetric encryption KMS keys to protect your data.\n These services do not support asymmetric KMS keys or HMAC KMS keys.
\nKMS supports the following key specs for KMS keys:
\nSymmetric encryption key (default)
\n\n SYMMETRIC_DEFAULT
(AES-256-GCM)
HMAC keys (symmetric)
\n\n HMAC_224
\n
\n HMAC_256
\n
\n HMAC_384
\n
\n HMAC_512
\n
Asymmetric RSA key pairs
\n\n RSA_2048
\n
\n RSA_3072
\n
\n RSA_4096
\n
Asymmetric NIST-recommended elliptic curve key pairs
\n\n ECC_NIST_P256
(secp256r1)
\n ECC_NIST_P384
(secp384r1)
\n ECC_NIST_P521
(secp521r1)
Other asymmetric elliptic curve key pairs
\n\n ECC_SECG_P256K1
(secp256k1), commonly used for\n cryptocurrencies.
Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.
\nFor a multi-Region key, set this parameter to True
. For a single-Region KMS\n key, omit this parameter or set it to False
. The default value is\n False
.
This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
\nThis value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.
\nYou can create a symmetric or asymmetric multi-Region key, and you can create a\n multi-Region key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.
" + "smithy.api#documentation": "Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.
\nFor a multi-Region key, set this parameter to True
. For a single-Region KMS\n key, omit this parameter or set it to False
. The default value is\n False
.
This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
\nThis value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.
\nYou can create a multi-Region version of a symmetric encryption KMS key, an HMAC KMS key, an asymmetric KMS key, or a\n KMS key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.
" } } } @@ -1059,7 +1059,7 @@ } ], "traits": { - "smithy.api#documentation": "Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nYou can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an\n asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the\n encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
\nThe Decrypt
operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by\n other libraries, such as the Amazon Web Services\n Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId
\n parameter is optional. KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. This feature adds durability to your implementation by ensuring\n that authorized users can decrypt ciphertext decades after it was encrypted, even if they've\n lost track of the key ID. However, specifying the KMS key is always recommended as a best\n practice. When you use the KeyId
parameter to specify a KMS key, KMS only uses\n the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the\n Decrypt
operation fails. This practice ensures that you use the KMS key that\n you intend.
Whenever possible, use key policies to give users permission to call the\n Decrypt
operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt
\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt
permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:Decrypt (key policy)
\n\n Related operations:\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\n\n ReEncrypt\n
\nDecrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nYou can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an\n asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the\n encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
\nThe Decrypt
operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by\n other libraries, such as the Amazon Web Services\n Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.
If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId
\n parameter is optional. KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. This feature adds durability to your implementation by ensuring\n that authorized users can decrypt ciphertext decades after it was encrypted, even if they've\n lost track of the key ID. However, specifying the KMS key is always recommended as a best\n practice. When you use the KeyId
parameter to specify a KMS key, KMS only uses\n the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the\n Decrypt
operation fails. This practice ensures that you use the KMS key that\n you intend.
Whenever possible, use key policies to give users permission to call the\n Decrypt
operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt
\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt
permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:Decrypt (key policy)
\n\n Related operations:\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\n\n ReEncrypt\n
\nSpecifies the KMS key that KMS uses to decrypt the ciphertext.
\n \nEnter a key ID of the KMS\n key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt
operation throws an IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.
\n \nTo specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
" + "smithy.api#documentation": "Specifies the KMS key that KMS uses to decrypt the ciphertext.
\nEnter a key ID of the KMS\n key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt
operation throws an IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.
\n \nTo specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
" } }, "EncryptionAlgorithm": { @@ -1474,7 +1474,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables automatic\n rotation of the key material for the specified symmetric encryption KMS key.
\nYou cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:DisableKeyRotation (key policy)
\n\n Related operations:\n
\n\n EnableKeyRotation\n
\n\n GetKeyRotationStatus\n
\nDisables automatic\n rotation of the key material of the specified symmetric encryption KMS key.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false
.\nTo enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You can enable (EnableKeyRotation) and disable automatic rotation of the\n key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS\n keys varies.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every\n three years to every year. For details, see EnableKeyRotation.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:DisableKeyRotation (key policy)
\n\n Related operations:\n
\n\n EnableKeyRotation\n
\n\n GetKeyRotationStatus\n
\nEnables automatic rotation\n of the key material for the specified symmetric encryption KMS key.
\nYou cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:EnableKeyRotation (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n GetKeyRotationStatus\n
\nEnables automatic rotation\n of the key material of the specified symmetric encryption KMS key.
\nWhen you enable automatic rotation of acustomer managed KMS key, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can monitor rotation of the key material for your KMS keys in\n CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer\n managed KMS key, use the DisableKeyRotation operation.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false
.\nTo enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys varies.
\nIn May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years (approximately 1,095 days) to every year (approximately 365 days).
\nNew Amazon Web Services managed keys are automatically rotated one year after they\n are created, and approximately every year thereafter.
\nExisting Amazon Web Services managed keys are automatically rotated one year after\n their most recent rotation, and every year thereafter.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:EnableKeyRotation (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n GetKeyRotationStatus\n
\nIdentifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
\nSpecify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", + "smithy.api#documentation": "Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false
.\nTo enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
Specify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", "smithy.api#required": {} } } @@ -1671,7 +1671,7 @@ } ], "traits": { - "smithy.api#documentation": "Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or\n asymmetric KMS key with a KeyUsage
of ENCRYPT_DECRYPT
.
You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or\n database password, or other sensitive information. You don't need to use the Encrypt
operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.
If you use a symmetric encryption KMS key, you can use an encryption context to add additional\n security to your encryption operation. If you specify an EncryptionContext
when\n encrypting data, you must specify the same encryption context (a case-sensitive exact match)\n when decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException
. For more information, see Encryption\n Context in the Key Management Service Developer Guide.
If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.
\nWhen you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
\nYou are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
\nThe maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.
\nSymmetric encryption KMS keys
\n\n SYMMETRIC_DEFAULT
: 4096 bytes
\n RSA_2048
\n
\n RSAES_OAEP_SHA_1
: 214 bytes
\n RSAES_OAEP_SHA_256
: 190 bytes
\n RSA_3072
\n
\n RSAES_OAEP_SHA_1
: 342 bytes
\n RSAES_OAEP_SHA_256
: 318 bytes
\n RSA_4096
\n
\n RSAES_OAEP_SHA_1
: 470 bytes
\n RSAES_OAEP_SHA_256
: 446 bytes
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: Yes.\n To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:Encrypt (key policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nEncrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or\n asymmetric KMS key with a KeyUsage
of ENCRYPT_DECRYPT
.
You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or\n database password, or other sensitive information. You don't need to use the Encrypt
operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.
If you use a symmetric encryption KMS key, you can use an encryption context to add additional\n security to your encryption operation. If you specify an EncryptionContext
when\n encrypting data, you must specify the same encryption context (a case-sensitive exact match)\n when decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException
. For more information, see Encryption\n Context in the Key Management Service Developer Guide.
If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.
\nWhen you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
\nYou are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
\nThe maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.
\nSymmetric encryption KMS keys
\n\n SYMMETRIC_DEFAULT
: 4096 bytes
\n RSA_2048
\n
\n RSAES_OAEP_SHA_1
: 214 bytes
\n RSAES_OAEP_SHA_256
: 190 bytes
\n RSA_3072
\n
\n RSAES_OAEP_SHA_1
: 342 bytes
\n RSAES_OAEP_SHA_256
: 318 bytes
\n RSA_4096
\n
\n RSAES_OAEP_SHA_1
: 470 bytes
\n RSAES_OAEP_SHA_256
: 446 bytes
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: Yes.\n To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:Encrypt (key policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nReturns a unique symmetric data key for use outside of KMS. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS\n key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS\n key. You can use the plaintext key to encrypt your data outside of KMS and store the\n encrypted data key with the encrypted data.
\n\nTo generate a data key, specify the symmetric encryption KMS key that will be used to\n encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the\n type of your KMS key, use the DescribeKey operation. You must also specify\n the length of the data key. Use either the KeySpec
or NumberOfBytes
\n parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec
\n parameter.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.
\n\nYou can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n How to use your data\n key\n
\nWe recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.
\nTo encrypt data outside of KMS:
\nUse the GenerateDataKey
operation to get a data key.
Use the plaintext data key (in the Plaintext
field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob
field of the\n response) with the encrypted data.
To decrypt data outside of KMS:
\nUse the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.
\nUse the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.
\n\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKey (key policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKeyPair\n
\nReturns a unique symmetric data key for use outside of KMS. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS\n key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS\n key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted\n data key with the encrypted data.
\n\nTo generate a data key, specify the symmetric encryption KMS key that will be used to\n encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the\n type of your KMS key, use the DescribeKey operation. You must also specify the length of\n the data key. Use either the KeySpec
or NumberOfBytes
parameters\n (but not both). For 128-bit and 256-bit data keys, use the KeySpec
parameter.
To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.
\n\nYou can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n How to use your data\n key\n
\nWe recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.
\nTo encrypt data outside of KMS:
\nUse the GenerateDataKey
operation to get a data key.
Use the plaintext data key (in the Plaintext
field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.
Store the encrypted data key (in the CiphertextBlob
field of the\n response) with the encrypted data.
To decrypt data outside of KMS:
\nUse the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.
\nUse the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.
\n\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKey (key policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKeyPair\n
\nReturns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key, a plaintext private key, and a copy of the private key that is\n encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes\n in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the\n private key.
\n\nYou can use the public key that GenerateDataKeyPair
returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
\nUse the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.
If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext
returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.
\n GenerateDataKeyPair
returns a unique data key pair for each request. The\n bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280. The private key is a\n DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.
You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKeyPair (key policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\nReturns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key, a plaintext private key, and a copy of the private key that is\n encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes\n in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the\n private key.
\n\nYou can use the public key that GenerateDataKeyPair
returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey\n operation.
\nUse the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.
If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext
returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.
\n GenerateDataKeyPair
returns a unique data key pair for each request. The\n bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280. The private key is a\n DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.
You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKeyPair (key policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\nReturns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key and a copy of the private key that is encrypted under the symmetric\n encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation\n does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller\n or to the KMS key that is used to encrypt the private key.
\nYou can use the public key that GenerateDataKeyPairWithoutPlaintext
returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
\nUse the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.
\n GenerateDataKeyPairWithoutPlaintext
returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt\n the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.
You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key\n policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nReturns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key and a copy of the private key that is encrypted under the symmetric\n encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation\n does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller\n or to the KMS key that is used to encrypt the private key.
\nYou can use the public key that GenerateDataKeyPairWithoutPlaintext
returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.
To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey\n operation.
\nUse the KeyPairSpec
parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.
\n GenerateDataKeyPairWithoutPlaintext
returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt\n the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.
You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key\n policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nSpecifies the symmetric encryption KMS key that encrypts the private key in the data key\n pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.
\nTo specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
", + "smithy.api#documentation": "Specifies the symmetric encryption KMS key that encrypts the private key in the data key\n pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.\n
\nTo specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
", "smithy.api#required": {} } }, @@ -2149,7 +2149,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a unique symmetric data key for use outside of KMS. This operation returns a\n data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in\n the key are random; they are not related to the caller or to the KMS key.
\n\n GenerateDataKeyWithoutPlaintext
is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the\n data key.
This operation is useful for systems that need to encrypt data at some point, but not\n immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key. It's also useful in distributed systems with\n different levels of trust. For example, you might store encrypted data in containers. One\n component of your system creates new containers and stores an encrypted data key with each\n container. Then, a different component puts the data into the containers. That component first\n decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data\n into the container, and then destroys the plaintext data key. In this system, the component\n that creates the containers never sees the plaintext data key.
\nTo request an asymmetric data key pair, use the GenerateDataKeyPair or\n GenerateDataKeyPairWithoutPlaintext operations.
\n\nTo generate a data key, you must specify the symmetric encryption KMS key that is used to\n encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the\n type of your KMS key, use the DescribeKey operation.
\nIf the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob
field.
You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key\n policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nReturns a unique symmetric data key for use outside of KMS. This operation returns a\n data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in\n the key are random; they are not related to the caller or to the KMS key.
\n\n GenerateDataKeyWithoutPlaintext
is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the\n data key.
This operation is useful for systems that need to encrypt data at some point, but not\n immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.
\nIt's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.
\nTo request an asymmetric data key pair, use the GenerateDataKeyPair or\n GenerateDataKeyPairWithoutPlaintext operations.
\n\nTo generate a data key, you must specify the symmetric encryption KMS key that is used to\n encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the\n type of your KMS key, use the DescribeKey operation.
\n\nIf the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob
field.
You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext
, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException
. For more information, see Encryption Context in the\n Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key\n policy)
\n\n Related operations:\n
\n\n Decrypt\n
\n\n Encrypt\n
\n\n GenerateDataKey\n
\n\n GenerateDataKeyPair\n
\nGenerates a hash-based message authentication code (HMAC) for a message using an HMAC KMS\n key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the\n message and the key as described in RFC 2104.
\nYou can use the HMAC that this operation generates with the VerifyMac\n operation to demonstrate that the original message has not changed. Also, because a secret key\n is used to create the hash, you can verify that the party that generated the hash has the\n required secret key. This operation is part of KMS support for HMAC KMS keys.\n For details, see HMAC keys in KMS in the \n Key Management Service Developer Guide\n .
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateMac (key policy)
\n\n Related operations: VerifyMac\n
" + "smithy.api#documentation": "Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS\n key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the\n message and the key as described in RFC 2104.
\nYou can use the HMAC that this operation generates with the VerifyMac\n operation to demonstrate that the original message has not changed. Also, because a secret key\n is used to create the hash, you can verify that the party that generated the hash has the\n required secret key. This operation is part of KMS support for HMAC KMS keys.\n For details, see HMAC keys in KMS in the \n Key Management Service Developer Guide\n .
\nBest practices recommend that you limit the time during which any signing mechanism,\n including an HMAC, is effective. This deters an attack where the actor uses a signed\n message to establish validity repeatedly or long after the message is superseded. HMAC\n tags do not include a timestamp, but you can include a timestamp in the token or message\n to help you detect when its time to refresh the HMAC.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GenerateMac (key policy)
\n\n Related operations: VerifyMac\n
" } }, "com.amazonaws.kms#GenerateMacRequest": { @@ -2437,7 +2437,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.
\nYou cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always\n false
.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\nDisabled: The key rotation status does not change when you disable a KMS key. However,\n while the KMS key is disabled, KMS does not rotate the key material.
\nPending deletion: While a KMS key is pending deletion, its key rotation status is\n false
and KMS does not rotate the key material. If you cancel the\n deletion, the original key rotation status is restored.
\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GetKeyRotationStatus (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n EnableKeyRotation\n
\nGets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.
\nWhen you enable automatic rotation for customer managed KMS keys, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can monitor rotation of the key material for your KMS keys in\n CloudTrail and Amazon CloudWatch.
\nAutomatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false
.\nTo enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key..
You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key\n material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The\n key rotation status for Amazon Web Services managed KMS keys is always true
.
In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\nDisabled: The key rotation status does not change when you disable a KMS key. However,\n while the KMS key is disabled, KMS does not rotate the key material. When you re-enable\n the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been\n rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been\n less than a year since the key material in the re-enabled KMS key was rotated, the KMS key\n resumes its prior rotation schedule.
\nPending deletion: While a KMS key is pending deletion, its key rotation status is\n false
and KMS does not rotate the key material. If you cancel the\n deletion, the original key rotation status returns to true
.
\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId
parameter.
\n Required permissions: kms:GetKeyRotationStatus (key policy)
\n\n Related operations:\n
\n\n DisableKeyRotation\n
\n\n EnableKeyRotation\n
\nReturns the items you need to import key material into a symmetric encryption KMS key. For\n more information about importing key material into KMS, see Importing key material in the\n Key Management Service Developer Guide.
\nThis operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
\nYou must specify the key ID of the symmetric encryption KMS key into which you will import\n key material. This KMS key's Origin
must be EXTERNAL
. You must also\n specify the wrapping algorithm and type of wrapping key (public key) that you will use to\n encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.
To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport
response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport
request.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:GetParametersForImport (key policy)
\n\n Related operations:\n
\n\n ImportKeyMaterial\n
\nReturns the items you need to import key material into a symmetric encryption KMS key. For\n more information about importing key material into KMS, see Importing key material\n in the Key Management Service Developer Guide.
\nThis operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
\nYou must specify the key ID of the symmetric encryption KMS key into which you will import\n key material. This KMS key's Origin
must be EXTERNAL
. You must also\n specify the wrapping algorithm and type of wrapping key (public key) that you will use to\n encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.
To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport
response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport
request.
The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:GetParametersForImport (key policy)
\n\n Related operations:\n
\n\n ImportKeyMaterial\n
\nImports key material into an existing symmetric encryption KMS key that was created\n without key material. After you successfully import key material into a KMS key, you can\n reimport the same key material into that KMS key, but you cannot import different\n key material.
\nYou cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about\n creating KMS keys with no key material and then importing key material, see Importing Key Material\n in the Key Management Service Developer Guide.
\nBefore using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport
\n response.
When calling this operation, you must specify the following values:
\nThe key ID or key ARN of a KMS key with no key material. Its Origin
must\n be EXTERNAL
.
To create a KMS key with no key material, call CreateKey and set the\n value of its Origin
parameter to EXTERNAL
. To get the\n Origin
of a KMS key, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call\n GetParametersForImport.
\nThe import token that GetParametersForImport returned. You must use\n a public key and token from the same GetParametersForImport
response.
Whether the key material expires and if so, when. If you set an expiration date, KMS\n deletes the key material from the KMS key on the specified date, and the KMS key becomes\n unusable. To use the KMS key again, you must reimport the same key material. The only way\n to change an expiration date is by reimporting the same key material and specifying a new\n expiration date.
\nWhen this operation is successful, the key state of the KMS key changes from\n PendingImport
to Enabled
, and you can use the KMS key.
If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key\n and repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:ImportKeyMaterial (key policy)
\n\n Related operations:\n
\nImports key material into an existing symmetric encryption KMS key that was created\n without key material. After you successfully import key material into a KMS key, you can\n reimport\n the same key material into that KMS key, but you cannot import different key\n material.
\nYou cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material\n and then importing key material, see Importing Key Material in the\n Key Management Service Developer Guide.
\nBefore using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport
\n response.
When calling this operation, you must specify the following values:
\nThe key ID or key ARN of a KMS key with no key material. Its Origin
must\n be EXTERNAL
.
To create a KMS key with no key material, call CreateKey and set the\n value of its Origin
parameter to EXTERNAL
. To get the\n Origin
of a KMS key, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call\n GetParametersForImport.
\nThe import token that GetParametersForImport returned. You must use\n a public key and token from the same GetParametersForImport
response.
Whether the key material expires and if so, when. If you set an expiration date, KMS\n deletes the key material from the KMS key on the specified date, and the KMS key becomes\n unusable. To use the KMS key again, you must reimport the same key material. The only way\n to change an expiration date is by reimporting the same key material and specifying a new\n expiration date.
\nWhen this operation is successful, the key state of the KMS key changes from\n PendingImport
to Enabled
, and you can use the KMS key.
If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key\n and repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
\n\n\n Required permissions: kms:ImportKeyMaterial (key policy)
\n\n Related operations:\n
\nThe identifier of the symmetric encryption KMS key that receives the imported key\n material. This must be the same KMS key specified in the KeyID
parameter of the\n corresponding GetParametersForImport request. The Origin
of the\n KMS key must be EXTERNAL
. You cannot perform this operation on an asymmetric KMS\n key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different\n Amazon Web Services account
Specify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", + "smithy.api#documentation": "The identifier of the symmetric encryption KMS key that receives the imported key\n material. This must be the same KMS key specified in the KeyID
parameter of the corresponding GetParametersForImport request. The Origin
of the\n KMS key must be EXTERNAL
. You cannot perform this operation on an asymmetric KMS\n key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different\n Amazon Web Services account
Specify the key ID or key ARN of the KMS key.
\nFor example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
", "smithy.api#required": {} } }, @@ -2965,7 +2965,7 @@ "code": "IncorrectKeyException", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId
in a Decrypt
request and the SourceKeyId
\n in a ReEncrypt
request must identify the same KMS key that was used to\n encrypt the ciphertext.
The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId
in a Decrypt request and the SourceKeyId
\n in a ReEncrypt request must identify the same KMS key that was used to\n encrypt the ciphertext.
The request was rejected for one of the following reasons:
\nThe KeyUsage
value of the KMS key is incompatible with the API\n operation.
The encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec
).
For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage
must be ENCRYPT_DECRYPT
. For signing and verifying\n messages, the KeyUsage
must be SIGN_VERIFY
. For generating and\n verifying message authentication codes (MACs), the KeyUsage
must be\n GENERATE_VERIFY_MAC
. To find the KeyUsage
of a KMS key, use the\n DescribeKey operation.
To find the encryption or signing algorithms supported for a particular KMS key, use the\n DescribeKey operation.
", + "smithy.api#documentation": "The request was rejected for one of the following reasons:
\nThe KeyUsage
value of the KMS key is incompatible with the API\n operation.
The encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec
).
For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage
must be ENCRYPT_DECRYPT
. For signing and verifying\n messages, the KeyUsage
must be SIGN_VERIFY
. For generating and\n verifying message authentication codes (MACs), the KeyUsage
must be\n GENERATE_VERIFY_MAC
. To find the KeyUsage
of\n a KMS key, use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular KMS key, use the\n DescribeKey operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4346,7 +4346,7 @@ "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "The key policy to attach to the KMS key.
\nThe key policy must meet the following criteria:
\nIf you don't set BypassPolicyLockoutSafetyCheck
to true, the key policy\n must allow the principal that is making the PutKeyPolicy
request to make a\n subsequent PutKeyPolicy
request on the KMS key. This reduces the risk that\n the KMS key becomes unmanageable. For more information, refer to the scenario in the\n Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals\n in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services\n principal (for example, an IAM user or role), you might need to enforce a delay before\n including the new principal in a key policy because the new principal might not be\n immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services\n Identity and Access Management User Guide.
\nThe key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the\n Key Management Service Developer Guide.
", + "smithy.api#documentation": "The key policy to attach to the KMS key.
\nThe key policy must meet the following criteria:
\nIf you don't set BypassPolicyLockoutSafetyCheck
to true, the key policy\n must allow the principal that is making the PutKeyPolicy
request to make a\n subsequent PutKeyPolicy
request on the KMS key. This reduces the risk that\n the KMS key becomes unmanageable. For more information, refer to the scenario in the\n Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals\n in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services\n principal (for example, an IAM user or role), you might need to enforce a delay before\n including the new principal in a key policy because the new principal might not be\n immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services\n Identity and Access Management User Guide.
\nA key policy document must conform to the following rules.
\nUp to 32 kilobytes (32768 bytes)
\nMust be UTF-8 encoded
\nThe only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.
\nThe Sid
element in a key policy statement can include spaces. (Spaces are\n prohibited in the Sid
element of an IAM policy document.)
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is\n re-encrypted.
\nEnter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt
operation throws an IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that\n it adds to the symmetric ciphertext blob. However, it is always recommended as a best\n practice. This practice ensures that you use the KMS key that you intend.
\n \nTo specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
" + "smithy.api#documentation": "Specifies the KMS key that KMS will use to decrypt the ciphertext before it is\n re-encrypted.
\nEnter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt
operation throws an IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.
\n \nTo specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
\n
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
" } }, "DestinationKeyId": { @@ -4566,7 +4566,7 @@ "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "The key policy to attach to the KMS key. This parameter is optional. If you do not provide\n a key policy, KMS attaches the default key policy to the\n KMS key.
\nThe key policy is not a shared property of multi-Region keys. You can specify the same key\n policy or a different key policy for each key in a set of related multi-Region keys. KMS\n does not synchronize this property.
\nIf you provide a key policy, it must meet the following criteria:
\nIf you don't set BypassPolicyLockoutSafetyCheck
to true, the key policy\n must give the caller kms:PutKeyPolicy
permission on the replica key. This\n reduces the risk that the KMS key becomes unmanageable. For more information, refer to the\n scenario in the Default Key Policy section of the \n Key Management Service Developer Guide\n .
Each statement in the key policy must contain one or more principals. The principals\n in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services\n principal (for example, an IAM user or role), you might need to enforce a delay before\n including the new principal in a key policy because the new principal might not be\n immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the\n \n Identity and Access Management User Guide\n .
\nThe key policy size quota is 32 kilobytes (32768 bytes).
\nThe key policy to attach to the KMS key. This parameter is optional. If you do not provide\n a key policy, KMS attaches the default key policy to the\n KMS key.
\nThe key policy is not a shared property of multi-Region keys. You can specify the same key\n policy or a different key policy for each key in a set of related multi-Region keys. KMS\n does not synchronize this property.
\nIf you provide a key policy, it must meet the following criteria:
\nIf you don't set BypassPolicyLockoutSafetyCheck
to true, the key policy\n must give the caller kms:PutKeyPolicy
permission on the replica key. This\n reduces the risk that the KMS key becomes unmanageable. For more information, refer to the\n scenario in the Default Key Policy section of the \n Key Management Service Developer Guide\n .
Each statement in the key policy must contain one or more principals. The principals\n in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services\n principal (for example, an IAM user or role), you might need to enforce a delay before\n including the new principal in a key policy because the new principal might not be\n immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the\n \n Identity and Access Management User Guide\n .
\nA key policy document must conform to the following rules.
\nUp to 32 kilobytes (32768 bytes)
\nMust be UTF-8 encoded
\nThe only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.
\nThe Sid
element in a key policy statement can include spaces. (Spaces are\n prohibited in the Sid
element of an IAM policy document.)
The waiting period, specified in number of days. After the waiting period ends, KMS\n deletes the KMS key.
\nIf the KMS key is a multi-Region primary key with replicas, the waiting period begins when\n the last of its replica keys is deleted. Otherwise, the waiting period begins\n immediately.
\nThis value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.
" + "smithy.api#documentation": "The waiting period, specified in number of days. After the waiting period ends, KMS\n deletes the KMS key.
\nIf the KMS key is a multi-Region primary key with replica keys, the waiting period begins when\n the last of its replica keys is deleted. Otherwise, the waiting period begins\n immediately.
\nThis value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.
" } } } @@ -4832,7 +4832,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n signing KMS key. To verify the signature, use the Verify operation, or use\n the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
\nDigital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized\n user) uses their private key to sign a message. Anyone with the public key can verify that the\n message was signed with that particular private key and that the message hasn't changed since\n it was signed.
\nTo use the Sign
operation, provide the following information:
Use the KeyId
parameter to identify an asymmetric KMS key with a\n KeyUsage
value of SIGN_VERIFY
. To get the\n KeyUsage
value of a KMS key, use the DescribeKey\n operation. The caller must have kms:Sign
permission on the KMS key.
Use the Message
parameter to specify the message or message digest to\n sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a\n hash digest of the message, and then provide the hash digest in the Message
\n parameter. To indicate whether the message is a full message or a digest, use the\n MessageType
parameter.
Choose a signing algorithm that is compatible with the KMS key.
\nWhen signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.
\nTo verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:Sign (key policy)
\n\n Related operations: Verify\n
" + "smithy.api#documentation": "Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n signing KMS key. To verify the signature, use the Verify operation, or use the\n public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.
\nDigital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized\n user) uses their private key to sign a message. Anyone with the public key can verify that the\n message was signed with that particular private key and that the message hasn't changed since\n it was signed.
\nTo use the Sign
operation, provide the following information:
Use the KeyId
parameter to identify an asymmetric KMS key with a\n KeyUsage
value of SIGN_VERIFY
. To get the\n KeyUsage
value of a KMS key, use the DescribeKey\n operation. The caller must have kms:Sign
permission on the KMS key.
Use the Message
parameter to specify the message or message digest to\n sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a\n hash digest of the message, and then provide the hash digest in the Message
\n parameter. To indicate whether the message is a full message or a digest, use the\n MessageType
parameter.
Choose a signing algorithm that is compatible with the KMS key.
\nWhen signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.
\nBest practices recommend that you limit the time during which any signature is effective. This deters an attack where the actor uses a signed\n message to establish validity repeatedly or long after the message is superseded. Signatures do not include a timestamp, but you can include a timestamp in the signed message\n to help you detect when its time to refresh the signature.
\nTo verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.
\nThe KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.
\n\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId
parameter.
\n Required permissions: kms:Sign (key policy)
\n\n Related operations: Verify\n
" } }, "com.amazonaws.kms#SignRequest": { @@ -5079,7 +5079,7 @@ "name": "kms" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .
\nKMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
\nAmazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.
\nWe recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
\nIf you need to use FIPS 140-2 validated cryptographic modules when communicating with\n Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the\n available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
\nClients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.
\n\n Signing Requests\n
\nRequests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.
\nAll KMS operations require Signature Version 4.
\n\n Logging API Requests\n
\nKMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.
\n\n Additional Resources\n
\nFor more information about credentials and request signing, see the following:
\n\n Amazon Web Services\n Security Credentials - This topic provides general information about the types\n of credentials used to access Amazon Web Services.
\n\n Temporary\n Security Credentials - This section of the IAM User Guide\n describes how to create and use temporary security credentials.
\n\n Signature Version\n 4 Signing Process - This set of topics walks you through the process of signing\n a request using an access key ID and a secret access key.
\n\n Commonly Used API Operations\n
\nOf the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.
\n\n Encrypt\n
\n\n Decrypt\n
\n\n GenerateDataKey\n
\nKey Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .
\nKMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
\nAmazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.
\nWe recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
\nIf you need to use FIPS 140-2 validated cryptographic modules when communicating with\n Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the\n available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.
\nAll KMS API calls must be signed and be transmitted using Transport Layer Security (TLS). \n KMS recommends you always use the latest supported TLS version. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.
\n\n Signing Requests\n
\nRequests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.
\nAll KMS operations require Signature Version 4.
\n\n Logging API Requests\n
\nKMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.
\n\n Additional Resources\n
\nFor more information about credentials and request signing, see the following:
\n\n Amazon Web Services\n Security Credentials - This topic provides general information about the types\n of credentials used to access Amazon Web Services.
\n\n Temporary\n Security Credentials - This section of the IAM User Guide\n describes how to create and use temporary security credentials.
\n\n Signature Version\n 4 Signing Process - This set of topics walks you through the process of signing\n a request using an access key ID and a secret access key.
\n\n Commonly Used API Operations\n
\nOf the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.
\n\n Encrypt\n
\n\n Decrypt\n
\n\n GenerateDataKey\n
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis - Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams - Default 100. Max 1,000.
\n\n Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
\n\n Self-Managed Apache Kafka - Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis - Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams - Default 100. Max 10,000.
\n\n Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
\n\n Self-Managed Apache Kafka - Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
\n(Streams only) A list of current response type enums applied to the event source mapping.
" + "smithy.api#documentation": "(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
" } } }, @@ -7110,6 +7134,9 @@ "input": { "target": "com.amazonaws.lambda#RemoveLayerVersionPermissionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.lambda#InvalidParameterValueException" @@ -7177,6 +7204,9 @@ "input": { "target": "com.amazonaws.lambda#RemovePermissionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.lambda#InvalidParameterValueException" @@ -7383,6 +7413,10 @@ "value": "nodejs14.x", "name": "nodejs14x" }, + { + "value": "nodejs16.x", + "name": "nodejs16x" + }, { "value": "java8", "name": "java8" @@ -7789,6 +7823,9 @@ "input": { "target": "com.amazonaws.lambda#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.lambda#InvalidParameterValueException" @@ -8027,6 +8064,9 @@ "input": { "target": "com.amazonaws.lambda#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.lambda#InvalidParameterValueException" @@ -8290,7 +8330,7 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis - Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams - Default 100. Max 1,000.
\n\n Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
\n\n Self-Managed Apache Kafka - Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
\nThe maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).
\n\n Amazon Kinesis - Default 100. Max 10,000.
\n\n Amazon DynamoDB Streams - Default 100. Max 10,000.
\n\n Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
\n\n Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000.
\n\n Self-Managed Apache Kafka - Default 100. Max 10,000.
\n\n Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
\nThe publicly accessible URL of the container service.
\n\nIf no public endpoint is specified in the currentDeployment
, this URL returns\n a 404 response.
An object that describes the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.
\n\nFor more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } } }, "traits": { @@ -2437,6 +2443,40 @@ ] } }, + "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { + "type": "structure", + "members": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that indicates whether the role is activated.
" + } + }, + "principalArn": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role, if it is activated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR)\n private repositories.
\n\nWhen activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } + }, + "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest": { + "type": "structure", + "members": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that indicates whether to activate the role.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a request to activate or deactivate the role that you can use to grant an\n Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.
\n\nWhen activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } + }, "com.amazonaws.lightsail#ContainerServiceEndpoint": { "type": "structure", "members": { @@ -3511,6 +3551,12 @@ "traits": { "smithy.api#documentation": "An object that describes a deployment for the container service.
\n\nA deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.
" } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", + "traits": { + "smithy.api#documentation": "An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.
\n\nFor more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } } } }, @@ -7929,7 +7975,7 @@ "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "A Boolean value indicating whether to include inactive results in your request.
" + "smithy.api#documentation": "A Boolean value that indicates whether to include inactive (unavailable) blueprints in the\n response of your request.
" } }, "pageToken": { @@ -8051,7 +8097,7 @@ "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response.
" + "smithy.api#documentation": "A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.
" } } } @@ -8284,7 +8330,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the list of bundles that are available for purchase. A bundle describes the specs\n for your virtual private server (or instance).
", + "smithy.api#documentation": "Returns the bundles that you can apply to an Amazon Lightsail instance when you create\n it.
\n\nA bundle describes the specifications of an instance, such as the monthly cost, amount of\n memory, the number of vCPUs, amount of storage space, and monthly network data transfer\n quota.
\n\nBundles are referred to as instance plans in the Lightsail\n console.
\nA Boolean value that indicates whether to include inactive bundle results in your\n request.
" + "smithy.api#documentation": "A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.
" } }, "pageToken": { @@ -11245,6 +11291,12 @@ "traits": { "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nTo get a page token, perform an initial GetRelationalDatabaseBundles
request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.
A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.
" + } } } }, @@ -16009,6 +16061,34 @@ ] } }, + "com.amazonaws.lightsail#PrivateRegistryAccess": { + "type": "structure", + "members": { + "ecrImagePullerRole": { + "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole", + "traits": { + "smithy.api#documentation": "An object that describes the activation status of the role that you can use to grant a\n Lightsail container service access to Amazon ECR private\n repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also\n listed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
\n\nFor more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } + }, + "com.amazonaws.lightsail#PrivateRegistryAccessRequest": { + "type": "structure", + "members": { + "ecrImagePullerRole": { + "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest", + "traits": { + "smithy.api#documentation": "An object to describe a request to activate or deactivate the role that you can use to\n grant an Amazon Lightsail container service access to Amazon Elastic Container Registry\n (Amazon ECR) private repositories.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a request to configure an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
\n\nFor more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } + }, "com.amazonaws.lightsail#PutAlarm": { "type": "operation", "input": { @@ -18730,6 +18810,12 @@ "traits": { "smithy.api#documentation": "The public domain names to use with the container service, such as\n example.com
and www.example.com
.
You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.
\n\nIf you don't specify public domain names, then you can use the default domain of the\n container service.
\n\nYou must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate
action to create a\n certificate for the public domain names you want to use with your container service.
You can specify public domain names using a string to array map as shown in the example\n later on this page.
" } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", + "traits": { + "smithy.api#documentation": "An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.
\n\nFor more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.
" + } } } }, diff --git a/aws/sdk/aws-models/logs.json b/aws/sdk/aws-models/logs.json index d29784bab3c..b1c88ea1e07 100644 --- a/aws/sdk/aws-models/logs.json +++ b/aws/sdk/aws-models/logs.json @@ -45,6 +45,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -87,6 +90,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#CancelExportTaskRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" @@ -146,7 +152,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an export task, which allows you to efficiently export data from a\n log group to an Amazon S3 bucket. When you perform a CreateExportTask
\n operation, you must use credentials that have permission to write to the S3 bucket \n that you specify as the destination.
This is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING
or PENDING
) export task at a time.\n To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate out log data for each export task, you can specify a prefix to be used as\n the Amazon S3 key prefix for all exported objects.
\nExporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets \n encrypted with SSE-KMS is not supported.
" + "smithy.api#documentation": "Creates an export task, which allows you to efficiently export data from a\n log group to an Amazon S3 bucket. When you perform a CreateExportTask
\n operation, you must use credentials that have permission to write to the S3 bucket \n that you specify as the destination.
Exporting log data to Amazon S3 buckets that are encrypted by KMS is not \n supported. Exporting\n log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is not supported.
\nExporting to S3 buckets that are encrypted with AES-256 is supported.
\nThis is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING
or PENDING
) export task at a time.\n To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate out log data for each export task, you can specify a prefix to be used as\n the Amazon S3 key prefix for all exported objects.
\n \nTime-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the \n exported log fild data by using Linux utilities.
\nThe end time of the range for the request, expreswatchlogsdocused as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n exported.
", + "smithy.api#documentation": "The end time of the range for the request, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not\n exported.
", "smithy.api#required": {} } }, @@ -216,6 +222,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -266,6 +275,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#CreateLogStreamRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -322,7 +334,7 @@ "type": "integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.
\nTo set a log group to never have log events expire, use\n DeleteRetentionPolicy.\n
" + "smithy.api#documentation": "The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
\nTo set a log group to never have log events expire, use\n DeleteRetentionPolicy.\n
" } }, "com.amazonaws.cloudwatchlogs#DefaultValue": { @@ -336,6 +348,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteDestinationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -371,6 +386,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteLogGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -406,6 +424,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteLogStreamRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -448,6 +469,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteMetricFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -536,6 +560,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteResourcePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -567,6 +594,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -602,6 +632,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -836,7 +869,7 @@ "logGroups": { "target": "com.amazonaws.cloudwatchlogs#LogGroups", "traits": { - "smithy.api#documentation": "The log groups.
\nIf the retentionInDays
value if not included for a log group, then that log group\n is set to have its events never expire.
The log groups.
\nIf the retentionInDays
value is not included for a log group, then that log group\n is set to have its events never expire.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the\n Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
\nYou can use CloudWatch Logs to:
\n\n Monitor logs from EC2 instances in real-time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs and\n send you a notification whenever the rate of errors exceeds a threshold that you specify.\n CloudWatch Logs uses your log data for monitoring so no code changes are required. For\n example, you can monitor application logs for specific literal terms (such as\n \"NullReferenceException\") or count the number of occurrences of a literal term at a\n particular position in log data (such as \"404\" status codes in an Apache access log). When\n the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch\n metric that you specify.
\n\n Monitor CloudTrail logged events: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.
\n\n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events older than this setting are automatically deleted. The CloudWatch Logs\n agent makes it easy to quickly send both rotated and non-rotated log data off of a host\n and into the log service. You can then access the raw log data when you need it.
\nYou can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the\n Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
\nYou can use CloudWatch Logs to:
\n\n Monitor logs from EC2 instances in real-time: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs and\n send you a notification whenever the rate of errors exceeds a threshold that you specify.\n CloudWatch Logs uses your log data for monitoring so no code changes are required. For\n example, you can monitor application logs for specific literal terms (such as\n \"NullReferenceException\") or count the number of occurrences of a literal term at a\n particular position in log data (such as \"404\" status codes in an Apache access log). When\n the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch\n metric that you specify.
\n\n Monitor CloudTrail logged events: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.
\n\n Archive log data: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events older than this setting are automatically deleted. The CloudWatch Logs\n agent makes it easy to quickly send both rotated and non-rotated log data off of a host\n and into the log service. You can then access the raw log data when you need it.
\nMultiple requests to update the same resource were in conflict.
", + "smithy.api#documentation": "Multiple concurrent requests to update the same resource were in conflict.
", "smithy.api#error": "client" } }, @@ -2865,6 +2901,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -3028,6 +3067,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -3206,6 +3248,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#PutRetentionPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -3247,6 +3292,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -4065,6 +4113,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#TagLogGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" @@ -4219,6 +4270,9 @@ "input": { "target": "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" diff --git a/aws/sdk/aws-models/lookoutmetrics.json b/aws/sdk/aws-models/lookoutmetrics.json index adcc54b2102..a644cd40935 100644 --- a/aws/sdk/aws-models/lookoutmetrics.json +++ b/aws/sdk/aws-models/lookoutmetrics.json @@ -728,6 +728,106 @@ "smithy.api#pattern": "^arn:([a-z\\d-]+):.*:.*:.*:.+$" } }, + "com.amazonaws.lookoutmetrics#AthenaDataCatalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.lookoutmetrics#AthenaDatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.lookoutmetrics#AthenaS3ResultsPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9].+$" + } + }, + "com.amazonaws.lookoutmetrics#AthenaSourceConfig": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.lookoutmetrics#Arn", + "traits": { + "smithy.api#documentation": "An IAM role that gives Amazon Lookout for Metrics permission to access the data.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.lookoutmetrics#AthenaDatabaseName", + "traits": { + "smithy.api#documentation": "The database's name.
" + } + }, + "DataCatalog": { + "target": "com.amazonaws.lookoutmetrics#AthenaDataCatalog", + "traits": { + "smithy.api#documentation": "The database's data catalog.
" + } + }, + "TableName": { + "target": "com.amazonaws.lookoutmetrics#AthenaTableName", + "traits": { + "smithy.api#documentation": "The database's table name.
" + } + }, + "WorkGroupName": { + "target": "com.amazonaws.lookoutmetrics#AthenaWorkGroupName", + "traits": { + "smithy.api#documentation": "The database's work group name.
" + } + }, + "S3ResultsPath": { + "target": "com.amazonaws.lookoutmetrics#AthenaS3ResultsPath", + "traits": { + "smithy.api#documentation": "The database's results path.
" + } + }, + "BackTestConfiguration": { + "target": "com.amazonaws.lookoutmetrics#BackTestConfiguration", + "traits": { + "smithy.api#documentation": "Settings for backtest mode.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an Amazon Athena datasource.
" + } + }, + "com.amazonaws.lookoutmetrics#AthenaTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.lookoutmetrics#AthenaWorkGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]{1,128}$" + } + }, "com.amazonaws.lookoutmetrics#AttributeValue": { "type": "structure", "members": { @@ -856,6 +956,21 @@ "type": "structure", "members": {} }, + "com.amazonaws.lookoutmetrics#BackTestConfiguration": { + "type": "structure", + "members": { + "RunBackTestMode": { + "target": "com.amazonaws.lookoutmetrics#Boolean", + "traits": { + "smithy.api#documentation": "Run a backtest instead of monitoring new data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for backtest mode.
" + } + }, "com.amazonaws.lookoutmetrics#BinaryAttributeValue": { "type": "string" }, @@ -3618,30 +3733,36 @@ "AppFlowConfig": { "target": "com.amazonaws.lookoutmetrics#AppFlowConfig", "traits": { - "smithy.api#documentation": "An object containing information about the AppFlow configuration.
" + "smithy.api#documentation": "Details about an AppFlow datasource.
" } }, "CloudWatchConfig": { "target": "com.amazonaws.lookoutmetrics#CloudWatchConfig", "traits": { - "smithy.api#documentation": "An object containing information about the Amazon CloudWatch monitoring configuration.
" + "smithy.api#documentation": "Details about an Amazon CloudWatch monitoring datasource.
" } }, "RDSSourceConfig": { "target": "com.amazonaws.lookoutmetrics#RDSSourceConfig", "traits": { - "smithy.api#documentation": "An object containing information about the Amazon Relational Database Service (RDS) configuration.
" + "smithy.api#documentation": "Details about an Amazon Relational Database Service (RDS) datasource.
" } }, "RedshiftSourceConfig": { "target": "com.amazonaws.lookoutmetrics#RedshiftSourceConfig", "traits": { - "smithy.api#documentation": "An object containing information about the Amazon Redshift database configuration.
" + "smithy.api#documentation": "Details about an Amazon Redshift database datasource.
" + } + }, + "AthenaSourceConfig": { + "target": "com.amazonaws.lookoutmetrics#AthenaSourceConfig", + "traits": { + "smithy.api#documentation": "Details about an Amazon Athena datasource.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about source data used to generate a metric.
" + "smithy.api#documentation": "Contains information about source data used to generate metrics.
" } }, "com.amazonaws.lookoutmetrics#MetricValue": { @@ -4025,6 +4146,12 @@ "smithy.api#documentation": "The ARN of the target SNS topic.
", "smithy.api#required": {} } + }, + "SnsFormat": { + "target": "com.amazonaws.lookoutmetrics#SnsFormat", + "traits": { + "smithy.api#documentation": "The format of the SNS topic.
" + } } }, "traits": { @@ -4154,6 +4281,25 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.lookoutmetrics#SnsFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LONG_TEXT", + "name": "LONG_TEXT" + }, + { + "value": "SHORT_TEXT", + "name": "SHORT_TEXT" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, "com.amazonaws.lookoutmetrics#StringAttributeValue": { "type": "string" }, diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index ff375cb30b3..9c476617857 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -599,6 +599,35 @@ "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF." } }, + "com.amazonaws.mediaconvert#AllowedRenditionSize": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Height to define the video resolution height, in pixels, for this rule.", + "smithy.api#jsonName": "height" + } + }, + "Required": { + "target": "com.amazonaws.mediaconvert#RequiredFlag", + "traits": { + "smithy.api#documentation": "Set to ENABLED to force a rendition to be included.", + "smithy.api#jsonName": "required" + } + }, + "Width": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Width to define the video resolution width, in pixels, for this rule.", + "smithy.api#jsonName": "width" + } + } + }, + "traits": { + "smithy.api#documentation": "Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions." + } + }, "com.amazonaws.mediaconvert#AlphaBehavior": { "type": "string", "traits": { @@ -1345,6 +1374,49 @@ ] } }, + "com.amazonaws.mediaconvert#AutomatedAbrRule": { + "type": "structure", + "members": { + "AllowedRenditions": { + "target": "com.amazonaws.mediaconvert#__listOfAllowedRenditionSize", + "traits": { + "smithy.api#documentation": "When customer adds the allowed renditions rule for auto ABR ladder, they are required to add at leat one rendition to allowedRenditions list", + "smithy.api#jsonName": "allowedRenditions" + } + }, + "ForceIncludeRenditions": { + "target": "com.amazonaws.mediaconvert#__listOfForceIncludeRenditionSize", + "traits": { + "smithy.api#documentation": "When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list", + "smithy.api#jsonName": "forceIncludeRenditions" + } + }, + "MinBottomRenditionSize": { + "target": "com.amazonaws.mediaconvert#MinBottomRenditionSize", + "traits": { + "smithy.api#documentation": "Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size.", + "smithy.api#jsonName": "minBottomRenditionSize" + } + }, + "MinTopRenditionSize": { + "target": "com.amazonaws.mediaconvert#MinTopRenditionSize", + "traits": { + "smithy.api#documentation": "Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution.", + "smithy.api#jsonName": "minTopRenditionSize" + } + }, + "Type": { + "target": "com.amazonaws.mediaconvert#RuleType", + "traits": { + "smithy.api#documentation": "Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify one or more Automated ABR rule types. Note: Force include and Allowed renditions are mutually exclusive." + } + }, "com.amazonaws.mediaconvert#AutomatedAbrSettings": { "type": "structure", "members": { @@ -1368,6 +1440,13 @@ "smithy.api#documentation": "Optional. The minimum target bitrate used in your automated ABR stack. Use this value to set a lower limit on the bitrate of video delivered to viewers with slow internet connections. If you don't specify a value, MediaConvert uses 600,000 (600 kb/s) by default.", "smithy.api#jsonName": "minAbrBitrate" } + }, + "Rules": { + "target": "com.amazonaws.mediaconvert#__listOfAutomatedAbrRule", + "traits": { + "smithy.api#documentation": "Optional. Use Automated ABR rules to specify restrictions for the rendition sizes MediaConvert will create in your ABR stack. You can use these rules if your ABR workflow has specific rendition size requirements, but you still want MediaConvert to optimize for video quality and overall file size.", + "smithy.api#jsonName": "rules" + } } }, "traits": { @@ -1492,7 +1571,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode)." + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode)." } }, "com.amazonaws.mediaconvert#Av1RateControlMode": { @@ -3427,7 +3506,7 @@ "com.amazonaws.mediaconvert#CmfcKlvMetadata": { "type": "string", "traits": { - "smithy.api#documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#documentation": "To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.", "smithy.api#enum": [ { "value": "PASSTHROUGH", @@ -3520,7 +3599,7 @@ "KlvMetadata": { "target": "com.amazonaws.mediaconvert#CmfcKlvMetadata", "traits": { - "smithy.api#documentation": "Applies to CMAF outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#documentation": "To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.", "smithy.api#jsonName": "klvMetadata" } }, @@ -5248,20 +5327,20 @@ "Mapping": { "target": "com.amazonaws.mediaconvert#DolbyVisionMapping", "traits": { - "smithy.api#documentation": "Required when you set Dolby Vision Profile (Profile) to Profile 8.1 (PROFILE_8_1). When you set Content mapping (Mapping) to None (HDR10_NOMAP), content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to Static (HDR10_1000), the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.", + "smithy.api#documentation": "Required when you set Dolby Vision Profile to Profile 8.1. When you set Content mapping to None, content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to HDR10 1000, the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.", "smithy.api#jsonName": "mapping" } }, "Profile": { "target": "com.amazonaws.mediaconvert#DolbyVisionProfile", "traits": { - "smithy.api#documentation": "Required when you use Dolby Vision (DolbyVision) processing. Set Profile (DolbyVisionProfile) to Profile 5 (Profile_5) to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 (Profile_8_1) to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.", + "smithy.api#documentation": "Required when you use Dolby Vision processing. Set Profile to Profile 5 to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.", "smithy.api#jsonName": "profile" } } }, "traits": { - "smithy.api#documentation": "With AWS Elemental MediaConvert, you can create profile 5 Dolby Vision outputs from MXF and IMF sources that contain mastering information as frame-interleaved Dolby Vision metadata." + "smithy.api#documentation": "With AWS Elemental MediaConvert, you can create profile 5 or 8.1 Dolby Vision outputs from MXF and IMF sources." } }, "com.amazonaws.mediaconvert#DolbyVisionLevel6Metadata": { @@ -5309,7 +5388,7 @@ "com.amazonaws.mediaconvert#DolbyVisionMapping": { "type": "string", "traits": { - "smithy.api#documentation": "Required when you set Dolby Vision Profile (Profile) to Profile 8.1 (PROFILE_8_1). When you set Content mapping (Mapping) to None (HDR10_NOMAP), content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to Static (HDR10_1000), the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.", + "smithy.api#documentation": "Required when you set Dolby Vision Profile to Profile 8.1. When you set Content mapping to None, content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to HDR10 1000, the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.", "smithy.api#enum": [ { "value": "HDR10_NOMAP", @@ -5325,7 +5404,7 @@ "com.amazonaws.mediaconvert#DolbyVisionProfile": { "type": "string", "traits": { - "smithy.api#documentation": "Required when you use Dolby Vision (DolbyVision) processing. Set Profile (DolbyVisionProfile) to Profile 5 (Profile_5) to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 (Profile_8_1) to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.", + "smithy.api#documentation": "Required when you use Dolby Vision processing. Set Profile to Profile 5 to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.", "smithy.api#enum": [ { "value": "PROFILE_5", @@ -7062,6 +7141,28 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.mediaconvert#ForceIncludeRenditionSize": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Height to define the video resolution height, in pixels, for this rule.", + "smithy.api#jsonName": "height" + } + }, + "Width": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Width to define the video resolution width, in pixels, for this rule.", + "smithy.api#jsonName": "width" + } + } + }, + "traits": { + "smithy.api#documentation": "Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting." + } + }, "com.amazonaws.mediaconvert#FrameCaptureSettings": { "type": "structure", "members": { @@ -7773,7 +7874,7 @@ } }, "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode)." + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode)." } }, "com.amazonaws.mediaconvert#H264RateControlMode": { @@ -10183,7 +10284,7 @@ "com.amazonaws.mediaconvert#ImscAccessibilitySubs": { "type": "string", "traits": { - "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", + "smithy.api#documentation": "Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#enum": [ { "value": "DISABLED", @@ -10202,7 +10303,7 @@ "Accessibility": { "target": "com.amazonaws.mediaconvert#ImscAccessibilitySubs", "traits": { - "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", + "smithy.api#documentation": "Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#jsonName": "accessibility" } }, @@ -12901,7 +13002,7 @@ "com.amazonaws.mediaconvert#M2tsKlvMetadata": { "type": "string", "traits": { - "smithy.api#documentation": "Applies to MPEG-TS outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#documentation": "To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.", "smithy.api#enum": [ { "value": "PASSTHROUGH", @@ -13166,7 +13267,7 @@ "KlvMetadata": { "target": "com.amazonaws.mediaconvert#M2tsKlvMetadata", "traits": { - "smithy.api#documentation": "Applies to MPEG-TS outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#documentation": "To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and passes it through to the output transport stream. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.", "smithy.api#jsonName": "klvMetadata" } }, @@ -13299,7 +13400,7 @@ "TimedMetadataPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for timed metadata in this output. Default is 502.", + "smithy.api#documentation": "Packet Identifier (PID) of the ID3 metadata stream in the transport stream.", "smithy.api#jsonName": "timedMetadataPid" } }, @@ -13648,6 +13749,50 @@ } ] }, + "com.amazonaws.mediaconvert#MinBottomRenditionSize": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Height to define the video resolution height, in pixels, for this rule.", + "smithy.api#jsonName": "height" + } + }, + "Width": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Width to define the video resolution width, in pixels, for this rule.", + "smithy.api#jsonName": "width" + } + } + }, + "traits": { + "smithy.api#documentation": "Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size." + } + }, + "com.amazonaws.mediaconvert#MinTopRenditionSize": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Height to define the video resolution height, in pixels, for this rule.", + "smithy.api#jsonName": "height" + } + }, + "Width": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "traits": { + "smithy.api#documentation": "Use Width to define the video resolution width, in pixels, for this rule.", + "smithy.api#jsonName": "width" + } + } + }, + "traits": { + "smithy.api#documentation": "Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution." + } + }, "com.amazonaws.mediaconvert#MotionImageInserter": { "type": "structure", "members": { @@ -14134,7 +14279,7 @@ "com.amazonaws.mediaconvert#MpdKlvMetadata": { "type": "string", "traits": { - "smithy.api#documentation": "Applies to DASH ISO outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#documentation": "To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.", "smithy.api#enum": [ { "value": "NONE", @@ -14206,7 +14351,7 @@ "KlvMetadata": { "target": "com.amazonaws.mediaconvert#MpdKlvMetadata", "traits": { - "smithy.api#documentation": "Applies to DASH ISO outputs. Use this setting to specify whether the service inserts the KLV metadata from the input in this output.", + "smithy.api#documentation": "To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.", "smithy.api#jsonName": "klvMetadata" } }, @@ -16601,6 +16746,22 @@ ] } }, + "com.amazonaws.mediaconvert#RequiredFlag": { + "type": "string", + "traits": { + "smithy.api#documentation": "Set to ENABLED to force a rendition to be included.", + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.mediaconvert#ReservationPlan": { "type": "structure", "members": { @@ -16741,6 +16902,30 @@ ] } }, + "com.amazonaws.mediaconvert#RuleType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Use Min top rendition size to specify a minimum size for the highest resolution in your ABR stack. * The highest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 1280x720 the highest resolution in your ABR stack will be equal to or greater than 1280x720. * If you specify a value for Max resolution, the value that you specify for Min top rendition size must be less than, or equal to, Max resolution. Use Min bottom rendition size to specify a minimum size for the lowest resolution in your ABR stack. * The lowest resolution in your ABR stack will be equal to or greater than the value that you enter. For example: If you specify 640x360 the lowest resolution in your ABR stack will be equal to or greater than to 640x360. * If you specify a Min top rendition size rule, the value that you specify for Min bottom rendition size must be less than, or equal to, Min top rendition size. Use Force include renditions to specify one or more resolutions to include your ABR stack. * (Recommended) To optimize automated ABR, specify as few resolutions as possible. * (Required) The number of resolutions that you specify must be equal to, or less than, the Max renditions setting. * If you specify a Min top rendition size rule, specify at least one resolution that is equal to, or greater than, Min top rendition size. * If you specify a Min bottom rendition size rule, only specify resolutions that are equal to, or greater than, Min bottom rendition size. * If you specify a Force include renditions rule, do not specify a separate rule for Allowed renditions. * Note: The ABR stack may include other resolutions that you do not specify here, depending on the Max renditions setting. Use Allowed renditions to specify a list of possible resolutions in your ABR stack. * (Required) The number of resolutions that you specify must be equal to, or greater than, the Max renditions setting. * MediaConvert will create an ABR stack exclusively from the list of resolutions that you specify. * Some resolutions in the Allowed renditions list may not be included, however you can force a resolution to be included by setting Required to ENABLED. * You must specify at least one resolution that is greater than or equal to any resolutions that you specify in Min top rendition size or Min bottom rendition size. * If you specify Allowed renditions, you must not specify a separate rule for Force include renditions.", + "smithy.api#enum": [ + { + "value": "MIN_TOP_RENDITION_SIZE", + "name": "MIN_TOP_RENDITION_SIZE" + }, + { + "value": "MIN_BOTTOM_RENDITION_SIZE", + "name": "MIN_BOTTOM_RENDITION_SIZE" + }, + { + "value": "FORCE_INCLUDE_RENDITIONS", + "name": "FORCE_INCLUDE_RENDITIONS" + }, + { + "value": "ALLOWED_RENDITIONS", + "name": "ALLOWED_RENDITIONS" + } + ] + } + }, "com.amazonaws.mediaconvert#S3DestinationAccessControl": { "type": "structure", "members": { @@ -19004,7 +19189,7 @@ "com.amazonaws.mediaconvert#WebvttAccessibilitySubs": { "type": "string", "traits": { - "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", + "smithy.api#documentation": "Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#enum": [ { "value": "DISABLED", @@ -19023,7 +19208,7 @@ "Accessibility": { "target": "com.amazonaws.mediaconvert#WebvttAccessibilitySubs", "traits": { - "smithy.api#documentation": "Set Accessibility subtitles (Accessibility) to Enabled (ENABLED) if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled (DISABLED), if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", + "smithy.api#documentation": "Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS=\"public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound\" and AUTOSELECT=\"YES\". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.", "smithy.api#jsonName": "accessibility" } }, @@ -20652,12 +20837,24 @@ } } }, + "com.amazonaws.mediaconvert#__listOfAllowedRenditionSize": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#AllowedRenditionSize" + } + }, "com.amazonaws.mediaconvert#__listOfAudioDescription": { "type": "list", "member": { "target": "com.amazonaws.mediaconvert#AudioDescription" } }, + "com.amazonaws.mediaconvert#__listOfAutomatedAbrRule": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#AutomatedAbrRule" + } + }, "com.amazonaws.mediaconvert#__listOfCaptionDescription": { "type": "list", "member": { @@ -20688,6 +20885,12 @@ "target": "com.amazonaws.mediaconvert#Endpoint" } }, + "com.amazonaws.mediaconvert#__listOfForceIncludeRenditionSize": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#ForceIncludeRenditionSize" + } + }, "com.amazonaws.mediaconvert#__listOfHlsAdMarkers": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/networkmanager.json b/aws/sdk/aws-models/networkmanager.json index 8577ac57744..109dd30698d 100644 --- a/aws/sdk/aws-models/networkmanager.json +++ b/aws/sdk/aws-models/networkmanager.json @@ -35,7 +35,8 @@ "smithy.api#length": { "min": 12, "max": 12 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#AWSLocation": { @@ -135,6 +136,41 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.networkmanager#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#AccountStatus": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.networkmanager#AccountId" + }, + "SLRDeploymentStatus": { + "target": "com.amazonaws.networkmanager#SLRDeploymentStatus" + } + } + }, + "com.amazonaws.networkmanager#AccountStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#AccountStatus" + } + }, + "com.amazonaws.networkmanager#Action": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.networkmanager#AssociateConnectPeer": { "type": "operation", "input": { @@ -251,7 +287,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates a customer gateway with a device and optionally, with a link. If you\n specify a link, it must be associated with the specified device.
\nYou can only associate customer gateways that are connected to a VPN attachment on a\n transit gateway. The transit gateway must be registered in your global network. When\n you register a transit gateway, customer gateways that are connected to the transit\n gateway are automatically included in the global network. To list customer gateways\n that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by\n transit-gateway-id
.
You cannot associate a customer gateway with more than one device and link.
", + "smithy.api#documentation": "Associates a customer gateway with a device and optionally, with a link. If you\n specify a link, it must be associated with the specified device.
\nYou can only associate customer gateways that are connected to a VPN attachment on a\n transit gateway or core network registered in your global network. When you register a\n transit gateway or core network, customer gateways that are connected to the transit\n gateway are automatically included in the global network. To list customer gateways\n that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by\n transit-gateway-id
.
You cannot associate a customer gateway with more than one device and link.
", "smithy.api#http": { "method": "POST", "uri": "/global-networks/{GlobalNetworkId}/customer-gateway-associations", @@ -755,7 +791,8 @@ "smithy.api#length": { "min": 0, "max": 256 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#ConflictException": { @@ -1202,7 +1239,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#ConnectionHealth": { @@ -1237,7 +1275,8 @@ "smithy.api#length": { "min": 0, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#ConnectionIdList": { @@ -1311,7 +1350,8 @@ "smithy.api#length": { "min": 0, "max": 256 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#ConstrainedStringList": { @@ -1388,7 +1428,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#CoreNetworkChange": { @@ -1599,7 +1640,14 @@ } }, "com.amazonaws.networkmanager#CoreNetworkPolicyDocument": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } }, "com.amazonaws.networkmanager#CoreNetworkPolicyError": { "type": "structure", @@ -1967,7 +2015,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a core network connect peer for a specified core network connect attachment between a core network and an appliance.\n The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
", + "smithy.api#documentation": "Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.\n The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
", "smithy.api#http": { "method": "POST", "uri": "/connect-peers", @@ -2620,7 +2668,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a site-to-site VPN attachment on an edge location of a core network.
", + "smithy.api#documentation": "Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
", "smithy.api#http": { "method": "POST", "uri": "/site-to-site-vpn-attachments", @@ -2770,7 +2818,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#CustomerGatewayArnList": { @@ -3268,7 +3317,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing global network. You must first delete all global network objects\n (devices, links, and sites) and deregister all transit gateways.
", + "smithy.api#documentation": "Deletes an existing global network. You must first delete all global network objects\n (devices, links, and sites), deregister all transit gateways, and delete any core networks.
", "smithy.api#http": { "method": "DELETE", "uri": "/global-networks/{GlobalNetworkId}", @@ -3738,7 +3787,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#DeviceId": { @@ -3747,7 +3797,8 @@ "smithy.api#length": { "min": 0, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#DeviceIdList": { @@ -4152,7 +4203,8 @@ "smithy.api#length": { "min": 1, "max": 63 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#ExternalRegionCodeList": { @@ -4528,7 +4580,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a core network. By default it returns the LIVE policy.
", + "smithy.api#documentation": "Returns information about the LIVE policy for a core network.
", "smithy.api#http": { "method": "GET", "uri": "/core-networks/{CoreNetworkId}", @@ -6271,7 +6323,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-manged Core Network.
" + "smithy.api#documentation": "Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-managed Core Network.
" } }, "com.amazonaws.networkmanager#GlobalNetworkArn": { @@ -6280,7 +6332,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#GlobalNetworkId": { @@ -6289,7 +6342,8 @@ "smithy.api#length": { "min": 0, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#GlobalNetworkIdList": { @@ -6333,7 +6387,8 @@ "smithy.api#length": { "min": 1, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#Integer": { @@ -6445,7 +6500,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#LinkAssociation": { @@ -6515,7 +6571,8 @@ "smithy.api#length": { "min": 0, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#LinkIdList": { @@ -6894,6 +6951,50 @@ } } }, + "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatusRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatusResponse" + }, + "traits": { + "smithy.api#http": { + "method": "GET", + "uri": "/organizations/service-access", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatusRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatusResponse": { + "type": "structure", + "members": { + "OrganizationStatus": { + "target": "com.amazonaws.networkmanager#OrganizationStatus" + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken" + } + } + }, "com.amazonaws.networkmanager#ListTagsForResource": { "type": "operation", "input": { @@ -7009,7 +7110,7 @@ "name": "networkmanager" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your\n Amazon Web Services and on-premises networks that are built around transit gateways.
", + "smithy.api#documentation": "Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.
", "smithy.api#title": "AWS Network Manager" }, "version": "2019-07-05", @@ -7191,6 +7292,9 @@ { "target": "com.amazonaws.networkmanager#ListCoreNetworks" }, + { + "target": "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatus" + }, { "target": "com.amazonaws.networkmanager#ListTagsForResource" }, @@ -7209,6 +7313,9 @@ { "target": "com.amazonaws.networkmanager#RestoreCoreNetworkPolicyVersion" }, + { + "target": "com.amazonaws.networkmanager#StartOrganizationServiceAccessUpdate" + }, { "target": "com.amazonaws.networkmanager#StartRouteAnalysis" }, @@ -7571,6 +7678,46 @@ "smithy.api#length": { "min": 0, "max": 2048 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.networkmanager#OrganizationAwsServiceAccessStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.networkmanager#OrganizationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^o-([0-9a-f]{8,17})$" + } + }, + "com.amazonaws.networkmanager#OrganizationStatus": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.networkmanager#OrganizationId" + }, + "OrganizationAwsServiceAccessStatus": { + "target": "com.amazonaws.networkmanager#OrganizationAwsServiceAccessStatus" + }, + "SLRDeploymentStatus": { + "target": "com.amazonaws.networkmanager#SLRDeploymentStatus" + }, + "AccountStatusList": { + "target": "com.amazonaws.networkmanager#AccountStatusList", + "traits": { + "smithy.api#xmlName": "OrganizationStatus" + } } } }, @@ -7784,7 +7931,14 @@ "members": {} }, "com.amazonaws.networkmanager#ReasonContextKey": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } }, "com.amazonaws.networkmanager#ReasonContextMap": { "type": "map", @@ -7796,7 +7950,14 @@ } }, "com.amazonaws.networkmanager#ReasonContextValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } }, "com.amazonaws.networkmanager#RegisterTransitGateway": { "type": "operation", @@ -7959,7 +8120,8 @@ "smithy.api#length": { "min": 0, "max": 1500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#ResourceNotFoundException": { @@ -8401,8 +8563,24 @@ "target": "com.amazonaws.networkmanager#RouteType" } }, + "com.amazonaws.networkmanager#SLRDeploymentStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.networkmanager#ServerSideString": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } }, "com.amazonaws.networkmanager#ServiceQuotaExceededException": { "type": "structure", @@ -8509,7 +8687,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#SiteId": { @@ -8518,7 +8697,8 @@ "smithy.api#length": { "min": 0, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#SiteIdList": { @@ -8576,6 +8756,61 @@ "smithy.api#documentation": "Creates a site-to-site VPN attachment.
" } }, + "com.amazonaws.networkmanager#StartOrganizationServiceAccessUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#StartOrganizationServiceAccessUpdateRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#StartOrganizationServiceAccessUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#http": { + "method": "POST", + "uri": "/organizations/service-access", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#StartOrganizationServiceAccessUpdateRequest": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.networkmanager#Action", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#StartOrganizationServiceAccessUpdateResponse": { + "type": "structure", + "members": { + "OrganizationStatus": { + "target": "com.amazonaws.networkmanager#OrganizationStatus" + } + } + }, "com.amazonaws.networkmanager#StartRouteAnalysis": { "type": "operation", "input": { @@ -8670,7 +8905,7 @@ "min": 0, "max": 500 }, - "smithy.api#pattern": "^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$" + "smithy.api#pattern": "^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$|^$" } }, "com.amazonaws.networkmanager#SubnetArnList": { @@ -8682,13 +8917,23 @@ "com.amazonaws.networkmanager#SynthesizedJsonCoreNetworkPolicyDocument": { "type": "string", "traits": { - "smithy.api#mediaType": "application/json" + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#mediaType": "application/json", + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#SynthesizedJsonResourcePolicyDocument": { "type": "string", "traits": { - "smithy.api#mediaType": "application/json" + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#mediaType": "application/json", + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#Tag": { @@ -8712,7 +8957,14 @@ } }, "com.amazonaws.networkmanager#TagKey": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } }, "com.amazonaws.networkmanager#TagKeyList": { "type": "list", @@ -8791,7 +9043,14 @@ "members": {} }, "com.amazonaws.networkmanager#TagValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } }, "com.amazonaws.networkmanager#ThrottlingException": { "type": "structure", @@ -8822,7 +9081,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#TransitGatewayArnList": { @@ -8837,7 +9097,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#TransitGatewayAttachmentId": { @@ -8846,7 +9107,8 @@ "smithy.api#length": { "min": 0, "max": 50 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#TransitGatewayConnectPeerArn": { @@ -8855,7 +9117,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#TransitGatewayConnectPeerArnList": { @@ -9016,7 +9279,8 @@ "smithy.api#length": { "min": 0, "max": 500 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.networkmanager#TunnelProtocol": { diff --git a/aws/sdk/aws-models/outposts.json b/aws/sdk/aws-models/outposts.json index 0ae67eb74d6..5e7878c3d92 100644 --- a/aws/sdk/aws-models/outposts.json +++ b/aws/sdk/aws-models/outposts.json @@ -670,7 +670,7 @@ "SiteId": { "target": "com.amazonaws.outposts#SiteId", "traits": { - "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID of the Outpost.\n
" + "smithy.api#documentation": "\n The ID of the Outpost.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on \n Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware\n assets that allocate resources for Dedicated Hosts. \n
", + "smithy.api#documentation": "\n Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on \n Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware\n assets that allocate resources for Dedicated Hosts. \n
", "smithy.api#http": { "method": "GET", "uri": "/outposts/{OutpostIdentifier}/assets", @@ -3135,7 +3135,7 @@ "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
\n The ID or the Amazon Resource Name (ARN) of the site.\n
", + "smithy.api#documentation": "\n The ID or the Amazon Resource Name (ARN) of the site.\n
\nIn requests, Amazon Web Services Outposts accepts the Amazon Resource Name (ARN) or an ID for Outposts and\n sites throughout the Outposts Query API. To address backwards compatibility, the parameter names\n OutpostID
or SiteID
remain in use. Despite the parameter name, \n you can make the request with an ARN.
Creates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n
\n \n\n Minimum recommendation requests per second\n
\n \nWhen you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second\n (minRecommendationRequestsPerSecond
) specifies the baseline recommendation request throughput provisioned by\n Amazon Personalize. The default minRecommendationRequestsPerSecond is 1
. A recommendation request is a single GetRecommendations
operation.\n Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive\n your requests per hour and the price of your recommender usage.\n
\n If your requests per second increases beyond\n minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minRecommendationRequestsPerSecond
.\n There's a short time delay while the capacity is increased that might cause loss of\n requests.
\n Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)\n or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window.\n \n We recommend starting with the default minRecommendationRequestsPerSecond
, track\n your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
\n as necessary.\n
\n Status\n
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the recommender status, call DescribeRecommender.
\nWait until the status
of the recommender\n is ACTIVE
before asking the recommender for recommendations.
\n Related APIs\n
\n\n ListRecommenders\n
\n\n DescribeRecommender\n
\n\n UpdateRecommender\n
\n\n DeleteRecommender\n
\nCreates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n
\n \n\n Minimum recommendation requests per second\n
\n \nWhen you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second\n (minRecommendationRequestsPerSecond
) specifies the baseline recommendation request throughput provisioned by\n Amazon Personalize. The default minRecommendationRequestsPerSecond is 1
. A recommendation request is a single GetRecommendations
operation.\n Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive\n your requests per hour and the price of your recommender usage.\n
\n If your requests per second increases beyond\n minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minRecommendationRequestsPerSecond
.\n There's a short time delay while the capacity is increased that might cause loss of\n requests.
\n Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)\n or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window.\n \n We recommend starting with the default minRecommendationRequestsPerSecond
, track\n your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond
\n as necessary.\n
\n Status\n
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nSTOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
\nDELETE PENDING > DELETE IN_PROGRESS
\nTo get the recommender status, call DescribeRecommender.
\nWait until the status
of the recommender\n is ACTIVE
before asking the recommender for recommendations.
\n Related APIs\n
\n\n ListRecommenders\n
\n\n DescribeRecommender\n
\n\n UpdateRecommender\n
\n\n DeleteRecommender\n
\nDescribes the given recommender, including its status.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nWhen the status
is CREATE FAILED
, the response includes the\n failureReason
key, which describes why.
For more information on recommenders, see CreateRecommender.
", + "smithy.api#documentation": "Describes the given recommender, including its status.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nSTOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
\nDELETE PENDING > DELETE IN_PROGRESS
\nWhen the status
is CREATE FAILED
, the response includes the\n failureReason
key, which describes why.
The modelMetrics
key is null when\n the recommender is being created or deleted.
For more information on recommenders, see CreateRecommender.
", "smithy.api#idempotent": {} } }, @@ -4269,7 +4272,7 @@ "metrics": { "target": "com.amazonaws.personalize#Metrics", "traits": { - "smithy.api#documentation": "The metrics for the solution version.
" + "smithy.api#documentation": "The metrics for the solution version. For more information, see\n \n Evaluating a solution version with metrics\n .
" } } } @@ -5835,7 +5838,7 @@ "status": { "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "The status of the recommender.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nThe status of the recommender.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nSTOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
\nDELETE PENDING > DELETE IN_PROGRESS
\nProvides a summary of the latest updates to the recommender.
" } + }, + "modelMetrics": { + "target": "com.amazonaws.personalize#Metrics", + "traits": { + "smithy.api#documentation": "Provides evaluation metrics that help you determine the performance\n of a recommender. For more information, see\n \n Evaluating a recommender.
" + } } }, "traits": { @@ -5911,7 +5920,7 @@ "status": { "target": "com.amazonaws.personalize#Status", "traits": { - "smithy.api#documentation": "The status of the recommender. A recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nThe status of the recommender. A recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nSTOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
\nDELETE PENDING > DELETE IN_PROGRESS
\nThe status of the recommender update.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nDELETE PENDING > DELETE IN_PROGRESS
\nThe status of the recommender update.
\nA recommender can be in one of the following states:
\nCREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
\nSTOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
\nDELETE PENDING > DELETE IN_PROGRESS
\nThe main notification email for your Amazon QuickSight subscription.
" } + }, + "PublicSharingEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "A boolean that indicates whether or not public sharing is enabled on an Amazon QuickSight account. For more information about enabling public sharing, see UpdatePublicSharingSettings.
" + } } }, "traits": { @@ -9137,7 +9143,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
\nThe following rules apply to the generated URL:
\nIt contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
\nThe URL validity period should not be confused with the actual session lifetime\n that can be customized using the \n SessionLifetimeInMinutes\n
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
\nYou are charged only when the URL is used or there is interaction with Amazon QuickSight.
\nFor more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
", + "smithy.api#documentation": "Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
\nThe following rules apply to the generated URL:
\nIt contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
\nThe URL validity period should not be confused with the actual session lifetime\n that can be customized using the \n SessionLifetimeInMinutes\n
parameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
\nYou are charged only when the URL is used or there is interaction with Amazon QuickSight.
\nFor more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/embed-url/anonymous-user", @@ -9178,7 +9184,7 @@ "AuthorizedResourceArns": { "target": "com.amazonaws.quicksight#ArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard
embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.
The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard
embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
\nThe following rules apply to the generated URL:
\nIt contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
\nThe URL validity period should not be confused with the actual session lifetime\n that can be customized using the \n SessionLifetimeInMinutes\n
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
\nYou are charged only when the URL is used or there is interaction with Amazon QuickSight.
\nFor more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
", + "smithy.api#documentation": "Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
\nThe following rules apply to the generated URL:
\nIt contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
\nThe URL validity period should not be confused with the actual session lifetime\n that can be customized using the \n SessionLifetimeInMinutes\n
parameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
\nYou are charged only when the URL is used or there is interaction with Amazon QuickSight.
\nFor more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", @@ -10722,6 +10728,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AnalysisSummaryList", "pageSize": "MaxResults" } } @@ -10822,6 +10829,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DashboardVersionSummaryList", "pageSize": "MaxResults" } } @@ -10924,6 +10932,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DashboardSummaryList", "pageSize": "MaxResults" } } @@ -11021,6 +11030,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DataSetSummaries", "pageSize": "MaxResults" } } @@ -11118,6 +11128,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DataSources", "pageSize": "MaxResults" } } @@ -11874,6 +11885,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Ingestions", "pageSize": "MaxResults" } } @@ -11988,6 +12000,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Namespaces", "pageSize": "MaxResults" } } @@ -12156,6 +12169,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TemplateAliasList", "pageSize": "MaxResults" } } @@ -12264,6 +12278,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TemplateVersionSummaryList", "pageSize": "MaxResults" } } @@ -12372,6 +12387,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TemplateSummaryList", "pageSize": "MaxResults" } } @@ -12581,6 +12597,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ThemeVersionSummaryList", "pageSize": "MaxResults" } } @@ -12692,6 +12709,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ThemeSummaryList", "pageSize": "MaxResults" } } @@ -14082,6 +14100,9 @@ { "target": "com.amazonaws.quicksight#UpdateIpRestriction" }, + { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -15037,6 +15058,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AnalysisSummaryList", "pageSize": "MaxResults" } } @@ -15142,6 +15164,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DashboardSummaryList", "pageSize": "MaxResults" } } @@ -18882,6 +18905,80 @@ } } }, + "com.amazonaws.quicksight#UpdatePublicSharingSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + } + ], + "traits": { + "smithy.api#documentation": "Use the UpdatePublicSharingSettings operation to enable or disable the public sharing settings of an Amazon QuickSight dashboard.
\nTo use this operation, enable session capacity pricing on your Amazon QuickSight account.
\nBefore you can enable public sharing on your account, you need to allow public sharing permissions to an administrative user in the IAM console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/public-sharing-settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID associated with your Amazon QuickSight subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PublicSharingEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "A boolean that indicates whether or not public sharing is enabled on a Amazon QuickSight account.
" + } + } + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.quicksight#UpdateResourcePermissionList": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/rekognition.json b/aws/sdk/aws-models/rekognition.json index 5ce8b082068..65cef0d4686 100644 --- a/aws/sdk/aws-models/rekognition.json +++ b/aws/sdk/aws-models/rekognition.json @@ -1039,7 +1039,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion
\n is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n
\n \n \nYou can train a modelin a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData
and TestingData
fields.\n
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.
\nInstead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.
\nTraining takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status
field is TRAINING_COMPLETED
.
If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.
\n \n \nOnce training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n
\n \nAfter evaluating the model, you start the model\n by calling StartProjectVersion.
\nThis operation requires permissions to perform the rekognition:CreateProjectVersion
action.
Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion
\n is an Amazon Resource Name (ARN) for the version of the model.
Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n
\n \n \nYou can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData
and TestingData
fields.\n
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.
\nInstead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.
\nTraining takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status
field is TRAINING_COMPLETED
.
If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.
\n \n \nOnce training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n
\n \nAfter evaluating the model, you start the model\n by calling StartProjectVersion.
\nThis operation requires permissions to perform the rekognition:CreateProjectVersion
action.
This is the API Reference for Amazon Rekognition Image, \n Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored Video, \n Amazon Rekognition Streaming Video.\n It provides descriptions of actions, data types, common parameters,\n and common errors.
\n\n\n Amazon Rekognition Image \n
\n\n\n Amazon Rekognition Custom Labels \n
\n\n Amazon Rekognition Video Stored Video \n
\n\n\n Amazon Rekognition Video Streaming Video \n
\n\nThis is the API Reference for Amazon Rekognition Image, \n Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored Video, \n Amazon Rekognition Streaming Video.\n It provides descriptions of actions, data types, common parameters,\n and common errors.
\n\n\n Amazon Rekognition Image \n
\n\n \n\n\n CompareFaces\n
\n\n CreateCollection\n
\n\n DeleteCollection\n
\n\n DeleteFaces\n
\n\n DescribeCollection\n
\n\n DetectFaces\n
\n\n DetectLabels\n
\n\n DetectText\n
\n\n GetCelebrityInfo\n
\n\n IndexFaces\n
\n\n ListCollections\n
\n\n ListFaces\n
\n\n RecognizeCelebrities\n
\n\n SearchFaces\n
\n\n SearchFacesByImage\n
\n\n Amazon Rekognition Custom Labels \n
\n\n CreateDataset\n
\n\n CreateProject\n
\n\n CreateProjectVersion\n
\n\n DeleteDataset\n
\n\n DeleteProject\n
\n\n DeleteProjectVersion\n
\n\n DescribeDataset\n
\n\n DescribeProjects\n
\n\n DetectCustomLabels\n
\n\n ListDatasetEntries\n
\n\n ListDatasetLabels\n
\n\n StartProjectVersion\n
\n\n StopProjectVersion\n
\n\n UpdateDatasetEntries\n
\n\n Amazon Rekognition Video Stored Video \n
\n\n\n GetContentModeration\n
\n\n GetFaceDetection\n
\n\n GetFaceSearch\n
\n\n GetLabelDetection\n
\n\n GetPersonTracking\n
\n\n GetSegmentDetection\n
\n\n GetTextDetection\n
\n\n StartFaceDetection\n
\n\n StartFaceSearch\n
\n\n StartLabelDetection\n
\n\n StartPersonTracking\n
\n\n StartTextDetection\n
\n\n Amazon Rekognition Video Streaming Video \n
\n\n\n ListStreamProcessors\n
\n\n StartStreamProcessor\n
\n\n StopStreamProcessor\n
\nThe Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" } + }, + "assessmentSchedule": { + "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", + "traits": { + "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + } } }, "traits": { @@ -272,7 +290,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. \nEach tag consists of a key/value pair.
" } + }, + "resourceErrorsDetails": { + "target": "com.amazonaws.resiliencehub#ResourceErrorsDetails", + "traits": { + "smithy.api#documentation": "\n A resource error object containing a list of errors retrieving an application's resources.\n
" + } } }, "traits": { "smithy.api#documentation": "Defines an application assessment.
" } }, + "com.amazonaws.resiliencehub#AppAssessmentScheduleType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Disabled", + "name": "DISABLED" + }, + { + "value": "Daily", + "name": "DAILY" + } + ] + } + }, "com.amazonaws.resiliencehub#AppAssessmentSummary": { "type": "structure", "members": { "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The current resiliency score for the application.
" } + }, + "assessmentSchedule": { + "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", + "traits": { + "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + } } }, "traits": { @@ -623,7 +668,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 5000 + "max": 51200 }, "smithy.api#pattern": "^[\\w\\s:,-\\.'{}\\[\\]:\"]+$" } @@ -733,7 +778,6 @@ "sdkId": "resiliencehub", "arnNamespace": "resiliencehub", "cloudFormationName": "Resiliencehub", - "cloudTrailEventSource": "resiliencehub.amazonaws.com", "endpointPrefix": "resiliencehub" }, "aws.auth#sigv4": { @@ -1181,7 +1225,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. \nYou should not reuse the same client token for other API requests.
", "smithy.api#idempotencyToken": {} } + }, + "assessmentSchedule": { + "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", + "traits": { + "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + } } } }, @@ -1272,7 +1322,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Names (ARNs) for the resources that you want to import.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Names (ARNs) for the resources that you want to import.
" + } + }, + "terraformSources": { + "target": "com.amazonaws.resiliencehub#TerraformSourceList", + "traits": { + "smithy.api#documentation": "\n A list of terraform file s3 URLs you need to import.\n
" } } } @@ -2460,7 +2524,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Names (ARNs) for the resources that you imported.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Names (ARNs) for the resources that you imported.
" } }, "status": { @@ -2484,6 +2547,12 @@ "smithy.api#documentation": "The status of the action.
", "smithy.api#required": {} } + }, + "terraformSources": { + "target": "com.amazonaws.resiliencehub#TerraformSourceList", + "traits": { + "smithy.api#documentation": "\n A list of terraform file s3 URLs you need to import.\n
" + } } } }, @@ -2534,7 +2603,8 @@ }, "smithy.api#paginated": { "inputToken": "nextToken", - "outputToken": "nextToken" + "outputToken": "nextToken", + "maxResults": "maxResults" } } }, @@ -2544,7 +2614,7 @@ "assessmentArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The name of the resource group that this resource belongs to.
" } + }, + "terraformSourceName": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "\n The name of the Terraform S3 state file this resource belongs to. \n
" + } } }, "traits": { @@ -3989,7 +4078,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:dcps:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app-assessment/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The names of the resource groups to remove from the resource mappings.
" } + }, + "terraformSourceNames": { + "target": "com.amazonaws.resiliencehub#String255List", + "traits": { + "smithy.api#documentation": "\n \n
" + } } } }, @@ -4421,7 +4516,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
\n This is the identifier of the resource.\n
" + } + }, + "physicalResourceId": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "\n This is the identifier of the physical resource.\n
" + } + }, + "reason": { + "target": "com.amazonaws.resiliencehub#ErrorMessage", + "traits": { + "smithy.api#documentation": "\n This is the error message.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Defines application resource errors.\n
" + } + }, + "com.amazonaws.resiliencehub#ResourceErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ResourceError" + } + }, + "com.amazonaws.resiliencehub#ResourceErrorsDetails": { + "type": "structure", + "members": { + "resourceErrors": { + "target": "com.amazonaws.resiliencehub#ResourceErrorList", + "traits": { + "smithy.api#documentation": "\n A list of errors retrieving an application's resources.\n
" + } + }, + "hasMoreErrors": { + "target": "com.amazonaws.resiliencehub#BooleanOptional", + "traits": { + "smithy.api#documentation": "\n This indicates if there are more errors not listed in the resourceErrors list.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A list of errors retrieving an application's resources.\n
" + } + }, "com.amazonaws.resiliencehub#ResourceId": { "type": "string", "traits": { @@ -4680,20 +4827,20 @@ "traits": { "smithy.api#enum": [ { - "value": "Pending", - "name": "PENDING" + "name": "PENDING", + "value": "Pending" }, { - "value": "InProgress", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "InProgress" }, { - "value": "Failed", - "name": "FAILED" + "name": "FAILED", + "value": "Failed" }, { - "value": "Success", - "name": "SUCCESS" + "name": "SUCCESS", + "value": "Success" } ] } @@ -4738,6 +4885,12 @@ "smithy.api#documentation": "The identifier of this resource.
", "smithy.api#required": {} } + }, + "terraformSourceName": { + "target": "com.amazonaws.resiliencehub#String255", + "traits": { + "smithy.api#documentation": "\n The short name of the Terraform source.\n
" + } } }, "traits": { @@ -4769,6 +4922,10 @@ { "value": "ResourceGroup", "name": "RESOURCE_GROUP" + }, + { + "value": "Terraform", + "name": "TERRAFORM" } ] } @@ -4853,6 +5010,15 @@ "smithy.api#documentation": "The location of the Amazon S3 bucket.
" } }, + "com.amazonaws.resiliencehub#S3Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2000 + }, + "smithy.api#pattern": "^((https://([^/]+)\\.s3((-|\\.)[^/]+)?\\.amazonaws\\.com(.cn)?)|(s3://([^/]+)))/\\S{1,2000}$" + } + }, "com.amazonaws.resiliencehub#Seconds": { "type": "integer", "traits": { @@ -5005,7 +5171,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
\n The Terraform s3 state file you need to import.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The Terraform s3 state file you need to import.\n
" + } + }, + "com.amazonaws.resiliencehub#TerraformSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#TerraformSource" + } + }, "com.amazonaws.resiliencehub#TestRecommendation": { "type": "structure", "members": { @@ -5264,6 +5452,12 @@ "traits": { "smithy.api#documentation": "The prerequisite of the test recommendation.
" } + }, + "dependsOnAlarms": { + "target": "com.amazonaws.resiliencehub#AlarmReferenceIdList", + "traits": { + "smithy.api#documentation": "\n A list of recommended alarms that are used in the test and must be exported before or with the test.\n
" + } } }, "traits": { @@ -5477,7 +5671,7 @@ "appArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:dcps:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the application. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
Specifies if the resiliency policy ARN should be cleared.
" } + }, + "assessmentSchedule": { + "target": "com.amazonaws.resiliencehub#AppAssessmentScheduleType", + "traits": { + "smithy.api#documentation": "\n Assessment execution schedule with 'Daily' or 'Disabled' values.\n
" + } } } }, @@ -5556,7 +5756,7 @@ "policyArn": { "target": "com.amazonaws.resiliencehub#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:dcps:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: \narn:partition
:resiliencehub:region
:account
:resiliency-policy/policy-id
. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n AWS General Reference.
The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag]
and registry/repository[@digest]
\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. \n SageMaker supports both registry/repository[:tag]
and registry/repository[@digest]
\n image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.
You must specify either the algorithm name to the AlgorithmName
parameter \n or the image URI of the algorithm container \n to the TrainingImage
parameter.
For more information, see the note in the AlgorithmName
parameter description.
The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for\n this parameter, you can't specify a value for TrainingImage
.
The name of the algorithm resource to use for the training job. This must be an\n algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.
\nYou must specify either the algorithm name to the AlgorithmName
parameter \n or the image URI of the algorithm container \n to the TrainingImage
parameter.
Note that the AlgorithmName
parameter is mutually exclusive \n with the TrainingImage
parameter. \n If you specify a value for the AlgorithmName
parameter,\n you can't specify a value for TrainingImage
, and vice versa.
If you specify values for both parameters, the training job might break; if you don't specify\n any value for both parameters, the training job might raise a null
error.
Information about a candidate produced by an AutoML training job, including its status,\n steps, and other properties.
" } }, + "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig": { + "type": "structure", + "members": { + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input data source to\n run an Autopilot job (optional). This file should be in json format as shown below:
\n\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }
.
The key name FeatureAttributeNames
is fixed. The values listed in\n [\"col1\", \"col2\", ...]
is case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
Stores the config information for how a candidate is generated (optional).
" + } + }, "com.amazonaws.sagemaker#AutoMLCandidateStep": { "type": "structure", "members": { @@ -1909,12 +1955,12 @@ "ChannelType": { "target": "com.amazonaws.sagemaker#AutoMLChannelType", "traits": { - "smithy.api#documentation": "The channel type (optional) is an enum string. The default value is\n training
. Channels for training and validation must share the same\n ContentType
and TargetAttributeName
.
The channel type (optional) is an enum
string. The default value is\n training
. Channels for training and validation must share the same\n ContentType
and TargetAttributeName
. For information on\n specifying training and validation channel types, see \n How to specify training and validation datasets
\n .
A channel is a named input source that training algorithms can consume. The\n validation dataset size is limited to less than 2 GB. The training dataset size must be\n less than 100 GB. For more information, see .
\nA validation dataset must contain the same headers as the training dataset.
\nA channel is a named input source that training algorithms can consume. The validation\n dataset size is limited to less than 2 GB. The training dataset size must be less than 100\n GB. For more information, see .
\nA validation dataset must contain the same headers as the training dataset.
\nThe validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values can range from 0 to\n 1. We recommend setting this value to be less than 0.5.
" + "smithy.api#documentation": "The validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values must be greater\n than 0 and less than 1. We recommend setting this value to be less than 0.5.
" } } }, @@ -2018,7 +2064,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 20 + "max": 2 } } }, @@ -2098,6 +2144,12 @@ "traits": { "smithy.api#documentation": "The configuration for splitting the input training dataset.
\nType: AutoMLDataSplitConfig
" } + }, + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#AutoMLCandidateGenerationConfig", + "traits": { + "smithy.api#documentation": "The configuration for generating a candidate for an AutoML job (optional).
" + } } }, "traits": { @@ -3102,18 +3154,18 @@ "CsvContentTypes": { "target": "com.amazonaws.sagemaker#CsvContentTypes", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The list of all content type headers that SageMaker will treat as CSV and capture accordingly.
" } }, "JsonContentTypes": { "target": "com.amazonaws.sagemaker#JsonContentTypes", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The list of all content type headers that SageMaker will treat as JSON and capture accordingly.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified SageMaker \n will by default base64 encode when capturing the data.
" } }, "com.amazonaws.sagemaker#CaptureMode": { @@ -3137,13 +3189,13 @@ "CaptureMode": { "target": "com.amazonaws.sagemaker#CaptureMode", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "Specify the boundary of data to capture.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Specifies data Model Monitor will capture.
" } }, "com.amazonaws.sagemaker#CaptureOptionList": { @@ -4747,7 +4799,7 @@ "InputDataConfig": { "target": "com.amazonaws.sagemaker#AutoMLInputDataConfig", "traits": { - "smithy.api#documentation": "An array of channel objects that describes the input data and its location. Each channel\n is a named input source. Similar to InputDataConfig
supported by . Format(s) supported: CSV. Minimum\n of 500 rows.
An array of channel objects that describes the input data and its location. Each channel\n is a named input source. Similar to InputDataConfig
supported by . Format(s) supported: CSV, Parquet.\n A minimum of 500 rows is required for the training dataset. There is not a minimum number\n of rows required for the validation dataset.
Defines the type of supervised learning available for the candidates. Options include:\n BinaryClassification
, MulticlassClassification
, and\n Regression
. For more information, see \n Amazon SageMaker Autopilot problem types and algorithm support.
Defines the type of supervised learning available for the candidates. For more\n information, see \n Amazon SageMaker Autopilot problem types and algorithm support.
" } }, "AutoMLJobObjective": { @@ -4773,7 +4825,7 @@ "AutoMLJobConfig": { "target": "com.amazonaws.sagemaker#AutoMLJobConfig", "traits": { - "smithy.api#documentation": "Contains CompletionCriteria
and SecurityConfig
settings for\n the AutoML job.
A collection of settings used to configure an AutoML job.
" } }, "RoleArn": { @@ -6639,7 +6691,7 @@ "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine \n learning tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine \n learning tasks include object detection and image classification. The following \n tasks are supported by Inference Recommender: \n \"IMAGE_CLASSIFICATION\"
| \"OBJECT_DETECTION\"
| \"TEXT_GENERATION\"
|\"IMAGE_SEGMENTATION\"
| \n \"FILL_MASK\"
| \"CLASSIFICATION\"
| \"REGRESSION\"
| \"OTHER\"
.
Specify \"OTHER\" if none of the tasks listed fit your use case.
" } }, "SamplePayloadUrl": { @@ -6935,6 +6987,12 @@ "traits": { "smithy.api#documentation": "The platform identifier of the notebook instance runtime environment.
" } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "Information on the IMDS configuration of the notebook instance
" + } } } }, @@ -7615,7 +7673,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.
\nTo perform batch transformations, you create a transform job and use the data that you\n have readily available.
\nIn the request body, you provide the following:
\n\n TransformJobName
- Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.
\n ModelName
- Identifies the model to use. ModelName
\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n account. For information on creating a model, see CreateModel.
\n TransformInput
- Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.
\n TransformOutput
- Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.
\n TransformResources
- Identifies the ML compute instances for the\n transform job.
For more information about how batch transformation works, see Batch\n Transform.
" + "smithy.api#documentation": "Starts a transform job. A transform job uses a trained model to get inferences on a\n dataset and saves these results to an Amazon S3 location that you specify.
\nTo perform batch transformations, you create a transform job and use the data that you\n have readily available.
\nIn the request body, you provide the following:
\n\n TransformJobName
- Identifies the transform job. The name must be\n unique within an Amazon Web Services Region in an Amazon Web Services account.
\n ModelName
- Identifies the model to use. ModelName
\n must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services\n\t\t account. For information on creating a model, see CreateModel.
\n TransformInput
- Describes the dataset to be transformed and the\n Amazon S3 location where it is stored.
\n TransformOutput
- Identifies the Amazon S3 location where you want\n Amazon SageMaker to save the results from the transform job.
\n TransformResources
- Identifies the ML compute instances for the\n transform job.
For more information about how batch transformation works, see Batch\n Transform.
" } }, "com.amazonaws.sagemaker#CreateTransformJobRequest": { @@ -8190,45 +8248,45 @@ "EnableCapture": { "target": "com.amazonaws.sagemaker#EnableCapture", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Whether data capture should be enabled or disabled (defaults to enabled).
" } }, "InitialSamplingPercentage": { "target": "com.amazonaws.sagemaker#SamplingPercentage", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "The percentage of requests SageMaker will capture. A lower value is recommended for \n Endpoints with high traffic.
", "smithy.api#required": {} } }, "DestinationS3Uri": { "target": "com.amazonaws.sagemaker#DestinationS3Uri", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "The Amazon S3 location used to capture the data.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.
\nThe KmsKeyId can be any of the following formats:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
\n
Specifies data Model Monitor will capture. You can configure whether to \n collect only input, only output, or both
", "smithy.api#required": {} } }, "CaptureContentTypeHeader": { "target": "com.amazonaws.sagemaker#CaptureContentTypeHeader", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Configuration specifying how to treat different headers. If no headers are specified SageMaker will \n by default base64 encode when capturing the data.
" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Configuration to control how SageMaker captures inference data.
" } }, "com.amazonaws.sagemaker#DataCaptureConfigSummary": { @@ -8237,41 +8295,41 @@ "EnableCapture": { "target": "com.amazonaws.sagemaker#EnableCapture", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "Whether data capture is enabled or disabled.
", "smithy.api#required": {} } }, "CaptureStatus": { "target": "com.amazonaws.sagemaker#CaptureStatus", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "Whether data capture is currently functional.
", "smithy.api#required": {} } }, "CurrentSamplingPercentage": { "target": "com.amazonaws.sagemaker#SamplingPercentage", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "The percentage of requests being captured by your Endpoint.
", "smithy.api#required": {} } }, "DestinationS3Uri": { "target": "com.amazonaws.sagemaker#DestinationS3Uri", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "The Amazon S3 location being used to capture the data.
", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "", + "smithy.api#documentation": "The KMS key being used to encrypt the data in Amazon S3.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The currently active data capture configuration used by your Endpoint.
" } }, "com.amazonaws.sagemaker#DataCatalogConfig": { @@ -14038,6 +14096,12 @@ "traits": { "smithy.api#documentation": "The platform identifier of the notebook instance runtime environment.
" } + }, + "InstanceMetadataServiceConfiguration": { + "target": "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration", + "traits": { + "smithy.api#documentation": "Information on the IMDS configuration of the notebook instance
" + } } } }, @@ -20394,6 +20458,21 @@ } } }, + "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration": { + "type": "structure", + "members": { + "MinimumInstanceMetadataServiceVersion": { + "target": "com.amazonaws.sagemaker#MinimumInstanceMetadataServiceVersion", + "traits": { + "smithy.api#documentation": "Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance
, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance
, there is no default.
Information on the IMDS configuration of the notebook instance
" + } + }, "com.amazonaws.sagemaker#InstanceType": { "type": "string", "traits": { @@ -27166,7 +27245,7 @@ "StandardMetricName": { "target": "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum", "traits": { - "smithy.api#documentation": "The name of the standard metric.
" + "smithy.api#documentation": "The name of the standard metric.
\nFor definitions of the standard metrics, see \n Autopilot candidate metrics
\n .
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId
can be any of the following\n formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
\n
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n
\nThe KMS key policy must grant permission to the IAM role that you specify in your\n CreateModel request. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId
can be any of the following\n formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Alias name: alias/ExampleAlias
\n
Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
\n
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your\n role's account. For more information, see KMS-Managed Encryption Keys in the\n Amazon Simple Storage Service\n Developer Guide.\n
\nThe KMS key policy must grant permission to the IAM role that you specify in your\n\tCreateModel\n\t\trequest. For more information, see Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.
" } } }, @@ -41433,6 +41522,12 @@ "traits": { "smithy.api#documentation": "Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled
.
If you set this to Disabled
, users don't have root access on the\n notebook instance, but lifecycle configuration scripts still run with root\n permissions.
Information on the IMDS configuration of the notebook instance
" + } } } }, diff --git a/aws/sdk/aws-models/secretsmanager.json b/aws/sdk/aws-models/secretsmanager.json index 1fd9745d41d..c9bdd76b9d9 100644 --- a/aws/sdk/aws-models/secretsmanager.json +++ b/aws/sdk/aws-models/secretsmanager.json @@ -1342,7 +1342,7 @@ "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
" + "smithy.api#documentation": "Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
" } } } diff --git a/aws/sdk/aws-models/servicecatalog.json b/aws/sdk/aws-models/servicecatalog.json index 3eee5f9c081..5eb2424df33 100644 --- a/aws/sdk/aws-models/servicecatalog.json +++ b/aws/sdk/aws-models/servicecatalog.json @@ -4303,7 +4303,7 @@ "Name": { "target": "com.amazonaws.servicecatalog#PortfolioName", "traits": { - "smithy.api#documentation": "The name of the portfolio to which the user was assigned.
" + "smithy.api#documentation": "The name of the portfolio that contains the product.
" } } }, @@ -4346,7 +4346,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all portfolios for which sharing was accepted by this account.
", + "smithy.api#documentation": "Lists all imported portfolios for which account-to-account shares were accepted by\n this account. By specifying the PortfolioShareType
, you can list portfolios for which\n organizational shares were accepted by this account.
The type of shared portfolios to list. The default is to list imported portfolios.
\n\n AWS_ORGANIZATIONS
- List portfolios shared by the management\n account of your organization
\n AWS_SERVICECATALOG
- List default portfolios
\n IMPORTED
- List imported portfolios
The type of shared portfolios to list. The default is to list imported portfolios.
\n\n AWS_ORGANIZATIONS
- List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization.
\n AWS_SERVICECATALOG
- Deprecated type.
\n IMPORTED
- List imported portfolios that have been accepted and\n shared through account-to-account sharing.
The Amazon SNS targets that Chatbot uses to notify the chat channel\n of updates to an incident. You can also make updates to the incident through the chat\n channel\n by\n using the Amazon SNS topics.
" + "smithy.api#documentation": "The Amazon SNS targets that Chatbot uses to notify the chat channel\n of updates to an incident. You can also make updates to the incident through the chat\n channel by using the Amazon SNS topics.
" } } }, @@ -501,7 +501,7 @@ "eventData": { "target": "com.amazonaws.ssmincidents#EventData", "traits": { - "smithy.api#documentation": "A short description of the event as a valid JSON string. There is no other schema\n imposed.
", + "smithy.api#documentation": "A short description of the event.
", "smithy.api#required": {} } } @@ -832,6 +832,44 @@ "type": "structure", "members": {} }, + "com.amazonaws.ssmincidents#DynamicSsmParameterValue": { + "type": "union", + "members": { + "variable": { + "target": "com.amazonaws.ssmincidents#VariableType", + "traits": { + "smithy.api#documentation": "Variable dynamic parameters. A parameter value is determined when an incident is created.
", + "smithy.api#tags": [ + "logs_investigations" + ] + } + } + }, + "traits": { + "smithy.api#documentation": "The dynamic SSM parameter value.
" + } + }, + "com.amazonaws.ssmincidents#DynamicSsmParameters": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "value": { + "target": "com.amazonaws.ssmincidents#DynamicSsmParameterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.ssmincidents#EmptyChatChannel": { "type": "structure", "members": {}, @@ -939,7 +977,7 @@ "condition": { "target": "com.amazonaws.ssmincidents#Condition", "traits": { - "smithy.api#documentation": "The condition accepts before or after a specified time, equal to a string, or equal to an integer.
", + "smithy.api#documentation": "The condition accepts before or after a specified time, equal to a string, or equal to\n an integer.
", "smithy.api#required": {} } } @@ -1525,7 +1563,7 @@ "dedupeString": { "target": "com.amazonaws.ssmincidents#DedupeString", "traits": { - "smithy.api#documentation": "The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
", + "smithy.api#documentation": "The string Incident Manager uses to prevent duplicate incidents from being created by the\n same incident in the same account.
", "smithy.api#required": {} } }, @@ -1562,7 +1600,7 @@ "invokedBy": { "target": "com.amazonaws.ssmincidents#ServicePrincipal", "traits": { - "smithy.api#documentation": "The principal the assumed the role specified of the createdBy
.
The service principal that assumed the role specified in createdBy
. If no\n service principal assumed the role this will be left blank.
Used to stop Incident Manager from creating multiple incident records for the same incident.
", + "smithy.api#documentation": "Used to stop Incident Manager from creating multiple incident records for the same incident.\n
", "smithy.api#tags": [ "logs_investigations" ] @@ -1730,7 +1768,7 @@ } }, "traits": { - "smithy.api#documentation": "Basic details used in creating a response plan. The response plan is then used to create an incident record.
" + "smithy.api#documentation": "Basic details used in creating a response plan. The response plan is then used to create\n an incident record.
" } }, "com.amazonaws.ssmincidents#IncidentTitle": { @@ -1786,7 +1824,7 @@ "type": { "target": "com.amazonaws.ssmincidents#ItemType", "traits": { - "smithy.api#documentation": "The type of related item. Incident Manager supports the following types:
\n\n ANALYSIS
\n
\n INCIDENT
\n
\n METRIC
\n
\n PARENT
\n
\n ATTACHMENT
\n
\n OTHER
\n
The type of related item.
", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" @@ -1829,6 +1867,10 @@ { "value": "AUTOMATION", "name": "AUTOMATION" + }, + { + "value": "INVOLVED_RESOURCE", + "name": "INVOLVED_RESOURCE" } ] } @@ -2467,7 +2509,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a resource policy to the specified response plan.
", + "smithy.api#documentation": "Adds a resource policy to the specified response plan. The resource policy is used to\n share the response plan using Resource Access Manager (RAM). For more\n information about cross-account sharing, see Setting up\n cross-account functionality.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2842,7 +2884,7 @@ } }, "traits": { - "smithy.api#documentation": "The resource policy that allows Incident Manager to perform actions on resources on your behalf.
" + "smithy.api#documentation": "The resource policy that allows Incident Manager to perform actions on resources on your\n behalf.
" } }, "com.amazonaws.ssmincidents#ResourcePolicyList": { @@ -3168,7 +3210,7 @@ "roleArn": { "target": "com.amazonaws.ssmincidents#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that the automation document will assume when\n running commands.
", "smithy.api#required": {}, "smithy.api#tags": [ "logs_investigations" @@ -3201,7 +3243,7 @@ "targetAccount": { "target": "com.amazonaws.ssmincidents#SsmTargetAccount", "traits": { - "smithy.api#documentation": "The account that the automation document will be run in. This can be in either the management account or an application account.
", + "smithy.api#documentation": "The account that the automation document will be run in. This can be in either the\n management account or an application account.
", "smithy.api#tags": [ "logs_investigations" ] @@ -3212,6 +3254,12 @@ "traits": { "smithy.api#documentation": "The key-value pair parameters to use when running the automation document.
" } + }, + "dynamicParameters": { + "target": "com.amazonaws.ssmincidents#DynamicSsmParameters", + "traits": { + "smithy.api#documentation": "The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
" + } } }, "traits": { @@ -3224,7 +3272,7 @@ "smithy.api#length": { "max": 2048 }, - "smithy.api#pattern": "^arn:[-\\w+=/,.@]+:ssm-contacts:[-\\w+=/,.@]*:[0-9]+:([\\w+=/,.@:-]+)*$" + "smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:ssm-contacts:[a-z0-9-]*:([0-9]{12}):contact/[a-z0-9_-]+$" } }, "com.amazonaws.ssmincidents#SsmParameterValues": { @@ -4009,6 +4057,9 @@ { "target": "com.amazonaws.ssmincidents#AccessDeniedException" }, + { + "target": "com.amazonaws.ssmincidents#ConflictException" + }, { "target": "com.amazonaws.ssmincidents#InternalServerException" }, @@ -4339,6 +4390,21 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.ssmincidents#VariableType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INCIDENT_RECORD_ARN", + "name": "INCIDENT_RECORD_ARN" + }, + { + "value": "INVOLVED_RESOURCES", + "name": "INVOLVED_RESOURCES" + } + ] + } } } } diff --git a/aws/sdk/aws-models/sts.json b/aws/sdk/aws-models/sts.json index a1cb802e727..8436979b512 100644 --- a/aws/sdk/aws-models/sts.json +++ b/aws/sdk/aws-models/sts.json @@ -800,7 +800,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The\n credentials consist of an access key ID, a secret access key, and a security token.\n Typically, you use GetSessionToken
if you want to use MFA to protect\n programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances
.\n MFA-enabled IAM users would need to call GetSessionToken
and submit an MFA\n code that is associated with their MFA device. Using the temporary security credentials\n that are returned from the call, IAM users can then make programmatic calls to API\n operations that require MFA authentication. If you do not supply a correct MFA code, then\n the API returns an access denied error. For a comparison of GetSessionToken
\n with the other API operations that produce temporary credentials, see Requesting\n Temporary Security Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
\n Session Duration\n
\nThe GetSessionToken
operation must be called by using the long-term Amazon Web Services\n security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are\n created by IAM users are valid for the duration that you specify. This duration can range\n from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default\n of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900\n seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
\n Permissions\n
\nThe temporary security credentials created by GetSessionToken
can be used\n to make API calls to any Amazon Web Services service with the following exceptions:
You cannot call any IAM API operations unless MFA authentication information is\n included in the request.
\nYou cannot call any STS API except\n AssumeRole
or GetCallerIdentity
.
We recommend that you do not call GetSessionToken
with Amazon Web Services account\n root user credentials. Instead, follow our best practices by\n creating one or more IAM users, giving them the necessary permissions, and using IAM\n users for everyday interaction with Amazon Web Services.
The credentials that are returned by GetSessionToken
are based on\n permissions associated with the user whose credentials were used to call the operation. If\n GetSessionToken
is called using Amazon Web Services account root user credentials, the\n temporary credentials have root user permissions. Similarly, if\n GetSessionToken
is called using the credentials of an IAM user, the\n temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken
to create temporary\n credentials, go to Temporary\n Credentials for Users in Untrusted Environments in the\n IAM User Guide.
Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The\n credentials consist of an access key ID, a secret access key, and a security token.\n Typically, you use GetSessionToken
if you want to use MFA to protect\n programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances
.\n MFA-enabled IAM users would need to call GetSessionToken
and submit an MFA\n code that is associated with their MFA device. Using the temporary security credentials\n that are returned from the call, IAM users can then make programmatic calls to API\n operations that require MFA authentication. If you do not supply a correct MFA code, then\n the API returns an access denied error. For a comparison of GetSessionToken
\n with the other API operations that produce temporary credentials, see Requesting\n Temporary Security Credentials and Comparing the\n Amazon Web Services STS API operations in the IAM User Guide.
No permissions are required for users to perform this operation. The purpose of the\n sts:GetSessionToken
operation is to authenticate the user using MFA. You\n cannot use policies to control authentication operations. For more information, see\n Permissions for GetSessionToken in the\n IAM User Guide.
\n Session Duration\n
\nThe GetSessionToken
operation must be called by using the long-term Amazon Web Services\n security credentials of the Amazon Web Services account root user or an IAM user. Credentials that are\n created by IAM users are valid for the duration that you specify. This duration can range\n from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default\n of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900\n seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
\n Permissions\n
\nThe temporary security credentials created by GetSessionToken
can be used\n to make API calls to any Amazon Web Services service with the following exceptions:
You cannot call any IAM API operations unless MFA authentication information is\n included in the request.
\nYou cannot call any STS API except\n AssumeRole
or GetCallerIdentity
.
We recommend that you do not call GetSessionToken
with Amazon Web Services account\n root user credentials. Instead, follow our best practices by\n creating one or more IAM users, giving them the necessary permissions, and using IAM\n users for everyday interaction with Amazon Web Services.
The credentials that are returned by GetSessionToken
are based on\n permissions associated with the user whose credentials were used to call the operation. If\n GetSessionToken
is called using Amazon Web Services account root user credentials, the\n temporary credentials have root user permissions. Similarly, if\n GetSessionToken
is called using the credentials of an IAM user, the\n temporary credentials have the same permissions as the IAM user.
For more information about using GetSessionToken
to create temporary\n credentials, go to Temporary\n Credentials for Users in Untrusted Environments in the\n IAM User Guide.
The protocol settings that are configured for your server.
\n\n Use the PassiveIp
parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the TlsSessionResumptionMode
parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
The protocol settings that are configured for your server.
\n\n Use the PassiveIp
parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the SetStatOption
to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.\n Set the value to ENABLE_NO_OP
to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n Note that with SetStatOption
set to ENABLE_NO_OP
, Transfer generates a log entry to CloudWatch Logs, so you can determine when the client\n is making a SETSTAT call.
Use the TlsSessionResumptionMode
parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
A property used with Transfer servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret\n key between the control and data connection for an FTPS session. TlsSessionResumptionMode
determines whether or not the server resumes recent,\n negotiated sessions through a unique session ID. This property is available during CreateServer
and UpdateServer
calls.\n If a TlsSessionResumptionMode
value is not specified during CreateServer, it is set to ENFORCED
by default.
\n DISABLED
: the server does not process TLS session resumption client requests and creates a new TLS session for each request.
\n ENABLED
: the server processes and accepts clients that are performing TLS session resumption.\n The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
\n ENFORCED
: the server processes and accepts clients that are performing TLS session resumption.\n The server rejects client data connections that do not perform the TLS session resumption client processing.\n Before you set the value to ENFORCED
, test your clients.
Not all FTPS clients perform TLS session resumption. So, if you choose to enforce\n TLS session resumption, you prevent any connections from FTPS clients that don't perform\n the protocol negotiation. To determine whether or not you can use the\n ENFORCED
value, you need to test your clients.
Use the SetStatOption
to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.
Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and permissions, using commands, such as SETSTAT when uploading the file.\n However, these commands are not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from these clients can result in errors even when \n the file is otherwise successfully uploaded.
\nSet the value to ENABLE_NO_OP
to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n While the SetStatOption
\n ENABLE_NO_OP
setting ignores the error, it does generate a log entry in CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
If you want to preserve the original timestamp for your file, and modify other file attributes using SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.
\n\n The protocol settings that are configured for your server.\n
\n\n Use the PassiveIp
parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the TlsSessionResumptionMode
parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
The protocol settings that are configured for your server.
\n\n Use the PassiveIp
parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the SetStatOption
to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket.\n Set the value to ENABLE_NO_OP
to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client.\n Note that with SetStatOption
set to ENABLE_NO_OP
, Transfer generates a log entry to CloudWatch Logs, so you can determine when the client\n is making a SETSTAT call.
Use the TlsSessionResumptionMode
parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer \n audio, and voiceprints.\n
", "smithy.api#http": { "method": "POST", - "uri": "/domains", - "code": 200 + "uri": "/domains" }, "smithy.api#idempotent": {} } @@ -302,6 +305,9 @@ "input": { "target": "com.amazonaws.voiceid#DeleteDomainRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.voiceid#AccessDeniedException" @@ -349,6 +355,9 @@ "input": { "target": "com.amazonaws.voiceid#DeleteFraudsterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.voiceid#AccessDeniedException" @@ -401,6 +410,9 @@ "input": { "target": "com.amazonaws.voiceid#DeleteSpeakerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.voiceid#AccessDeniedException" @@ -480,8 +492,7 @@ "smithy.api#documentation": "Describes the specified domain.
", "smithy.api#http": { "method": "GET", - "uri": "/domains/{DomainId}", - "code": 200 + "uri": "/domains/{DomainId}" } } }, @@ -538,8 +549,7 @@ "smithy.api#documentation": "Describes the specified fraudster.
", "smithy.api#http": { "method": "GET", - "uri": "/domains/{DomainId}/fraudsters/{FraudsterId}", - "code": 200 + "uri": "/domains/{DomainId}/fraudsters/{FraudsterId}" } } }, @@ -572,8 +582,7 @@ "smithy.api#documentation": "Describes the specified fraudster registration job.
", "smithy.api#http": { "method": "GET", - "uri": "/domains/{DomainId}/fraudster-registration-jobs/{JobId}", - "code": 200 + "uri": "/domains/{DomainId}/fraudster-registration-jobs/{JobId}" } } }, @@ -670,8 +679,7 @@ "smithy.api#documentation": "Describes the specified speaker.
", "smithy.api#http": { "method": "GET", - "uri": "/domains/{DomainId}/speakers/{SpeakerId}", - "code": 200 + "uri": "/domains/{DomainId}/speakers/{SpeakerId}" } } }, @@ -704,8 +712,7 @@ "smithy.api#documentation": "Describes the specified speaker enrollment job.
", "smithy.api#http": { "method": "GET", - "uri": "/domains/{DomainId}/speaker-enrollment-jobs/{JobId}", - "code": 200 + "uri": "/domains/{DomainId}/speaker-enrollment-jobs/{JobId}" } } }, @@ -1026,8 +1033,7 @@ "smithy.api#documentation": "Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice \n ID call.
", "smithy.api#http": { "method": "PUT", - "uri": "/sessions/{SessionNameOrId}/evaluate", - "code": 200 + "uri": "/sessions/{SessionNameOrId}/evaluate" } } }, @@ -1626,12 +1632,12 @@ "smithy.api#documentation": "Lists all the domains in the Amazon Web Services account.\n
", "smithy.api#http": { "method": "GET", - "uri": "/domains", - "code": 200 + "uri": "/domains" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DomainSummaries", "pageSize": "MaxResults" } } @@ -1701,12 +1707,12 @@ "smithy.api#documentation": "Lists all the fraudster registration jobs in the domain with the given JobStatus
.\n If JobStatus
is not provided, this lists all fraudster registration jobs in the given\n domain.\n
Lists all the speaker enrollment jobs in the domain with the specified JobStatus
. If\n JobStatus
is not provided, this lists all jobs with all possible speaker enrollment job\n statuses.
Lists all speakers in a specified domain.
", "smithy.api#http": { "method": "GET", - "uri": "/domains/{DomainId}/speakers", - "code": 200 + "uri": "/domains/{DomainId}/speakers" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "SpeakerSummaries", "pageSize": "MaxResults" } } @@ -1963,9 +1969,8 @@ "traits": { "smithy.api#documentation": "Lists all tags associated with a specified Voice ID resource.
", "smithy.api#http": { - "method": "GET", "uri": "/tags/{ResourceArn}", - "code": 200 + "method": "GET" } } }, @@ -2055,8 +2060,7 @@ "smithy.api#documentation": "Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they\n already exist in the system. If they don't yet exist, a new speaker is created in an opted out state.\n If they already exist, their existing status is overridden and they are opted out. Enrollment and\n evaluation authentication requests are rejected for opted out speakers, and opted out speakers have\n no voice embeddings stored in the system.
", "smithy.api#http": { "method": "PUT", - "uri": "/domains/{DomainId}/speakers/{SpeakerId}/optout", - "code": 200 + "uri": "/domains/{DomainId}/speakers/{SpeakerId}/optout" } } }, @@ -2299,6 +2303,12 @@ "traits": { "smithy.api#documentation": "A timestamp showing the speaker's last update.
" } + }, + "LastAccessedAt": { + "target": "com.amazonaws.voiceid#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
" + } } }, "traits": { @@ -2552,6 +2562,12 @@ "traits": { "smithy.api#documentation": "A timestamp showing the speaker's last update.
" } + }, + "LastAccessedAt": { + "target": "com.amazonaws.voiceid#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
" + } } }, "traits": { @@ -2593,8 +2609,7 @@ "smithy.api#documentation": "Starts a new batch fraudster registration job using provided details.
", "smithy.api#http": { "method": "POST", - "uri": "/domains/{DomainId}/fraudster-registration-jobs", - "code": 200 + "uri": "/domains/{DomainId}/fraudster-registration-jobs" }, "smithy.api#idempotent": {} } @@ -2698,8 +2713,7 @@ "smithy.api#documentation": "Starts a new batch speaker enrollment job using specified details.
", "smithy.api#http": { "method": "POST", - "uri": "/domains/{DomainId}/speaker-enrollment-jobs", - "code": 200 + "uri": "/domains/{DomainId}/speaker-enrollment-jobs" }, "smithy.api#idempotent": {} } @@ -2883,9 +2897,8 @@ "traits": { "smithy.api#documentation": "Tags an Amazon Connect Voice ID resource with the provided list of tags.
", "smithy.api#http": { - "method": "POST", "uri": "/tags/{ResourceArn}", - "code": 200 + "method": "POST" } } }, @@ -2981,8 +2994,8 @@ "traits": { "smithy.api#documentation": "Removes specified tags from a specified Amazon Connect Voice ID resource.
", "smithy.api#http": { - "method": "DELETE", "uri": "/tags/{ResourceArn}", + "method": "DELETE", "code": 204 } } @@ -3044,8 +3057,7 @@ "smithy.api#documentation": "Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes.\n If an optional field, such as 'Description' is not provided, it is removed from the domain.
", "smithy.api#http": { "method": "PUT", - "uri": "/domains/{DomainId}", - "code": 200 + "uri": "/domains/{DomainId}" } } }, @@ -3108,6 +3120,21 @@ }, "com.amazonaws.voiceid#VoiceID": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Voice ID", + "arnNamespace": "voiceid", + "cloudFormationName": "VoiceID", + "cloudTrailEventSource": "voiceid.amazonaws.com", + "endpointPrefix": "voiceid" + }, + "aws.auth#sigv4": { + "name": "voiceid" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide\n describes the APIs used for this service.\n
", + "smithy.api#title": "Amazon Voice ID" + }, "version": "2021-09-27", "operations": [ { @@ -3173,22 +3200,7 @@ { "target": "com.amazonaws.voiceid#UpdateDomain" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Voice ID", - "arnNamespace": "voiceid", - "cloudFormationName": "VoiceID", - "cloudTrailEventSource": "voiceid.amazonaws.com", - "endpointPrefix": "voiceid" - }, - "aws.auth#sigv4": { - "name": "voiceid" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide\n describes the APIs used for this service.\n
", - "smithy.api#title": "Amazon Voice ID" - } + ] } } } diff --git a/aws/sdk/aws-models/workspaces-web.json b/aws/sdk/aws-models/workspaces-web.json index 6c48f08d58b..2f48ae915c9 100644 --- a/aws/sdk/aws-models/workspaces-web.json +++ b/aws/sdk/aws-models/workspaces-web.json @@ -499,7 +499,8 @@ "min": 2, "max": 131072 }, - "smithy.api#pattern": "\\{[\\S\\s]*\\}\\s*" + "smithy.api#pattern": "\\{[\\S\\s]*\\}\\s*", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#BrowserSettings": { @@ -827,6 +828,9 @@ { "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.workspacesweb#ThrottlingException" }, @@ -870,7 +874,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id
\n
\n client_secret
\n
\n authorize_scopes
\n
For Facebook:
\n\n client_id
\n
\n client_secret
\n
\n authorize_scopes
\n
\n api_version
\n
For Sign in with Apple:
\n\n client_id
\n
\n team_id
\n
\n key_id
\n
\n private_key
\n
\n authorize_scopes
\n
For OIDC providers:
\n\n client_id
\n
\n client_secret
\n
\n attributes_request_method
\n
\n oidc_issuer
\n
\n authorize_scopes
\n
\n authorize_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n token_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n attributes_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n jwks_uri
\n if not available from discovery URL specified by\n oidc_issuer
key\n
For SAML providers:
\n\n MetadataFile
OR MetadataURL
\n
\n IDPSignout
\n optional\n
The identity provider details. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id
\n
\n client_secret
\n
\n authorize_scopes
\n
For Facebook:
\n\n client_id
\n
\n client_secret
\n
\n authorize_scopes
\n
\n api_version
\n
For Sign in with Apple:
\n\n client_id
\n
\n team_id
\n
\n key_id
\n
\n private_key
\n
\n authorize_scopes
\n
For OIDC providers:
\n\n client_id
\n
\n client_secret
\n
\n attributes_request_method
\n
\n oidc_issuer
\n
\n authorize_scopes
\n
\n authorize_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n token_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n attributes_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n jwks_uri
\n if not available from discovery URL specified by\n oidc_issuer
key\n
For SAML providers:
\n\n MetadataFile
OR MetadataURL
\n
\n IDPSignout
(boolean) \n optional\n
The tags to add to the user settings resource. A tag is a key-value pair.
" } }, + "disconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + } + }, + "idleDisconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + } + }, "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { @@ -1774,6 +1790,16 @@ "type": "structure", "members": {} }, + "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 600 + } + } + }, "com.amazonaws.workspacesweb#DisplayName": { "type": "string", "traits": { @@ -1781,7 +1807,8 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^.+$" + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#EnabledType": { @@ -2347,6 +2374,9 @@ }, "value": { "target": "com.amazonaws.workspacesweb#StringType" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#IdentityProviderList": { @@ -2362,7 +2392,8 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$" + "smithy.api#pattern": "^[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#IdentityProviderSummary": { @@ -2422,6 +2453,16 @@ ] } }, + "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 60 + } + } + }, "com.amazonaws.workspacesweb#InternalServerException": { "type": "structure", "members": { @@ -3491,7 +3532,8 @@ } }, "traits": { - "smithy.api#documentation": "The tag.
" + "smithy.api#documentation": "The tag.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#TagExceptionMessage": { @@ -3504,7 +3546,8 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#TagKeyList": { @@ -3606,7 +3649,8 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "smithy.api#sensitive": {} } }, "com.amazonaws.workspacesweb#ThrottlingException": { @@ -3861,7 +3905,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the identity provider.
", + "smithy.api#documentation": "Updates the identity provider.
", "smithy.api#http": { "method": "PATCH", "uri": "/identityProviders/{identityProviderArn+}", @@ -3895,7 +3939,7 @@ "identityProviderDetails": { "target": "com.amazonaws.workspacesweb#IdentityProviderDetails", "traits": { - "smithy.api#documentation": "The details of the identity provider.
" + "smithy.api#documentation": "The details of the identity provider. The following list describes the provider detail keys for\n each identity provider type.
\nFor Google and Login with Amazon:
\n\n client_id
\n
\n client_secret
\n
\n authorize_scopes
\n
For Facebook:
\n\n client_id
\n
\n client_secret
\n
\n authorize_scopes
\n
\n api_version
\n
For Sign in with Apple:
\n\n client_id
\n
\n team_id
\n
\n key_id
\n
\n private_key
\n
\n authorize_scopes
\n
For OIDC providers:
\n\n client_id
\n
\n client_secret
\n
\n attributes_request_method
\n
\n oidc_issuer
\n
\n authorize_scopes
\n
\n authorize_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n token_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n attributes_url
\n if not available from discovery URL specified by\n oidc_issuer
key\n
\n jwks_uri
\n if not available from discovery URL specified by\n oidc_issuer
key\n
For SAML providers:
\n\n MetadataFile
OR MetadataURL
\n
\n IDPSignout
(boolean) \n optional\n
Specifies whether the user can print to the local device.
" } }, + "disconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + } + }, + "idleDisconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + } + }, "clientToken": { "target": "com.amazonaws.workspacesweb#ClientToken", "traits": { @@ -4290,6 +4346,18 @@ "traits": { "smithy.api#documentation": "Specifies whether the user can print to the local device.
" } + }, + "disconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + } + }, + "idleDisconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + } } }, "traits": { @@ -4340,6 +4408,18 @@ "traits": { "smithy.api#documentation": "Specifies whether the user can print to the local device.
" } + }, + "disconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" + } + }, + "idleDisconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" + } } }, "traits": { diff --git a/aws/sdk/aws-models/workspaces.json b/aws/sdk/aws-models/workspaces.json index 08cf7d68748..600d5c1647d 100644 --- a/aws/sdk/aws-models/workspaces.json +++ b/aws/sdk/aws-models/workspaces.json @@ -475,7 +475,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 600 + "max": 850 }, "smithy.api#pattern": "^.*$" } diff --git a/gradle.properties b/gradle.properties index 28617090026..fb4504bf4b5 100644 --- a/gradle.properties +++ b/gradle.properties @@ -10,10 +10,10 @@ org.gradle.jvmargs=-Xmx1024M # Version number to use for the generated SDK # Note: these must always be full 3-segment semver versions -aws.sdk.version=0.12.0 +aws.sdk.version=0.13.0 # Version number to use for the generated runtime crates -smithy.rs.runtime.crate.version=0.42.0 +smithy.rs.runtime.crate.version=0.43.0 kotlin.code.style=official From f8867814ba3461d192113cf4aabba2bd087a4747 Mon Sep 17 00:00:00 2001 From: John DiSanti