Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM PCA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it will be permanently deleted. The length of time remaining in the CA's restoration period will also be included in this operation's output.
Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM PCA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this operation's output.
The private CA is in a state during which a report cannot be generated.
", + "documentation":"The private CA is in a state during which a report or certificate cannot be generated.
", "exception":true }, "InvalidTagException":{ diff --git a/services/alexaforbusiness/src/main/resources/codegen-resources/service-2.json b/services/alexaforbusiness/src/main/resources/codegen-resources/service-2.json index 8cfbe5fa58ae..39a8fa53601c 100644 --- a/services/alexaforbusiness/src/main/resources/codegen-resources/service-2.json +++ b/services/alexaforbusiness/src/main/resources/codegen-resources/service-2.json @@ -78,10 +78,24 @@ "output":{"shape":"AssociateSkillWithSkillGroupResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, - {"shape":"NotFoundException"} + {"shape":"NotFoundException"}, + {"shape":"SkillNotLinkedException"} ], "documentation":"Associates a skill with a skill group.
" }, + "AssociateSkillWithUsers":{ + "name":"AssociateSkillWithUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSkillWithUsersRequest"}, + "output":{"shape":"AssociateSkillWithUsersResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"Makes a private skill available for enrolled users to enable on their devices.
" + }, "CreateAddressBook":{ "name":"CreateAddressBook", "http":{ @@ -386,6 +400,19 @@ ], "documentation":"Disassociates a skill from a skill group.
" }, + "DisassociateSkillFromUsers":{ + "name":"DisassociateSkillFromUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillFromUsersRequest"}, + "output":{"shape":"DisassociateSkillFromUsersResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
" + }, "DisassociateSkillGroupFromRoom":{ "name":"DisassociateSkillGroupFromRoom", "http":{ @@ -1136,6 +1163,25 @@ "members":{ } }, + "AssociateSkillWithUsersRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "OrganizationArn":{ + "shape":"Arn", + "documentation":"The ARN of the organization.
" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"The private skill ID you want to make available to enrolled users.>
" + } + } + }, + "AssociateSkillWithUsersResponse":{ + "type":"structure", + "members":{ + } + }, "AuthorizationResult":{ "type":"map", "key":{"shape":"Key"}, @@ -2261,6 +2307,25 @@ "members":{ } }, + "DisassociateSkillFromUsersRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "OrganizationArn":{ + "shape":"Arn", + "documentation":"The ARN of the organization.
" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"The private skill ID you want to make unavailable for enrolled users.
" + } + } + }, + "DisassociateSkillFromUsersResponse":{ + "type":"structure", + "members":{ + } + }, "DisassociateSkillGroupFromRoomRequest":{ "type":"structure", "members":{ @@ -2727,7 +2792,7 @@ "members":{ "SkillGroupArn":{ "shape":"Arn", - "documentation":"The ARN of the skill group for which to list enabled skills. Required.
" + "documentation":"The ARN of the skill group for which to list enabled skills.
" }, "EnablementType":{ "shape":"EnablementTypeFilter", @@ -2739,11 +2804,11 @@ }, "NextToken":{ "shape":"NextToken", - "documentation":"An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The skill must be linked to a third-party account.
", + "exception":true + }, "SkillStoreType":{"type":"string"}, "SkillSummary":{ "type":"structure", @@ -4402,5 +4475,5 @@ "pattern":"[a-zA-Z0-9@_+.-]*" } }, - "documentation":"Alexa for Business helps you use Alexa in your organization. Alexa for Business provides the tools you to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. In addition, Alexa for Business enables Alexa Voice Services (AVS) device manufacturers to centrally deploy and manage their devices in Alexa for Business as shared devices as a part of their existing management flow.
" + "documentation":"Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.
" } diff --git a/services/apigatewaymanagementapi/pom.xml b/services/apigatewaymanagementapi/pom.xml new file mode 100644 index 000000000000..768ce03eb423 --- /dev/null +++ b/services/apigatewaymanagementapi/pom.xml @@ -0,0 +1,60 @@ + + + +The connection with the provided id no longer exists.
" + }, { + "shape" : "LimitExceededException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "PayloadTooLargeException", + "documentation" : "The data has exceeded the maximum size allowed.
" + }, { + "shape" : "ForbiddenException", + "documentation" : "The caller is not authorized to invoke this operation.
" + } ], + "documentation" : "Sends the provided data to the specified connection.
" + } + }, + "shapes" : { + "Data" : { + "type" : "blob", + "max" : "131072", + "documentation" : "The data to be sent to the client specified by its connection id.
" + }, + "ForbiddenException" : { + "type" : "structure", + "members" : { }, + "exception" : true, + "error" : { + "httpStatusCode" : 403 + }, + "documentation" : "The caller is not authorized to invoke this operation.
" + }, + "GoneException" : { + "type" : "structure", + "members" : { }, + "exception" : true, + "error" : { + "httpStatusCode" : 410 + }, + "documentation" : "The connection with the provided id no longer exists.
" + }, + "LimitExceededException" : { + "type" : "structure", + "members" : { }, + "exception" : true, + "error" : { + "httpStatusCode" : 429 + }, + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, + "PayloadTooLargeException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 413 + }, + "documentation" : "The data has exceeded the maximum size allowed.
" + }, + "PostToConnectionRequest" : { + "type" : "structure", + "members" : { + "Data" : { + "shape" : "Data", + "documentation" : "The data to be sent to the client specified by its connection id.
" + }, + "ConnectionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "connectionId", + "documentation" : "The identifier of the connection that a specific client is using.
" + } + }, + "required" : [ "ConnectionId", "Data" ], + "payload" : "Data" + }, + "__string" : { + "type" : "string" + } + }, + "documentation" : "The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.
" +} \ No newline at end of file diff --git a/services/apigatewayv2/pom.xml b/services/apigatewayv2/pom.xml new file mode 100644 index 000000000000..bdf636f3b0f4 --- /dev/null +++ b/services/apigatewayv2/pom.xml @@ -0,0 +1,60 @@ + + + +The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates an Api resource.
" + }, + "CreateApiMapping" : { + "name" : "CreateApiMapping", + "http" : { + "method" : "POST", + "requestUri" : "/v2/domainnames/{domainName}/apimappings", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateApiMappingRequest" + }, + "output" : { + "shape" : "CreateApiMappingResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates an API mapping.
" + }, + "CreateAuthorizer" : { + "name" : "CreateAuthorizer", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/authorizers", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateAuthorizerRequest" + }, + "output" : { + "shape" : "CreateAuthorizerResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates an Authorizer for an API.
" + }, + "CreateDeployment" : { + "name" : "CreateDeployment", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/deployments", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateDeploymentRequest" + }, + "output" : { + "shape" : "CreateDeploymentResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates a Deployment for an API.
" + }, + "CreateDomainName" : { + "name" : "CreateDomainName", + "http" : { + "method" : "POST", + "requestUri" : "/v2/domainnames", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateDomainNameRequest" + }, + "output" : { + "shape" : "CreateDomainNameResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates a domain name.
" + }, + "CreateIntegration" : { + "name" : "CreateIntegration", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/integrations", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateIntegrationRequest" + }, + "output" : { + "shape" : "CreateIntegrationResult", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates an Integration.
" + }, + "CreateIntegrationResponse" : { + "name" : "CreateIntegrationResponse", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateIntegrationResponseRequest" + }, + "output" : { + "shape" : "CreateIntegrationResponseResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates an IntegrationResponses.
" + }, + "CreateModel" : { + "name" : "CreateModel", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/models", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateModelRequest" + }, + "output" : { + "shape" : "CreateModelResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates a Model for an API.
" + }, + "CreateRoute" : { + "name" : "CreateRoute", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/routes", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateRouteRequest" + }, + "output" : { + "shape" : "CreateRouteResult", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates a Route for an API.
" + }, + "CreateRouteResponse" : { + "name" : "CreateRouteResponse", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateRouteResponseRequest" + }, + "output" : { + "shape" : "CreateRouteResponseResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates a RouteResponse for a Route.
" + }, + "CreateStage" : { + "name" : "CreateStage", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/stages", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateStageRequest" + }, + "output" : { + "shape" : "CreateStageResponse", + "documentation" : "The request has succeeded and has resulted in the creation of a resource.
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Creates a Stage for an API.
" + }, + "DeleteApi" : { + "name" : "DeleteApi", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteApiRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes an Api resource.
" + }, + "DeleteApiMapping" : { + "name" : "DeleteApiMapping", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteApiMappingRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Deletes an API mapping.
" + }, + "DeleteAuthorizer" : { + "name" : "DeleteAuthorizer", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteAuthorizerRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes an Authorizer.
" + }, + "DeleteDeployment" : { + "name" : "DeleteDeployment", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteDeploymentRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes a Deployment.
" + }, + "DeleteDomainName" : { + "name" : "DeleteDomainName", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/domainnames/{domainName}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteDomainNameRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes a domain name.
" + }, + "DeleteIntegration" : { + "name" : "DeleteIntegration", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteIntegrationRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes an Integration.
" + }, + "DeleteIntegrationResponse" : { + "name" : "DeleteIntegrationResponse", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteIntegrationResponseRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes an IntegrationResponses.
" + }, + "DeleteModel" : { + "name" : "DeleteModel", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteModelRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes a Model.
" + }, + "DeleteRoute" : { + "name" : "DeleteRoute", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteRouteRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes a Route.
" + }, + "DeleteRouteResponse" : { + "name" : "DeleteRouteResponse", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteRouteResponseRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes a RouteResponse.
" + }, + "DeleteStage" : { + "name" : "DeleteStage", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteStageRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Deletes a Stage.
" + }, + "GetApi" : { + "name" : "GetApi", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApiRequest" + }, + "output" : { + "shape" : "GetApiResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets an Api resource.
" + }, + "GetApiMapping" : { + "name" : "GetApiMapping", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApiMappingRequest" + }, + "output" : { + "shape" : "GetApiMappingResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "The API mapping.
" + }, + "GetApiMappings" : { + "name" : "GetApiMappings", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames/{domainName}/apimappings", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApiMappingsRequest" + }, + "output" : { + "shape" : "GetApiMappingsResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "The API mappings.
" + }, + "GetApis" : { + "name" : "GetApis", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApisRequest" + }, + "output" : { + "shape" : "GetApisResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets a collection of Api resources.
" + }, + "GetAuthorizer" : { + "name" : "GetAuthorizer", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetAuthorizerRequest" + }, + "output" : { + "shape" : "GetAuthorizerResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets an Authorizer.
" + }, + "GetAuthorizers" : { + "name" : "GetAuthorizers", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/authorizers", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetAuthorizersRequest" + }, + "output" : { + "shape" : "GetAuthorizersResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the Authorizers for an API.
" + }, + "GetDeployment" : { + "name" : "GetDeployment", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeploymentRequest" + }, + "output" : { + "shape" : "GetDeploymentResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a Deployment.
" + }, + "GetDeployments" : { + "name" : "GetDeployments", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/deployments", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeploymentsRequest" + }, + "output" : { + "shape" : "GetDeploymentsResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the Deployments for an API.
" + }, + "GetDomainName" : { + "name" : "GetDomainName", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames/{domainName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDomainNameRequest" + }, + "output" : { + "shape" : "GetDomainNameResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a domain name.
" + }, + "GetDomainNames" : { + "name" : "GetDomainNames", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDomainNamesRequest" + }, + "output" : { + "shape" : "GetDomainNamesResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the domain names for an AWS account.
" + }, + "GetIntegration" : { + "name" : "GetIntegration", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationRequest" + }, + "output" : { + "shape" : "GetIntegrationResult", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets an Integration.
" + }, + "GetIntegrationResponse" : { + "name" : "GetIntegrationResponse", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationResponseRequest" + }, + "output" : { + "shape" : "GetIntegrationResponseResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets an IntegrationResponses.
" + }, + "GetIntegrationResponses" : { + "name" : "GetIntegrationResponses", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationResponsesRequest" + }, + "output" : { + "shape" : "GetIntegrationResponsesResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the IntegrationResponses for an Integration.
" + }, + "GetIntegrations" : { + "name" : "GetIntegrations", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationsRequest" + }, + "output" : { + "shape" : "GetIntegrationsResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the Integrations for an API.
" + }, + "GetModel" : { + "name" : "GetModel", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetModelRequest" + }, + "output" : { + "shape" : "GetModelResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a Model.
" + }, + "GetModelTemplate" : { + "name" : "GetModelTemplate", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}/template", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetModelTemplateRequest" + }, + "output" : { + "shape" : "GetModelTemplateResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a model template.
" + }, + "GetModels" : { + "name" : "GetModels", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/models", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetModelsRequest" + }, + "output" : { + "shape" : "GetModelsResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the Models for an API.
" + }, + "GetRoute" : { + "name" : "GetRoute", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRouteRequest" + }, + "output" : { + "shape" : "GetRouteResult", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a Route.
" + }, + "GetRouteResponse" : { + "name" : "GetRouteResponse", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRouteResponseRequest" + }, + "output" : { + "shape" : "GetRouteResponseResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a RouteResponse.
" + }, + "GetRouteResponses" : { + "name" : "GetRouteResponses", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRouteResponsesRequest" + }, + "output" : { + "shape" : "GetRouteResponsesResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the RouteResponses for a Route.
" + }, + "GetRoutes" : { + "name" : "GetRoutes", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRoutesRequest" + }, + "output" : { + "shape" : "GetRoutesResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the Routes for an API.
" + }, + "GetStage" : { + "name" : "GetStage", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetStageRequest" + }, + "output" : { + "shape" : "GetStageResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + } ], + "documentation" : "Gets a Stage.
" + }, + "GetStages" : { + "name" : "GetStages", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/stages", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetStagesRequest" + }, + "output" : { + "shape" : "GetStagesResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + } ], + "documentation" : "Gets the Stages for an API.
" + }, + "UpdateApi" : { + "name" : "UpdateApi", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateApiRequest" + }, + "output" : { + "shape" : "UpdateApiResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates an Api resource.
" + }, + "UpdateApiMapping" : { + "name" : "UpdateApiMapping", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateApiMappingRequest" + }, + "output" : { + "shape" : "UpdateApiMappingResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "The API mapping.
" + }, + "UpdateAuthorizer" : { + "name" : "UpdateAuthorizer", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateAuthorizerRequest" + }, + "output" : { + "shape" : "UpdateAuthorizerResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates an Authorizer.
" + }, + "UpdateDeployment" : { + "name" : "UpdateDeployment", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateDeploymentRequest" + }, + "output" : { + "shape" : "UpdateDeploymentResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates a Deployment.
" + }, + "UpdateDomainName" : { + "name" : "UpdateDomainName", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/domainnames/{domainName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateDomainNameRequest" + }, + "output" : { + "shape" : "UpdateDomainNameResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates a domain name.
" + }, + "UpdateIntegration" : { + "name" : "UpdateIntegration", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateIntegrationRequest" + }, + "output" : { + "shape" : "UpdateIntegrationResult", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates an Integration.
" + }, + "UpdateIntegrationResponse" : { + "name" : "UpdateIntegrationResponse", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateIntegrationResponseRequest" + }, + "output" : { + "shape" : "UpdateIntegrationResponseResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates an IntegrationResponses.
" + }, + "UpdateModel" : { + "name" : "UpdateModel", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateModelRequest" + }, + "output" : { + "shape" : "UpdateModelResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates a Model.
" + }, + "UpdateRoute" : { + "name" : "UpdateRoute", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateRouteRequest" + }, + "output" : { + "shape" : "UpdateRouteResult", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates a Route.
" + }, + "UpdateRouteResponse" : { + "name" : "UpdateRouteResponse", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateRouteResponseRequest" + }, + "output" : { + "shape" : "UpdateRouteResponseResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates a RouteResponse.
" + }, + "UpdateStage" : { + "name" : "UpdateStage", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateStageRequest" + }, + "output" : { + "shape" : "UpdateStageResponse", + "documentation" : "Success
" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "The resource specified in the request was not found.
" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "The client is sending more than the allowed number of requests per unit of time.
" + }, { + "shape" : "BadRequestException", + "documentation" : "One of the parameters in the request is invalid.
" + }, { + "shape" : "ConflictException", + "documentation" : "The resource already exists.
" + } ], + "documentation" : "Updates a Stage.
" + } + }, + "shapes" : { + "AccessLogSettings" : { + "type" : "structure", + "members" : { + "DestinationArn" : { + "shape" : "Arn", + "locationName" : "destinationArn", + "documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
" + }, + "Format" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "format", + "documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
" + } + }, + "documentation" : "Settings for logging access in a stage.
" + }, + "Api" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API ID.
" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the API was created.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "The API protocol: HTTP or WEBSOCKET.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "The warning messages reported when failonwarnings is turned on during API import.
" + } + }, + "documentation" : "Represents an API.
", + "required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ] + }, + "ApiMapping" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + }, + "documentation" : "Represents an API mapping.
", + "required" : [ "Stage", "ApiId" ] + }, + "Apis" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfApi", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of APIs.
" + }, + "Arn" : { + "type" : "string", + "documentation" : "Represents an Amazon Resource Name (ARN).
" + }, + "AuthorizationScopes" : { + "type" : "list", + "documentation" : "A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
", + "member" : { + "shape" : "StringWithLengthBetween1And64" + } + }, + "AuthorizationType" : { + "type" : "string", + "documentation" : "The authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
", + "enum" : [ "NONE", "AWS_IAM", "CUSTOM" ] + }, + "Authorizer" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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 and a Name query string parameters 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + }, + "documentation" : "Represents an authorizer.
", + "required" : [ "Name" ] + }, + "AuthorizerType" : { + "type" : "string", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
", + "enum" : [ "REQUEST" ] + }, + "Authorizers" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfAuthorizer", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of authorizers.
" + }, + "BadRequestException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "Describes the error encountered.
" + } + }, + "documentation" : "The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
", + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "ConflictException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "Describes the error encountered.
" + } + }, + "documentation" : "The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
", + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "ConnectionType" : { + "type" : "string", + "documentation" : "Represents a connection type.
", + "enum" : [ "INTERNET", "VPC_LINK" ] + }, + "ContentHandlingStrategy" : { + "type" : "string", + "documentation" : "Specifies how to handle response payload content type conversions.
", + "enum" : [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ] + }, + "CreateApiInput" : { + "type" : "structure", + "members" : { + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "The API protocol: HTTP or WEBSOCKET.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + } + }, + "documentation" : "Represents the input parameters for a CreateApi request.
", + "required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ] + }, + "CreateApiMappingInput" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + }, + "documentation" : "Represents the input parameters for a CreateApiMapping request.
", + "required" : [ "Stage", "ApiId" ] + }, + "CreateApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + }, + "required" : [ "DomainName", "Stage", "ApiId" ] + }, + "CreateApiMappingResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + } + }, + "CreateApiRequest" : { + "type" : "structure", + "members" : { + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "The API protocol: HTTP or WEBSOCKET.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + } + }, + "required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ] + }, + "CreateApiResponse" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API ID.
" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the API was created.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "The API protocol: HTTP or WEBSOCKET.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "The warning messages reported when failonwarnings is turned on during API import.
" + } + } + }, + "CreateAuthorizerInput" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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 and a Name query string parameters 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + }, + "documentation" : "Represents the input parameters for a CreateAuthorizer request.
", + "required" : [ "AuthorizerUri", "AuthorizerType", "IdentitySource", "Name" ] + }, + "CreateAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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 and a Name query string parameters 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + }, + "required" : [ "ApiId", "AuthorizerUri", "AuthorizerType", "IdentitySource", "Name" ] + }, + "CreateAuthorizerResponse" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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 and a Name query string parameters 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + } + }, + "CreateDeploymentInput" : { + "type" : "structure", + "members" : { + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment resource.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the Stage resource for the Deployment resource to create.
" + } + }, + "documentation" : "Represents the input parameters for a CreateDeployment request.
" + }, + "CreateDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment resource.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the Stage resource for the Deployment resource to create.
" + } + }, + "required" : [ "ApiId" ] + }, + "CreateDeploymentResponse" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The date and time when the Deployment resource was created.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier for the deployment.
" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "May contain additional feedback on the status of an API deployment.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment.
" + } + } + }, + "CreateDomainNameInput" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "The domain name.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + }, + "documentation" : "Represents the input parameters for a CreateDomainName request.
", + "required" : [ "DomainName" ] + }, + "CreateDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "The domain name.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + }, + "required" : [ "DomainName" ] + }, + "CreateDomainNameResponse" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "The API mapping selection expression.
" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "The name of the DomainName resource.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + } + }, + "CreateIntegrationInput" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the integration.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + }, + "documentation" : "Represents the input parameters for a CreateIntegration request.
" + }, + "CreateIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the integration.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + }, + "required" : [ "ApiId" ] + }, + "CreateIntegrationResult" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "Represents the description of an integration.
" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "Represents the identifier of an integration.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + } + }, + "CreateIntegrationResponseInput" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration response.
" + } + }, + "documentation" : "Represents the input parameters for a CreateIntegrationResponse request.
", + "required" : [ "IntegrationResponseKey" ] + }, + "CreateIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration response.
" + } + }, + "required" : [ "ApiId", "IntegrationId", "IntegrationResponseKey" ] + }, + "CreateIntegrationResponseResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "The integration response ID.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expressions for the integration response.
" + } + } + }, + "CreateModelInput" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model. Must be alphanumeric.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + }, + "documentation" : "Represents the input parameters for a CreateModel request.
", + "required" : [ "Name" ] + }, + "CreateModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model. Must be alphanumeric.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + }, + "required" : [ "ApiId", "Name" ] + }, + "CreateModelResponse" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "The model identifier.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model. Must be alphanumeric.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + } + }, + "CreateRouteInput" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for the route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + }, + "documentation" : "Represents the input parameters for a CreateRoute request.
", + "required" : [ "RouteKey" ] + }, + "CreateRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for the route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + }, + "required" : [ "ApiId", "RouteKey" ] + }, + "CreateRouteResult" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for this route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + } + }, + "CreateRouteResponseInput" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "The response models for the route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "The route response parameters.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "The route response key.
" + } + }, + "documentation" : "Represents the input parameters for an CreateRouteResponse request.
", + "required" : [ "RouteResponseKey" ] + }, + "CreateRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "The response models for the route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "The route response parameters.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "The route response key.
" + } + }, + "required" : [ "ApiId", "RouteId", "RouteResponseKey" ] + }, + "CreateRouteResponseResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "Represents the model selection expression of a route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "Represents the response models of a route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "Represents the response parameters of a route response.
" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "Represents the identifier of a route response.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "Represents the route response key of a route response.
" + } + } + }, + "CreateStageInput" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "The default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The deployment identifier of the API stage.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the API stage.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + }, + "documentation" : "Represents the input parameters for a CreateStage request.
", + "required" : [ "StageName" ] + }, + "CreateStageRequest" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "The default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The deployment identifier of the API stage.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the API stage.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + }, + "required" : [ "ApiId", "StageName" ] + }, + "CreateStageResponse" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the stage was created.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "Default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier of the Deployment that the Stage is associated with.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the stage.
" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "The timestamp when the stage was last updated.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + } + }, + "DeleteApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "apiId", + "documentation" : "The identifier of the API.
" + }, + "ApiMappingId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + } + }, + "required" : [ "ApiMappingId", "ApiId", "DomainName" ] + }, + "DeleteApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + } + }, + "required" : [ "ApiId" ] + }, + "DeleteAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "AuthorizerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + } + }, + "required" : [ "AuthorizerId", "ApiId" ] + }, + "DeleteDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deploymentId", + "documentation" : "The deployment ID.
" + } + }, + "required" : [ "ApiId", "DeploymentId" ] + }, + "DeleteDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + } + }, + "required" : [ "DomainName" ] + }, + "DeleteIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + } + }, + "required" : [ "ApiId", "IntegrationId" ] + }, + "DeleteIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + }, + "IntegrationResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationResponseId", + "documentation": "The integration response ID.
" + } + }, + "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + }, + "DeleteModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "The model ID.
" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "DeleteRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + } + }, + "required" : [ "ApiId", "RouteId" ] + }, + "DeleteRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeResponseId", + "documentation" : "The route response ID.
" + } + }, + "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + }, + "DeleteStageRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "StageName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "stageName", + "documentation" : "The stage name.
" + } + }, + "required" : [ "StageName", "ApiId" ] + }, + "Deployment" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The date and time when the Deployment resource was created.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier for the deployment.
" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "May contain additional feedback on the status of an API deployment.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment.
" + } + }, + "documentation" : "An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
" + }, + "DeploymentStatus" : { + "type" : "string", + "documentation" : "Represents a deployment status.
", + "enum" : [ "PENDING", "FAILED", "DEPLOYED" ] + }, + "Deployments" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDeployment", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "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.
" + }, + "DomainName" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "The API mapping selection expression.
" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "The name of the DomainName resource.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + }, + "documentation" : "Represents a domain name.
", + "required" : [ "DomainName" ] + }, + "DomainNameConfiguration" : { + "type" : "structure", + "members" : { + "ApiGatewayDomainName" : { + "shape" : "__string", + "locationName" : "apiGatewayDomainName", + "documentation" : "A domain name for the WebSocket API.
" + }, + "CertificateArn" : { + "shape" : "Arn", + "locationName" : "certificateArn", + "documentation" : "An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
" + }, + "CertificateName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "certificateName", + "documentation" : "The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
" + }, + "CertificateUploadDate" : { + "shape" : "__timestampIso8601", + "locationName" : "certificateUploadDate", + "documentation" : "The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
" + }, + "EndpointType" : { + "shape" : "EndpointType", + "locationName" : "endpointType", + "documentation" : "The endpoint type.
" + }, + "HostedZoneId" : { + "shape" : "__string", + "locationName" : "hostedZoneId", + "documentation" : "The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway.
" + } + }, + "documentation" : "The domain name configuration.
" + }, + "DomainNameConfigurations" : { + "type" : "list", + "documentation" : "The domain name configurations.
", + "member" : { + "shape" : "DomainNameConfiguration" + } + }, + "DomainNames" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDomainName", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of domain names.
" + }, + "EndpointType" : { + "type" : "string", + "documentation" : "Represents an endpoint type.
", + "enum" : [ "REGIONAL", "EDGE" ] + }, + "GetApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "apiId", + "documentation" : "The identifier of the API.
" + }, + "ApiMappingId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + } + }, + "required" : [ "ApiMappingId", "ApiId", "DomainName" ] + }, + "GetApiMappingResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + } + }, + "GetApiMappingsRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "DomainName" ] + }, + "GetApiMappingsResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + } + }, + "GetApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetApiResponse" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API ID.
" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the API was created.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "The API protocol: HTTP or WEBSOCKET.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "The warning messages reported when failonwarnings is turned on during API import.
" + } + } + }, + "GetApisRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetApisResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfApi", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "AuthorizerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + } + }, + "required" : [ "AuthorizerId", "ApiId" ] + }, + "GetAuthorizerResponse" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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 and a Name query string parameters 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + } + }, + "GetAuthorizersRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetAuthorizersResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfAuthorizer", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deploymentId", + "documentation" : "The deployment ID.
" + } + }, + "required" : [ "ApiId", "DeploymentId" ] + }, + "GetDeploymentResponse" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The date and time when the Deployment resource was created.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier for the deployment.
" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "May contain additional feedback on the status of an API deployment.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment.
" + } + } + }, + "GetDeploymentsRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetDeploymentsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDeployment", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + } + }, + "required" : [ "DomainName" ] + }, + "GetDomainNameResponse" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "The API mapping selection expression.
" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "The name of the DomainName resource.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + } + }, + "GetDomainNamesRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetDomainNamesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDomainName", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + } + }, + "required" : [ "ApiId", "IntegrationId" ] + }, + "GetIntegrationResult" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "Represents the description of an integration.
" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "Represents the identifier of an integration.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + } + }, + "GetIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + }, + "IntegrationResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationResponseId", + "documentation": "The integration response ID.
" + } + }, + "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + }, + "GetIntegrationResponseResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "The integration response ID.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expressions for the integration response.
" + } + } + }, + "GetIntegrationResponsesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "IntegrationId", "ApiId" ] + }, + "GetIntegrationResponsesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegrationResponse", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetIntegrationsRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetIntegrationsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegration", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "The model ID.
" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "GetModelResponse" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "The model identifier.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model. Must be alphanumeric.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + } + }, + "GetModelTemplateRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "The model ID.
" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "GetModelTemplateResponse" : { + "type" : "structure", + "members" : { + "Value" : { + "shape" : "__string", + "locationName" : "value", + "documentation" : "The template value.
" + } + } + }, + "GetModelsRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetModelsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfModel", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + } + }, + "required" : [ "ApiId", "RouteId" ] + }, + "GetRouteResult" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for this route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + } + }, + "GetRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeResponseId", + "documentation" : "The route response ID.
" + } + }, + "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + }, + "GetRouteResponseResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "Represents the model selection expression of a route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "Represents the response models of a route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "Represents the response parameters of a route response.
" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "Represents the identifier of a route response.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "Represents the route response key of a route response.
" + } + } + }, + "GetRouteResponsesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + } + }, + "required" : [ "RouteId", "ApiId" ] + }, + "GetRouteResponsesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRouteResponse", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetRoutesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetRoutesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRoute", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "GetStageRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "StageName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "stageName", + "documentation" : "The stage name.
" + } + }, + "required" : [ "StageName", "ApiId" ] + }, + "GetStageResponse" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the stage was created.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "Default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier of the Deployment that the Stage is associated with.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the stage.
" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "The timestamp when the stage was last updated.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + } + }, + "GetStagesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of elements to be returned for this resource.
" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "required" : [ "ApiId" ] + }, + "GetStagesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfStage", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + } + }, + "Id" : { + "type" : "string", + "documentation" : "An API Gateway-generated, unique identifier.
" + }, + "IdentitySourceList" : { + "type" : "list", + "documentation" : "The identity source for which authorization is requested.
For the 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.
", + "member" : { + "shape" : "__string" + } + }, + "IntegerWithLengthBetween0And3600" : { + "type" : "integer", + "documentation" : "An integer with a value between [0-3600].
", + "min" : 0, + "max" : 3600 + }, + "IntegerWithLengthBetween50And29000" : { + "type" : "integer", + "documentation" : "An integer with a value between [50-29000].
", + "min" : 50, + "max" : 29000 + }, + "Integration" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "Represents the description of an integration.
" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "Represents the identifier of an integration.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + }, + "documentation" : "Represents an integration.
" + }, + "IntegrationParameters" : { + "type" : "map", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween1And512" + } + }, + "IntegrationResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "The integration response ID.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expressions for the integration response.
" + } + }, + "documentation" : "Represents an integration response.
", + "required" : [ "IntegrationResponseKey" ] + }, + "IntegrationResponses" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegrationResponse", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of integration responses.
" + }, + "IntegrationType" : { + "type" : "string", + "documentation" : "Represents an API method integration type.
", + "enum" : [ "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY" ] + }, + "Integrations" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegration", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of integrations.
" + }, + "LimitExceededException" : { + "type" : "structure", + "members" : { + "LimitType" : { + "shape" : "__string", + "locationName" : "limitType", + "documentation" : "The limit type.
" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "Describes the error encountered.
" + } + }, + "documentation" : "A limit has been exceeded. See the accompanying error message for details.
" + }, + "LoggingLevel" : { + "type" : "string", + "documentation" : "The logging level.
", + "enum" : [ "ERROR", "INFO", "false" ] + }, + "Model" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "The model identifier.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model. Must be alphanumeric.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + }, + "documentation" : "Represents a data model for an API. See Create Models and Mapping Templates for Request and Response Mappings.
", + "required" : [ "Name" ] + }, + "Models" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfModel", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of data models. See Create Models and Mapping Templates for Request and Response Mappings.
" + }, + "NextToken" : { + "type" : "string", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + }, + "NotFoundException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "Describes the error encountered.
" + }, + "ResourceType" : { + "shape" : "__string", + "locationName" : "resourceType", + "documentation" : "The resource type.
" + } + }, + "documentation" : "The resource specified in the request was not found. See the message field for more information.
", + "exception" : true, + "error" : { + "httpStatusCode" : 404 + } + }, + "ParameterConstraints" : { + "type" : "structure", + "members" : { + "Required" : { + "shape" : "__boolean", + "locationName" : "required", + "documentation" : "Whether or not the parameter is required.
" + } + }, + "documentation" : "Validation constraints imposed on parameters of a request (path, query string, headers).
" + }, + "PassthroughBehavior" : { + "type" : "string", + "documentation" : "Represents passthrough behavior for an integration response.
", + "enum" : [ "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES" ] + }, + "ProtocolType" : { + "type" : "string", + "documentation" : "", + "enum" : [ "WEBSOCKET" ] + }, + "ProviderArnList" : { + "type" : "list", + "documentation" : "For REQUEST authorizer, this is not defined.
", + "member" : { + "shape" : "Arn" + } + }, + "Route" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for this route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + }, + "documentation" : "Represents a route.
", + "required" : [ "RouteKey" ] + }, + "RouteModels" : { + "type" : "map", + "documentation" : "The route models.
", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween1And128" + } + }, + "RouteParameters" : { + "type" : "map", + "documentation" : "The route parameters.
", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "ParameterConstraints" + } + }, + "RouteResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "Represents the model selection expression of a route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "Represents the response models of a route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "Represents the response parameters of a route response.
" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "Represents the identifier of a route response.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "Represents the route response key of a route response.
" + } + }, + "documentation" : "Represents a route response.
", + "required" : [ "RouteResponseKey" ] + }, + "RouteResponses" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRouteResponse", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of route responses.
" + }, + "RouteSettings" : { + "type" : "structure", + "members" : { + "DataTraceEnabled" : { + "shape" : "__boolean", + "locationName" : "dataTraceEnabled", + "documentation" : "Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs.
" + }, + "DetailedMetricsEnabled" : { + "shape" : "__boolean", + "locationName" : "detailedMetricsEnabled", + "documentation" : "Specifies whether detailed metrics are enabled.
" + }, + "LoggingLevel" : { + "shape" : "LoggingLevel", + "locationName" : "loggingLevel", + "documentation" : "Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
" + }, + "ThrottlingBurstLimit" : { + "shape" : "__integer", + "locationName" : "throttlingBurstLimit", + "documentation" : "Specifies the throttling burst limit.
" + }, + "ThrottlingRateLimit" : { + "shape" : "__double", + "locationName" : "throttlingRateLimit", + "documentation" : "Specifies the throttling rate limit.
" + } + }, + "documentation" : "Represents a collection of route settings.
" + }, + "RouteSettingsMap" : { + "type" : "map", + "documentation" : "The route settings map.
", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "RouteSettings" + } + }, + "Routes" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRoute", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "Represents a collection of routes.
" + }, + "SelectionExpression" : { + "type" : "string", + "documentation" : "An expression used to extract information at runtime. See Selection Expressions for more information.
" + }, + "SelectionKey" : { + "type" : "string", + "documentation" : "After evaulating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
" + }, + "Stage" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the stage was created.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "Default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier of the Deployment that the Stage is associated with.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the stage.
" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "The timestamp when the stage was last updated.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + }, + "documentation" : "Represents an API stage.
", + "required" : [ "StageName" ] + }, + "StageVariablesMap" : { + "type" : "map", + "documentation" : "The stage variable map.
", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween0And2048" + } + }, + "Stages" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfStage", + "locationName" : "items", + "documentation" : "The elements from this collection.
" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "The next page of elements from this collection. Not valid for the last element of the collection.
" + } + }, + "documentation" : "A collection of Stage resources that are associated with the ApiKey resource.
" + }, + "StringWithLengthBetween0And1024" : { + "type" : "string", + "documentation" : "A string with a length between [0-1024].
" + }, + "StringWithLengthBetween0And2048" : { + "type" : "string", + "documentation" : "A string with a length between [0-2048].
" + }, + "StringWithLengthBetween0And32K" : { + "type" : "string", + "documentation" : "A string with a length between [0-32768].
" + }, + "StringWithLengthBetween1And1024" : { + "type" : "string", + "documentation" : "A string with a length between [1-1024].
" + }, + "StringWithLengthBetween1And128" : { + "type" : "string", + "documentation" : "A string with a length between [1-128].
" + }, + "StringWithLengthBetween1And256" : { + "type" : "string", + "documentation" : "A string with a length between [1-256].
" + }, + "StringWithLengthBetween1And512" : { + "type" : "string", + "documentation" : "A string with a length between [1-512].
" + }, + "StringWithLengthBetween1And64" : { + "type" : "string", + "documentation" : "A string with a length between [1-64].
" + }, + "Template" : { + "type" : "structure", + "members" : { + "Value" : { + "shape" : "__string", + "locationName" : "value", + "documentation" : "The template value.
" + } + }, + "documentation" : "Represents a template.
" + }, + "TemplateMap" : { + "type" : "map", + "documentation" : "A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween0And32K" + } + }, + "TooManyRequestsException" : { + "type" : "structure", + "members" : { + "LimitType" : { + "shape" : "__string", + "locationName" : "limitType", + "documentation" : "The limit type.
" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "Describes the error encountered.
" + } + }, + "documentation" : "A limit has been exceeded. See the accompanying error message for details.
", + "exception" : true, + "error" : { + "httpStatusCode" : 429 + } + }, + "UpdateApiInput" : { + "type" : "structure", + "members" : { + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateApi request.
" + }, + "UpdateApiMappingInput" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateApiMapping request.
" + }, + "UpdateApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + }, + "required" : [ "ApiMappingId", "ApiId", "DomainName" ] + }, + "UpdateApiMappingResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "The API mapping identifier.
" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "The API mapping key.
" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "The API stage.
" + } + } + }, + "UpdateApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + } + }, + "required" : [ "ApiId" ] + }, + "UpdateApiResponse" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "The API ID.
" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "An API key selection expression. See API Key Selection Expressions.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the API was created.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the API.
" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "Avoid validating models when creating a deployment.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the API.
" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "The API protocol: HTTP or WEBSOCKET.
" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "The route selection expression for the API.
" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "A version identifier for the API.
" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "The warning messages reported when failonwarnings is turned on during API import.
" + } + } + }, + "UpdateAuthorizerInput" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + }, + "documentation" : "The input parameters for an UpdateAuthorizer request.
" + }, + "UpdateAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + }, + "required" : [ "AuthorizerId", "ApiId" ] + }, + "UpdateAuthorizerResponse" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The authorizer identifier.
" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "The identity source for which authorization is requested.
For the 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 and a Name query string parameters 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.
" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "The validation expression does not apply to the REQUEST authorizer.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the authorizer.
" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "For REQUEST authorizer, this is not defined.
" + } + } + }, + "UpdateDeploymentInput" : { + "type" : "structure", + "members" : { + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment resource.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateDeployment request.
" + }, + "UpdateDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deploymentId", + "documentation" : "The deployment ID.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment resource.
" + } + }, + "required" : [ "ApiId", "DeploymentId" ] + }, + "UpdateDeploymentResponse" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The date and time when the Deployment resource was created.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier for the deployment.
" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "May contain additional feedback on the status of an API deployment.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the deployment.
" + } + } + }, + "UpdateDomainNameInput" : { + "type" : "structure", + "members" : { + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateDomainName request.
" + }, + "UpdateDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "The domain name.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + }, + "required" : [ "DomainName" ] + }, + "UpdateDomainNameResponse" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "The API mapping selection expression.
" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "The name of the DomainName resource.
" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "The domain name configurations.
" + } + } + }, + "UpdateIntegrationInput" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the integration
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateIntegration request.
" + }, + "UpdateIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the integration
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + }, + "required" : [ "ApiId", "IntegrationId" ] + }, + "UpdateIntegrationResult" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "Represents the description of an integration.
" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "Represents the identifier of an integration.
" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "Specifies the integration's HTTP method type.
" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "The integration type of an integration. One of the following:
AWS: for integrating the route or 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 route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or 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 route or 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 HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend.
" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
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}
" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "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.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend 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 HTTP 415 Unsupported Media Type response.
" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration.
" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
" + } + } + }, + "UpdateIntegrationResponseInput" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration response.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateIntegrationResponse request.
" + }, + "UpdateIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "The integration ID.
" + }, + "IntegrationResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationResponseId", + "documentation": "The integration response ID.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expression for the integration response.
" + } + }, + "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + }, + "UpdateIntegrationResponseResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "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 route response or method response without modification.
" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "The integration response ID.
" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "The integration response key.
" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "The template selection expressions for the integration response.
" + } + } + }, + "UpdateModelInput" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateModel request.
" + }, + "UpdateModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "The model ID.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "UpdateModelResponse" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "The content-type for the model, for example, \"application/json\".
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the model.
" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "The model identifier.
" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "The name of the model. Must be alphanumeric.
" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" + } + } + }, + "UpdateRouteInput" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for the route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateRoute request.
" + }, + "UpdateRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for the route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + }, + "required" : [ "ApiId", "RouteId" ] + }, + "UpdateRouteResult" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "Specifies whether an API key is required for this route.
" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "The authorization scopes supported by this route.
" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "The identifier of the Authorizer resource to be associated with this route.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route.
" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "The operation name for the route.
" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "The request models for the route.
" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "The request parameters for the route.
" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "The route key for the route.
" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "The route response selection expression for the route.
" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "The target for the route.
" + } + } + }, + "UpdateRouteResponseInput" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "The response models for the route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "The route response parameters.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "The route response key.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateRouteResponse request.
" + }, + "UpdateRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "The model selection expression for the route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "The response models for the route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "The route response parameters.
" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "The route ID.
" + }, + "RouteResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeResponseId", + "documentation" : "The route response ID.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "The route response key.
" + } + }, + "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + }, + "UpdateRouteResponseResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "Represents the model selection expression of a route response.
" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "Represents the response models of a route response.
" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "Represents the response parameters of a route response.
" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "Represents the identifier of a route response.
" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "Represents the route response key of a route response.
" + } + } + }, + "UpdateStageInput" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "The default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The deployment identifier for the API stage.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the API stage.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + }, + "documentation" : "Represents the input parameters for an UpdateStage request.
" + }, + "UpdateStageRequest" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "The API identifier.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "The default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The deployment identifier for the API stage.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description for the API stage.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "stageName", + "documentation" : "The stage name.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + }, + "required" : [ "StageName", "ApiId" ] + }, + "UpdateStageResponse" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "Settings for logging access in this stage.
" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "The identifier of a client certificate for a Stage.
" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "The timestamp when the stage was created.
" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "Default route settings for the stage.
" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "The identifier of the Deployment that the Stage is associated with.
" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "The description of the stage.
" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "The timestamp when the stage was last updated.
" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "Route settings for the stage.
" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "The name of the stage.
" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" + } + } + }, + "UriWithLengthBetween1And2048" : { + "type" : "string", + "documentation" : "A string representation of a URI with a length between [1-2048].
" + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__listOfApi" : { + "type" : "list", + "member" : { + "shape" : "Api" + } + }, + "__listOfAuthorizer" : { + "type" : "list", + "member" : { + "shape" : "Authorizer" + } + }, + "__listOfDeployment" : { + "type" : "list", + "member" : { + "shape" : "Deployment" + } + }, + "__listOfDomainName" : { + "type" : "list", + "member" : { + "shape" : "DomainName" + } + }, + "__listOfIntegration" : { + "type" : "list", + "member" : { + "shape" : "Integration" + } + }, + "__listOfIntegrationResponse" : { + "type" : "list", + "member" : { + "shape" : "IntegrationResponse" + } + }, + "__listOfModel" : { + "type" : "list", + "member" : { + "shape" : "Model" + } + }, + "__listOfRoute" : { + "type" : "list", + "member" : { + "shape" : "Route" + } + }, + "__listOfRouteResponse" : { + "type" : "list", + "member" : { + "shape" : "RouteResponse" + } + }, + "__listOfStage" : { + "type" : "list", + "member" : { + "shape" : "Stage" + } + }, + "__listOf__string" : { + "type" : "list", + "member" : { + "shape" : "__string" + } + }, + "__long" : { + "type" : "long" + }, + "__string" : { + "type" : "string" + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "authorizers" : { + "authorization_strategy" : { + "name" : "authorization_strategy", + "type" : "provided", + "placement" : { + "location" : "header", + "name" : "Authorization" + } + } + }, + "documentation" : "Amazon API Gateway V2
" +} diff --git a/services/appmesh/src/main/resources/codegen-resources/service-2.json b/services/appmesh/src/main/resources/codegen-resources/service-2.json index d0fb2b1a6337..20ed19ea0c7d 100644 --- a/services/appmesh/src/main/resources/codegen-resources/service-2.json +++ b/services/appmesh/src/main/resources/codegen-resources/service-2.json @@ -11,7 +11,7 @@ "signingName": "appmesh", "uid": "appmesh-2018-10-01" }, - "documentation": "AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control containerized 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 every\n microservice in an application. You can use App Mesh with Amazon ECS\n (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.
\nApp Mesh supports containerized microservice applications that use service discovery\n naming for their components. To use App Mesh, you must have a containerized application\n running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For\n more information about service discovery on Amazon ECS, see Service Discovery in the\n Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns is supported.\n For more information, see DNS\n for Services and Pods in the Kubernetes documentation.
AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control containerized 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 every\n microservice in an application. You can use App Mesh with Amazon ECS\n (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.
\nApp Mesh supports containerized microservice applications that use service discovery\n naming for their components. To use App Mesh, you must have a containerized application\n running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For\n more information about service discovery on Amazon ECS, see Service Discovery in the\n Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns is supported.\n For more information, see DNS\n for Services and Pods in the Kubernetes documentation.
Describes an existing cluster.
" + "documentation": "Describes an existing service mesh.
" }, "DescribeRoute": { "name": "DescribeRoute", @@ -763,6 +763,11 @@ "fault": true } }, + "HealthCheckThreshold": { + "type": "integer", + "min": 2, + "max": 10 + }, "DeleteMeshOutput": { "type": "structure", "members": { @@ -907,6 +912,12 @@ "senderFault": true } }, + "HealthCheckIntervalMillis": { + "type": "long", + "box": true, + "min": 5000, + "max": 300000 + }, "VirtualNodeRef": { "type": "structure", "members": { @@ -1011,14 +1022,6 @@ }, "max": 10 }, - "DurationMillis": { - "type": "long", - "box": true - }, - "NonNegativeInt": { - "type": "integer", - "min": 0 - }, "MeshRef": { "type": "structure", "members": { @@ -1113,6 +1116,12 @@ "documentation": "", "payload": "virtualRouter" }, + "HealthCheckTimeoutMillis": { + "type": "long", + "box": true, + "min": 2000, + "max": 60000 + }, "CreateVirtualRouterInput": { "type": "structure", "required": [ @@ -1672,11 +1681,11 @@ }, "createdAt": { "shape": "Timestamp", - "documentation": "The Unix epoch timestamp in seconds for when the cluster was created.
" + "documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" }, "lastUpdatedAt": { "shape": "Timestamp", - "documentation": "The Unix epoch timestamp in seconds for when the cluster was last updated.
" + "documentation": "The Unix epoch timestamp in seconds for when the resource was last updated.
" }, "uid": { "shape": "String", @@ -1878,7 +1887,7 @@ "members": { "healthCheck": { "shape": "HealthCheckPolicy", - "documentation": "The health check information for the listener.
\nListener health checks are not available during the App Mesh preview.
\nThe health check information for the listener.
" }, "portMapping": { "shape": "PortMapping", @@ -1892,37 +1901,44 @@ }, "HealthCheckPolicy": { "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], "members": { "healthyThreshold": { - "shape": "NonNegativeInt", + "shape": "HealthCheckThreshold", "documentation": "The number of consecutive successful health checks that must occur before declaring\n listener healthy.
" }, "intervalMillis": { - "shape": "DurationMillis", + "shape": "HealthCheckIntervalMillis", "documentation": "The time period in milliseconds between each health check execution.
" }, "path": { "shape": "String", - "documentation": "The destination path for the health check request.
" + "documentation": "The destination path for the health check request. This is only required if the\n specified protocol is HTTP; if the protocol is TCP, then this parameter is ignored.
" }, "port": { "shape": "PortNumber", - "documentation": "The destination port for the health check request.
" + "documentation": "The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.
" }, "protocol": { "shape": "PortProtocol", "documentation": "The protocol for the health check request.
" }, "timeoutMillis": { - "shape": "DurationMillis", + "shape": "HealthCheckTimeoutMillis", "documentation": "The amount of time to wait when receiving a response from the health check, in\n milliseconds.
" }, "unhealthyThreshold": { - "shape": "NonNegativeInt", + "shape": "HealthCheckThreshold", "documentation": "The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy.
" } }, - "documentation": "An object representing the health check policy for a virtual node's listener.
\nListener health checks are not available during the App Mesh preview.
\nAn object representing the health check policy for a virtual node's listener.
" }, "ListVirtualRoutersInput": { "type": "structure", diff --git a/services/cloudformation/src/main/resources/codegen-resources/service-2.json b/services/cloudformation/src/main/resources/codegen-resources/service-2.json index 13c5b0b65975..ce940eeb4c13 100644 --- a/services/cloudformation/src/main/resources/codegen-resources/service-2.json +++ b/services/cloudformation/src/main/resources/codegen-resources/service-2.json @@ -998,7 +998,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
" + "documentation":"In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.
For more information on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
" + "documentation":"In some cases, you must explicity acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation":"The Stack data type.
" @@ -3247,7 +3247,7 @@ }, "DriftInformation":{ "shape":"StackResourceDriftInformation", - "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation":"The StackResource data type.
" @@ -3303,7 +3303,7 @@ }, "DriftInformation":{ "shape":"StackResourceDriftInformation", - "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation":"Contains detailed information about the specified stack resource.
" @@ -3359,7 +3359,7 @@ "documentation":"Time at which AWS CloudFormation performed drift detection on the stack resource.
" } }, - "documentation":"Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" + "documentation":"Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" }, "StackResourceDriftInformation":{ "type":"structure", @@ -3449,7 +3449,7 @@ }, "DriftInformation":{ "shape":"StackResourceDriftInformationSummary", - "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation":"Contains high-level information about the specified stack resource.
" @@ -3813,7 +3813,7 @@ }, "DriftInformation":{ "shape":"StackDriftInformationSummary", - "documentation":"Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + "documentation":"Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" } }, "documentation":"The StackSummary Data Type
" @@ -3993,7 +3993,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.
For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter:
AWS::IAM::AccessKey
AWS::IAM::Group
AWS::IAM::InstanceProfile
AWS::IAM::Policy
AWS::IAM::Role
AWS::IAM::User
AWS::IAM::UserToGroupAddition
If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.
If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
" + "documentation":"In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.
CAPABILITY_IAM and CAPABILITY_NAMED_IAM
Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
CAPABILITY_AUTO_EXPAND
Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
Updates the specified user pool app client with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool app client settings with .
" }, + "UpdateUserPoolDomain":{ + "name":"UpdateUserPoolDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserPoolDomainRequest"}, + "output":{"shape":"UpdateUserPoolDomainResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.
A 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 manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, 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, and your custom domain uses the new certificate automatically.
However, 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 this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
" + }, "VerifySoftwareToken":{ "name":"VerifySoftwareToken", "http":{ @@ -3638,7 +3655,7 @@ }, "WriteAttributes":{ "shape":"ClientPermissionListType", - "documentation":"The write attributes.
" + "documentation":"The user pool attributes that the app client can write to.
If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", @@ -3706,7 +3723,7 @@ }, "CustomDomainConfig":{ "shape":"CustomDomainConfigType", - "documentation":"The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Provide this parameter only if you want to use own custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
" + "documentation":"The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Provide 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.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
" } } }, @@ -6091,7 +6108,7 @@ }, "Mutable":{ "shape":"BooleanType", - "documentation":"Specifies whether the value of the attribute can be changed.
", + "documentation":"Specifies whether the value of the attribute can be changed.
For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users 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, see Specifying Identity Provider Attribute Mappings for Your User Pool.
Represents the response from the server to the request to update the user pool client.
" }, + "UpdateUserPoolDomainRequest":{ + "type":"structure", + "required":[ + "Domain", + "UserPoolId", + "CustomDomainConfig" + ], + "members":{ + "Domain":{ + "shape":"DomainType", + "documentation":"The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names.
" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"The ID of the user pool that is associated with the custom domain that you are updating the certificate for.
" + }, + "CustomDomainConfig":{ + "shape":"CustomDomainConfigType", + "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.
" + } + }, + "documentation":"The UpdateUserPoolDomain request input.
" + }, + "UpdateUserPoolDomainResponse":{ + "type":"structure", + "members":{ + "CloudFrontDomain":{ + "shape":"DomainType", + "documentation":"The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
" + } + }, + "documentation":"The UpdateUserPoolDomain response output.
" + }, "UpdateUserPoolRequest":{ "type":"structure", "required":["UserPoolId"], diff --git a/services/comprehend/src/main/resources/codegen-resources/service-2.json b/services/comprehend/src/main/resources/codegen-resources/service-2.json index de428cf20361..0c859fc951a8 100644 --- a/services/comprehend/src/main/resources/codegen-resources/service-2.json +++ b/services/comprehend/src/main/resources/codegen-resources/service-2.json @@ -113,7 +113,7 @@ {"shape":"UnsupportedLanguageException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories.
" + "documentation":"Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.
" }, "CreateEntityRecognizer":{ "name":"CreateEntityRecognizer", @@ -657,6 +657,38 @@ {"shape":"InternalServerException"} ], "documentation":"Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
" + }, + "StopTrainingDocumentClassifier":{ + "name":"StopTrainingDocumentClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTrainingDocumentClassifierRequest"}, + "output":{"shape":"StopTrainingDocumentClassifierResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
The status of the document classifier. The the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
" + } + } + }, + "StopTrainingDocumentClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "StopTrainingEntityRecognizerRequest":{ + "type":"structure", + "required":["EntityRecognizerArn"], + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
" + } + } + }, + "StopTrainingEntityRecognizerResponse":{ + "type":"structure", + "members":{ + } + }, "String":{ "type":"string", "min":1 diff --git a/services/devicefarm/src/main/resources/codegen-resources/service-2.json b/services/devicefarm/src/main/resources/codegen-resources/service-2.json index 7f45e8983cfe..614fbce988c6 100644 --- a/services/devicefarm/src/main/resources/codegen-resources/service-2.json +++ b/services/devicefarm/src/main/resources/codegen-resources/service-2.json @@ -1122,7 +1122,7 @@ }, "type":{ "shape":"ArtifactType", - "documentation":"The artifact's type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
The artifact's type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
VIDEO_LOG: The video log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
VIDEO: The Video output type.
CUSTOMER_ARTIFACT:The Customer Artifact output type.
CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.
TESTSPEC_OUTPUT: The Test Spec Output type.
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
Reflects how likely a device will be available for a test run.
" + "documentation":"Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
" } }, "documentation":"Represents a device type that an app is tested against.
" @@ -1839,7 +1839,7 @@ "members":{ "attribute":{ "shape":"DeviceFilterAttribute", - "documentation":"The aspect of a device such as platform or model used as the selection criteria in a device filter.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
OS_VERSION: The operating system version. For example, \"10.3.2\".
MODEL: The device model. For example, \"iPad 5th Gen\".
AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
The aspect of a device such as platform or model used as the selection criteria in a device filter.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
OS_VERSION: The operating system version. For example, \"10.3.2\".
MODEL: The device model. For example, \"iPad 5th Gen\".
AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
An array of one or more filter values used in a device filter.
Operator Values
The IN and NOT operators can take a values array that has more than one element.
The other operators require an array with a single element.
Attribute Values
The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".
The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".
The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".
An array of one or more filter values used in a device filter.
Operator Values
The IN and NOT_IN operators can take a values array that has more than one element.
The other operators require an array with a single element.
Attribute Values
The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".
The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".
The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".
Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the \"deviceSelectionConfiguration\" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
It is also passed in as the \"filters\" parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.
" + "documentation":"Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
OS_VERSION: The operating system version. For example, \"10.3.2\".
MODEL: The device model. For example, \"iPad 5th Gen\".
AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
Operator: The filter operator.
The EQUALS operator is available for every attribute except INSTANCE_LABELS.
The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
Values: An array of one or more filter values.
The IN and NOT operators can take a values array that has more than one element.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.
Attribute
The aspect of a device such as platform or model used as the selection criteria in a device filter.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
OS_VERSION: The operating system version. For example, \"10.3.2\".
MODEL: The device model. For example, \"iPad 5th Gen\".
AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
Operator
The filter operator.
The EQUALS operator is available for every attribute except INSTANCE_LABELS.
The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
Values
An array of one or more filter values.
Operator Values
The IN and NOT_IN operators can take a values array that has more than one element.
The other operators require an array with a single element.
Attribute Values
The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".
The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".
The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".
The maximum number of devices to be included in a test run.
" } }, - "documentation":"Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.
" + "documentation":"Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selction criteria in a device filter.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
OS_VERSION: The operating system version. For example, \"10.3.2\".
MODEL: The device model. For example, \"iPad 5th Gen\".
AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
Operator: The filter operator.
The EQUALS operator is available for every attribute except INSTANCE_LABELS.
The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
Values: An array of one or more filter values.
The IN and NOT operators can take a values array that has more than one element.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.
Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selction criteria in a device filter.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
OS_VERSION: The operating system version. For example, \"10.3.2\".
MODEL: The device model. For example, \"iPad 5th Gen\".
AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
Operator: The filter operator.
The EQUALS operator is available for every attribute except INSTANCE_LABELS.
The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.
Values: An array of one or more filter values.
The IN and NOT_IN operators take a values array that has one or more elements.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.
Represents the result of a list devices request.
" @@ -3182,7 +3182,7 @@ }, "type":{ "shape":"UploadType", - "documentation":"The type of upload.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The type of upload.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The rule's attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of a device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
APPIUM_VERSION: The Appium version for the test.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
The rule's attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of a device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".
MANUFACTURER: The device manufacturer. For example, \"Apple\".
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".
APPIUM_VERSION: The Appium version for the test.
INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
INSTANCE_LABELS: The label of the device instance.
FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".
The run's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The run's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The ARN of the device pool for the run to be scheduled.
Either devicePoolArn or deviceSelectionConfiguration are required in a request.
The ARN of the device pool for the run to be scheduled.
Either devicePoolArn or deviceSelectionConfiguration is required in a request.
The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.
Either devicePoolArn or deviceSelectionConfiguration are required in a request.
The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.
Either devicePoolArn or deviceSelectionConfiguration is required in a request.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.
For all tests:
app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to \"false\" to disable it.
For Calabash tests:
profile: A cucumber profile, for example, \"my_profile_name\".
tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".
For Appium tests (all types):
appium_version: The Appium version. Currently supported values are \"1.7.2\", \"1.7.1\", \"1.6.5\", \"latest\", and \"default\".
“latest” will run the latest Appium version supported by Device Farm (1.7.2).
For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.
This behavior is subject to change.
For Fuzz tests (Android only):
event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
For Explorer tests:
username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.
For Instrumentation:
filter: A test filter string. Examples:
Running a single test case: \"com.android.abc.Test1\"
Running a single test: \"com.android.abc.Test1#smoke\"
Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"
For XCTest and XCTestUI:
filter: A test filter string. Examples:
Running a single test class: \"LoginTests\"
Running a multiple test classes: \"LoginTests,SmokeTests\"
Running a single test: \"LoginTests/testValid\"
Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"
For UIAutomator:
filter: A test filter string. Examples:
Running a single test case: \"com.android.abc.Test1\"
Running a single test: \"com.android.abc.Test1#smoke\"
Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"
The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.
For all tests:
app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to \"false\" to disable it.
For Calabash tests:
profile: A cucumber profile, for example, \"my_profile_name\".
tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".
For Appium tests (all types):
appium_version: The Appium version. Currently supported values are \"1.6.5\" (and higher), \"latest\", and \"default\".
“latest” will run the latest Appium version supported by Device Farm (1.9.1).
For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.
This behavior is subject to change.
For Fuzz tests (Android only):
event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
For Explorer tests:
username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.
For Instrumentation:
filter: A test filter string. Examples:
Running a single test case: \"com.android.abc.Test1\"
Running a single test: \"com.android.abc.Test1#smoke\"
Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"
For XCTest and XCTestUI:
filter: A test filter string. Examples:
Running a single test class: \"LoginTests\"
Running a multiple test classes: \"LoginTests,SmokeTests\"
Running a single test: \"LoginTests/testValid\"
Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"
For UIAutomator:
filter: A test filter string. Examples:
Running a single test case: \"com.android.abc.Test1\"
Running a single test: \"com.android.abc.Test1#smoke\"
Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"
Represents test settings. This data structure is passed in as the \"test\" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
" + "documentation":"Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
The suite's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The suite's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and region. A TransactGetItems call can contain up to 10 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or region.
DynamoDB rejects the entire TransactGetItems request if any of the following is true:
A conflicting operation is in the process of updating an item to be read.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.
TransactWriteItems is a synchronous write operation that groups up to 10 action requests. These actions can target items in different tables, but not in different AWS accounts or regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item.
The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:
Put — Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether or not to retrieve the item's attributes if the condition is not met.
Update — Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether or not to retrieve the item's attributes if the condition is not met.
Delete — Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether or not to retrieve the item's attributes if the condition is not met.
ConditionCheck — Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether or not to retrieve the item's attributes if the condition is not met.
DynamoDB rejects the entire TransactWriteItems request if any of the following is true:
A condition in one of the condition expressions is not met.
A conflicting operation is in the process of updating the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (bigger than 400 KB), a Local Secondary Index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
There is a user error, such as an invalid data format.
Represents the amount of provisioned throughput capacity consumed on a table or an index.
" }, + "ClientRequestToken":{ + "type":"string", + "max":36, + "min":1 + }, "Code":{"type":"string"}, "ComparisonOperator":{ "type":"string", @@ -3986,7 +3993,7 @@ "documentation":"Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned.
Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls may not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes, and subsequent TransactWriteItems calls with the same client token return the amount of read capacity units consumed in reading the item.
A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 10 minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.
Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.
" }, + "ApplySecurityGroupsToClientVpnTargetNetwork":{ + "name":"ApplySecurityGroupsToClientVpnTargetNetwork", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplySecurityGroupsToClientVpnTargetNetworkRequest"}, + "output":{"shape":"ApplySecurityGroupsToClientVpnTargetNetworkResult"}, + "documentation":"Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
" + }, "AssignIpv6Addresses":{ "name":"AssignIpv6Addresses", "http":{ @@ -111,6 +121,16 @@ "output":{"shape":"AssociateAddressResult"}, "documentation":"Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
" + }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ @@ -219,6 +239,16 @@ "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud User Guide.
" }, + "AuthorizeClientVpnIngress":{ + "name":"AuthorizeClientVpnIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeClientVpnIngressRequest"}, + "output":{"shape":"AuthorizeClientVpnIngressResult"}, + "documentation":"Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
" + }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ @@ -375,6 +405,26 @@ "output":{"shape":"CreateCapacityReservationResult"}, "documentation":"Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide.
" }, + "CreateClientVpnEndpoint":{ + "name":"CreateClientVpnEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClientVpnEndpointRequest"}, + "output":{"shape":"CreateClientVpnEndpointResult"}, + "documentation":"Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
" + }, + "CreateClientVpnRoute":{ + "name":"CreateClientVpnRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClientVpnRouteRequest"}, + "output":{"shape":"CreateClientVpnRouteResult"}, + "documentation":"Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
" + }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ @@ -571,7 +621,7 @@ "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, - "documentation":"Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware.
For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", @@ -781,6 +831,26 @@ "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information about virtual private gateways, see AWS Managed VPN Connections in the Amazon Virtual Private Cloud User Guide.
" }, + "DeleteClientVpnEndpoint":{ + "name":"DeleteClientVpnEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClientVpnEndpointRequest"}, + "output":{"shape":"DeleteClientVpnEndpointResult"}, + "documentation":"Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
" + }, + "DeleteClientVpnRoute":{ + "name":"DeleteClientVpnRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClientVpnRouteRequest"}, + "output":{"shape":"DeleteClientVpnRouteResult"}, + "documentation":"Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
" + }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ @@ -1220,6 +1290,56 @@ "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
" }, + "DescribeClientVpnAuthorizationRules":{ + "name":"DescribeClientVpnAuthorizationRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnAuthorizationRulesRequest"}, + "output":{"shape":"DescribeClientVpnAuthorizationRulesResult"}, + "documentation":"Describes the authorization rules for a specified Client VPN endpoint.
" + }, + "DescribeClientVpnConnections":{ + "name":"DescribeClientVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnConnectionsRequest"}, + "output":{"shape":"DescribeClientVpnConnectionsResult"}, + "documentation":"Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
" + }, + "DescribeClientVpnEndpoints":{ + "name":"DescribeClientVpnEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnEndpointsRequest"}, + "output":{"shape":"DescribeClientVpnEndpointsResult"}, + "documentation":"Describes one or more Client VPN endpoints in the account.
" + }, + "DescribeClientVpnRoutes":{ + "name":"DescribeClientVpnRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnRoutesRequest"}, + "output":{"shape":"DescribeClientVpnRoutesResult"}, + "documentation":"Describes the routes for the specified Client VPN endpoint.
" + }, + "DescribeClientVpnTargetNetworks":{ + "name":"DescribeClientVpnTargetNetworks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnTargetNetworksRequest"}, + "output":{"shape":"DescribeClientVpnTargetNetworksResult"}, + "documentation":"Describes the target networks associated with the specified Client VPN endpoint.
" + }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ @@ -1348,7 +1468,7 @@ }, "input":{"shape":"DescribeHostReservationOfferingsRequest"}, "output":{"shape":"DescribeHostReservationOfferingsResult"}, - "documentation":"Describes the Dedicated Host reservations that are available to purchase.
The results describe all the Dedicated Host reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the Dedicated Host reservations that are available to purchase.
The results describe all the Dedicated Host reservation offerings, including offerings that may not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.
" }, "DescribeHostReservations":{ "name":"DescribeHostReservations", @@ -1368,7 +1488,7 @@ }, "input":{"shape":"DescribeHostsRequest"}, "output":{"shape":"DescribeHostsResult"}, - "documentation":"Describes one or more of your Dedicated Hosts.
The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
Describes one or more of your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.
Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" }, + "DisassociateClientVpnTargetNetwork":{ + "name":"DisassociateClientVpnTargetNetwork", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateClientVpnTargetNetworkRequest"}, + "output":{"shape":"DisassociateClientVpnTargetNetworkResult"}, + "documentation":"Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint's status changes to pending-associate
Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
" }, + "ExportClientVpnClientCertificateRevocationList":{ + "name":"ExportClientVpnClientCertificateRevocationList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportClientVpnClientCertificateRevocationListRequest"}, + "output":{"shape":"ExportClientVpnClientCertificateRevocationListResult"}, + "documentation":"Downloads the client certificate revocation list for the specified Client VPN endpoint.
" + }, + "ExportClientVpnClientConfiguration":{ + "name":"ExportClientVpnClientConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportClientVpnClientConfigurationRequest"}, + "output":{"shape":"ExportClientVpnClientConfigurationResult"}, + "documentation":"Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
" + }, "ExportTransitGatewayRoutes":{ "name":"ExportTransitGatewayRoutes", "http":{ @@ -2332,6 +2482,16 @@ "output":{"shape":"GetTransitGatewayRouteTablePropagationsResult"}, "documentation":"Gets information about the route table propagations for the specified transit gateway route table.
" }, + "ImportClientVpnClientCertificateRevocationList":{ + "name":"ImportClientVpnClientCertificateRevocationList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportClientVpnClientCertificateRevocationListRequest"}, + "output":{"shape":"ImportClientVpnClientCertificateRevocationListResult"}, + "documentation":"Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
" + }, "ImportImage":{ "name":"ImportImage", "http":{ @@ -2392,6 +2552,16 @@ "output":{"shape":"ModifyCapacityReservationResult"}, "documentation":"Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.
" }, + "ModifyClientVpnEndpoint":{ + "name":"ModifyClientVpnEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClientVpnEndpointRequest"}, + "output":{"shape":"ModifyClientVpnEndpointResult"}, + "documentation":"Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.
" + }, "ModifyFleet":{ "name":"ModifyFleet", "http":{ @@ -2486,7 +2656,7 @@ }, "input":{"shape":"ModifyInstancePlacementRequest"}, "output":{"shape":"ModifyInstancePlacementResult"}, - "documentation":"Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance from host to dedicated, or from dedicated to host.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, or placement group for an instance, the instance must be in the stopped state.
Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance from host to dedicated, or from dedicated to host.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
" }, + "RevokeClientVpnIngress":{ + "name":"RevokeClientVpnIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeClientVpnIngressRequest"}, + "output":{"shape":"RevokeClientVpnIngressResult"}, + "documentation":"Removes an ingress authorization rule from a Client VPN endpoint.
" + }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ @@ -2982,6 +3162,16 @@ "output":{"shape":"StopInstancesResult"}, "documentation":"Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.
" }, + "TerminateClientVpnConnections":{ + "name":"TerminateClientVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateClientVpnConnectionsRequest"}, + "output":{"shape":"TerminateClientVpnConnectionsResult"}, + "documentation":"Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
" + }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ @@ -3502,6 +3692,43 @@ "locationName":"item" } }, + "ApplySecurityGroupsToClientVpnTargetNetworkRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "VpcId", + "SecurityGroupIds" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint.
" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC in which the associated target network is located.
" + }, + "SecurityGroupIds":{ + "shape":"ClientVpnSecurityGroupIdSet", + "documentation":"The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.
", + "locationName":"SecurityGroupId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The IDs of the applied security groups.
", + "locationName":"securityGroupIds" + } + } + }, "ArchitectureValues":{ "type":"string", "enum":[ @@ -3620,6 +3847,42 @@ } } }, + "AssociateClientVpnTargetNetworkRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "SubnetId" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint.
" + }, + "SubnetId":{ + "shape":"String", + "documentation":"The ID of the subnet to associate with the Client VPN endpoint.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The unique ID of the target network association.
", + "locationName":"associationId" + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"The current state of the target network association.
", + "locationName":"status" + } + } + }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ @@ -3808,6 +4071,33 @@ } } }, + "AssociatedNetworkType":{ + "type":"string", + "enum":["vpc"] + }, + "AssociatedTargetNetwork":{ + "type":"structure", + "members":{ + "NetworkId":{ + "shape":"String", + "documentation":"The ID of the subnet.
", + "locationName":"networkId" + }, + "NetworkType":{ + "shape":"AssociatedNetworkType", + "documentation":"The target network type.
", + "locationName":"networkType" + } + }, + "documentation":"Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
" + }, + "AssociatedTargetNetworkSet":{ + "type":"list", + "member":{ + "shape":"AssociatedTargetNetwork", + "locationName":"item" + } + }, "AssociationIdList":{ "type":"list", "member":{ @@ -3815,6 +4105,32 @@ "locationName":"AssociationId" } }, + "AssociationStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"AssociationStatusCode", + "documentation":"The state of the target network association.
", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"A message about the status of the target network association, if applicable.
", + "locationName":"message" + } + }, + "documentation":"Describes the state of a target network association.
" + }, + "AssociationStatusCode":{ + "type":"string", + "enum":[ + "associating", + "associated", + "association-failed", + "disassociating", + "disassociated" + ] + }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ @@ -4014,6 +4330,92 @@ }, "documentation":"Describes a value for a resource attribute that is a String.
" }, + "AuthorizationRule":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint with which the authorization rule is associated.
", + "locationName":"clientVpnEndpointId" + }, + "Description":{ + "shape":"String", + "documentation":"A brief description of the authorization rule.
", + "locationName":"description" + }, + "GroupId":{ + "shape":"String", + "documentation":"The ID of the Active Directory group to which the authorization rule grants access.
", + "locationName":"groupId" + }, + "AccessAll":{ + "shape":"Boolean", + "documentation":"Indicates whether the authorization rule grants access to all clients.
", + "locationName":"accessAll" + }, + "DestinationCidr":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
", + "locationName":"destinationCidr" + }, + "Status":{ + "shape":"ClientVpnAuthorizationRuleStatus", + "documentation":"The current state of the authorization rule.
", + "locationName":"status" + } + }, + "documentation":"Information about an authorization rule.
" + }, + "AuthorizationRuleSet":{ + "type":"list", + "member":{ + "shape":"AuthorizationRule", + "locationName":"item" + } + }, + "AuthorizeClientVpnIngressRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint.
" + }, + "TargetNetworkCidr":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
" + }, + "AccessGroupId":{ + "shape":"String", + "documentation":"The ID of the Active Directory group to grant access.
" + }, + "AuthorizeAllGroups":{ + "shape":"Boolean", + "documentation":"Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.
A brief description of the authorization rule.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of the authorization rule.
", + "locationName":"status" + } + } + }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], @@ -4608,10 +5010,6 @@ }, "CancelSpotFleetRequestsError":{ "type":"structure", - "required":[ - "Code", - "Message" - ], "members":{ "Code":{ "shape":"CancelBatchErrorCode", @@ -4628,10 +5026,6 @@ }, "CancelSpotFleetRequestsErrorItem":{ "type":"structure", - "required":[ - "Error", - "SpotFleetRequestId" - ], "members":{ "Error":{ "shape":"CancelSpotFleetRequestsError", @@ -4696,11 +5090,6 @@ }, "CancelSpotFleetRequestsSuccessItem":{ "type":"structure", - "required":[ - "CurrentSpotFleetRequestState", - "PreviousSpotFleetRequestState", - "SpotFleetRequestId" - ], "members":{ "CurrentSpotFleetRequestState":{ "shape":"BatchState", @@ -4971,6 +5360,27 @@ "dedicated" ] }, + "CertificateAuthentication":{ + "type":"structure", + "members":{ + "ClientRootCertificateChain":{ + "shape":"String", + "documentation":"The ARN of the client certificate.
", + "locationName":"clientRootCertificateChain" + } + }, + "documentation":"Information about the client certificate used for authentication.
" + }, + "CertificateAuthenticationRequest":{ + "type":"structure", + "members":{ + "ClientRootCertificateChainArn":{ + "shape":"String", + "documentation":"The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).
" + } + }, + "documentation":"Information about the client certificate to be used for authentication.
" + }, "CidrAuthorizationContext":{ "type":"structure", "required":[ @@ -5065,7 +5475,6 @@ }, "ClassicLoadBalancer":{ "type":"structure", - "required":["Name"], "members":{ "Name":{ "shape":"String", @@ -5086,7 +5495,6 @@ }, "ClassicLoadBalancersConfig":{ "type":"structure", - "required":["ClassicLoadBalancers"], "members":{ "ClassicLoadBalancers":{ "shape":"ClassicLoadBalancers", @@ -5096,11 +5504,34 @@ }, "documentation":"Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
" }, - "ClientData":{ + "ClientCertificateRevocationListStatus":{ "type":"structure", "members":{ - "Comment":{ - "shape":"String", + "Code":{ + "shape":"ClientCertificateRevocationListStatusCode", + "documentation":"The state of the client certificate revocation list.
", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"A message about the status of the client certificate revocation list, if applicable.
", + "locationName":"message" + } + }, + "documentation":"Describes the state of a client certificate revocation list.
" + }, + "ClientCertificateRevocationListStatusCode":{ + "type":"string", + "enum":[ + "pending", + "active" + ] + }, + "ClientData":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"String", "documentation":"A user-defined comment about the disk upload.
" }, "UploadEnd":{ @@ -5118,6 +5549,372 @@ }, "documentation":"Describes the client-specific data.
" }, + "ClientVpnAuthentication":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ClientVpnAuthenticationType", + "documentation":"The authentication type used.
", + "locationName":"type" + }, + "ActiveDirectory":{ + "shape":"DirectoryServiceAuthentication", + "documentation":"Information about the Active Directory, if applicable.
", + "locationName":"activeDirectory" + }, + "MutualAuthentication":{ + "shape":"CertificateAuthentication", + "documentation":"Information about the authentication certificates, if applicable.
", + "locationName":"mutualAuthentication" + } + }, + "documentation":"Describes the authentication methods used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Admin Guide.
" + }, + "ClientVpnAuthenticationList":{ + "type":"list", + "member":{ + "shape":"ClientVpnAuthentication", + "locationName":"item" + } + }, + "ClientVpnAuthenticationRequest":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ClientVpnAuthenticationType", + "documentation":"The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication.
Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Admin Guide.
" + }, + "ClientVpnAuthenticationRequestList":{ + "type":"list", + "member":{"shape":"ClientVpnAuthenticationRequest"} + }, + "ClientVpnAuthenticationType":{ + "type":"string", + "enum":[ + "certificate-authentication", + "directory-service-authentication" + ] + }, + "ClientVpnAuthorizationRuleStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnAuthorizationRuleStatusCode", + "documentation":"The state of the authorization rule.
", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"A message about the status of the authorization rule, if applicable.
", + "locationName":"message" + } + }, + "documentation":"Describes the state of an authorization rule.
" + }, + "ClientVpnAuthorizationRuleStatusCode":{ + "type":"string", + "enum":[ + "authorizing", + "active", + "failed", + "revoking" + ] + }, + "ClientVpnConnection":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint to which the client is connected.
", + "locationName":"clientVpnEndpointId" + }, + "Timestamp":{ + "shape":"String", + "documentation":"The current date and time.
", + "locationName":"timestamp" + }, + "ConnectionId":{ + "shape":"String", + "documentation":"The ID of the client connection.
", + "locationName":"connectionId" + }, + "Username":{ + "shape":"String", + "documentation":"The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
", + "locationName":"username" + }, + "ConnectionEstablishedTime":{ + "shape":"String", + "documentation":"The date and time the client connection was established.
", + "locationName":"connectionEstablishedTime" + }, + "IngressBytes":{ + "shape":"String", + "documentation":"The number of bytes sent by the client.
", + "locationName":"ingressBytes" + }, + "EgressBytes":{ + "shape":"String", + "documentation":"The number of bytes received by the client.
", + "locationName":"egressBytes" + }, + "IngressPackets":{ + "shape":"String", + "documentation":"The number of packets sent by the client.
", + "locationName":"ingressPackets" + }, + "EgressPackets":{ + "shape":"String", + "documentation":"The number of packets received by the client.
", + "locationName":"egressPackets" + }, + "ClientIp":{ + "shape":"String", + "documentation":"The IP address of the client.
", + "locationName":"clientIp" + }, + "CommonName":{ + "shape":"String", + "documentation":"The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
", + "locationName":"commonName" + }, + "Status":{ + "shape":"ClientVpnConnectionStatus", + "documentation":"The current state of the client connection.
", + "locationName":"status" + }, + "ConnectionEndTime":{ + "shape":"String", + "documentation":"The date and time the client connection was terminated.
", + "locationName":"connectionEndTime" + } + }, + "documentation":"Describes a client connection.
" + }, + "ClientVpnConnectionSet":{ + "type":"list", + "member":{ + "shape":"ClientVpnConnection", + "locationName":"item" + } + }, + "ClientVpnConnectionStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnConnectionStatusCode", + "documentation":"The state of the client connection.
", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"A message about the status of the client connection, if applicable.
", + "locationName":"message" + } + }, + "documentation":"Describes the status of a client connection.
" + }, + "ClientVpnConnectionStatusCode":{ + "type":"string", + "enum":[ + "active", + "failed-to-terminate", + "terminating", + "terminated" + ] + }, + "ClientVpnEndpoint":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint.
", + "locationName":"clientVpnEndpointId" + }, + "Description":{ + "shape":"String", + "documentation":"A brief description of the endpoint.
", + "locationName":"description" + }, + "Status":{ + "shape":"ClientVpnEndpointStatus", + "documentation":"The current state of the Client VPN endpoint.
", + "locationName":"status" + }, + "CreationTime":{ + "shape":"String", + "documentation":"The date and time the Client VPN endpoint was created.
", + "locationName":"creationTime" + }, + "DeletionTime":{ + "shape":"String", + "documentation":"The date and time the Client VPN endpoint was deleted, if applicable. Information about deleted Client VPN endpoints is retained for 24 hours, unless a new Client VPN is created with the same name.
", + "locationName":"deletionTime" + }, + "DnsName":{ + "shape":"String", + "documentation":"The DNS name to be used by clients when establishing a connection.
", + "locationName":"dnsName" + }, + "ClientCidrBlock":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
", + "locationName":"clientCidrBlock" + }, + "SplitTunnel":{ + "shape":"Boolean", + "documentation":"Indicates whether VPN split tunneling is supported.
", + "locationName":"splitTunnel" + }, + "VpnProtocol":{ + "shape":"VpnProtocol", + "documentation":"The protocol used by the VPN session.
", + "locationName":"vpnProtocol" + }, + "TransportProtocol":{ + "shape":"TransportProtocol", + "documentation":"The transport protocol used by the Client VPN endpoint.
", + "locationName":"transportProtocol" + }, + "AssociatedTargetNetworks":{ + "shape":"AssociatedTargetNetworkSet", + "documentation":"Information about the associated target networks. A target network is a subnet in a VPC.
", + "locationName":"associatedTargetNetwork" + }, + "ServerCertificateArn":{ + "shape":"String", + "documentation":"The ARN of the server certificate.
", + "locationName":"serverCertificateArn" + }, + "AuthenticationOptions":{ + "shape":"ClientVpnAuthenticationList", + "documentation":"Information about the authentication method used by the Client VPN endpoint.
", + "locationName":"authenticationOptions" + }, + "ConnectionLogOptions":{ + "shape":"ConnectionLogResponseOptions", + "documentation":"Information about the client connection logging options for the Client VPN endpoint.
", + "locationName":"connectionLogOptions" + } + }, + "documentation":"Describes a Client VPN endpoint.
" + }, + "ClientVpnEndpointStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnEndpointStatusCode", + "documentation":"The state of the Client VPN endpoint. Possible states include:
pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
A message about the status of the Client VPN endpoint.
", + "locationName":"message" + } + }, + "documentation":"Describes the state of a Client VPN endpoint.
" + }, + "ClientVpnEndpointStatusCode":{ + "type":"string", + "enum":[ + "pending-associate", + "available", + "deleting", + "deleted" + ] + }, + "ClientVpnRoute":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint with which the route is associated.
", + "locationName":"clientVpnEndpointId" + }, + "DestinationCidr":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, of the route destination.
", + "locationName":"destinationCidr" + }, + "TargetSubnet":{ + "shape":"String", + "documentation":"The ID of the subnet through which traffic is routed.
", + "locationName":"targetSubnet" + }, + "Type":{ + "shape":"String", + "documentation":"The route type.
", + "locationName":"type" + }, + "Origin":{ + "shape":"String", + "documentation":"Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.
The current state of the route.
", + "locationName":"status" + }, + "Description":{ + "shape":"String", + "documentation":"A brief description of the route.
", + "locationName":"description" + } + }, + "documentation":"Information about a Client VPN endpoint route.
" + }, + "ClientVpnRouteSet":{ + "type":"list", + "member":{ + "shape":"ClientVpnRoute", + "locationName":"item" + } + }, + "ClientVpnRouteStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnRouteStatusCode", + "documentation":"The state of the Client VPN endpoint route.
", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"A message about the status of the Client VPN endpoint route, if applicable.
", + "locationName":"message" + } + }, + "documentation":"Describes the state of a Client VPN endpoint route.
" + }, + "ClientVpnRouteStatusCode":{ + "type":"string", + "enum":[ + "creating", + "active", + "failed", + "deleting" + ] + }, + "ClientVpnSecurityGroupIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ @@ -5155,6 +5952,42 @@ } } }, + "ConnectionLogOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether connection logging is enabled.
" + }, + "CloudwatchLogGroup":{ + "shape":"String", + "documentation":"The name of the CloudWatch Logs log group.
" + }, + "CloudwatchLogStream":{ + "shape":"String", + "documentation":"The name of the CloudWatch Logs log stream to which the connection data is published.
" + } + }, + "documentation":"Describes the client connection logging options for the Client VPN endpoint.
" + }, + "ConnectionLogResponseOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether client connection logging is enabled for the Client VPN endpoint.
" + }, + "CloudwatchLogGroup":{ + "shape":"String", + "documentation":"The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
" + }, + "CloudwatchLogStream":{ + "shape":"String", + "documentation":"The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
" + } + }, + "documentation":"Information about the client connection logging options for a Client VPN endpoint.
" + }, "ConnectionNotification":{ "type":"structure", "members":{ @@ -5472,53 +6305,162 @@ "InstanceCount" ], "members":{ - "ClientToken":{ + "ClientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Constraint: Maximum 64 ASCII characters.
" + }, + "InstanceType":{ + "shape":"String", + "documentation":"The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
" + }, + "InstancePlatform":{ + "shape":"CapacityReservationInstancePlatform", + "documentation":"The type of operating system for which to reserve capacity.
" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone in which to create the Capacity Reservation.
" + }, + "Tenancy":{ + "shape":"CapacityReservationTenancy", + "documentation":"Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
The number of instances for which to reserve capacity.
" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
" + }, + "EphemeralStorage":{ + "shape":"Boolean", + "documentation":"Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
The tags to apply to the Capacity Reservation during launch.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation.
", + "locationName":"capacityReservation" + } + } + }, + "CreateClientVpnEndpointRequest":{ + "type":"structure", + "required":[ + "ClientCidrBlock", + "ServerCertificateArn", + "AuthenticationOptions", + "ConnectionLogOptions" + ], + "members":{ + "ClientCidrBlock":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.
" + }, + "ServerCertificateArn":{ + "shape":"String", + "documentation":"The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .
" + }, + "AuthenticationOptions":{ + "shape":"ClientVpnAuthenticationRequestList", + "documentation":"Information about the authentication method to be used to authenticate clients.
", + "locationName":"Authentication" + }, + "ConnectionLogOptions":{ + "shape":"ConnectionLogOptions", + "documentation":"Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.
" + }, + "TransportProtocol":{ + "shape":"TransportProtocol", + "documentation":"The transport protocol to be used by the VPN session.
Default value: udp
A brief description of the Client VPN endpoint.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", + "idempotencyToken":true + } + } + }, + "CreateClientVpnEndpointResult":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint.
", + "locationName":"clientVpnEndpointId" + }, + "Status":{ + "shape":"ClientVpnEndpointStatus", + "documentation":"The current state of the Client VPN endpoint.
", + "locationName":"status" + }, + "DnsName":{ + "shape":"String", + "documentation":"The DNS name to be used by clients when establishing their VPN session.
", + "locationName":"dnsName" + } + } + }, + "CreateClientVpnRouteRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "DestinationCidrBlock", + "TargetVpcSubnetId" + ], + "members":{ + "ClientVpnEndpointId":{ "shape":"String", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
Constraint: Maximum 64 ASCII characters.
" + "documentation":"The ID of the Client VPN endpoint to which to add the route.
" }, - "InstanceType":{ + "DestinationCidrBlock":{ "shape":"String", - "documentation":"The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
" - }, - "InstancePlatform":{ - "shape":"CapacityReservationInstancePlatform", - "documentation":"The type of operating system for which to reserve capacity.
" + "documentation":"The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
Route address ranges cannot overlap with the CIDR range specified for client allocation.
" }, - "AvailabilityZone":{ + "TargetVpcSubnetId":{ "shape":"String", - "documentation":"The Availability Zone in which to create the Capacity Reservation.
" - }, - "Tenancy":{ - "shape":"CapacityReservationTenancy", - "documentation":"Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
The number of instances for which to reserve capacity.
" - }, - "EbsOptimized":{ - "shape":"Boolean", - "documentation":"Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
" - }, - "EphemeralStorage":{ - "shape":"Boolean", - "documentation":"Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
" - }, - "EndDate":{ - "shape":"DateTime", - "documentation":"The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.
" }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags to apply to the Capacity Reservation during launch.
" + "Description":{ + "shape":"String", + "documentation":"A brief description of the route.
" }, "DryRun":{ "shape":"Boolean", @@ -5526,13 +6468,13 @@ } } }, - "CreateCapacityReservationResult":{ + "CreateClientVpnRouteResult":{ "type":"structure", "members":{ - "CapacityReservation":{ - "shape":"CapacityReservation", - "documentation":"Information about the Capacity Reservation.
", - "locationName":"capacityReservation" + "Status":{ + "shape":"ClientVpnRouteStatus", + "documentation":"The current state of the route.
", + "locationName":"status" } } }, @@ -6380,10 +7322,6 @@ }, "CreatePlacementGroupRequest":{ "type":"structure", - "required":[ - "GroupName", - "Strategy" - ], "members":{ "DryRun":{ "shape":"Boolean", @@ -6392,13 +7330,17 @@ }, "GroupName":{ "shape":"String", - "documentation":"A name for the placement group. Must be unique within the scope of your account for the region.
Constraints: Up to 255 ASCII characters
", + "documentation":"A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"The placement strategy.
", "locationName":"strategy" + }, + "PartitionCount":{ + "shape":"Integer", + "documentation":"The number of partitions. Valid only when Strategy is set to partition.
The IDs of one or more resources, separated by spaces.
", + "documentation":"The IDs of one or more resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", "locationName":"ResourceId" }, "Tags":{ @@ -6913,7 +7855,7 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000IOPS for volumes in most regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
" + "documentation":"The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
" }, "KmsKeyId":{ "shape":"String", @@ -7378,6 +8320,65 @@ "on-demand" ] }, + "DeleteClientVpnEndpointRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN to be deleted.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of the Client VPN endpoint.
", + "locationName":"status" + } + } + }, + "DeleteClientVpnRouteRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "DestinationCidrBlock" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint from which the route is to be deleted.
" + }, + "TargetVpcSubnetId":{ + "shape":"String", + "documentation":"The ID of the target subnet used by the route.
" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, of the route to be deleted.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of the route.
", + "locationName":"status" + } + } + }, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], @@ -7994,7 +8995,7 @@ }, "Resources":{ "shape":"ResourceIdList", - "documentation":"The IDs of one or more resources, separated by spaces.
", + "documentation":"The IDs of one or more resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
", "locationName":"resourceId" }, "Tags":{ @@ -8596,7 +9597,221 @@ "locationName":"instancesSet" }, "NextToken":{ - "shape":"String", + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters. Filter names and values are case-sensitive.
", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" + } + } + }, + "DescribeClientVpnAuthorizationRulesResult":{ + "type":"structure", + "members":{ + "AuthorizationRules":{ + "shape":"AuthorizationRuleSet", + "documentation":"Information about the authorization rules.
", + "locationName":"authorizationRule" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters. Filter names and values are case-sensitive.
", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to retrieve the next page of results.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the active and terminated client connections.
", + "locationName":"connections" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
", + "locationName":"ClientVpnEndpointId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to retrieve the next page of results.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters. Filter names and values are case-sensitive.
", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Client VPN endpoints.
", + "locationName":"clientVpnEndpoint" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters. Filter names and values are case-sensitive.
", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to retrieve the next page of results.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Client VPN endpoint routes.
", + "locationName":"routes" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
" + }, + "AssociationIds":{ + "shape":"ValueStringList", + "documentation":"The IDs of the target network associations.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token to retrieve the next page of results.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters. Filter names and values are case-sensitive.
", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the associated target networks.
", + "locationName":"clientVpnTargetNetworks" + }, + "NextToken":{ + "shape":"NextToken", "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen).
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
One or more filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen).
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
owner-id - The AWS account ID of the instance owner.
partition-number - The partition in which the instance is located.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
One or more filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread).
One or more filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
The ID of the Active Directory used for authentication.
", + "locationName":"directoryId" + } + }, + "documentation":"Describes an Active Directory.
" + }, + "DirectoryServiceAuthenticationRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"String", + "documentation":"The ID of the Active Directory to be used for authentication.
" + } + }, + "documentation":"Describes the Active Directory to be used for client authentication.
" + }, "DisableTransitGatewayRouteTablePropagationRequest":{ "type":"structure", "required":[ @@ -12314,6 +13539,42 @@ } } }, + "DisassociateClientVpnTargetNetworkRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "AssociationId" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint from which to disassociate the target network.
" + }, + "AssociationId":{ + "shape":"String", + "documentation":"The ID of the target network association.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the target network association.
", + "locationName":"associationId" + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"The current state of the target network association.
", + "locationName":"status" + } + } + }, "DisassociateIamInstanceProfileRequest":{ "type":"structure", "required":["AssociationId"], @@ -12559,6 +13820,20 @@ "locationName":"item" } }, + "DnsServersOptionsModifyStructure":{ + "type":"structure", + "members":{ + "CustomDnsServers":{ + "shape":"ValueStringList", + "documentation":"The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
Information about the DNS server to be used.
" + }, "DnsSupportValue":{ "type":"string", "enum":[ @@ -12584,7 +13859,7 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-10,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most regions. Maximum io1IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
The ID of the Client VPN endpoint.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the client certificate revocation list.
", + "locationName":"certificateRevocationList" + }, + "Status":{ + "shape":"ClientCertificateRevocationListStatus", + "documentation":"The current state of the client certificate revocation list.
", + "locationName":"status" + } + } + }, + "ExportClientVpnClientConfigurationRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The contents of the Client VPN endpoint configuration file.
", + "locationName":"clientConfiguration" + } + } + }, "ExportEnvironment":{ "type":"string", "enum":[ @@ -14258,11 +15593,6 @@ }, "HistoryRecord":{ "type":"structure", - "required":[ - "EventInformation", - "EventType", - "Timestamp" - ], "members":{ "EventInformation":{ "shape":"EventInformation", @@ -14964,6 +16294,37 @@ "ramdisk" ] }, + "ImportClientVpnClientCertificateRevocationListRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "CertificateRevocationList" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint to which the client certificate revocation list applies.
" + }, + "CertificateRevocationList":{ + "shape":"String", + "documentation":"The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Admin Guide.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Client VPN endpoint to modify.
" + }, + "ServerCertificateArn":{ + "shape":"String", + "documentation":"The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).
" + }, + "ConnectionLogOptions":{ + "shape":"ConnectionLogOptions", + "documentation":"Information about the client connection logging options.
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
" + }, + "Description":{ + "shape":"String", + "documentation":"A brief description of the Client VPN endpoint.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string (\"\").
" + "documentation":"The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string (\"\").
" }, "HostId":{ "shape":"String", @@ -18644,6 +20045,10 @@ "shape":"HostTenancy", "documentation":"The tenancy for the instance.
", "locationName":"tenancy" + }, + "PartitionNumber":{ + "shape":"Integer", + "documentation":"Reserved for future use.
" } } }, @@ -20130,6 +21535,11 @@ "documentation":"The name of the placement group the instance is in.
", "locationName":"groupName" }, + "PartitionNumber":{ + "shape":"Integer", + "documentation":"The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
", @@ -20165,6 +21575,11 @@ "shape":"PlacementStrategy", "documentation":"The placement strategy.
", "locationName":"strategy" + }, + "PartitionCount":{ + "shape":"Integer", + "documentation":"The number of partitions. Valid only if strategy is set to partition.
Describes a placement group.
" @@ -20204,7 +21619,8 @@ "type":"string", "enum":[ "cluster", - "spread" + "spread", + "partition" ] }, "PlatformValues":{ @@ -21627,7 +23043,6 @@ }, "RequestSpotFleetResponse":{ "type":"structure", - "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", @@ -22697,6 +24112,45 @@ } } }, + "RevokeClientVpnIngressRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint with which the authorization rule is associated.
" + }, + "TargetNetworkCidr":{ + "shape":"String", + "documentation":"The IPv4 address range, in CIDR notation, of the network for which access is being removed.
" + }, + "AccessGroupId":{ + "shape":"String", + "documentation":"The ID of the Active Directory group for which to revoke access.
" + }, + "RevokeAllGroups":{ + "shape":"Boolean", + "documentation":"Indicates whether access should be revoked for all clients.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of the authorization rule.
", + "locationName":"status" + } + } + }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], @@ -24455,12 +25909,6 @@ }, "SpotFleetRequestConfig":{ "type":"structure", - "required":[ - "CreateTime", - "SpotFleetRequestConfig", - "SpotFleetRequestId", - "SpotFleetRequestState" - ], "members":{ "ActivityStatus":{ "shape":"ActivityStatus", @@ -25524,7 +26972,6 @@ }, "TargetGroup":{ "type":"structure", - "required":["Arn"], "members":{ "Arn":{ "shape":"String", @@ -25545,7 +26992,6 @@ }, "TargetGroupsConfig":{ "type":"structure", - "required":["TargetGroups"], "members":{ "TargetGroups":{ "shape":"TargetGroups", @@ -25555,6 +27001,49 @@ }, "documentation":"Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
" }, + "TargetNetwork":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"The ID of the association.
", + "locationName":"associationId" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC in which the target network (subnet) is located.
", + "locationName":"vpcId" + }, + "TargetNetworkId":{ + "shape":"String", + "documentation":"The ID of the subnet specified as the target network.
", + "locationName":"targetNetworkId" + }, + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint with which the target network is associated.
", + "locationName":"clientVpnEndpointId" + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"The current state of the target network association.
", + "locationName":"status" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "documentation":"The IDs of the security groups applied to the target network association.
", + "locationName":"securityGroups" + } + }, + "documentation":"Describes a target network associated with a Client VPN endpoint.
" + }, + "TargetNetworkSet":{ + "type":"list", + "member":{ + "shape":"TargetNetwork", + "locationName":"item" + } + }, "TargetReservationValue":{ "type":"structure", "members":{ @@ -25593,6 +27082,76 @@ "host" ] }, + "TerminateClientVpnConnectionsRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"The ID of the Client VPN endpoint to which the client is connected.
" + }, + "ConnectionId":{ + "shape":"String", + "documentation":"The ID of the client connection to be terminated.
" + }, + "Username":{ + "shape":"String", + "documentation":"The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the Client VPN endpoint.
", + "locationName":"clientVpnEndpointId" + }, + "Username":{ + "shape":"String", + "documentation":"The user who established the terminated client connections.
", + "locationName":"username" + }, + "ConnectionStatuses":{ + "shape":"TerminateConnectionStatusSet", + "documentation":"The current state of the client connections.
", + "locationName":"connectionStatuses" + } + } + }, + "TerminateConnectionStatus":{ + "type":"structure", + "members":{ + "ConnectionId":{ + "shape":"String", + "documentation":"The ID of the client connection.
", + "locationName":"connectionId" + }, + "PreviousStatus":{ + "shape":"ClientVpnConnectionStatus", + "documentation":"The state of the client connection.
", + "locationName":"previousStatus" + }, + "CurrentStatus":{ + "shape":"ClientVpnConnectionStatus", + "documentation":"A message about the status of the client connection, if applicable.
", + "locationName":"currentStatus" + } + }, + "documentation":"Information about a terminated Client VPN endpoint client connection.
" + }, + "TerminateConnectionStatusSet":{ + "type":"list", + "member":{ + "shape":"TerminateConnectionStatus", + "locationName":"item" + } + }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], @@ -26269,6 +27828,13 @@ }, "documentation":"Describes the VPC attachment options.
" }, + "TransportProtocol":{ + "type":"string", + "enum":[ + "tcp", + "udp" + ] + }, "TunnelOptionsList":{ "type":"list", "member":{ @@ -26406,7 +27972,6 @@ }, "UnsuccessfulItem":{ "type":"structure", - "required":["Error"], "members":{ "Error":{ "shape":"UnsuccessfulItemError", @@ -26423,10 +27988,6 @@ }, "UnsuccessfulItemError":{ "type":"structure", - "required":[ - "Code", - "Message" - ], "members":{ "Code":{ "shape":"String", @@ -26742,7 +28303,7 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-10,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most regions. Maximum io1IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most regions. Maximum io1IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
Lists all the image IDs for a given repository.
You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
List the tags for an Amazon ECR resource.
" + }, "PutImage":{ "name":"PutImage", "http":{ @@ -347,6 +364,40 @@ ], "documentation":"Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
" }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"TooManyTagsException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ServerException"} + ], + "documentation":"Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"TooManyTagsException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ServerException"} + ], + "documentation":"Deletes specified tags from a resource.
" + }, "UploadLayerPart":{ "name":"UploadLayerPart", "http":{ @@ -566,6 +617,10 @@ "repositoryName":{ "shape":"RepositoryName", "documentation":"The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
" + "documentation":"A list of repositories to describe.
" }, "imageIds":{ "shape":"ImageIdentifierList", @@ -704,7 +759,7 @@ }, "maxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.
The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.
The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.
The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.
The nextToken value returned from a previous paginated
GetLifecyclePolicyPreviewRequest request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from the end of the
previous results that returned the nextToken value. This value is
null when there are no more results to return. This option cannot be used when you specify images with imageIds.
The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
maxResults results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending
another GetLifecyclePolicyPreviewRequest request with the returned nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
100 results and a nextToken value, if
applicable. This option cannot be used when you specify images with imageIds.
The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
maxResults results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending
another GetLifecyclePolicyPreviewRequest request with the returned nextToken
value. This value can be between 1 and 1000. If this
parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
100 results and a nextToken value, if
applicable. This option cannot be used when you specify images with imageIds.
The specified parameter is invalid. Review the available parameters for the API request.
", "exception":true }, + "InvalidTagParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
", + "exception":true + }, "Layer":{ "type":"structure", "members":{ @@ -1403,9 +1466,14 @@ }, "LifecyclePolicyText":{ "type":"string", - "max":10240, + "max":30720, "min":100 }, + "LifecyclePreviewMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, "LimitExceededException":{ "type":"structure", "members":{ @@ -1445,7 +1513,7 @@ }, "maxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.
" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"The tags for the resource.
" + } + } + }, "MaxResults":{ "type":"integer", - "max":100, + "max":1000, "min":1 }, "MediaType":{"type":"string"}, @@ -1745,13 +1832,90 @@ } } }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "TagStatus":{ "type":"string", "enum":[ "TAGGED", - "UNTAGGED" + "UNTAGGED", + "ANY" ] }, + "TagValue":{"type":"string"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.
" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The keys of the tags to be removed.
" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "UploadId":{ "type":"string", "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" diff --git a/services/ecs/src/main/resources/codegen-resources/service-2.json b/services/ecs/src/main/resources/codegen-resources/service-2.json index f9e25c943faf..89208bafcbf4 100644 --- a/services/ecs/src/main/resources/codegen-resources/service-2.json +++ b/services/ecs/src/main/resources/codegen-resources/service-2.json @@ -1309,7 +1309,7 @@ }, "enableECSManagedTags":{ "shape":"Boolean", - "documentation":"Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "propagateTags":{ "shape":"PropagateTags", @@ -2841,7 +2841,7 @@ }, "enableECSManagedTags":{ "shape":"Boolean", - "documentation":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "propagateTags":{ "shape":"PropagateTags", @@ -3034,7 +3034,7 @@ }, "enableECSManagedTags":{ "shape":"Boolean", - "documentation":"Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "propagateTags":{ "shape":"PropagateTags", @@ -3202,7 +3202,7 @@ }, "enableECSManagedTags":{ "shape":"Boolean", - "documentation":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" + "documentation":"Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
" }, "propagateTags":{ "shape":"PropagateTags", diff --git a/services/elasticbeanstalk/src/main/resources/codegen-resources/service-2.json b/services/elasticbeanstalk/src/main/resources/codegen-resources/service-2.json index 72d8127e316b..f557701d2af6 100755 --- a/services/elasticbeanstalk/src/main/resources/codegen-resources/service-2.json +++ b/services/elasticbeanstalk/src/main/resources/codegen-resources/service-2.json @@ -2161,7 +2161,7 @@ }, "Health":{ "shape":"EnvironmentHealth", - "documentation":"Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
Green: Indicates the environment is healthy and fully functional.
Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
Default: Grey
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
Green: Indicates the environment is healthy and fully functional.
Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.
Default: Grey
The retrieved information.
" + "documentation":"The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.
Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.
" } }, "documentation":"The information retrieved from the Amazon EC2 instances.
" @@ -2328,6 +2328,10 @@ "shape":"LaunchConfigurationList", "documentation":"The Auto Scaling launch configurations in use by this environment.
" }, + "LaunchTemplates":{ + "shape":"LaunchTemplateList", + "documentation":"The Amazon EC2 launch templates in use by this environment.
" + }, "LoadBalancers":{ "shape":"LoadBalancerList", "documentation":"The LoadBalancers in use by this environment.
" @@ -2378,11 +2382,11 @@ "members":{ "Name":{ "shape":"String", - "documentation":"The name of this environment tier.
" + "documentation":"The name of this environment tier.
Valid values:
For Web server tier – WebServer
For Worker tier – Worker
The type of this environment tier.
" + "documentation":"The type of this environment tier.
Valid values:
For Web server tier – Standard
For Worker tier – SQS/HTTP
The ID of the launch template.
" + } + }, + "documentation":"Describes an Amazon EC2 launch template.
" + }, + "LaunchTemplateList":{ + "type":"list", + "member":{"shape":"LaunchTemplate"} + }, "LaunchedAt":{"type":"timestamp"}, "ListAvailableSolutionStacksResultMessage":{ "type":"structure", diff --git a/services/firehose/src/main/resources/codegen-resources/service-2.json b/services/firehose/src/main/resources/codegen-resources/service-2.json index 9a100c24028b..8a7fc7053126 100644 --- a/services/firehose/src/main/resources/codegen-resources/service-2.json +++ b/services/firehose/src/main/resources/codegen-resources/service-2.json @@ -26,7 +26,7 @@ {"shape":"LimitExceededException"}, {"shape":"ResourceInUseException"} ], - "documentation":"Creates a Kinesis Data Firehose delivery stream.
By default, you can create up to 50 delivery streams per AWS Region.
This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.
A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
" + "documentation":"Creates a Kinesis Data Firehose delivery stream.
By default, you can create up to 50 delivery streams per AWS Region.
This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.
A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
" }, "DeleteDeliveryStream":{ "name":"DeleteDeliveryStream", @@ -63,7 +63,7 @@ }, "input":{"shape":"ListDeliveryStreamsInput"}, "output":{"shape":"ListDeliveryStreamsOutput"}, - "documentation":"Lists your delivery streams in alphabetical order of their names.
The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.
Lists your delivery streams in alphabetical order of their names.
The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.
By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits.
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.
Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.
By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits.
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.
Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.
Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Enables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Firehose first sets the status of the stream to ENABLING then to ENABLED. You can continue to read and write data to your stream while its status is ENABLING but they won't get encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted.
To check the encryption state of a delivery stream, use DescribeDeliveryStream.
You can only enable SSE for a delivery stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption thirteen times and StopDeliveryStreamEncryption twelve times for the same stream in a 24-hour period.
Enables server-side encryption (SSE) for the delivery stream.
This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to ENABLING, and then to ENABLED. You can continue to read and write data to your stream while its status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption state of a delivery stream, use DescribeDeliveryStream.
You can only enable SSE for a delivery stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
Disables server-side encryption (SSE) for the delivery stream. This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Firehose first sets the status of the stream to DISABLING then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption.
To check the encryption state of a delivery stream, use DescribeDeliveryStream.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption thirteen times and StopDeliveryStreamEncryption twelve times for the same stream in a 24-hour period.
Disables server-side encryption (SSE) for the delivery stream.
This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption state of a delivery stream, use DescribeDeliveryStream.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.
Adds or updates tags for the specified delivery stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
Each delivery stream can have up to 50 tags.
This operation has a limit of five transactions per second per account.
" + "documentation":"Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
Each delivery stream can have up to 50 tags.
This operation has a limit of five transactions per second per account.
" }, "UntagDeliveryStream":{ "name":"UntagDeliveryStream", @@ -188,7 +188,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"} ], - "documentation":"Updates the specified destination of the specified delivery stream.
Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.
Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.
If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.
Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
" + "documentation":"Updates the specified destination of the specified delivery stream.
Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.
Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.
If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.
Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
A message that provides information about the error.
" } }, - "documentation":"Another modification has already happened. Fetch VersionId again and use it to update the destination.
", + "documentation":"Another modification has already happened. Fetch VersionId again and use it to update the destination.
The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.
The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
" + "documentation":"The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
" }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.
" + }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"The buffering option.
" @@ -910,6 +915,10 @@ "shape":"Prefix", "documentation":"The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
" }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.
" + }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"The buffering option.
" @@ -960,6 +969,10 @@ "shape":"Prefix", "documentation":"The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
" }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.
" + }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"The buffering option.
" @@ -1014,7 +1027,7 @@ "members":{ "TimestampFormats":{ "shape":"ListOfNonEmptyStrings", - "documentation":"Indicates how you want Kinesis Data Firehose to parse the date and time stamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse time stamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
" @@ -1093,7 +1106,7 @@ }, "DeliveryStartTimestamp":{ "shape":"DeliveryStartTimestamp", - "documentation":"Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this time stamp.
" + "documentation":"Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.
" } }, "documentation":"Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.
" @@ -1802,6 +1815,10 @@ "shape":"Prefix", "documentation":"The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
" }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.
" + }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"The buffering option. If no value is specified, BufferingHints object default values are used.
The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
" }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.
" + }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"The buffering option. If no value is specified, BufferingHints object default values are used.
The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
" }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name.
" + }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"The buffering option. If no value is specified, BufferingHints object default values are used.
Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
Create an endpoint group for the specified accelerator. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.
" + "documentation":"Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.
" }, "CreateListener":{ "name":"CreateListener", @@ -77,7 +77,7 @@ {"shape":"InternalServiceErrorException"}, {"shape":"InvalidArgumentException"} ], - "documentation":"Delete an accelerator. Note: before you can delete an accelerator, you must disable it.
" + "documentation":"Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).
" }, "DeleteEndpointGroup":{ "name":"DeleteEndpointGroup", @@ -318,15 +318,15 @@ "members":{ "FlowLogsEnabled":{ "shape":"GenericBoolean", - "documentation":"Indicates whether flow logs are enabled. The value is true or false. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
" + "documentation":"Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.
" }, "FlowLogsS3Bucket":{ "shape":"GenericString", - "documentation":"The name of the Amazon S3 bucket for the flow logs. This attribute is required if flow logs are enabled. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
" + "documentation":"The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
The prefix for the location in the Amazon S3 bucket for the flow logs. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.
" + "documentation":"The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.
Attributes of an accelerator.
" @@ -363,7 +363,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"The endpoint group that you specified doesn't exist.
", + "documentation":"The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
", "exception":true }, "AssociatedListenerFoundException":{ @@ -371,7 +371,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"The listener that you specified doesn't exist.
", + "documentation":"The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
", "exception":true }, "ClientAffinity":{ @@ -453,7 +453,7 @@ }, "HealthCheckIntervalSeconds":{ "shape":"HealthCheckIntervalSeconds", - "documentation":"The time, in seconds, between each health check for an endpoint. The default value is 30.
" + "documentation":"The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
" }, "ThresholdCount":{ "shape":"ThresholdCount", @@ -497,7 +497,7 @@ }, "ClientAffinity":{ "shape":"ClientAffinity", - "documentation":"Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.
AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—client IP address, client port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to CLIENT_IP instead. When you use the CLIENT_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— client IP address and destination IP address—to select the hash value. For UDP, Global Accelerator always uses two-tuple properties to select the hash value.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.
AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
" + "documentation":"The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe. Value is required.
" } } }, @@ -628,7 +628,7 @@ }, "Weight":{ "shape":"EndpointWeight", - "documentation":"The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.
" + "documentation":"The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.
" } }, "documentation":"A complex type for endpoints.
" @@ -648,7 +648,7 @@ }, "Weight":{ "shape":"EndpointWeight", - "documentation":"The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.
" + "documentation":"The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.
" }, "HealthState":{ "shape":"HealthState", @@ -698,7 +698,7 @@ }, "HealthCheckIntervalSeconds":{ "shape":"HealthCheckIntervalSeconds", - "documentation":"The elapsed time, in seconds, between health checks for each endpoint. The default value is 30.
" + "documentation":"The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
" }, "ThresholdCount":{ "shape":"ThresholdCount", @@ -942,7 +942,7 @@ }, "ClientAffinity":{ "shape":"ClientAffinity", - "documentation":"The client properties that Global Accelerator uses to select an endpoint so that you can choose to route traffic from users to their original endpoint. The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.
AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
A complex type for a listener.
" @@ -1012,19 +1012,19 @@ "members":{ "AcceleratorArn":{ "shape":"GenericString", - "documentation":"The Amazon Resource Name (ARN) of the accelerator that you want to update.
" + "documentation":"The Amazon Resource Name (ARN) of the accelerator that you want to update. Attribute is required.
" }, "FlowLogsEnabled":{ "shape":"GenericBoolean", - "documentation":"Update whether flow logs are enabled.
" + "documentation":"Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.
" }, "FlowLogsS3Bucket":{ "shape":"GenericString", - "documentation":"Update the name of the Amazon S3 bucket for the flow logs.
" + "documentation":"The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.
Update the prefix for the location in the Amazon S3 bucket for the flow logs.
" + "documentation":"Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.
The time, in seconds, between each health check for an endpoint. The default value is 30.
" + "documentation":"The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
" }, "ThresholdCount":{ "shape":"ThresholdCount", @@ -1133,7 +1133,7 @@ }, "ClientAffinity":{ "shape":"ClientAffinity", - "documentation":"Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the source port and protocol of the user request. This gives you control over whether and how to maintain client affinity to a given endpoint.
The default value is NONE.
Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.
AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
The default value is NONE.
This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.
AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.
Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.
Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.
Global Accelerator includes components that work together to help you improve performance and availability for your applications:
AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed points of contact for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.
An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.
A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.
Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example.
An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. You can configure weights for each endpoint, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.
This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.
AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.
Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.
Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.
Global Accelerator includes components that work together to help you improve performance and availability for your applications:
AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.
An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.
A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.
Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example.
An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.
Creates the content of a data set by applying a SQL action.
" + "documentation":"Creates the content of a data set by applying a \"queryAction\" (a SQL query) or a \"containerAction\" (executing a containerized application).
" }, "CreateDatastore":{ "name":"CreateDatastore", @@ -681,7 +681,7 @@ }, "messages":{ "shape":"Messages", - "documentation":"The list of messages to be sent. Each message has format: '{ \"messageId\": \"string\", \"payload\": \"string\"}'.
" + "documentation":"The list of messages to be sent. Each message has format: '{ \"messageId\": \"string\", \"payload\": \"string\"}'.
Note that the field names of message payloads (data) that you send to AWS IoT Analytics:
Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.
Must begin with an alphabetic character or single underscore (_).
Cannot contain hyphens (-).
In regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\".
Cannot be greater than 255 characters.
Are case-insensitive. (Fields named \"foo\" and \"FOO\" in the same payload are considered duplicates.)
For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.
" } } }, @@ -932,7 +932,10 @@ "shape":"DatasetTriggers", "documentation":"A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
" }, - "contentDeliveryRules":{"shape":"DatasetContentDeliveryRules"}, + "contentDeliveryRules":{ + "shape":"DatasetContentDeliveryRules", + "documentation":"When data set contents are created they are delivered to destinations specified here.
" + }, "retentionPeriod":{ "shape":"RetentionPeriod", "documentation":"[Optional] How long, in days, message data is kept for the data set. If not given or set to null, the latest version of the dataset content plus the latest succeeded version (if they are different) are retained for at most 90 days.
" @@ -1048,7 +1051,10 @@ "shape":"DatasetTriggers", "documentation":"The \"DatasetTrigger\" objects that specify when the data set is automatically updated.
" }, - "contentDeliveryRules":{"shape":"DatasetContentDeliveryRules"}, + "contentDeliveryRules":{ + "shape":"DatasetContentDeliveryRules", + "documentation":"When data set contents are created they are delivered to destinations specified here.
" + }, "status":{ "shape":"DatasetStatus", "documentation":"The status of the data set.
" @@ -1077,14 +1083,14 @@ }, "queryAction":{ "shape":"SqlQueryDatasetAction", - "documentation":"An \"SqlQueryDatasetAction\" object that contains the SQL query to modify the message.
" + "documentation":"An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.
" }, "containerAction":{ "shape":"ContainerDatasetAction", "documentation":"Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.
" } }, - "documentation":"A \"DatasetAction\" object specifying the query that creates the data set content.
" + "documentation":"A \"DatasetAction\" object that specifies how data set contents are automatically created.
" }, "DatasetActionName":{ "type":"string", @@ -1129,16 +1135,27 @@ "DatasetContentDeliveryDestination":{ "type":"structure", "members":{ - "iotEventsDestinationConfiguration":{"shape":"IotEventsDestinationConfiguration"} - } + "iotEventsDestinationConfiguration":{ + "shape":"IotEventsDestinationConfiguration", + "documentation":"Configuration information for delivery of data set contents to AWS IoT Events.
" + } + }, + "documentation":"The destination to which data set contents are delivered.
" }, "DatasetContentDeliveryRule":{ "type":"structure", "required":["destination"], "members":{ - "entryName":{"shape":"EntryName"}, - "destination":{"shape":"DatasetContentDeliveryDestination"} - } + "entryName":{ + "shape":"EntryName", + "documentation":"The name of the data set content delivery rules entry.
" + }, + "destination":{ + "shape":"DatasetContentDeliveryDestination", + "documentation":"The destination to which data set contents are delivered.
" + } + }, + "documentation":"When data set contents are created they are delivered to destination specified here.
" }, "DatasetContentDeliveryRules":{ "type":"list", @@ -1205,10 +1222,10 @@ "members":{ "datasetName":{ "shape":"DatasetName", - "documentation":"The name of the data set whose latest contents will be used as input to the notebook or application.
" + "documentation":"The name of the data set whose latest contents are used as input to the notebook or application.
" } }, - "documentation":"The data set whose latest contents will be used as input to the notebook or application.
" + "documentation":"The data set whose latest contents are used as input to the notebook or application.
" }, "DatasetEntries":{ "type":"list", @@ -1285,7 +1302,7 @@ }, "dataset":{ "shape":"TriggeringDataset", - "documentation":"The data set whose content creation will trigger the creation of this data set's contents.
" + "documentation":"The data set whose content creation triggers the creation of this data set's contents.
" } }, "documentation":"The \"DatasetTrigger\" that specifies when the data set is automatically updated.
" @@ -1470,14 +1487,14 @@ "members":{ "offsetSeconds":{ "shape":"OffsetSeconds", - "documentation":"The number of seconds of estimated \"in flight\" lag time of message data.
" + "documentation":"The number of seconds of estimated \"in flight\" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
" }, "timeExpression":{ "shape":"TimeExpression", "documentation":"An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.
" } }, - "documentation":"When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of your message data, so that data not processed from the previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
" + "documentation":"Used to limit data to that which has arrived since the last execution of the action.
" }, "DescribeChannelRequest":{ "type":"structure", @@ -1773,9 +1790,16 @@ "roleArn" ], "members":{ - "inputName":{"shape":"IotEventsInputName"}, - "roleArn":{"shape":"RoleArn"} - } + "inputName":{ + "shape":"IotEventsInputName", + "documentation":"The name of the AWS IoT Events input to which data set contents are delivered.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.
" + } + }, + "documentation":"Configuration information for delivery of data set contents to AWS IoT Events.
" }, "IotEventsInputName":{ "type":"string", @@ -1876,6 +1900,18 @@ "documentation":"The maximum number of results to return in this request.
", "location":"querystring", "locationName":"maxResults" + }, + "scheduledOnOrAfter":{ + "shape":"Timestamp", + "documentation":"A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
The name of the attribute that will contain the result of the math operation.
" + "documentation":"The name of the attribute that contains the result of the math operation.
" }, "math":{ "shape":"MathExpression", @@ -2123,7 +2159,7 @@ "documentation":"The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.
" } }, - "documentation":"The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.
" + "documentation":"The value of the variable as a structure that specifies an output file URI.
" }, "Pipeline":{ "type":"structure", @@ -2256,7 +2292,7 @@ "members":{ "deltaTime":{ "shape":"DeltaTime", - "documentation":"Used to limit data to that which has arrived since the last execution of the action. When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of you message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
" + "documentation":"Used to limit data to that which has arrived since the last execution of the action.
" } }, "documentation":"Information which is used to filter message data, to segregate it according to the time frame in which it arrives.
" @@ -2602,7 +2638,7 @@ "members":{ "resourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN of the resource whose tags will be modified.
", + "documentation":"The ARN of the resource whose tags you want to modify.
", "location":"querystring", "locationName":"resourceArn" }, @@ -2639,10 +2675,10 @@ "members":{ "name":{ "shape":"DatasetName", - "documentation":"The name of the data set whose content generation will trigger the new data set content generation.
" + "documentation":"The name of the data set whose content generation triggers the new data set content generation.
" } }, - "documentation":"Information about the data set whose content generation will trigger the new data set content generation.
" + "documentation":"Information about the data set whose content generation triggers the new data set content generation.
" }, "UnlimitedRetentionPeriod":{"type":"boolean"}, "UntagResourceRequest":{ @@ -2654,13 +2690,13 @@ "members":{ "resourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN of the resource whose tags will be removed.
", + "documentation":"The ARN of the resource whose tags you want to remove.
", "location":"querystring", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", - "documentation":"The keys of those tags which will be removed.
", + "documentation":"The keys of those tags which you want to remove.
", "location":"querystring", "locationName":"tagKeys" } @@ -2708,7 +2744,10 @@ "shape":"DatasetTriggers", "documentation":"A list of \"DatasetTrigger\" objects. The list can be empty or can contain up to five DataSetTrigger objects.
" }, - "contentDeliveryRules":{"shape":"DatasetContentDeliveryRules"}, + "contentDeliveryRules":{ + "shape":"DatasetContentDeliveryRules", + "documentation":"When data set contents are created they are delivered to destinations specified here.
" + }, "retentionPeriod":{ "shape":"RetentionPeriod", "documentation":"How long, in days, message data is kept for the data set.
" diff --git a/services/medialive/src/main/resources/codegen-resources/service-2.json b/services/medialive/src/main/resources/codegen-resources/service-2.json index 4151a45b3d87..affd624c0896 100644 --- a/services/medialive/src/main/resources/codegen-resources/service-2.json +++ b/services/medialive/src/main/resources/codegen-resources/service-2.json @@ -4437,6 +4437,11 @@ "locationName": "spatialAq", "documentation": "If set to enabled, adjust quantization within each frame based on spatial variation of content complexity." }, + "SubgopLength": { + "shape": "H264SubGopLength", + "locationName": "subgopLength", + "documentation": "If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality." + }, "Syntax": { "shape": "H264Syntax", "locationName": "syntax", @@ -4463,6 +4468,14 @@ ], "documentation": "Placeholder documentation for H264SpatialAq" }, + "H264SubGopLength": { + "type": "string", + "enum": [ + "DYNAMIC", + "FIXED" + ], + "documentation": "Placeholder documentation for H264SubGopLength" + }, "H264Syntax": { "type": "string", "enum": [ @@ -4785,7 +4798,7 @@ "SegmentationMode": { "shape": "HlsSegmentationMode", "locationName": "segmentationMode", - "documentation": "When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams." + "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used." }, "SegmentsPerSubdirectory": { "shape": "__integerMin1", @@ -5014,6 +5027,20 @@ ], "documentation": "Placeholder documentation for HlsTimedMetadataId3Frame" }, + "HlsTimedMetadataScheduleActionSettings": { + "type": "structure", + "members": { + "Id3": { + "shape": "__string", + "locationName": "id3", + "documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure" + } + }, + "documentation": "Settings for the action to emit HLS metadata", + "required": [ + "Id3" + ] + }, "HlsTsFileMode": { "type": "string", "enum": [ @@ -6582,7 +6609,7 @@ "SegmentationMode": { "shape": "SmoothGroupSegmentationMode", "locationName": "segmentationMode", - "documentation": "When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams." + "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used." }, "SendDelayMs": { "shape": "__integerMin0Max10000", @@ -7367,6 +7394,11 @@ "ScheduleActionSettings": { "type": "structure", "members": { + "HlsTimedMetadataSettings": { + "shape": "HlsTimedMetadataScheduleActionSettings", + "locationName": "hlsTimedMetadataSettings", + "documentation": "Settings to emit HLS metadata" + }, "InputSwitchSettings": { "shape": "InputSwitchScheduleActionSettings", "locationName": "inputSwitchSettings", diff --git a/services/opsworkscm/src/main/resources/codegen-resources/service-2.json b/services/opsworkscm/src/main/resources/codegen-resources/service-2.json index c4b4ba9d0abd..84ae35d01b6a 100644 --- a/services/opsworkscm/src/main/resources/codegen-resources/service-2.json +++ b/services/opsworkscm/src/main/resources/codegen-resources/service-2.json @@ -248,7 +248,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":" Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's private key (CHEF_PIVOTAL_KEY), a Chef server's admin password (CHEF_DELIVERY_ADMIN_PASSWORD), or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).
This operation is asynchronous.
This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's private key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).
This operation is asynchronous.
This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
The name of the export attribute. Currently supported export attribute is \"Userdata\" which exports a userdata script filled out with parameters provided in the InputAttributes list.
The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.
The name of the Server to which the attribute is being exported from
" + "documentation":"The name of the server from which you are exporting the attribute.
" }, "InputAttributes":{ "shape":"EngineAttributes", - "documentation":"The list of engine attributes. The list type is EngineAttribute. EngineAttribute is a pair of attribute name and value. For ExportAttributeName \"Userdata\", currently supported input attribute names are: - \"RunList\": For Chef, an ordered list of roles and/or recipes that are run in the exact order. For Puppet, this parameter is ignored. - \"OrganizationName\": For Chef, an organization name. AWS OpsWorks for Chef Server always creates the organization \"default\". For Puppet, this parameter is ignored. - \"NodeEnvironment\": For Chef, a node environment (eg. development, staging, onebox). For Puppet, this parameter is ignored. - \"NodeClientVersion\": For Chef, version of Chef Engine (3 numbers separated by dots, eg. \"13.8.5\"). If empty, it uses the latest one. For Puppet, this parameter is ignored.
The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.
RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.
OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.
NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.
NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.
The requested engine attribute pair with attribute name and value.
" + "documentation":"The requested engine attribute pair with attribute name and value.
" }, "ServerName":{ "shape":"ServerName", - "documentation":"The requested ServerName.
" + "documentation":"The server name used in the request.
" } } }, diff --git a/services/pinpointsmsvoice/src/main/resources/codegen-resources/service-2.json b/services/pinpointsmsvoice/src/main/resources/codegen-resources/service-2.json index 5d1f9097b635..7938a2cead10 100644 --- a/services/pinpointsmsvoice/src/main/resources/codegen-resources/service-2.json +++ b/services/pinpointsmsvoice/src/main/resources/codegen-resources/service-2.json @@ -275,7 +275,7 @@ "documentation" : "The name of the Amazon CloudWatch Log Group that you want to record events in." } }, - "documentation" : "An object that contains information about a event destination that sends data to Amazon CloudWatch Logs.", + "documentation" : "An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.", "required" : [ ] }, "CreateConfigurationSetEventDestinationRequest" : { @@ -295,7 +295,7 @@ "documentation" : "A name that identifies the event destination." } }, - "documentation" : "CreateConfigurationSetEventDestinationRequest", + "documentation" : "Create a new event destination in a configuration set.", "required" : [ "ConfigurationSetName" ] }, "CreateConfigurationSetEventDestinationResponse" : { @@ -311,7 +311,7 @@ "documentation" : "The name that you want to give the configuration set." } }, - "documentation" : "CreateConfigurationSetRequest" + "documentation" : "A request to create a new configuration set." }, "CreateConfigurationSetResponse" : { "type" : "structure", @@ -377,6 +377,9 @@ "Name" : { "shape" : "String", "documentation" : "A name that identifies the event destination configuration." + }, + "SnsDestination" : { + "shape" : "SnsDestination" } }, "documentation" : "An object that defines an event destination." @@ -396,6 +399,9 @@ }, "MatchingEventTypes" : { "shape" : "EventTypes" + }, + "SnsDestination" : { + "shape" : "SnsDestination" } }, "documentation" : "An object that defines a single event destination.", @@ -466,7 +472,7 @@ "documentation" : "The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination." } }, - "documentation" : "An object that contains information about a event destination that sends data to Amazon Kinesis Data Firehose.", + "documentation" : "An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.", "required" : [ ] }, "LimitExceededException" : { @@ -571,6 +577,17 @@ }, "documentation" : "An object that that contains the Message ID of a Voice message that was sent successfully." }, + "SnsDestination" : { + "type" : "structure", + "members" : { + "TopicArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon SNS.", + "required" : [ ] + }, "String" : { "type" : "string" }, diff --git a/services/pom.xml b/services/pom.xml index 51b0b68d9bce..b8a843ee7b47 100644 --- a/services/pom.xml +++ b/services/pom.xml @@ -175,6 +175,8 @@Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
" + "documentation":"Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
CLI Sample:
aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name=\"Sales-Management\" --description=\"Sales Management - Forecasting\"
Adds an Amazon QuickSight user to an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
The response is the group member object.
" + "documentation":"Adds an Amazon QuickSight user to an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
The response is the group member object.
CLI Sample:
aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
Removes a user group from Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
Removes a user group from Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
CLI Sample:
aws quicksight delete-group -\\-aws-account-id=111122223333 -\\-namespace=default -\\-group-name=Sales-Management
Removes a user from a group so that the user is no longer a member of the group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
Removes a user from a group so that the user is no longer a member of the group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
CLI Sample:
aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
CLI Sample:
aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is the group object.
" + "documentation":"Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is the group object.
CLI Sample:
aws quicksight describe-group -\\-aws-account-id=11112222333 -\\-namespace=default -\\-group-name=Sales
Returns information about a user, given the user name.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
" + "documentation":"Returns information about a user, given the user name.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
CLI Sample:
aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
Generates an embedded URL and authorization code. Before this can work properly, you need to configure the dashboards and user permissions first.
" + "documentation":"Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
CLI Sample:
Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.
aws sts assume-role --role-arn \"arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role\" --role-session-name embeddingsession
If the user does not exist in QuickSight, register the user:
aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn \"arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role\" --user-role READER --session-name \"embeddingsession\" --email user123@example.com --region us-east-1
Get the URL for the embedded dashboard
aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
Lists member users in a group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a list of group member objects.
" + "documentation":"Lists member users in a group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a list of group member objects.
CLI Sample:
aws quicksight list-group-memberships -\\-aws-account-id=111122223333 -\\-namespace=default
Lists all user groups in Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.
The response is a list of group objects.
" + "documentation":"Lists all user groups in Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.
The response is a list of group objects.
CLI Sample:
aws quicksight list-groups -\\-aws-account-id=111122223333 -\\-namespace=default
Lists the Amazon QuickSight groups that a user is part of.
" + "documentation":"Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The response is a one or more group objects.
CLI Sample:
aws quicksight list-user-groups -\\-user-name=Pat -\\-aws-account-id=111122223333 -\\-namespace=default -\\-region=us-east-1
Returns a list of all of the Amazon QuickSight users belonging to this account.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .
The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
" + "documentation":"Returns a list of all of the Amazon QuickSight users belonging to this account.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .
The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
CLI Sample:
aws quicksight list-users --aws-account-id=111122223333 --namespace=default
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.
The condition keys are quicksight:IamArn and quicksight:SessionName.
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.
The condition keys are quicksight:IamArn and quicksight:SessionName.
CLI Sample:
aws quicksight register-user -\\-aws-account-id=111122223333 -\\-namespace=default -\\-email=pat@example.com -\\-identity-type=IAM -\\-user-role=AUTHOR -\\-iam-arn=arn:aws:iam::111122223333:user/Pat
Changes a group description.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a group object.
" + "documentation":"Changes a group description.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a group object.
CLI Sample:
aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description=\"Sales BI Dashboards\"
Updates an Amazon QuickSight user.
" + "documentation":"Updates an Amazon QuickSight user.
The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).
CLI Sample:
aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
The AWS request id for this request.
" } }, - "documentation":"You don't have access to this.
", + "documentation":"You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
", "error":{"httpStatusCode":401}, "exception":true }, @@ -665,7 +665,7 @@ } }, "documentation":"The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
", - "error":{"httpStatusCode":407}, + "error":{"httpStatusCode":403}, "exception":true }, "EmbeddingUrl":{ @@ -706,7 +706,7 @@ }, "IdentityType":{ "shape":"IdentityType", - "documentation":"The authentication method the user uses to sign in (IAM or QUICKSIGHT).
", + "documentation":"The authentication method the user uses to sign in (IAM only).
", "location":"querystring", "locationName":"creds-type" }, @@ -735,7 +735,7 @@ "members":{ "EmbedUrl":{ "shape":"EmbeddingUrl", - "documentation":"Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.
" + "documentation":"URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.
" }, "Status":{ "shape":"StatusCode", @@ -820,8 +820,8 @@ "documentation":"The AWS request ID for this request.
" } }, - "documentation":"The identity type specified is not supported. Supported identity types include: IAM and QUICKSIGHT.
", - "error":{"httpStatusCode":416}, + "documentation":"The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.
", + "error":{"httpStatusCode":403}, "exception":true }, "InternalFailureException":{ @@ -1010,13 +1010,13 @@ "members":{ "UserName":{ "shape":"UserName", - "documentation":"The name of the user that you want to list groups for.
", + "documentation":"The Amazon QuickSight user name that you want to list group memberships for.
", "location":"uri", "locationName":"UserName" }, "AwsAccountId":{ "shape":"AwsAccountId", - "documentation":"The AWS Account ID that the user is in. Currently, use the AWS Account ID which contains your Amazon QuickSight account.
", + "documentation":"The AWS Account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "location":"uri", "locationName":"AwsAccountId" }, @@ -1058,7 +1058,7 @@ }, "Status":{ "shape":"StatusCode", - "documentation":"The http status of the request.
", + "documentation":"The HTTP status of the request.
", "location":"statusCode" } } @@ -1150,8 +1150,8 @@ "documentation":"The AWS request ID for this request.
" } }, - "documentation":"The user is not found. This could happen in any operation that requires finding a user based on the provided user name, such as DeleteUser, DescribeUser, and so on.
", - "error":{"httpStatusCode":412}, + "documentation":"The user is not found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.
The user name.
" }, + "UserInvitationUrl":{ + "shape":"String", + "documentation":"The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
The AWS request ID for this operation.
" @@ -1250,7 +1254,7 @@ "documentation":"The AWS request ID for this request.
" } }, - "documentation":"One or more resources couldn't be found.
", + "documentation":"One or more resources can't be found.
", "error":{"httpStatusCode":404}, "exception":true }, @@ -1285,8 +1289,8 @@ "documentation":"The AWS request ID for this request.
" } }, - "documentation":"The number of minutes specified for the lifetime of a session is invalid. The session lifetime must be between 15 and 600 minutes.
", - "error":{"httpStatusCode":418}, + "documentation":"The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.
", + "error":{"httpStatusCode":400}, "exception":true }, "StatusCode":{"type":"integer"}, @@ -1313,8 +1317,8 @@ "documentation":"The AWS request ID for this request.
" } }, - "documentation":"Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition does not include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
", - "error":{"httpStatusCode":419}, + "documentation":"This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
", + "error":{"httpStatusCode":403}, "exception":true }, "UpdateGroupRequest":{ @@ -1474,5 +1478,5 @@ }, "boolean":{"type":"boolean"} }, - "documentation":"Amazon QuickSight is a fast, cloud-powered BI service that makes it easy to build visualizations, perform ad hoc analysis, and quickly get business insights from your data. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
" + "documentation":"Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
" } diff --git a/services/redshift/src/main/resources/codegen-resources/service-2.json b/services/redshift/src/main/resources/codegen-resources/service-2.json index fc0935b25800..7edb26e1db18 100644 --- a/services/redshift/src/main/resources/codegen-resources/service-2.json +++ b/services/redshift/src/main/resources/codegen-resources/service-2.json @@ -3530,7 +3530,7 @@ }, "ClusterExists":{ "shape":"BooleanOptional", - "documentation":"A value that indicates whether to return snapshots only for an existing cluster. Table-level restore can be performed only using a snapshot of an existing cluster, that is, a cluster that has not been deleted. If ClusterExists is set to true, ClusterIdentifier is required.
A value that indicates whether to return snapshots only for an existing cluster. Table-level restore can be performed only using a snapshot of an existing cluster, that is, a cluster that has not been deleted.
If ClusterExists is set to true, ClusterIdentifier is required.
If ClusterExists is set to false and ClusterIdentifier is not specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.
If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.
Creates a job that uses human workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models
You can select your workforce from one of three providers:
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when the data is highly confidential or a specific set of skills is required.
One or more vendors that you select from the Amazon Marketplace. Vendors provide expertise in specific areas. Vendors are selected by AWS and meet a minimum standard of data security requirements.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
" + "documentation":"Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.
You can select your workforce from one of three providers:
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
" }, "CreateModel":{ "name":"CreateModel", @@ -133,7 +133,7 @@ }, "input":{"shape":"CreateModelPackageInput"}, "output":{"shape":"CreateModelPackageOutput"}, - "documentation":"Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
" + "documentation":"Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. To restrict access, attach an IAM policy that denies access to this API unless the call comes from an IP address in the specified list to every AWS Identity and Access Management user, group, or role used to access the notebook instance. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. To restrict access, attach an IAM policy that denies access to this API unless the call comes from an IP address in the specified list to every AWS Identity and Access Management user, group, or role used to access the notebook instance. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
Returns a description of the specified model package, which is used to create Amazon SageMaker models or list on AWS Marketplace.
Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
" + "documentation":"Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.
To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.
" }, "DescribeNotebookInstance":{ "name":"DescribeNotebookInstance", @@ -481,7 +481,7 @@ }, "input":{"shape":"GetSearchSuggestionsRequest"}, "output":{"shape":"GetSearchSuggestionsResponse"}, - "documentation":"Returns suggestions for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. The search results can be sorted by any resrouce property in a ascending or descending order.
You can query against the following value types: numerical, text, Booleans, and timestamps.
" + "documentation":"Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numerical, text, Booleans, and timestamps.
" }, "StartNotebookInstance":{ "name":"StartNotebookInstance", @@ -711,7 +711,7 @@ "errors":[ {"shape":"ResourceNotFound"} ], - "documentation":"Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn’t stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.
Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.
The status of the validation of the algorithm.
" + "documentation":"The status of algorithm validation.
" }, "ImageScanStatuses":{ "shape":"AlgorithmStatusItemList", @@ -959,7 +959,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"The name of the algorithm for which the overall status is being repoorted.
" + "documentation":"The name of the algorithm for which the overall status is being reported.
" }, "Status":{ "shape":"DetailedAlgorithmStatus", @@ -967,7 +967,7 @@ }, "FailureReason":{ "shape":"String", - "documentation":"The reason for failure, if the overall status is a failed state.
" + "documentation":"if the overall status is Failed, the reason for the failure.
Represents the overall status of an algorithm.
" @@ -987,7 +987,7 @@ "members":{ "AlgorithmName":{ "shape":"EntityName", - "documentation":"The name of the algorithm which is described by the summary.
" + "documentation":"The name of the algorithm that is described by the summary.
" }, "AlgorithmArn":{ "shape":"AlgorithmArn", @@ -995,7 +995,7 @@ }, "AlgorithmDescription":{ "shape":"EntityDescription", - "documentation":"A brief statement describing the algorithm.
" + "documentation":"A brief description of the algorithm.
" }, "CreationTime":{ "shape":"CreationTime", @@ -1064,7 +1064,7 @@ "members":{ "AnnotationConsolidationLambdaArn":{ "shape":"LambdaFunctionArn", - "documentation":"The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.
Amazon SageMaker Ground Truth provides three annotation consolidation functions that you can choose to use. They are:
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:region:432418664414:function:ACS-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:region:432418664414:function:ACS-ImageMultiClass
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:region:432418664414:function:ACS-TextMultiClass
For more information, see Annotation Consolidation.
" + "documentation":"The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.
For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:
Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.
arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox
Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass
Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.
arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation
Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.
arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass
arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass
arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass
For more information, see Annotation Consolidation.
" } }, "documentation":"Configures how labels are consolidated across human workers.
" @@ -1207,7 +1207,7 @@ "members":{ "Name":{ "shape":"ChannelName", - "documentation":"The name of the channel./sagemaker/eia
" + "documentation":"The name of the channel.
" }, "Description":{ "shape":"EntityDescription", @@ -1394,6 +1394,10 @@ "shape":"CreationTime", "documentation":"The time when the model compilation job was created.
" }, + "CompilationStartTime":{ + "shape":"Timestamp", + "documentation":"The time when the model compilation job started.
" + }, "CompilationEndTime":{ "shape":"Timestamp", "documentation":"The time when the model compilation job completed.
" @@ -1437,7 +1441,7 @@ }, "ModelDataUrl":{ "shape":"Url", - "documentation":"The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.
" + "documentation":"The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
" }, "Environment":{ "shape":"EnvironmentMap", @@ -1445,7 +1449,7 @@ }, "ModelPackageName":{ "shape":"ArnOrName", - "documentation":"The name of the model package in this container.
" + "documentation":"The name of the model package to use to create the model.
" } }, "documentation":"Describes the container, as part of model definition.
" @@ -1536,7 +1540,7 @@ "members":{ "AlgorithmName":{ "shape":"EntityName", - "documentation":"The name of the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
" + "documentation":"The name of the algorithm.
" }, "AlgorithmDescription":{ "shape":"EntityDescription", @@ -1762,7 +1766,7 @@ }, "LabelAttributeName":{ "shape":"LabelAttributeName", - "documentation":"The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with \"-metadata\" or \"-ref\".
" + "documentation":"The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with \"-metadata\". If you are running a semantic segmentation labeling job, the attribute name must end with \"-ref\". If you are running any other kind of labeling job, the attribute name must not end with \"-ref\".
" }, "InputConfig":{ "shape":"LabelingJobInputConfig", @@ -1778,7 +1782,7 @@ }, "LabelCategoryConfigS3Uri":{ "shape":"S3Uri", - "documentation":"The S3 URL of the file that defines the categories used to label the data objects.
" + "documentation":"The S3 URL of the file that defines the categories used to label the data objects.
The file is a JSON structure in the following format:
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label 1\"
},
{
\"label\": \"label 2\"
},
...
{
\"label\": \"label n\"
}
]
}
If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance.
" + "documentation":"If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide.
" }, "Tags":{ "shape":"TagList", @@ -2041,7 +2045,7 @@ }, "RoleArn":{ "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform tasks on your behalf.
During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of the algorithm.>
" + "documentation":"The Amazon Resource Name (ARN) of the algorithm.
" }, "AlgorithmDescription":{ "shape":"EntityDescription", @@ -2782,7 +2786,7 @@ }, "LabelCategoryConfigS3Uri":{ "shape":"S3Uri", - "documentation":"The S3 location of the JSON file that defines the categories used to label data objects.
" + "documentation":"The S3 location of the JSON file that defines the categories used to label data objects.
The file is a JSON structure in the following format:
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label 1\"
},
{
\"label\": \"label 2\"
},
...
{
\"label\": \"label n\"
}
]
}
A brief summary about the model package.
" + "documentation":"A brief summary of the model package.
" }, "CreationTime":{ "shape":"CreationTime", @@ -3513,18 +3517,18 @@ "members":{ "Name":{ "shape":"ResourcePropertyName", - "documentation":"A property name. For example, TrainingJobName. See TrainingJob properties for the list of valid property names for each supported resource.
A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The specified resource in Name equals the specified Value.
The specified resource in Name does not equal the specified Value.
The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
The specified resource in Name is less than the specified Value. Not supported for text-based properties.
The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value.
A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:
The specified resource in Name equals the specified Value.
The specified resource in Name does not equal the specified Value.
The specified resource in Name is greater than the specified Value. Not supported for text-based properties.
The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.
The specified resource in Name is less than the specified Value. Not supported for text-based properties.
The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.
Only supported for text-based properties. The word-list of the property contains the specified Value.
If you have specified a filter Value, the default is Equals.
A value used with Resource and Operator to determin if objects statisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.
A conditional statement for a search expression that includes a Boolean operator, a resource property, and a value.
If you don't specify an Operator and a Value, the filter searches for only the specified property. For example, defining a Filter for the FailureReason for the TrainingJob Resource searches for training job objects that have a value in the FailureReason field.
If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator as a default.
In search, there are several property types:
To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":
{
\"Name\": \"Metrics.accuracy\",
\"Operator\": \"GREATER_THAN\",
\"Value\": \"0.9\"
}
To define a hyperparameter filter, enter a value with the form \"HyperParamters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":
{
\"Name\": \"HyperParameters.learning_rate\",
\"Operator\": \"LESS_THAN\",
\"Value\": \"0.5\"
}
To define a tag filter, enter a value with the form \"Tags.<key>\".
A conditional statement for a search expression that includes a Boolean operator, a resource property, and a value.
If you don't specify an Operator and a Value, the filter searches for only the specified property. For example, defining a Filter for the FailureReason for the TrainingJob Resource searches for training job objects that have a value in the FailureReason field.
If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator as the default.
In search, there are several property types:
To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":
{
\"Name\": \"Metrics.accuracy\",
\"Operator\": \"GREATER_THAN\",
\"Value\": \"0.9\"
}
To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":
{
\"Name\": \"HyperParameters.learning_rate\",
\"Operator\": \"LESS_THAN\",
\"Value\": \"0.5\"
}
To define a tag filter, enter a value with the form \"Tags.<key>\".
The URL where the git repository is located.
" }, "Branch":{ "shape":"Branch", - "documentation":"The default brach for the git repository.
" + "documentation":"The default beach for the git repository.
" }, "SecretArn":{ "shape":"SecretArn", @@ -3628,6 +3632,10 @@ }, "documentation":"Specifies configuration details for a git repository when the repository is updated.
" }, + "GitConfigUrl":{ + "type":"string", + "pattern":"^https://([^/]+)/?(.*)$" + }, "HumanTaskConfig":{ "type":"structure", "required":[ @@ -3651,7 +3659,7 @@ }, "PreHumanTaskLambdaArn":{ "shape":"LambdaFunctionArn", - "documentation":"The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.
" + "documentation":"The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.
For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:
US East (Northern Virginia) (us-east-1):
arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox
arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass
US East (Ohio) (us-east-2):
arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
US West (Oregon) (us-west-2):
arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
EU (Ireland) (eu-west-1):
arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
Asia Pacific (Tokyo (ap-northeast-1):
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
The HyperParameterAlgorithmSpecification object that specifies the algorithm to use for the training jobs that the tuning job launches.
" + "documentation":"The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.
" }, "RoleArn":{ "shape":"RoleArn", @@ -3803,7 +3811,7 @@ }, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specifed VPC, but the training container does not have network access.
The Semantic Segmentation built-in algorithm does not support network isolation.
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
The Semantic Segmentation built-in algorithm does not support network isolation.
Defines the training jobs launched by a hyperparameter tuning job.
" @@ -3832,7 +3840,7 @@ }, "TuningJobName":{ "shape":"HyperParameterTuningJobName", - "documentation":"The name of the hyperparameter tuning job that launched this training job.
" + "documentation":"The HyperParameter tuning job that launched the training job.
" }, "CreationTime":{ "shape":"Timestamp", @@ -3901,7 +3909,7 @@ }, "TrainingJobEarlyStoppingType":{ "shape":"TrainingJobEarlyStoppingType", - "documentation":"Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. One of the following values:
Training jobs launched by the hyperparameter tuning job do not use early stopping.
Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are no longer improving as measured by the objective metric of the tuning job.
Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):
Training jobs launched by the hyperparameter tuning job do not use early stopping.
Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
Configures a hyperparameter tuning job.
" @@ -4112,7 +4120,7 @@ }, "DataInputConfig":{ "shape":"DataInputConfig", - "documentation":"Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.
TENSORFLOW, MXNET and ONNX: You must specify the name and shape of the expected data inputs in order using a dictionary format for your trained model.
Example of one input: {‘data’:[1,3,1024,1024]}}
Example for two inputs: {‘var1’: [1,1,28,28], ‘var2’:[1,1,28,28]}
PYTORCH: You can either specify the name and shape of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format.
Example of one input in dictionary format: {‘input0’:[1,3,224,234]}
Example of one input in list format: [1,3,224,224]
Example of two inputs in dictionary format: {‘input0’:[1,3,224,234], 'input1':[1,3,224,224]}
Example of two inputs in list format: [[1,3,224,224], [1,3,224,224]]
XGBOOST: input data name and shape are not needed.
Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.
TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {\"input\":[1,1024,1024,3]}
If using the CLI, {\\\"input\\\":[1,1024,1024,3]}
Examples for two inputs:
If using the console, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}
If using the CLI, {\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}
MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.
Examples for one input:
If using the console, {\"data\":[1,3,1024,1024]}
If using the CLI, {\\\"data\\\":[1,3,1024,1024]}
Examples for two inputs:
If using the console, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}
If using the CLI, {\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}
PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.
Examples for one input in dictionary format:
If using the console, {\"input0\":[1,3,224,224]}
If using the CLI, {\\\"input0\\\":[1,3,224,224]}
Example for one input in list format: [[1,3,224,224]]
Examples for two inputs in dictionary format:
If using the console, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}
If using the CLI, {\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]}
Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]
XGBOOST: input data name and shape are not needed.
A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.
" + }, + "SortBy":{ + "shape":"ListCompilationJobsSortBy", + "documentation":"The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
The Amazon EC2 Container Registry path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The ID of the model package.
" + "documentation":"The AWS Marketplace product ID of the model package.
" } }, "documentation":"Describes the Docker container for the model package.
" @@ -5666,7 +5690,7 @@ "members":{ "ValidationStatuses":{ "shape":"ModelPackageStatusItemList", - "documentation":"The status of the validation of the model package.
" + "documentation":"The validation status of the model package.
" }, "ImageScanStatuses":{ "shape":"ModelPackageStatusItemList", @@ -5684,7 +5708,7 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"The name of the model package for which the overall status is being repoorted.
" + "documentation":"The name of the model package for which the overall status is being reported.
" }, "Status":{ "shape":"DetailedModelPackageStatus", @@ -5692,7 +5716,7 @@ }, "FailureReason":{ "shape":"String", - "documentation":"The reason for failure, if the overall status is a failed state.
" + "documentation":"if the overall status is Failed, the reason for the failure.
Represents the overall status of a model package.
" @@ -5720,7 +5744,7 @@ }, "ModelPackageDescription":{ "shape":"EntityDescription", - "documentation":"A brief statement describing the model package.
" + "documentation":"A brief description of the model package.
" }, "CreationTime":{ "shape":"CreationTime", @@ -5753,7 +5777,7 @@ "documentation":"The TransformJobDefinition object that describes the transform job used for the validation of the model package.
Contains data such as the inputs and targeted instance types that are used in the process of validating the model package.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
" + "documentation":"Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.
The data provided in the validation profile is made available to your buyers on AWS Marketplace.
" }, "ModelPackageValidationProfiles":{ "type":"list", @@ -5770,7 +5794,7 @@ "members":{ "ValidationRole":{ "shape":"RoleArn", - "documentation":"The IAM roles to be used for the validation of a model package.
" + "documentation":"The IAM roles to be used for the validation of the model package.
" }, "ValidationProfiles":{ "shape":"ModelPackageValidationProfiles", @@ -5827,14 +5851,14 @@ "members":{ "NestedPropertyName":{ "shape":"ResourcePropertyName", - "documentation":".The name of the property used in the nested filters.
" + "documentation":"The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.
A list of filters. Each filter acts on a property. For example, a NestedFilters call might include a filter on the PropertyName parameter fof the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.
A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.
A NestedFilter is defined by using a resource name under NestedPropertyName, which entries in a list that properties must match to be included in the results. To satisfy the conditions specified in the NestedFilters call, each object in the list must satisfy the conditions of all of the filters.
For example, a NestedFilters could be defined using the training job's InputDataConfig property, this would be defined as a list of Channel objects.
A NestedFilters object contains multiple filters. For example, to find all training jobs that have train in their name, and have cat/data in their S3Uri (under InputDataConfig), you need to create a NestedFilters object that specfies the InputDataConfig property with the following Filter objects:
'{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"EQUALS\", \"Value\":\"train\"}',
'{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"CONTAINS\", \"Value\":\"cat/data\"}'
Defines a list of NestedFilter objects. To satisfy the conditions specified in the NestedFilters call, a resource must satisfy the conditions of all of the filters.
For example, a NestedFilters could be defined using the training job's InputDataConfig property, this would be defined as a list of Channel objects.
A NestedFilters object contains multiple filters. For example, to find all training jobs whose name contains train and that have cat/data in their S3Uri (specified in InputDataConfig), you need to create a NestedFilters object that specifies the InputDataConfig property with the following Filter objects:
'{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"EQUALS\", \"Value\":\"train\"}',
'{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"CONTAINS\", \"Value\":\"cat/data\"}'
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you don't provide the KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob request. Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.
Defines the possible values for categorical, continous, and integer hyperparameters to be used by an algorithm.
" + "documentation":"Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.
" }, "ParameterRanges":{ "type":"structure", @@ -6347,17 +6371,17 @@ "members":{ "PropertyNameHint":{ "shape":"PropertyNameHint", - "documentation":"The hyperparameter, metric, and tag key property names that begin with the specified hint.
" + "documentation":"Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the PropertyNameHint.
A suggestion query for retrieving property names.
" + "documentation":"A type of SuggestionQuery. A suggestion query for retrieving property names that match the specified hint.
A suggested property name.
" + "documentation":"A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.
" } }, "documentation":"A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.
Defines the amount of money paid to a worker in United States dollars.
" } }, - "documentation":"Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed. For more information, see Public Workforce Task Price.
" + "documentation":"Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
Use one of the following prices for bounding box tasks. Prices are in US dollars.
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.
0.012
0.024
0.036
0.048
0.060
0.072
0.120
0.240
0.360
0.480
0.600
0.720
0.840
0.960
1.080
1.200
Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.
0.840
0.960
1.080
1.200
A Tempateobject containing the worker UI template to render.
A Templateobject containing the worker UI template to render.
Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix.
A manifest might look like this: s3://bucketname/example.manifest
The manifest is an S3 object which is a JSON file with the following format:
[
{\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
]
The preceding JSON matches the following s3Uris:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-1
...
The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix.
A manifest might look like this: s3://bucketname/example.manifest
The manifest is an S3 object which is a JSON file with the following format:
[
{\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
]
The preceding JSON matches the following s3Uris:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-2
...
The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipemodes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.
If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.
If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.
Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.
In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.
A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or.
A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.
A multi-expression that searches for the specified resource or resources. All resource objects that satisfy the expression's condition are included in the search results.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects.
A Boolean operator: And or Or.
A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.
A SearchExpression contains the following components:
A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.
A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.
A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.
A Boolean operator: And or Or.
A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results.
" + "documentation":"A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.
The name of the resource property used to sort the SearchResults.
The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
How SearchResults are ordered. Valid values are Ascending or Descending.
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
Determines the shuffling order in ShuffleConfig. value.
Determines the shuffling order in ShuffleConfig value.
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
The maximum length of time, in seconds, that the training or compilation job can run. If the job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.
" + "documentation":"The maximum length of time, in seconds, that the training job can run. If model training does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. Maximum value is 5 days.
" } }, - "documentation":"Specifies how long a model training or compilation job can run. When the job reaches the limit, Amazon SageMaker ends the training job. Use this API to cap model processing cost.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of training is not lost.
Training algorithms provided by Amazon SageMaker automatically saves the intermediate results of a model training job (it is best effort case, as model might not be ready to save as some stages, for example training just started). This intermediate data is a valid model artifact. You can use it to create a model (CreateModel).
Specifies how long model training can run. When model training reaches the limit, Amazon SageMaker ends the training job. Use this API to cap model training cost.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of training is not lost.
Training algorithms provided by Amazon SageMaker automatically saves the intermediate results of a model training job (it is best effort case, as model might not be ready to save as some stages, for example training just started). This intermediate data is a valid model artifact. You can use it to create a model (CreateModel).
Defines a property name hint. Only property names that match the specified hint are included in the response.
" + "documentation":"A type of SuggestionQuery. Defines a property name hint. Only property names that match the specified hint are included in the response.
Limits the property names that are included in the response.
" @@ -7212,7 +7237,7 @@ }, "FinalMetricDataList":{ "shape":"FinalMetricDataList", - "documentation":"A list of final metric values that are set when the Training Job completes. Used only if the training job was configured to use metrics.
" + "documentation":"A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.
" }, "EnableNetworkIsolation":{ "shape":"Boolean", @@ -7407,7 +7432,7 @@ }, "SupportedTuningJobObjectiveMetrics":{ "shape":"HyperParameterTuningJobObjectives", - "documentation":"A list of the metrics that the alogorithm emits that can be used as the objective metric in a hyperparameter tuning job.
" + "documentation":"A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.
" } }, "documentation":"Defines how the algorithm is used for a training job.
" @@ -7456,7 +7481,7 @@ }, "SplitType":{ "shape":"SplitType", - "documentation":"The method to use to split the transform job's data into smaller batches. The default value is None. If you don't want to split the data, specify None. If you want to split records on a newline character boundary, specify Line. To split records according to the RecordIO format, specify RecordIO.
Amazon SageMaker will send maximum number of records per batch in each request up to the MaxPayloadInMB limit. For more information, see RecordIO data format.
For information about the RecordIO format, see Data Format.
The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.
For more information about the RecordIO data format, see Data Format in the MXNet documentation. For more information about the TFRecord fofmat, see Consuming TFRecord data in the TensorFlow documentation.
" } }, "documentation":"Describes the input source of a transform job and the way the transform job consumes it.
" @@ -7692,7 +7717,7 @@ "members":{ "UiTemplateS3Uri":{ "shape":"S3Uri", - "documentation":"The Amazon S3 bucket location of the UI template.
" + "documentation":"The Amazon S3 bucket location of the UI template. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.
" } }, "documentation":"Provided configuration information for the worker UI for a labeling job.
" diff --git a/services/securityhub/src/main/resources/codegen-resources/customization.config b/services/securityhub/src/main/resources/codegen-resources/customization.config index dbb2b77872f8..532e8858a198 100644 --- a/services/securityhub/src/main/resources/codegen-resources/customization.config +++ b/services/securityhub/src/main/resources/codegen-resources/customization.config @@ -2,5 +2,8 @@ "blacklistedSimpleMethods": [ "getEnabledStandards", "getInsights" + ], + "verifiedSimpleMethods": [ + "getFindings" ] } diff --git a/services/sfn/src/main/resources/codegen-resources/service-2.json b/services/sfn/src/main/resources/codegen-resources/service-2.json index fb978bc55ecd..1f67f55dec37 100644 --- a/services/sfn/src/main/resources/codegen-resources/service-2.json +++ b/services/sfn/src/main/resources/codegen-resources/service-2.json @@ -157,7 +157,7 @@ {"shape":"InvalidArn"}, {"shape":"InvalidToken"} ], - "documentation":"Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Lists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Lists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Lists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Lists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
List tags for a given resource.
" }, "SendTaskFailure":{ "name":"SendTaskFailure", @@ -280,6 +294,35 @@ ], "documentation":"Stops an execution.
" }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"ResourceNotFound"}, + {"shape":"TooManyTags"} + ], + "documentation":"Add a tag to a Step Functions resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"ResourceNotFound"} + ], + "documentation":"Remove a tag from a Step Functions resource
" + }, "UpdateStateMachine":{ "name":"UpdateStateMachine", "http":{ @@ -913,7 +956,7 @@ }, "nextToken":{ "shape":"PageToken", - "documentation":"If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"An array of tags associated with the resource.
" } } }, @@ -1297,6 +1359,15 @@ "max":1024, "min":1 }, + "ResourceNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceName":{"shape":"Arn"} + }, + "documentation":"Could not fine the referenced resource. Only state machine and activity ARNs are supported.
", + "exception":true + }, "ReverseOrder":{"type":"boolean"}, "SendTaskFailureInput":{ "type":"structure", @@ -1534,6 +1605,60 @@ } } }, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"The key of a tag.
" + }, + "value":{ + "shape":"TagValue", + "documentation":"The value of a tag.
" + } + }, + "documentation":"Tags are key-value pairs that can be associated with Step Functions state machines and activities.
" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The list of tags to add to a resource.
Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" }, "error":{ "shape":"SensitiveError", @@ -1578,16 +1703,19 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" + }, + "region":{ + "shape":"Name", + "documentation":"The region of the scheduled task
" }, - "region":{"shape":"Name"}, "parameters":{ "shape":"ConnectorParameters", - "documentation":"The JSON data passed to the connected service referenced in a task state.
" + "documentation":"The JSON data passed to the resource referenced in a task state.
" }, "timeoutInSeconds":{ "shape":"TimeoutInSeconds", @@ -1606,11 +1734,11 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" }, "error":{ "shape":"SensitiveError", @@ -1632,11 +1760,11 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" } }, "documentation":"Contains details about the start of a task during an execution.
" @@ -1650,11 +1778,11 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" }, "error":{ "shape":"SensitiveError", @@ -1665,7 +1793,7 @@ "documentation":"A more detailed explanation of the cause of the failure.
" } }, - "documentation":"" + "documentation":"Contains details about a task that failed to submit during an execution.
" }, "TaskSubmittedEventDetails":{ "type":"structure", @@ -1676,18 +1804,18 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" }, "output":{ "shape":"SensitiveData", - "documentation":"The response from a connected service when a task has started.
" + "documentation":"The response from a resource when a task has started.
" } }, - "documentation":"" + "documentation":"Contains details about a task submitted to a resource .
" }, "TaskSucceededEventDetails":{ "type":"structure", @@ -1698,18 +1826,18 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" }, "output":{ "shape":"SensitiveData", - "documentation":"The full JSON response from a connected service when a task has succeeded. This response becomes the output of the related task.
" + "documentation":"The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task.
" } }, - "documentation":"Contains details about the start of connected service by a task state.
" + "documentation":"Contains details about the successful completion of a task state.
" }, "TaskTimedOut":{ "type":"structure", @@ -1727,11 +1855,11 @@ "members":{ "resourceType":{ "shape":"Name", - "documentation":"The action of the connected service called by a task state.
" + "documentation":"The action of the resource called by a task state.
" }, "resource":{ "shape":"Name", - "documentation":"The service name of the connected service in a task state.
" + "documentation":"The service name of the resource in a task state.
" }, "error":{ "shape":"SensitiveError", @@ -1742,7 +1870,7 @@ "documentation":"A more detailed explanation of the cause of the failure.
" } }, - "documentation":"Contains details about a connected service timeout that occured during an execution.
" + "documentation":"Contains details about a resource timeout that occurred during an execution.
" }, "TaskToken":{ "type":"string", @@ -1751,6 +1879,37 @@ }, "TimeoutInSeconds":{"type":"long"}, "Timestamp":{"type":"timestamp"}, + "TooManyTags":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceName":{"shape":"Arn"} + }, + "documentation":"You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.
", + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tags to remove from the resource.
" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, "UpdateStateMachineInput":{ "type":"structure", "required":["stateMachineArn"], diff --git a/services/transcribe/src/main/resources/codegen-resources/service-2.json b/services/transcribe/src/main/resources/codegen-resources/service-2.json index 54f686bfe865..01d34a74bde4 100644 --- a/services/transcribe/src/main/resources/codegen-resources/service-2.json +++ b/services/transcribe/src/main/resources/codegen-resources/service-2.json @@ -27,7 +27,7 @@ {"shape":"InternalFailureException"}, {"shape":"ConflictException"} ], - "documentation":"Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.
" + "documentation":"Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
" }, "DeleteTranscriptionJob":{ "name":"DeleteTranscriptionJob", @@ -88,7 +88,7 @@ {"shape":"InternalFailureException"}, {"shape":"BadRequestException"} ], - "documentation":"Gets information about a vocabulary. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.
" + "documentation":"Gets information about a vocabulary.
" }, "ListTranscriptionJobs":{ "name":"ListTranscriptionJobs", @@ -134,7 +134,7 @@ {"shape":"InternalFailureException"}, {"shape":"ConflictException"} ], - "documentation":"Starts an asynchronous job to transcribe speech to text. Note that en-AU, en-UK, and fr-CA languages are in preview and are only available to whitelisted customers.
" + "documentation":"Starts an asynchronous job to transcribe speech to text.
" }, "UpdateVocabulary":{ "name":"UpdateVocabulary", @@ -151,7 +151,7 @@ {"shape":"NotFoundException"}, {"shape":"ConflictException"} ], - "documentation":"Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
When specified, returns only transcription jobs with the specified status.
" + "documentation":"When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
" }, "JobNameContains":{ "shape":"TranscriptionJobName", @@ -420,7 +421,7 @@ "members":{ "MediaFileUri":{ "shape":"Uri", - "documentation":"The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4
https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
" + "documentation":"The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4
https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
" } }, "documentation":"Describes the input media file in a transcription request.
" @@ -600,7 +601,7 @@ "documentation":"Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
" } }, - "documentation":"Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation. Note that en-AU, en-UK, and fr-CA languages are in preview and are only available to whitelisted customers.
Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.
Provides a summary of information about a transcription job. Note that en-AU, en-UK, and fr-CA languages are in preview and are only available to whitelisted customers.
" + "documentation":"Provides a summary of information about a transcription job. .
" }, "UpdateVocabularyRequest":{ "type":"structure", @@ -726,7 +727,7 @@ "documentation":"The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
Provides information about a custom vocabulary. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.
" + "documentation":"Provides information about a custom vocabulary.
" }, "VocabularyName":{ "type":"string", diff --git a/services/waf/src/main/resources/codegen-resources/waf/service-2.json b/services/waf/src/main/resources/codegen-resources/waf/service-2.json index 65e16779c70b..bf1a0c82e7c1 100644 --- a/services/waf/src/main/resources/codegen-resources/waf/service-2.json +++ b/services/waf/src/main/resources/codegen-resources/waf/service-2.json @@ -65,7 +65,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "CreateRateBasedRule":{ "name":"CreateRateBasedRule", @@ -131,7 +131,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a Rule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to specify the predicates that you want to include in the Rule.
Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to specify the predicates that you want to include in the Rule.
Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "CreateRuleGroup":{ "name":"CreateRuleGroup", @@ -953,9 +953,10 @@ "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFNonexistentItemException"}, - {"shape":"WAFStaleDataException"} + {"shape":"WAFStaleDataException"}, + {"shape":"WAFServiceLinkedRoleErrorException"} ], - "documentation":"Associates a LoggingConfiguration with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose delivery stream. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream.
Associate that delivery stream to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose delivery stream. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
Associates a LoggingConfiguration with a specified web ACL.
You can access information about all traffic that AWS WAF inspects using the following steps:
Create an Amazon Kinesis Data Firehose .
Associate that firehose to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule.
Create the Rule. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule.
Create and update a WebACL that contains the Rule. See CreateWebACL.
If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:
A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule.
Create the Rule. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule.
Create and update a WebACL that contains the Rule. See CreateWebACL.
If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "UpdateRuleGroup":{ "name":"UpdateRuleGroup", @@ -1175,7 +1176,7 @@ {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "UpdateWebACL":{ "name":"UpdateWebACL", @@ -1197,7 +1198,7 @@ {"shape":"WAFLimitsExceededException"}, {"shape":"WAFSubscriptionNotFoundException"} ], - "documentation":"Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.
The Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.
For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.
The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.
To create and configure a WebACL, perform the following steps:
Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
Create a WebACL. See CreateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.
The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.
For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.
The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.
To create and configure a WebACL, perform the following steps:
Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
Create a WebACL. See CreateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "UpdateXssMatchSet":{ "name":"UpdateXssMatchSet", @@ -1217,7 +1218,7 @@ {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" } }, "shapes":{ @@ -1239,7 +1240,7 @@ }, "Action":{ "shape":"WafAction", - "documentation":"Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:
ALLOW: CloudFront responds with the requested object.
BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:
ALLOW: CloudFront responds with the requested object.
BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.
An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.
Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.
If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
Submit an UpdateWebACL request that has two actions:
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.
The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.
The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch:
HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.
METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.
URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.
If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting value, QmFkQm90, in the value of TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" + "documentation":"The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch:
HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.
METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.
URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.
If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" }, "TextTransformation":{ "shape":"TextTransformation", @@ -1631,7 +1636,7 @@ }, "MetricName":{ "shape":"MetricName", - "documentation":"A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.
A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change the name of the metric after you create the Rule.
A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.
A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change MetricName after you create the WebACL.
The response to a request to delete an XssMatchSet from AWS WAF.
" }, + "ExcludedRule":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"The unique identifier for the rule to exclude from the rule group.
" + } + }, + "documentation":"The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is specified by the ActivatedRule.
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
WafAction: Contains Type
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
WafAction: Contains Type
An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple
XssMatchTuple: Contains FieldToMatch and TextTransformation
FieldToMatch: Contains Data and Type
An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple
XssMatchTuple: Contains FieldToMatch and TextTransformation
FieldToMatch: Contains Data and Type
A request to update an XssMatchSet.
" @@ -4744,6 +4766,14 @@ "documentation":"The operation failed because you tried to delete an object that is still in use. For example:
You tried to delete a ByteMatchSet that is still referenced by a Rule.
You tried to delete a Rule that is still referenced by a WebACL.
AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a XssMatchSetUpdate from an XssMatchSet.
Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.
This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.
" -} \ No newline at end of file +} diff --git a/services/waf/src/main/resources/codegen-resources/wafregional/service-2.json b/services/waf/src/main/resources/codegen-resources/wafregional/service-2.json index c7e850e94825..c5f5751f3b32 100644 --- a/services/waf/src/main/resources/codegen-resources/wafregional/service-2.json +++ b/services/waf/src/main/resources/codegen-resources/wafregional/service-2.json @@ -28,7 +28,7 @@ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFUnavailableEntityException"} ], - "documentation":"Associates a web ACL with a resource.
" + "documentation":"Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.
" }, "CreateByteMatchSet":{ "name":"CreateByteMatchSet", @@ -82,7 +82,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.
To create and configure an IPSet, perform the following steps:
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.
Submit a CreateIPSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "CreateRateBasedRule":{ "name":"CreateRateBasedRule", @@ -148,7 +148,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a Rule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to specify the predicates that you want to include in the Rule.
Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:
An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header
You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to specify the predicates that you want to include in the Rule.
Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "CreateRuleGroup":{ "name":"CreateRuleGroup", @@ -498,7 +498,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"} ], - "documentation":"Removes a web ACL from the specified resource.
" + "documentation":"Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.
" }, "GetByteMatchSet":{ "name":"GetByteMatchSet", @@ -764,7 +764,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFUnavailableEntityException"} ], - "documentation":"Returns the web ACL for the specified resource.
" + "documentation":"Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.
" }, "GetXssMatchSet":{ "name":"GetXssMatchSet", @@ -1182,7 +1182,7 @@ {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:
A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule.
Create the Rule. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule.
Create and update a WebACL that contains the Rule. See CreateWebACL.
If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:
A ByteMatchSet that matches the value BadBot in the User-Agent header
An IPSet that matches the IP address 192.0.2.44
You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.
To create and configure a Rule, perform the following steps:
Create and update the predicates that you want to include in the Rule.
Create the Rule. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRule request to add predicates to the Rule.
Create and update a WebACL that contains the Rule. See CreateWebACL.
If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "UpdateRuleGroup":{ "name":"UpdateRuleGroup", @@ -1242,7 +1242,7 @@ {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You can only specify a single type of TextTransformation.
You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure a SqlInjectionMatchSet, perform the following steps:
Submit a CreateSqlInjectionMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "UpdateWebACL":{ "name":"UpdateWebACL", @@ -1264,7 +1264,7 @@ {"shape":"WAFLimitsExceededException"}, {"shape":"WAFSubscriptionNotFoundException"} ], - "documentation":"Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.
The Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.
For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.
The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.
To create and configure a WebACL, perform the following steps:
Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
Create a WebACL. See CreateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:
A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.
The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.
For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.
The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.
To create and configure a WebACL, perform the following steps:
Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.
Create a WebACL. See CreateWebACL.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.
Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.
The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group.
If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules.
Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" }, "UpdateXssMatchSet":{ "name":"UpdateXssMatchSet", @@ -1284,7 +1284,7 @@ {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], - "documentation":"Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" + "documentation":"Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:
Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.
FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.
TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You can only specify a single type of TextTransformation.
You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.
To create and configure an XssMatchSet, perform the following steps:
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
" } }, "shapes":{ @@ -1306,7 +1306,7 @@ }, "Action":{ "shape":"WafAction", - "documentation":"Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:
ALLOW: CloudFront responds with the requested object.
BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:
ALLOW: CloudFront responds with the requested object.
BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.
An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.
Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.
Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.
If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:
Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.
Submit an UpdateWebACL request that has two actions:
The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.
The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.
The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.
A unique identifier (ID) for the web ACL.
" + "documentation":"A unique identifier (ID) for the web ACL.
" }, "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN (Amazon Resource Name) of the resource to be protected.
" + "documentation":"The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch:
HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.
METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.
URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.
If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting value, QmFkQm90, in the value of TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" + "documentation":"The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch:
HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.
METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.
URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.
If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
" }, "TextTransformation":{ "shape":"TextTransformation", @@ -1720,7 +1724,7 @@ }, "MetricName":{ "shape":"MetricName", - "documentation":"A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.
A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change the name of the metric after you create the Rule.
A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.
A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change MetricName after you create the WebACL.
The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed.
" + "documentation":"The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
The unique identifier for the rule to exclude from the rule group.
" + } + }, + "documentation":"The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is specified by the ActivatedRule.
The ARN (Amazon Resource Name) of the resource for which to get the web ACL.
" + "documentation":"The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.
The ARN should be in one of the following formats:
For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
The type of resource to list, either and application load balancer or Amazon API Gateway.
" + "documentation":"The type of resource to list, either an application load balancer or Amazon API Gateway.
" } } }, @@ -3645,7 +3664,8 @@ "GEO_MATCH_LOCATION_VALUE", "RATE_KEY", "RULE_TYPE", - "NEXT_MARKER" + "NEXT_MARKER", + "RESOURCE_ARN" ] }, "ParameterExceptionParameter":{ @@ -3656,7 +3676,8 @@ "type":"string", "enum":[ "INVALID_OPTION", - "ILLEGAL_COMBINATION" + "ILLEGAL_COMBINATION", + "ILLEGAL_ARGUMENT" ] }, "PolicyString":{ @@ -4753,7 +4774,7 @@ }, "Updates":{ "shape":"WebACLUpdates", - "documentation":"An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
WafAction: Contains Type
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:
WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
WafAction: Contains Type
An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple
XssMatchTuple: Contains FieldToMatch and TextTransformation
FieldToMatch: Contains Data and Type
An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple
XssMatchTuple: Contains FieldToMatch and TextTransformation
FieldToMatch: Contains Data and Type
A request to update an XssMatchSet.
" @@ -5110,7 +5131,7 @@ "members":{ "Action":{ "shape":"ChangeAction", - "documentation":"Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a XssMatchSetUpdate from an XssMatchSet.
Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.