dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/apigatewayv2/2018-11-29/service-2.json
TANIGUCHI Takaki ec7ff4b8b5 New upstream version 1.12.200+repack
2019-08-03 14:08:36 +09:00

6963 lines
321 KiB
JSON
Raw Blame History

{
"metadata" : {
"apiVersion" : "2018-11-29",
"endpointPrefix" : "apigateway",
"signingName" : "apigateway",
"serviceFullName" : "AmazonApiGatewayV2",
"serviceId" : "ApiGatewayV2",
"protocol" : "rest-json",
"jsonVersion" : "1.1",
"uid" : "apigatewayv2-2018-11-29",
"signatureVersion" : "v4"
},
"operations" : {
"CreateApi" : {
"name" : "CreateApi",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis",
"responseCode" : 201
},
"input" : {
"shape" : "CreateApiRequest"
},
"output" : {
"shape" : "CreateApiResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates an Api resource.</p>"
},
"CreateApiMapping" : {
"name" : "CreateApiMapping",
"http" : {
"method" : "POST",
"requestUri" : "/v2/domainnames/{domainName}/apimappings",
"responseCode" : 201
},
"input" : {
"shape" : "CreateApiMappingRequest"
},
"output" : {
"shape" : "CreateApiMappingResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates an API mapping.</p>"
},
"CreateAuthorizer" : {
"name" : "CreateAuthorizer",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/authorizers",
"responseCode" : 201
},
"input" : {
"shape" : "CreateAuthorizerRequest"
},
"output" : {
"shape" : "CreateAuthorizerResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates an Authorizer for an API.</p>"
},
"CreateDeployment" : {
"name" : "CreateDeployment",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/deployments",
"responseCode" : 201
},
"input" : {
"shape" : "CreateDeploymentRequest"
},
"output" : {
"shape" : "CreateDeploymentResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates a Deployment for an API.</p>"
},
"CreateDomainName" : {
"name" : "CreateDomainName",
"http" : {
"method" : "POST",
"requestUri" : "/v2/domainnames",
"responseCode" : 201
},
"input" : {
"shape" : "CreateDomainNameRequest"
},
"output" : {
"shape" : "CreateDomainNameResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates a domain name.</p>"
},
"CreateIntegration" : {
"name" : "CreateIntegration",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/integrations",
"responseCode" : 201
},
"input" : {
"shape" : "CreateIntegrationRequest"
},
"output" : {
"shape" : "CreateIntegrationResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates an Integration.</p>"
},
"CreateIntegrationResponse" : {
"name" : "CreateIntegrationResponse",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses",
"responseCode" : 201
},
"input" : {
"shape" : "CreateIntegrationResponseRequest"
},
"output" : {
"shape" : "CreateIntegrationResponseResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates an IntegrationResponses.</p>"
},
"CreateModel" : {
"name" : "CreateModel",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/models",
"responseCode" : 201
},
"input" : {
"shape" : "CreateModelRequest"
},
"output" : {
"shape" : "CreateModelResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates a Model for an API.</p>"
},
"CreateRoute" : {
"name" : "CreateRoute",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/routes",
"responseCode" : 201
},
"input" : {
"shape" : "CreateRouteRequest"
},
"output" : {
"shape" : "CreateRouteResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates a Route for an API.</p>"
},
"CreateRouteResponse" : {
"name" : "CreateRouteResponse",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses",
"responseCode" : 201
},
"input" : {
"shape" : "CreateRouteResponseRequest"
},
"output" : {
"shape" : "CreateRouteResponseResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates a RouteResponse for a Route.</p>"
},
"CreateStage" : {
"name" : "CreateStage",
"http" : {
"method" : "POST",
"requestUri" : "/v2/apis/{apiId}/stages",
"responseCode" : 201
},
"input" : {
"shape" : "CreateStageRequest"
},
"output" : {
"shape" : "CreateStageResponse",
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Creates a Stage for an API.</p>"
},
"DeleteApi" : {
"name" : "DeleteApi",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteApiRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes an Api resource.</p>"
},
"DeleteApiMapping" : {
"name" : "DeleteApiMapping",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteApiMappingRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Deletes an API mapping.</p>"
},
"DeleteAuthorizer" : {
"name" : "DeleteAuthorizer",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteAuthorizerRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes an Authorizer.</p>"
},
"DeleteDeployment" : {
"name" : "DeleteDeployment",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteDeploymentRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes a Deployment.</p>"
},
"DeleteDomainName" : {
"name" : "DeleteDomainName",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/domainnames/{domainName}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteDomainNameRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes a domain name.</p>"
},
"DeleteIntegration" : {
"name" : "DeleteIntegration",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteIntegrationRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes an Integration.</p>"
},
"DeleteIntegrationResponse" : {
"name" : "DeleteIntegrationResponse",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteIntegrationResponseRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes an IntegrationResponses.</p>"
},
"DeleteModel" : {
"name" : "DeleteModel",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/models/{modelId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteModelRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes a Model.</p>"
},
"DeleteRoute" : {
"name" : "DeleteRoute",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteRouteRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes a Route.</p>"
},
"DeleteRouteResponse" : {
"name" : "DeleteRouteResponse",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteRouteResponseRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes a RouteResponse.</p>"
},
"DeleteStage" : {
"name" : "DeleteStage",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/apis/{apiId}/stages/{stageName}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteStageRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Deletes a Stage.</p>"
},
"GetApi" : {
"name" : "GetApi",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetApiRequest"
},
"output" : {
"shape" : "GetApiResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets an Api resource.</p>"
},
"GetApiMapping" : {
"name" : "GetApiMapping",
"http" : {
"method" : "GET",
"requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetApiMappingRequest"
},
"output" : {
"shape" : "GetApiMappingResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>The API mapping.</p>"
},
"GetApiMappings" : {
"name" : "GetApiMappings",
"http" : {
"method" : "GET",
"requestUri" : "/v2/domainnames/{domainName}/apimappings",
"responseCode" : 200
},
"input" : {
"shape" : "GetApiMappingsRequest"
},
"output" : {
"shape" : "GetApiMappingsResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>The API mappings.</p>"
},
"GetApis" : {
"name" : "GetApis",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis",
"responseCode" : 200
},
"input" : {
"shape" : "GetApisRequest"
},
"output" : {
"shape" : "GetApisResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets a collection of Api resources.</p>"
},
"GetAuthorizer" : {
"name" : "GetAuthorizer",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetAuthorizerRequest"
},
"output" : {
"shape" : "GetAuthorizerResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets an Authorizer.</p>"
},
"GetAuthorizers" : {
"name" : "GetAuthorizers",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/authorizers",
"responseCode" : 200
},
"input" : {
"shape" : "GetAuthorizersRequest"
},
"output" : {
"shape" : "GetAuthorizersResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the Authorizers for an API.</p>"
},
"GetDeployment" : {
"name" : "GetDeployment",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetDeploymentRequest"
},
"output" : {
"shape" : "GetDeploymentResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a Deployment.</p>"
},
"GetDeployments" : {
"name" : "GetDeployments",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/deployments",
"responseCode" : 200
},
"input" : {
"shape" : "GetDeploymentsRequest"
},
"output" : {
"shape" : "GetDeploymentsResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the Deployments for an API.</p>"
},
"GetDomainName" : {
"name" : "GetDomainName",
"http" : {
"method" : "GET",
"requestUri" : "/v2/domainnames/{domainName}",
"responseCode" : 200
},
"input" : {
"shape" : "GetDomainNameRequest"
},
"output" : {
"shape" : "GetDomainNameResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a domain name.</p>"
},
"GetDomainNames" : {
"name" : "GetDomainNames",
"http" : {
"method" : "GET",
"requestUri" : "/v2/domainnames",
"responseCode" : 200
},
"input" : {
"shape" : "GetDomainNamesRequest"
},
"output" : {
"shape" : "GetDomainNamesResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the domain names for an AWS account.</p>"
},
"GetIntegration" : {
"name" : "GetIntegration",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetIntegrationRequest"
},
"output" : {
"shape" : "GetIntegrationResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets an Integration.</p>"
},
"GetIntegrationResponse" : {
"name" : "GetIntegrationResponse",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetIntegrationResponseRequest"
},
"output" : {
"shape" : "GetIntegrationResponseResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets an IntegrationResponses.</p>"
},
"GetIntegrationResponses" : {
"name" : "GetIntegrationResponses",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses",
"responseCode" : 200
},
"input" : {
"shape" : "GetIntegrationResponsesRequest"
},
"output" : {
"shape" : "GetIntegrationResponsesResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the IntegrationResponses for an Integration.</p>"
},
"GetIntegrations" : {
"name" : "GetIntegrations",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/integrations",
"responseCode" : 200
},
"input" : {
"shape" : "GetIntegrationsRequest"
},
"output" : {
"shape" : "GetIntegrationsResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the Integrations for an API.</p>"
},
"GetModel" : {
"name" : "GetModel",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/models/{modelId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetModelRequest"
},
"output" : {
"shape" : "GetModelResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a Model.</p>"
},
"GetModelTemplate" : {
"name" : "GetModelTemplate",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/models/{modelId}/template",
"responseCode" : 200
},
"input" : {
"shape" : "GetModelTemplateRequest"
},
"output" : {
"shape" : "GetModelTemplateResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a model template.</p>"
},
"GetModels" : {
"name" : "GetModels",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/models",
"responseCode" : 200
},
"input" : {
"shape" : "GetModelsRequest"
},
"output" : {
"shape" : "GetModelsResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the Models for an API.</p>"
},
"GetRoute" : {
"name" : "GetRoute",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetRouteRequest"
},
"output" : {
"shape" : "GetRouteResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a Route.</p>"
},
"GetRouteResponse" : {
"name" : "GetRouteResponse",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetRouteResponseRequest"
},
"output" : {
"shape" : "GetRouteResponseResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a RouteResponse.</p>"
},
"GetRouteResponses" : {
"name" : "GetRouteResponses",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses",
"responseCode" : 200
},
"input" : {
"shape" : "GetRouteResponsesRequest"
},
"output" : {
"shape" : "GetRouteResponsesResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the RouteResponses for a Route.</p>"
},
"GetRoutes" : {
"name" : "GetRoutes",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/routes",
"responseCode" : 200
},
"input" : {
"shape" : "GetRoutesRequest"
},
"output" : {
"shape" : "GetRoutesResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the Routes for an API.</p>"
},
"GetStage" : {
"name" : "GetStage",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/stages/{stageName}",
"responseCode" : 200
},
"input" : {
"shape" : "GetStageRequest"
},
"output" : {
"shape" : "GetStageResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
} ],
"documentation" : "<p>Gets a Stage.</p>"
},
"GetStages" : {
"name" : "GetStages",
"http" : {
"method" : "GET",
"requestUri" : "/v2/apis/{apiId}/stages",
"responseCode" : 200
},
"input" : {
"shape" : "GetStagesRequest"
},
"output" : {
"shape" : "GetStagesResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
} ],
"documentation" : "<p>Gets the Stages for an API.</p>"
},
"GetTags" : {
"name" : "GetTags",
"http" : {
"method" : "GET",
"requestUri" : "/v2/tags/{resource-arn}",
"responseCode" : 200
},
"input" : {
"shape" : "GetTagsRequest"
},
"output" : {
"shape" : "GetTagsResponse"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Gets the Tags for an API.</p>"
},
"TagResource" : {
"name" : "TagResource",
"http" : {
"method" : "POST",
"requestUri" : "/v2/tags/{resource-arn}",
"responseCode" : 201
},
"input" : {
"shape" : "TagResourceRequest"
},
"output" : {
"shape" : "TagResourceResponse"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Tag an APIGW resource</p>"
},
"UntagResource" : {
"name" : "UntagResource",
"http" : {
"method" : "DELETE",
"requestUri" : "/v2/tags/{resource-arn}",
"responseCode" : 204
},
"input" : {
"shape" : "UntagResourceRequest"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Untag an APIGW resource</p>"
},
"UpdateApi" : {
"name" : "UpdateApi",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateApiRequest"
},
"output" : {
"shape" : "UpdateApiResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates an Api resource.</p>"
},
"UpdateApiMapping" : {
"name" : "UpdateApiMapping",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateApiMappingRequest"
},
"output" : {
"shape" : "UpdateApiMappingResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>The API mapping.</p>"
},
"UpdateAuthorizer" : {
"name" : "UpdateAuthorizer",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateAuthorizerRequest"
},
"output" : {
"shape" : "UpdateAuthorizerResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates an Authorizer.</p>"
},
"UpdateDeployment" : {
"name" : "UpdateDeployment",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateDeploymentRequest"
},
"output" : {
"shape" : "UpdateDeploymentResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates a Deployment.</p>"
},
"UpdateDomainName" : {
"name" : "UpdateDomainName",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/domainnames/{domainName}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateDomainNameRequest"
},
"output" : {
"shape" : "UpdateDomainNameResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates a domain name.</p>"
},
"UpdateIntegration" : {
"name" : "UpdateIntegration",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateIntegrationRequest"
},
"output" : {
"shape" : "UpdateIntegrationResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates an Integration.</p>"
},
"UpdateIntegrationResponse" : {
"name" : "UpdateIntegrationResponse",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateIntegrationResponseRequest"
},
"output" : {
"shape" : "UpdateIntegrationResponseResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates an IntegrationResponses.</p>"
},
"UpdateModel" : {
"name" : "UpdateModel",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/models/{modelId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateModelRequest"
},
"output" : {
"shape" : "UpdateModelResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates a Model.</p>"
},
"UpdateRoute" : {
"name" : "UpdateRoute",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateRouteRequest"
},
"output" : {
"shape" : "UpdateRouteResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates a Route.</p>"
},
"UpdateRouteResponse" : {
"name" : "UpdateRouteResponse",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateRouteResponseRequest"
},
"output" : {
"shape" : "UpdateRouteResponseResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates a RouteResponse.</p>"
},
"UpdateStage" : {
"name" : "UpdateStage",
"http" : {
"method" : "PATCH",
"requestUri" : "/v2/apis/{apiId}/stages/{stageName}",
"responseCode" : 200
},
"input" : {
"shape" : "UpdateStageRequest"
},
"output" : {
"shape" : "UpdateStageResponse",
"documentation" : "<p>Success</p>"
},
"errors" : [ {
"shape" : "NotFoundException",
"documentation" : "<p>The resource specified in the request was not found.</p>"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of\n time.</p>"
}, {
"shape" : "BadRequestException",
"documentation" : "<p>One of the parameters in the request is invalid.</p>"
}, {
"shape" : "ConflictException",
"documentation" : "<p>The resource already exists.</p>"
} ],
"documentation" : "<p>Updates a Stage.</p>"
}
},
"shapes" : {
"AccessLogSettings" : {
"type" : "structure",
"members" : {
"DestinationArn" : {
"shape" : "Arn",
"locationName" : "destinationArn",
"documentation" : "<p>The ARN of the CloudWatch Logs log group to receive access logs.</p>"
},
"Format" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "format",
"documentation" : "<p>A single line format of the access logs of data, as specified by selected $context\n variables. The format must include at least $context.requestId.</p>"
}
},
"documentation" : "<p>Settings for logging access in a stage.</p>"
},
"Api" : {
"type" : "structure",
"members" : {
"ApiEndpoint" : {
"shape" : "__string",
"locationName" : "apiEndpoint",
"documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.</p>"
},
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API ID.</p>"
},
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the API was created.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"ProtocolType" : {
"shape" : "ProtocolType",
"locationName" : "protocolType",
"documentation" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
},
"Warnings" : {
"shape" : "__listOf__string",
"locationName" : "warnings",
"documentation" : "<p>The warning messages reported when failonwarnings is turned on during\n API import.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"documentation" : "<p>Represents an API.</p>",
"required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ]
},
"ApiMapping" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingId" : {
"shape" : "Id",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : "<p>The API mapping key.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
},
"documentation" : "<p>Represents an API mapping.</p>",
"required" : [ "Stage", "ApiId" ]
},
"ApiMappings" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfApiMapping",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of ApiMappings resources.</p>"
},
"Apis" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfApi",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of APIs.</p>"
},
"Arn" : {
"type" : "string",
"documentation" : "<p>Represents an Amazon Resource Name (ARN).</p>"
},
"AuthorizationScopes" : {
"type" : "list",
"documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>",
"member" : {
"shape" : "StringWithLengthBetween1And64"
}
},
"AuthorizationType" : {
"type" : "string",
"documentation" : "<p>The authorization type. Valid values are NONE for open access,\n AWS_IAM for using AWS IAM permissions, and CUSTOM for\n using a Lambda authorizer.</p>",
"enum" : [ "NONE", "AWS_IAM", "CUSTOM" ]
},
"Authorizer" : {
"type" : "structure",
"members" : {
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
},
"documentation" : "<p>Represents an authorizer.</p>",
"required" : [ "Name" ]
},
"AuthorizerType" : {
"type" : "string",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>",
"enum" : [ "REQUEST" ]
},
"Authorizers" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfAuthorizer",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of authorizers.</p>"
},
"BadRequestException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>Describes the error encountered.</p>"
}
},
"documentation" : "<p>The request is not valid, for example, the input is incomplete or incorrect. See\n the accompanying error message for details.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 400
}
},
"ConflictException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>Describes the error encountered.</p>"
}
},
"documentation" : "<p>The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request. See the accompanying error message for details.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 409
}
},
"ConnectionType" : {
"type" : "string",
"documentation" : "<p>Represents a connection type.</p>",
"enum" : [ "INTERNET", "VPC_LINK" ]
},
"ContentHandlingStrategy" : {
"type" : "string",
"documentation" : "<p>Specifies how to handle response payload content type conversions.</p>",
"enum" : [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ]
},
"CreateApiInput" : {
"type" : "structure",
"members" : {
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"ProtocolType" : {
"shape" : "ProtocolType",
"locationName" : "protocolType",
"documentation" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateApi request.</p>",
"required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ]
},
"CreateApiMappingInput" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : ""
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateApiMapping\n request.</p>",
"required" : [ "Stage", "ApiId" ]
},
"CreateApiMappingRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : ""
},
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
},
"required" : [ "DomainName", "Stage", "ApiId" ]
},
"CreateApiMappingResponse" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingId" : {
"shape" : "Id",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : "<p>The API mapping key.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
}
},
"CreateApiRequest" : {
"type" : "structure",
"members" : {
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"ProtocolType" : {
"shape" : "ProtocolType",
"locationName" : "protocolType",
"documentation" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ]
},
"CreateApiResponse" : {
"type" : "structure",
"members" : {
"ApiEndpoint" : {
"shape" : "__string",
"locationName" : "apiEndpoint",
"documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.</p>"
},
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API ID.</p>"
},
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the API was created.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"ProtocolType" : {
"shape" : "ProtocolType",
"locationName" : "protocolType",
"documentation" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
},
"Warnings" : {
"shape" : "__listOf__string",
"locationName" : "warnings",
"documentation" : "<p>The warning messages reported when failonwarnings is turned on during\n API import.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"CreateAuthorizerInput" : {
"type" : "structure",
"members" : {
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateAuthorizer\n request.</p>",
"required" : [ "AuthorizerUri", "AuthorizerType", "IdentitySource", "Name" ]
},
"CreateAuthorizerRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
},
"required" : [ "ApiId", "AuthorizerUri", "AuthorizerType", "IdentitySource", "Name" ]
},
"CreateAuthorizerResponse" : {
"type" : "structure",
"members" : {
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
}
},
"CreateDeploymentInput" : {
"type" : "structure",
"members" : {
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment resource.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the Stage resource for the Deployment\n resource to create.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateDeployment\n request.</p>"
},
"CreateDeploymentRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment resource.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the Stage resource for the Deployment\n resource to create.</p>"
}
},
"required" : [ "ApiId" ]
},
"CreateDeploymentResponse" : {
"type" : "structure",
"members" : {
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The date and time when the Deployment resource was created.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier for the deployment.</p>"
},
"DeploymentStatus" : {
"shape" : "DeploymentStatus",
"locationName" : "deploymentStatus",
"documentation" : "<p>The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.</p>"
},
"DeploymentStatusMessage" : {
"shape" : "__string",
"locationName" : "deploymentStatusMessage",
"documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment.</p>"
}
}
},
"CreateDomainNameInput" : {
"type" : "structure",
"members" : {
"DomainName" : {
"shape" : "StringWithLengthBetween1And512",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateDomainName\n request.</p>",
"required" : [ "DomainName" ]
},
"CreateDomainNameRequest" : {
"type" : "structure",
"members" : {
"DomainName" : {
"shape" : "StringWithLengthBetween1And512",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"required" : [ "DomainName" ]
},
"CreateDomainNameResponse" : {
"type" : "structure",
"members" : {
"ApiMappingSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiMappingSelectionExpression",
"documentation" : "<p>The API mapping selection expression.</p>"
},
"DomainName" : {
"shape" : "StringWithLengthBetween1And512",
"locationName" : "domainName",
"documentation" : "<p>The name of the DomainName resource.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"CreateIntegrationInput" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the integration.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateIntegration\n request.</p>",
"required" : [ "IntegrationType" ]
},
"CreateIntegrationRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the integration.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
},
"required" : [ "ApiId", "IntegrationType" ]
},
"CreateIntegrationResponse" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>Represents the description of an integration.</p>"
},
"IntegrationId" : {
"shape" : "Id",
"locationName" : "integrationId",
"documentation" : "<p>Represents the identifier of an integration.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "integrationResponseSelectionExpression",
"documentation" : "<p>The integration response selection expression for the integration. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
}
},
"CreateIntegrationResponseInput" : {
"type" : "structure",
"members" : {
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name},\n where {name} is a valid and unique header name. The mapped non-static\n value must match the pattern of integration.response.header.{name} or\n integration.response.body.{JSON-expression}, where\n {name} is a valid and unique response header name and\n {JSON-expression} is a valid JSON expression without the $\n prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration response.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateIntegrationResponse\n request.</p>",
"required" : [ "IntegrationResponseKey" ]
},
"CreateIntegrationResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name},\n where {name} is a valid and unique header name. The mapped non-static\n value must match the pattern of integration.response.header.{name} or\n integration.response.body.{JSON-expression}, where\n {name} is a valid and unique response header name and\n {JSON-expression} is a valid JSON expression without the $\n prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration response.</p>"
}
},
"required" : [ "ApiId", "IntegrationId", "IntegrationResponseKey" ]
},
"CreateIntegrationResponseResponse" : {
"type" : "structure",
"members" : {
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationResponseId" : {
"shape" : "Id",
"locationName" : "integrationResponseId",
"documentation" : "<p>The integration response ID.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expressions for the integration response.</p>"
}
}
},
"CreateModelInput" : {
"type" : "structure",
"members" : {
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model. Must be alphanumeric.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateModel request.</p>",
"required" : [ "Schema", "Name" ]
},
"CreateModelRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model. Must be alphanumeric.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
},
"required" : [ "ApiId", "Schema", "Name" ]
},
"CreateModelResponse" : {
"type" : "structure",
"members" : {
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"ModelId" : {
"shape" : "Id",
"locationName" : "modelId",
"documentation" : "<p>The model identifier.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model. Must be alphanumeric.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
}
},
"CreateRouteInput" : {
"type" : "structure",
"members" : {
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for the route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>The authorization scopes supported by this\n route.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateRoute request.</p>",
"required" : [ "RouteKey" ]
},
"CreateRouteRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for the route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>The authorization scopes supported by this\n route.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
},
"required" : [ "ApiId", "RouteKey" ]
},
"CreateRouteResponse" : {
"type" : "structure",
"members" : {
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for this route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteId" : {
"shape" : "Id",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
}
},
"CreateRouteResponseInput" : {
"type" : "structure",
"members" : {
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>The response models for the route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>The route response parameters.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>The route response key.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an CreateRouteResponse\n request.</p>",
"required" : [ "RouteResponseKey" ]
},
"CreateRouteResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>The response models for the route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>The route response parameters.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>The route response key.</p>"
}
},
"required" : [ "ApiId", "RouteId", "RouteResponseKey" ]
},
"CreateRouteResponseResponse" : {
"type" : "structure",
"members" : {
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>Represents the model selection expression of a route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>Represents the response models of a route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>Represents the response parameters of a route response.</p>"
},
"RouteResponseId" : {
"shape" : "Id",
"locationName" : "routeResponseId",
"documentation" : "<p>Represents the identifier of a route response.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>Represents the route response key of a route response.</p>"
}
}
},
"CreateStageInput" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>The default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment identifier of the API stage.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the API stage.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"documentation" : "<p>Represents the input parameters for a CreateStage request.</p>",
"required" : [ "StageName" ]
},
"CreateStageRequest" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>The default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment identifier of the API stage.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the API stage.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"required" : [ "ApiId", "StageName" ]
},
"CreateStageResponse" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the stage was created.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>Default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier of the Deployment that the Stage is\n associated with.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the stage.</p>"
},
"LastUpdatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "lastUpdatedDate",
"documentation" : "<p>The timestamp when the stage was last updated.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"DeleteApiMappingRequest" : {
"type" : "structure",
"members" : {
"ApiMappingId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
}
},
"required" : [ "ApiMappingId", "DomainName" ]
},
"DeleteApiRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
}
},
"required" : [ "ApiId" ]
},
"DeleteAuthorizerRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"AuthorizerId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
}
},
"required" : [ "AuthorizerId", "ApiId" ]
},
"DeleteDeploymentRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"DeploymentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment ID.</p>"
}
},
"required" : [ "ApiId", "DeploymentId" ]
},
"DeleteDomainNameRequest" : {
"type" : "structure",
"members" : {
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
}
},
"required" : [ "DomainName" ]
},
"DeleteIntegrationRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
}
},
"required" : [ "ApiId", "IntegrationId" ]
},
"DeleteIntegrationResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
},
"IntegrationResponseId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationResponseId",
"documentation" : "<p>The integration response ID.</p>"
}
},
"required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ]
},
"DeleteModelRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ModelId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "modelId",
"documentation" : "<p>The model ID.</p>"
}
},
"required" : [ "ModelId", "ApiId" ]
},
"DeleteRouteRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
}
},
"required" : [ "ApiId", "RouteId" ]
},
"DeleteRouteResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteResponseId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeResponseId",
"documentation" : "<p>The route response ID.</p>"
}
},
"required" : [ "RouteResponseId", "ApiId", "RouteId" ]
},
"DeleteStageRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"StageName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "stageName",
"documentation" : "<p>The stage name.</p>"
}
},
"required" : [ "StageName", "ApiId" ]
},
"Deployment" : {
"type" : "structure",
"members" : {
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The date and time when the Deployment resource was created.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier for the deployment.</p>"
},
"DeploymentStatus" : {
"shape" : "DeploymentStatus",
"locationName" : "deploymentStatus",
"documentation" : "<p>The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.</p>"
},
"DeploymentStatusMessage" : {
"shape" : "__string",
"locationName" : "deploymentStatusMessage",
"documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment.</p>"
}
},
"documentation" : "<p>An immutable representation of an API that can be called by users. A\n Deployment must be associated with a Stage for it to be\n callable over the internet.</p>"
},
"DeploymentStatus" : {
"type" : "string",
"documentation" : "<p>Represents a deployment status.</p>",
"enum" : [ "PENDING", "FAILED", "DEPLOYED" ]
},
"Deployments" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfDeployment",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>A collection resource that contains zero or more references to your existing\n deployments, and links that guide you on how to interact with your collection. The\n collection offers a paginated view of the contained deployments.</p>"
},
"DomainName" : {
"type" : "structure",
"members" : {
"ApiMappingSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiMappingSelectionExpression",
"documentation" : "<p>The API mapping selection expression.</p>"
},
"DomainName" : {
"shape" : "StringWithLengthBetween1And512",
"locationName" : "domainName",
"documentation" : "<p>The name of the DomainName resource.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"documentation" : "<p>Represents a domain name.</p>",
"required" : [ "DomainName" ]
},
"DomainNameConfiguration" : {
"type" : "structure",
"members" : {
"ApiGatewayDomainName" : {
"shape" : "__string",
"locationName" : "apiGatewayDomainName",
"documentation" : "<p>A domain name for the WebSocket API.</p>"
},
"CertificateArn" : {
"shape" : "Arn",
"locationName" : "certificateArn",
"documentation" : "<p>An AWS-managed certificate that will be used by the edge-optimized endpoint for\n this domain name. AWS Certificate Manager is the only supported source.</p>"
},
"CertificateName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "certificateName",
"documentation" : "<p>The user-friendly name of the certificate that will be used by the edge-optimized\n endpoint for this domain name.</p>"
},
"CertificateUploadDate" : {
"shape" : "__timestampIso8601",
"locationName" : "certificateUploadDate",
"documentation" : "<p>The timestamp when the certificate that was used by edge-optimized endpoint for\n this domain name was uploaded.</p>"
},
"EndpointType" : {
"shape" : "EndpointType",
"locationName" : "endpointType",
"documentation" : "<p>The endpoint type.</p>"
},
"HostedZoneId" : {
"shape" : "__string",
"locationName" : "hostedZoneId",
"documentation" : "<p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>"
},
"SecurityPolicy" : {
"shape" : "SecurityPolicy",
"locationName" : "securityPolicy",
"documentation" : "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>"
},
"DomainNameStatus" : {
"shape" : "DomainNameStatus",
"locationName" : "domainNameStatus",
"documentation" : "<p>The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>"
},
"DomainNameStatusMessage" : {
"shape" : "__string",
"locationName" : "domainNameStatusMessage",
"documentation" : "<p>An optional text message containing detailed information about status of the domain name migration.</p>"
}
},
"documentation" : "<p>The domain name configuration.</p>"
},
"DomainNameConfigurations" : {
"type" : "list",
"documentation" : "<p>The domain name configurations.</p>",
"member" : {
"shape" : "DomainNameConfiguration"
}
},
"DomainNames" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfDomainName",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of domain names.</p>"
},
"EndpointType" : {
"type" : "string",
"documentation" : "<p>Represents an endpoint type.</p>",
"enum" : [ "REGIONAL", "EDGE" ]
},
"SecurityPolicy" : {
"type" : "string",
"documentation" : "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>",
"enum" : [ "TLS_1_0", "TLS_1_2" ]
},
"DomainNameStatus" : {
"type" : "string",
"documentation" : "<p>The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>",
"enum" : [ "AVAILABLE", "UPDATING"]
},
"GetApiMappingRequest" : {
"type" : "structure",
"members" : {
"ApiMappingId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
}
},
"required" : [ "ApiMappingId", "DomainName" ]
},
"GetApiMappingResponse" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingId" : {
"shape" : "Id",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : "<p>The API mapping key.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
}
},
"GetApiMappingsRequest" : {
"type" : "structure",
"members" : {
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "DomainName" ]
},
"GetApiMappingsResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfApiMapping",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetApiRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetApiResponse" : {
"type" : "structure",
"members" : {
"ApiEndpoint" : {
"shape" : "__string",
"locationName" : "apiEndpoint",
"documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.</p>"
},
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API ID.</p>"
},
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the API was created.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"ProtocolType" : {
"shape" : "ProtocolType",
"locationName" : "protocolType",
"documentation" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
},
"Warnings" : {
"shape" : "__listOf__string",
"locationName" : "warnings",
"documentation" : "<p>The warning messages reported when failonwarnings is turned on during\n API import.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"GetApisRequest" : {
"type" : "structure",
"members" : {
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetApisResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfApi",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetAuthorizerRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"AuthorizerId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
}
},
"required" : [ "AuthorizerId", "ApiId" ]
},
"GetAuthorizerResponse" : {
"type" : "structure",
"members" : {
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
}
},
"GetAuthorizersRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetAuthorizersResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfAuthorizer",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetDeploymentRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"DeploymentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment ID.</p>"
}
},
"required" : [ "ApiId", "DeploymentId" ]
},
"GetDeploymentResponse" : {
"type" : "structure",
"members" : {
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The date and time when the Deployment resource was created.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier for the deployment.</p>"
},
"DeploymentStatus" : {
"shape" : "DeploymentStatus",
"locationName" : "deploymentStatus",
"documentation" : "<p>The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.</p>"
},
"DeploymentStatusMessage" : {
"shape" : "__string",
"locationName" : "deploymentStatusMessage",
"documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment.</p>"
}
}
},
"GetDeploymentsRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetDeploymentsResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfDeployment",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetDomainNameRequest" : {
"type" : "structure",
"members" : {
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
}
},
"required" : [ "DomainName" ]
},
"GetDomainNameResponse" : {
"type" : "structure",
"members" : {
"ApiMappingSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiMappingSelectionExpression",
"documentation" : "<p>The API mapping selection expression.</p>"
},
"DomainName" : {
"shape" : "StringWithLengthBetween1And512",
"locationName" : "domainName",
"documentation" : "<p>The name of the DomainName resource.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"GetDomainNamesRequest" : {
"type" : "structure",
"members" : {
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetDomainNamesResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfDomainName",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetIntegrationRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
}
},
"required" : [ "ApiId", "IntegrationId" ]
},
"GetIntegrationResponse" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>Represents the description of an integration.</p>"
},
"IntegrationId" : {
"shape" : "Id",
"locationName" : "integrationId",
"documentation" : "<p>Represents the identifier of an integration.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "integrationResponseSelectionExpression",
"documentation" : "<p>The integration response selection expression for the integration. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
}
},
"GetIntegrationResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
},
"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" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationResponseId" : {
"shape" : "Id",
"locationName" : "integrationResponseId",
"documentation" : "<p>The integration response ID.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expressions for the integration response.</p>"
}
}
},
"GetIntegrationResponsesRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "IntegrationId", "ApiId" ]
},
"GetIntegrationResponsesResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfIntegrationResponse",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetIntegrationsRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetIntegrationsResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfIntegration",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetModelRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ModelId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "modelId",
"documentation" : "<p>The model ID.</p>"
}
},
"required" : [ "ModelId", "ApiId" ]
},
"GetModelResponse" : {
"type" : "structure",
"members" : {
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"ModelId" : {
"shape" : "Id",
"locationName" : "modelId",
"documentation" : "<p>The model identifier.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model. Must be alphanumeric.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
}
},
"GetModelTemplateRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ModelId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "modelId",
"documentation" : "<p>The model ID.</p>"
}
},
"required" : [ "ModelId", "ApiId" ]
},
"GetModelTemplateResponse" : {
"type" : "structure",
"members" : {
"Value" : {
"shape" : "__string",
"locationName" : "value",
"documentation" : "<p>The template value.</p>"
}
}
},
"GetModelsRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetModelsResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfModel",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetRouteRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
}
},
"required" : [ "ApiId", "RouteId" ]
},
"GetRouteResponse" : {
"type" : "structure",
"members" : {
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for this route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteId" : {
"shape" : "Id",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
}
},
"GetRouteResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteResponseId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeResponseId",
"documentation" : "<p>The route response ID.</p>"
}
},
"required" : [ "RouteResponseId", "ApiId", "RouteId" ]
},
"GetRouteResponseResponse" : {
"type" : "structure",
"members" : {
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>Represents the model selection expression of a route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>Represents the response models of a route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>Represents the response parameters of a route response.</p>"
},
"RouteResponseId" : {
"shape" : "Id",
"locationName" : "routeResponseId",
"documentation" : "<p>Represents the identifier of a route response.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>Represents the route response key of a route response.</p>"
}
}
},
"GetRouteResponsesRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
}
},
"required" : [ "RouteId", "ApiId" ]
},
"GetRouteResponsesResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfRouteResponse",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetRoutesRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetRoutesResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfRoute",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"GetStageRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"StageName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "stageName",
"documentation" : "<p>The stage name.</p>"
}
},
"required" : [ "StageName", "ApiId" ]
},
"GetStageResponse" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the stage was created.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>Default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier of the Deployment that the Stage is\n associated with.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the stage.</p>"
},
"LastUpdatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "lastUpdatedDate",
"documentation" : "<p>The timestamp when the stage was last updated.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"GetStagesRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"MaxResults" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "maxResults",
"documentation" : "<p>The maximum number of elements to be returned for this resource.</p>"
},
"NextToken" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"required" : [ "ApiId" ]
},
"GetStagesResponse" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfStage",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
}
},
"Id" : {
"type" : "string",
"documentation" : "<p>The identifier.</p>"
},
"IdentitySourceList" : {
"type" : "list",
"documentation" : "<p>The identity source for which authorization is requested. For the REQUEST\n authorizer, this is required when authorization caching is enabled. The value is a\n comma-separated string of one or more mapping expressions of the specified request\n parameters. For example, if an Auth header, a Name query string parameter are defined\n as identity sources, this value is $method.request.header.Auth,\n $method.request.querystring.Name. These parameters will be used to derive\n the authorization caching key and to perform runtime validation of the REQUEST\n authorizer by verifying all of the identity-related request parameters are present,\n not null and non-empty. Only when this is true does the authorizer invoke the\n authorizer Lambda function, otherwise, it returns a 401 Unauthorized\n response without calling the Lambda function. The valid value is a string of\n comma-separated mapping expressions of the specified request parameters. When the\n authorization caching is not enabled, this property is optional.</p>",
"member" : {
"shape" : "__string"
}
},
"IntegerWithLengthBetween0And3600" : {
"type" : "integer",
"documentation" : "<p>An integer with a value between [0-3600].</p>",
"min" : -2147483648,
"max" : 2147483647
},
"IntegerWithLengthBetween50And29000" : {
"type" : "integer",
"documentation" : "<p>An integer with a value between [50-29000].</p>",
"min" : -2147483648,
"max" : 2147483647
},
"Integration" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>Represents the description of an integration.</p>"
},
"IntegrationId" : {
"shape" : "Id",
"locationName" : "integrationId",
"documentation" : "<p>Represents the identifier of an integration.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "integrationResponseSelectionExpression",
"documentation" : "<p>The integration response selection expression for the integration. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
},
"documentation" : "<p>Represents an integration.</p>"
},
"IntegrationParameters" : {
"type" : "map",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "StringWithLengthBetween1And512"
}
},
"IntegrationResponse" : {
"type" : "structure",
"members" : {
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationResponseId" : {
"shape" : "Id",
"locationName" : "integrationResponseId",
"documentation" : "<p>The integration response ID.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expressions for the integration response.</p>"
}
},
"documentation" : "<p>Represents an integration response.</p>",
"required" : [ "IntegrationResponseKey" ]
},
"IntegrationResponses" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfIntegrationResponse",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of integration responses.</p>"
},
"IntegrationType" : {
"type" : "string",
"documentation" : "<p>Represents an API method integration type.</p>",
"enum" : [ "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY" ]
},
"Integrations" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfIntegration",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of integrations.</p>"
},
"LimitExceededException" : {
"type" : "structure",
"members" : {
"LimitType" : {
"shape" : "__string",
"locationName" : "limitType",
"documentation" : "<p>The limit type.</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>Describes the error encountered.</p>"
}
},
"documentation" : "<p>A limit has been exceeded. See the accompanying error message for details.</p>"
},
"GetTagsRequest" : {
"type" : "structure",
"members" : {
"ResourceArn" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "resource-arn"
}
},
"required" : [ "ResourceArn" ]
},
"GetTagsResponse" : {
"type" : "structure",
"members" : {
"Tags" : {
"shape" : "__mapOf__string",
"locationName" : "tags"
}
}
},
"LoggingLevel" : {
"type" : "string",
"documentation" : "<p>The logging level.</p>",
"enum" : [ "ERROR", "INFO", "false" ]
},
"Model" : {
"type" : "structure",
"members" : {
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"ModelId" : {
"shape" : "Id",
"locationName" : "modelId",
"documentation" : "<p>The model identifier.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model. Must be alphanumeric.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
},
"documentation" : "<p>Represents a data model for an API. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response\n Mappings</a>.</p>",
"required" : [ "Name" ]
},
"Models" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfModel",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of data models. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response\n Mappings</a>.</p>"
},
"NextToken" : {
"type" : "string",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
},
"NotFoundException" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>Describes the error encountered.</p>"
},
"ResourceType" : {
"shape" : "__string",
"locationName" : "resourceType",
"documentation" : "<p>The resource type.</p>"
}
},
"documentation" : "<p>The resource specified in the request was not found. See the message\n field for more information.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 404
}
},
"ParameterConstraints" : {
"type" : "structure",
"members" : {
"Required" : {
"shape" : "__boolean",
"locationName" : "required",
"documentation" : "<p>Whether or not the parameter is required.</p>"
}
},
"documentation" : "<p>Validation constraints imposed on parameters of a request (path, query string,\n headers).</p>"
},
"PassthroughBehavior" : {
"type" : "string",
"documentation" : "<p>Represents passthrough behavior for an integration response.</p>",
"enum" : [ "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES" ]
},
"ProtocolType" : {
"type" : "string",
"documentation" : "",
"enum" : [ "WEBSOCKET" ]
},
"ProviderArnList" : {
"type" : "list",
"documentation" : "<p>For REQUEST authorizer, this is not defined.</p>",
"member" : {
"shape" : "Arn"
}
},
"Route" : {
"type" : "structure",
"members" : {
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for this route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteId" : {
"shape" : "Id",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
},
"documentation" : "<p>Represents a route.</p>",
"required" : [ "RouteKey" ]
},
"RouteModels" : {
"type" : "map",
"documentation" : "<p>The route models.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "StringWithLengthBetween1And128"
}
},
"RouteParameters" : {
"type" : "map",
"documentation" : "<p>The route parameters.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "ParameterConstraints"
}
},
"RouteResponse" : {
"type" : "structure",
"members" : {
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>Represents the model selection expression of a route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>Represents the response models of a route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>Represents the response parameters of a route response.</p>"
},
"RouteResponseId" : {
"shape" : "Id",
"locationName" : "routeResponseId",
"documentation" : "<p>Represents the identifier of a route response.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>Represents the route response key of a route response.</p>"
}
},
"documentation" : "<p>Represents a route response.</p>",
"required" : [ "RouteResponseKey" ]
},
"RouteResponses" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfRouteResponse",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of route responses.</p>"
},
"RouteSettings" : {
"type" : "structure",
"members" : {
"DataTraceEnabled" : {
"shape" : "__boolean",
"locationName" : "dataTraceEnabled",
"documentation" : "<p>Specifies whether (true) or not (false) data trace\n logging is enabled for this route. This property affects the log entries pushed to\n Amazon CloudWatch Logs.</p>"
},
"DetailedMetricsEnabled" : {
"shape" : "__boolean",
"locationName" : "detailedMetricsEnabled",
"documentation" : "<p>Specifies whether detailed metrics are enabled.</p>"
},
"LoggingLevel" : {
"shape" : "LoggingLevel",
"locationName" : "loggingLevel",
"documentation" : "<p>Specifies the logging level for this route: DEBUG, INFO,\n or WARN. This property affects the log entries pushed to Amazon\n CloudWatch Logs.</p>"
},
"ThrottlingBurstLimit" : {
"shape" : "__integer",
"locationName" : "throttlingBurstLimit",
"documentation" : "<p>Specifies the throttling burst limit.</p>"
},
"ThrottlingRateLimit" : {
"shape" : "__double",
"locationName" : "throttlingRateLimit",
"documentation" : "<p>Specifies the throttling rate limit.</p>"
}
},
"documentation" : "<p>Represents a collection of route settings.</p>"
},
"RouteSettingsMap" : {
"type" : "map",
"documentation" : "<p>The route settings map.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "RouteSettings"
}
},
"Routes" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfRoute",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>Represents a collection of routes.</p>"
},
"SelectionExpression" : {
"type" : "string",
"documentation" : "<p>An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.</p>"
},
"SelectionKey" : {
"type" : "string",
"documentation" : "<p>After evaulating a selection expression, the result is compared against one or\n more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's\n associated selection key type.</p>"
},
"Stage" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the stage was created.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>Default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier of the Deployment that the Stage is\n associated with.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the stage.</p>"
},
"LastUpdatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "lastUpdatedDate",
"documentation" : "<p>The timestamp when the stage was last updated.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"documentation" : "<p>Represents an API stage.</p>",
"required" : [ "StageName" ]
},
"StageVariablesMap" : {
"type" : "map",
"documentation" : "<p>The stage variable map.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "StringWithLengthBetween0And2048"
}
},
"Stages" : {
"type" : "structure",
"members" : {
"Items" : {
"shape" : "__listOfStage",
"locationName" : "items",
"documentation" : "<p>The elements from this collection.</p>"
},
"NextToken" : {
"shape" : "NextToken",
"locationName" : "nextToken",
"documentation" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
}
},
"documentation" : "<p>A collection of Stage resources that are associated with the ApiKey\n resource.</p>"
},
"StringWithLengthBetween0And1024" : {
"type" : "string",
"documentation" : "<p>A string with a length between [0-1024].</p>"
},
"StringWithLengthBetween0And2048" : {
"type" : "string",
"documentation" : "<p>A string with a length between [0-2048].</p>"
},
"StringWithLengthBetween0And32K" : {
"type" : "string",
"documentation" : "<p>A string with a length between [0-32768].</p>"
},
"StringWithLengthBetween1And1024" : {
"type" : "string",
"documentation" : "<p>A string with a length between [1-1024].</p>"
},
"StringWithLengthBetween1And128" : {
"type" : "string",
"documentation" : "<p>A string with a length between [1-128].</p>"
},
"StringWithLengthBetween1And256" : {
"type" : "string",
"documentation" : "<p>A string with a length between [1-256].</p>"
},
"StringWithLengthBetween1And512" : {
"type" : "string",
"documentation" : "<p>A string with a length between [1-512].</p>"
},
"StringWithLengthBetween1And64" : {
"type" : "string",
"documentation" : "<p>A string with a length between [1-64].</p>"
},
"StringWithLengthBetween1And1600" : {
"type" : "string",
"documentation" : "<p>A string with a length between [1-1600].</p>"
},
"TagResourceInput" : {
"type" : "structure",
"members" : {
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"TagResourceRequest" : {
"type" : "structure",
"members" : {
"ResourceArn" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "resource-arn",
"documentation" : "<p>AWS resource arn </p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
},
"required" : [ "ResourceArn" ]
},
"TagResourceResponse" : {
"type" : "structure",
"members" : { }
},
"Tags" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "StringWithLengthBetween1And1600"
}
},
"UntagResourceRequest" : {
"type" : "structure",
"members" : {
"ResourceArn" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "resource-arn",
"documentation" : "<p>AWS resource arn </p>"
},
"TagKeys" : {
"shape" : "__listOf__string",
"location" : "querystring",
"locationName" : "tagKeys",
"documentation" : "<p>The Tag keys to delete</p>"
}
},
"required" : [ "TagKeys", "ResourceArn" ]
},
"Template" : {
"type" : "structure",
"members" : {
"Value" : {
"shape" : "__string",
"locationName" : "value",
"documentation" : "<p>The template value.</p>"
}
},
"documentation" : "<p>Represents a template.</p>"
},
"TemplateMap" : {
"type" : "map",
"documentation" : "<p>A mapping of identifier keys to templates. The value is an actual template script.\n The key is typically a SelectionKey which is chosen based on evaluating\n a selection expression.</p>",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "StringWithLengthBetween0And32K"
}
},
"TooManyRequestsException" : {
"type" : "structure",
"members" : {
"LimitType" : {
"shape" : "__string",
"locationName" : "limitType",
"documentation" : "<p>The limit type.</p>"
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "<p>Describes the error encountered.</p>"
}
},
"documentation" : "<p>A limit has been exceeded. See the accompanying error message for details.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 429
}
},
"UpdateApiInput" : {
"type" : "structure",
"members" : {
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateApi request.</p>"
},
"UpdateApiMappingInput" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : "<p>The API mapping key.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateApiMapping\n request.</p>"
},
"UpdateApiMappingRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : "<p>The API mapping key.</p>"
},
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
},
"required" : [ "ApiMappingId", "ApiId", "DomainName" ]
},
"UpdateApiMappingResponse" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiMappingId" : {
"shape" : "Id",
"locationName" : "apiMappingId",
"documentation" : "<p>The API mapping identifier.</p>"
},
"ApiMappingKey" : {
"shape" : "SelectionKey",
"locationName" : "apiMappingKey",
"documentation" : "<p>The API mapping key.</p>"
},
"Stage" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stage",
"documentation" : "<p>The API stage.</p>"
}
}
},
"UpdateApiRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
}
},
"required" : [ "ApiId" ]
},
"UpdateApiResponse" : {
"type" : "structure",
"members" : {
"ApiEndpoint" : {
"shape" : "__string",
"locationName" : "apiEndpoint",
"documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.</p>"
},
"ApiId" : {
"shape" : "Id",
"locationName" : "apiId",
"documentation" : "<p>The API ID.</p>"
},
"ApiKeySelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiKeySelectionExpression",
"documentation" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the API was created.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the API.</p>"
},
"DisableSchemaValidation" : {
"shape" : "__boolean",
"locationName" : "disableSchemaValidation",
"documentation" : "<p>Avoid validating models when creating a deployment.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the API.</p>"
},
"ProtocolType" : {
"shape" : "ProtocolType",
"locationName" : "protocolType",
"documentation" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
},
"RouteSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeSelectionExpression",
"documentation" : "<p>The route selection expression for the API.</p>"
},
"Version" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "version",
"documentation" : "<p>A version identifier for the API.</p>"
},
"Warnings" : {
"shape" : "__listOf__string",
"locationName" : "warnings",
"documentation" : "<p>The warning messages reported when failonwarnings is turned on during\n API import.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"UpdateAuthorizerInput" : {
"type" : "structure",
"members" : {
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it is zero,\n authorization caching is disabled. If it is greater than zero, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth header, a\n Name query string parameter are defined as identity sources, this value is\n $method.request.header.Auth, $method.request.querystring.Name. These\n parameters will be used to derive the authorization caching key and to perform\n runtime validation of the REQUEST authorizer by verifying all of the\n identity-related request parameters are present, not null and non-empty. Only when\n this is true does the authorizer invoke the authorizer Lambda function, otherwise, it\n returns a 401 Unauthorized response without calling the Lambda function.\n The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
},
"documentation" : "<p>The input parameters for an UpdateAuthorizer request.</p>"
},
"UpdateAuthorizerRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it is zero,\n authorization caching is disabled. If it is greater than zero, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth header, a\n Name query string parameter are defined as identity sources, this value is\n $method.request.header.Auth, $method.request.querystring.Name. These\n parameters will be used to derive the authorization caching key and to perform\n runtime validation of the REQUEST authorizer by verifying all of the\n identity-related request parameters are present, not null and non-empty. Only when\n this is true does the authorizer invoke the authorizer Lambda function, otherwise, it\n returns a 401 Unauthorized response without calling the Lambda function.\n The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
},
"required" : [ "AuthorizerId", "ApiId" ]
},
"UpdateAuthorizerResponse" : {
"type" : "structure",
"members" : {
"AuthorizerCredentialsArn" : {
"shape" : "Arn",
"locationName" : "authorizerCredentialsArn",
"documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The authorizer identifier.</p>"
},
"AuthorizerResultTtlInSeconds" : {
"shape" : "IntegerWithLengthBetween0And3600",
"locationName" : "authorizerResultTtlInSeconds",
"documentation" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
},
"AuthorizerType" : {
"shape" : "AuthorizerType",
"locationName" : "authorizerType",
"documentation" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
},
"AuthorizerUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "authorizerUri",
"documentation" : "<p>The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>"
},
"IdentitySource" : {
"shape" : "IdentitySourceList",
"locationName" : "identitySource",
"documentation" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
},
"IdentityValidationExpression" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "identityValidationExpression",
"documentation" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the authorizer.</p>"
},
"ProviderArns" : {
"shape" : "ProviderArnList",
"locationName" : "providerArns",
"documentation" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
}
}
},
"UpdateDeploymentInput" : {
"type" : "structure",
"members" : {
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment resource.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateDeployment\n request.</p>"
},
"UpdateDeploymentRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"DeploymentId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment ID.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment resource.</p>"
}
},
"required" : [ "ApiId", "DeploymentId" ]
},
"UpdateDeploymentResponse" : {
"type" : "structure",
"members" : {
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The date and time when the Deployment resource was created.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier for the deployment.</p>"
},
"DeploymentStatus" : {
"shape" : "DeploymentStatus",
"locationName" : "deploymentStatus",
"documentation" : "<p>The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.</p>"
},
"DeploymentStatusMessage" : {
"shape" : "__string",
"locationName" : "deploymentStatusMessage",
"documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the deployment.</p>"
}
}
},
"UpdateDomainNameInput" : {
"type" : "structure",
"members" : {
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateDomainName\n request.</p>"
},
"UpdateDomainNameRequest" : {
"type" : "structure",
"members" : {
"DomainName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "domainName",
"documentation" : "<p>The domain name.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
}
},
"required" : [ "DomainName" ]
},
"UpdateDomainNameResponse" : {
"type" : "structure",
"members" : {
"ApiMappingSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "apiMappingSelectionExpression",
"documentation" : "<p>The API mapping selection expression.</p>"
},
"DomainName" : {
"shape" : "StringWithLengthBetween1And512",
"locationName" : "domainName",
"documentation" : "<p>The name of the DomainName resource.</p>"
},
"DomainNameConfigurations" : {
"shape" : "DomainNameConfigurations",
"locationName" : "domainNameConfigurations",
"documentation" : "<p>The domain name configurations.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"UpdateIntegrationInput" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the integration</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateIntegration\n request.</p>"
},
"UpdateIntegrationRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the integration</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
},
"required" : [ "ApiId", "IntegrationId" ]
},
"UpdateIntegrationResponse" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "StringWithLengthBetween1And1024",
"locationName" : "connectionId",
"documentation" : "<p>The connection ID.</p>"
},
"ConnectionType" : {
"shape" : "ConnectionType",
"locationName" : "connectionType",
"documentation" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"CredentialsArn" : {
"shape" : "Arn",
"locationName" : "credentialsArn",
"documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>Represents the description of an integration.</p>"
},
"IntegrationId" : {
"shape" : "Id",
"locationName" : "integrationId",
"documentation" : "<p>Represents the identifier of an integration.</p>"
},
"IntegrationMethod" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "integrationMethod",
"documentation" : "<p>Specifies the integration's HTTP method type.</p>"
},
"IntegrationResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "integrationResponseSelectionExpression",
"documentation" : "<p>The integration response selection expression for the integration. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>"
},
"IntegrationType" : {
"shape" : "IntegrationType",
"locationName" : "integrationType",
"documentation" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
},
"IntegrationUri" : {
"shape" : "UriWithLengthBetween1And2048",
"locationName" : "integrationUri",
"documentation" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
},
"PassthroughBehavior" : {
"shape" : "PassthroughBehavior",
"locationName" : "passthroughBehavior",
"documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
},
"RequestParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "requestParameters",
"documentation" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>"
},
"RequestTemplates" : {
"shape" : "TemplateMap",
"locationName" : "requestTemplates",
"documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration.</p>"
},
"TimeoutInMillis" : {
"shape" : "IntegerWithLengthBetween50And29000",
"locationName" : "timeoutInMillis",
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
}
}
},
"UpdateIntegrationResponseInput" : {
"type" : "structure",
"members" : {
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of\n method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value\n must match the pattern of\n integration.response.header.{name}\n or\n integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration response.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateIntegrationResponse\n request.</p>"
},
"UpdateIntegrationResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationId",
"documentation" : "<p>The integration ID.</p>"
},
"IntegrationResponseId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "integrationResponseId",
"documentation" : "The integration response ID."
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of\n method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value\n must match the pattern of\n integration.response.header.{name}\n or\n integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expression for the integration response.</p>"
}
},
"required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ]
},
"UpdateIntegrationResponseResponse" : {
"type" : "structure",
"members" : {
"ContentHandlingStrategy" : {
"shape" : "ContentHandlingStrategy",
"locationName" : "contentHandlingStrategy",
"documentation" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
},
"IntegrationResponseId" : {
"shape" : "Id",
"locationName" : "integrationResponseId",
"documentation" : "<p>The integration response ID.</p>"
},
"IntegrationResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "integrationResponseKey",
"documentation" : "<p>The integration response key.</p>"
},
"ResponseParameters" : {
"shape" : "IntegrationParameters",
"locationName" : "responseParameters",
"documentation" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>"
},
"ResponseTemplates" : {
"shape" : "TemplateMap",
"locationName" : "responseTemplates",
"documentation" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
},
"TemplateSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "templateSelectionExpression",
"documentation" : "<p>The template selection expressions for the integration response.</p>"
}
}
},
"UpdateModelInput" : {
"type" : "structure",
"members" : {
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateModel request.</p>"
},
"UpdateModelRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"ModelId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "modelId",
"documentation" : "<p>The model ID.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
},
"required" : [ "ModelId", "ApiId" ]
},
"UpdateModelResponse" : {
"type" : "structure",
"members" : {
"ContentType" : {
"shape" : "StringWithLengthBetween1And256",
"locationName" : "contentType",
"documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the model.</p>"
},
"ModelId" : {
"shape" : "Id",
"locationName" : "modelId",
"documentation" : "<p>The model identifier.</p>"
},
"Name" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "name",
"documentation" : "<p>The name of the model. Must be alphanumeric.</p>"
},
"Schema" : {
"shape" : "StringWithLengthBetween0And32K",
"locationName" : "schema",
"documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
}
}
},
"UpdateRouteInput" : {
"type" : "structure",
"members" : {
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for the route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>The authorization scopes supported by this\n route.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateRoute request.</p>"
},
"UpdateRouteRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for the route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>The authorization scopes supported by this\n route.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
},
"required" : [ "ApiId", "RouteId" ]
},
"UpdateRouteResponse" : {
"type" : "structure",
"members" : {
"ApiKeyRequired" : {
"shape" : "__boolean",
"locationName" : "apiKeyRequired",
"documentation" : "<p>Specifies whether an API key is required for this route.</p>"
},
"AuthorizationScopes" : {
"shape" : "AuthorizationScopes",
"locationName" : "authorizationScopes",
"documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>"
},
"AuthorizationType" : {
"shape" : "AuthorizationType",
"locationName" : "authorizationType",
"documentation" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer</p>"
},
"AuthorizerId" : {
"shape" : "Id",
"locationName" : "authorizerId",
"documentation" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route.</p>"
},
"OperationName" : {
"shape" : "StringWithLengthBetween1And64",
"locationName" : "operationName",
"documentation" : "<p>The operation name for the route.</p>"
},
"RequestModels" : {
"shape" : "RouteModels",
"locationName" : "requestModels",
"documentation" : "<p>The request models for the route.</p>"
},
"RequestParameters" : {
"shape" : "RouteParameters",
"locationName" : "requestParameters",
"documentation" : "<p>The request parameters for the route.</p>"
},
"RouteId" : {
"shape" : "Id",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteKey" : {
"shape" : "SelectionKey",
"locationName" : "routeKey",
"documentation" : "<p>The route key for the route.</p>"
},
"RouteResponseSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "routeResponseSelectionExpression",
"documentation" : "<p>The route response selection expression for the route.</p>"
},
"Target" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "target",
"documentation" : "<p>The target for the route.</p>"
}
}
},
"UpdateRouteResponseInput" : {
"type" : "structure",
"members" : {
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>The response models for the route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>The route response parameters.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>The route response key.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateRouteResponse\n request.</p>"
},
"UpdateRouteResponseRequest" : {
"type" : "structure",
"members" : {
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>The model selection expression for the route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>The response models for the route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>The route response parameters.</p>"
},
"RouteId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeId",
"documentation" : "<p>The route ID.</p>"
},
"RouteResponseId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "routeResponseId",
"documentation" : "<p>The route response ID.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>The route response key.</p>"
}
},
"required" : [ "RouteResponseId", "ApiId", "RouteId" ]
},
"UpdateRouteResponseResponse" : {
"type" : "structure",
"members" : {
"ModelSelectionExpression" : {
"shape" : "SelectionExpression",
"locationName" : "modelSelectionExpression",
"documentation" : "<p>Represents the model selection expression of a route response.</p>"
},
"ResponseModels" : {
"shape" : "RouteModels",
"locationName" : "responseModels",
"documentation" : "<p>Represents the response models of a route response.</p>"
},
"ResponseParameters" : {
"shape" : "RouteParameters",
"locationName" : "responseParameters",
"documentation" : "<p>Represents the response parameters of a route response.</p>"
},
"RouteResponseId" : {
"shape" : "Id",
"locationName" : "routeResponseId",
"documentation" : "<p>Represents the identifier of a route response.</p>"
},
"RouteResponseKey" : {
"shape" : "SelectionKey",
"locationName" : "routeResponseKey",
"documentation" : "<p>Represents the route response key of a route response.</p>"
}
}
},
"UpdateStageInput" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>The default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment identifier for the API stage.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the API stage.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
}
},
"documentation" : "<p>Represents the input parameters for an UpdateStage request.</p>"
},
"UpdateStageRequest" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ApiId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "apiId",
"documentation" : "<p>The API identifier.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>The default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The deployment identifier for the API stage.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description for the API stage.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "stageName",
"documentation" : "<p>The stage name.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
}
},
"required" : [ "StageName", "ApiId" ]
},
"UpdateStageResponse" : {
"type" : "structure",
"members" : {
"AccessLogSettings" : {
"shape" : "AccessLogSettings",
"locationName" : "accessLogSettings",
"documentation" : "<p>Settings for logging access in this stage.</p>"
},
"ClientCertificateId" : {
"shape" : "Id",
"locationName" : "clientCertificateId",
"documentation" : "<p>The identifier of a client certificate for a Stage.</p>"
},
"CreatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "createdDate",
"documentation" : "<p>The timestamp when the stage was created.</p>"
},
"DefaultRouteSettings" : {
"shape" : "RouteSettings",
"locationName" : "defaultRouteSettings",
"documentation" : "<p>Default route settings for the stage.</p>"
},
"DeploymentId" : {
"shape" : "Id",
"locationName" : "deploymentId",
"documentation" : "<p>The identifier of the Deployment that the Stage is\n associated with.</p>"
},
"Description" : {
"shape" : "StringWithLengthBetween0And1024",
"locationName" : "description",
"documentation" : "<p>The description of the stage.</p>"
},
"LastUpdatedDate" : {
"shape" : "__timestampIso8601",
"locationName" : "lastUpdatedDate",
"documentation" : "<p>The timestamp when the stage was last updated.</p>"
},
"RouteSettings" : {
"shape" : "RouteSettingsMap",
"locationName" : "routeSettings",
"documentation" : "<p>Route settings for the stage.</p>"
},
"StageName" : {
"shape" : "StringWithLengthBetween1And128",
"locationName" : "stageName",
"documentation" : "<p>The name of the stage.</p>"
},
"StageVariables" : {
"shape" : "StageVariablesMap",
"locationName" : "stageVariables",
"documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
},
"Tags" : {
"shape" : "Tags",
"locationName" : "tags",
"documentation" : "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..</p>"
}
}
},
"UriWithLengthBetween1And2048" : {
"type" : "string",
"documentation" : "<p>A string representation of a URI with a length between [1-2048].</p>"
},
"__boolean" : {
"type" : "boolean"
},
"__double" : {
"type" : "double"
},
"__integer" : {
"type" : "integer"
},
"__listOfApi" : {
"type" : "list",
"member" : {
"shape" : "Api"
}
},
"__listOfApiMapping" : {
"type" : "list",
"member" : {
"shape" : "ApiMapping"
}
},
"__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"
},
"__mapOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__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" : "<p>Amazon API Gateway V2</p>"
}
Reference in a new issue View git blame Copy permalink