The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates an Api resource.
" }, "CreateApiMapping": { "name": "CreateApiMapping", "http": { "method": "POST", "requestUri": "/v2/domainnames/{domainName}/apimappings", "responseCode": 201 }, "input": { "shape": "CreateApiMappingRequest" }, "output": { "shape": "CreateApiMappingResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates an API mapping.
" }, "CreateAuthorizer": { "name": "CreateAuthorizer", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/authorizers", "responseCode": 201 }, "input": { "shape": "CreateAuthorizerRequest" }, "output": { "shape": "CreateAuthorizerResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates an Authorizer for an API.
" }, "CreateDeployment": { "name": "CreateDeployment", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/deployments", "responseCode": 201 }, "input": { "shape": "CreateDeploymentRequest" }, "output": { "shape": "CreateDeploymentResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates a Deployment for an API.
" }, "CreateDomainName": { "name": "CreateDomainName", "http": { "method": "POST", "requestUri": "/v2/domainnames", "responseCode": 201 }, "input": { "shape": "CreateDomainNameRequest" }, "output": { "shape": "CreateDomainNameResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" }, { "shape": "AccessDeniedException", "documentation": "403 response
" } ], "documentation": "Creates a domain name.
" }, "CreateIntegration": { "name": "CreateIntegration", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/integrations", "responseCode": 201 }, "input": { "shape": "CreateIntegrationRequest" }, "output": { "shape": "CreateIntegrationResult", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates an Integration.
" }, "CreateIntegrationResponse": { "name": "CreateIntegrationResponse", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", "responseCode": 201 }, "input": { "shape": "CreateIntegrationResponseRequest" }, "output": { "shape": "CreateIntegrationResponseResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates an IntegrationResponses.
" }, "CreateModel": { "name": "CreateModel", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/models", "responseCode": 201 }, "input": { "shape": "CreateModelRequest" }, "output": { "shape": "CreateModelResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates a Model for an API.
" }, "CreateRoute": { "name": "CreateRoute", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/routes", "responseCode": 201 }, "input": { "shape": "CreateRouteRequest" }, "output": { "shape": "CreateRouteResult", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates a Route for an API.
" }, "CreateRouteResponse": { "name": "CreateRouteResponse", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses", "responseCode": 201 }, "input": { "shape": "CreateRouteResponseRequest" }, "output": { "shape": "CreateRouteResponseResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates a RouteResponse for a Route.
" }, "CreateStage": { "name": "CreateStage", "http": { "method": "POST", "requestUri": "/v2/apis/{apiId}/stages", "responseCode": 201 }, "input": { "shape": "CreateStageRequest" }, "output": { "shape": "CreateStageResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates a Stage for an API.
" }, "CreateVpcLink": { "name": "CreateVpcLink", "http": { "method": "POST", "requestUri": "/v2/vpclinks", "responseCode": 201 }, "input": { "shape": "CreateVpcLinkRequest" }, "output": { "shape": "CreateVpcLinkResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Creates a VPC link.
" }, "DeleteAccessLogSettings": { "name": "DeleteAccessLogSettings", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/stages/{stageName}/accesslogsettings", "responseCode": 204 }, "input": { "shape": "DeleteAccessLogSettingsRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
" }, "DeleteApi": { "name": "DeleteApi", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}", "responseCode": 204 }, "input": { "shape": "DeleteApiRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes an Api resource.
" }, "DeleteApiMapping": { "name": "DeleteApiMapping", "http": { "method": "DELETE", "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", "responseCode": 204 }, "input": { "shape": "DeleteApiMappingRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Deletes an API mapping.
" }, "DeleteAuthorizer": { "name": "DeleteAuthorizer", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", "responseCode": 204 }, "input": { "shape": "DeleteAuthorizerRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes an Authorizer.
" }, "DeleteCorsConfiguration": { "name": "DeleteCorsConfiguration", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/cors", "responseCode": 204 }, "input": { "shape": "DeleteCorsConfigurationRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a CORS configuration.
" }, "DeleteDeployment": { "name": "DeleteDeployment", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", "responseCode": 204 }, "input": { "shape": "DeleteDeploymentRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a Deployment.
" }, "DeleteDomainName": { "name": "DeleteDomainName", "http": { "method": "DELETE", "requestUri": "/v2/domainnames/{domainName}", "responseCode": 204 }, "input": { "shape": "DeleteDomainNameRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a domain name.
" }, "DeleteIntegration": { "name": "DeleteIntegration", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", "responseCode": 204 }, "input": { "shape": "DeleteIntegrationRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes an Integration.
" }, "DeleteIntegrationResponse": { "name": "DeleteIntegrationResponse", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", "responseCode": 204 }, "input": { "shape": "DeleteIntegrationResponseRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes an IntegrationResponses.
" }, "DeleteModel": { "name": "DeleteModel", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/models/{modelId}", "responseCode": 204 }, "input": { "shape": "DeleteModelRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a Model.
" }, "DeleteRoute": { "name": "DeleteRoute", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/routes/{routeId}", "responseCode": 204 }, "input": { "shape": "DeleteRouteRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a Route.
" }, "DeleteRouteRequestParameter": { "name": "DeleteRouteRequestParameter", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}", "responseCode": 204 }, "input": { "shape": "DeleteRouteRequestParameterRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a route request parameter. Supported only for WebSocket APIs.
" }, "DeleteRouteResponse": { "name": "DeleteRouteResponse", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", "responseCode": 204 }, "input": { "shape": "DeleteRouteResponseRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a RouteResponse.
" }, "DeleteRouteSettings": { "name": "DeleteRouteSettings", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}", "responseCode": 204 }, "input": { "shape": "DeleteRouteSettingsRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes the RouteSettings for a stage.
" }, "DeleteStage": { "name": "DeleteStage", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/stages/{stageName}", "responseCode": 204 }, "input": { "shape": "DeleteStageRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a Stage.
" }, "DeleteVpcLink": { "name": "DeleteVpcLink", "http": { "method": "DELETE", "requestUri": "/v2/vpclinks/{vpcLinkId}", "responseCode": 202 }, "input": { "shape": "DeleteVpcLinkRequest" }, "output": { "shape": "DeleteVpcLinkResponse", "documentation": "202 response
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Deletes a VPC link.
" }, "ExportApi": { "name": "ExportApi", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/exports/{specification}", "responseCode": 200 }, "input": { "shape": "ExportApiRequest" }, "output": { "shape": "ExportApiResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ] }, "ResetAuthorizersCache": { "name": "ResetAuthorizersCache", "http": { "method": "DELETE", "requestUri": "/v2/apis/{apiId}/stages/{stageName}/cache/authorizers", "responseCode": 204 }, "input": { "shape": "ResetAuthorizersCacheRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.
" }, "GetApi": { "name": "GetApi", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}", "responseCode": 200 }, "input": { "shape": "GetApiRequest" }, "output": { "shape": "GetApiResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets an Api resource.
" }, "GetApiMapping": { "name": "GetApiMapping", "http": { "method": "GET", "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", "responseCode": 200 }, "input": { "shape": "GetApiMappingRequest" }, "output": { "shape": "GetApiMappingResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets an API mapping.
" }, "GetApiMappings": { "name": "GetApiMappings", "http": { "method": "GET", "requestUri": "/v2/domainnames/{domainName}/apimappings", "responseCode": 200 }, "input": { "shape": "GetApiMappingsRequest" }, "output": { "shape": "GetApiMappingsResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets API mappings.
" }, "GetApis": { "name": "GetApis", "http": { "method": "GET", "requestUri": "/v2/apis", "responseCode": 200 }, "input": { "shape": "GetApisRequest" }, "output": { "shape": "GetApisResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets a collection of Api resources.
" }, "GetAuthorizer": { "name": "GetAuthorizer", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", "responseCode": 200 }, "input": { "shape": "GetAuthorizerRequest" }, "output": { "shape": "GetAuthorizerResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets an Authorizer.
" }, "GetAuthorizers": { "name": "GetAuthorizers", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/authorizers", "responseCode": 200 }, "input": { "shape": "GetAuthorizersRequest" }, "output": { "shape": "GetAuthorizersResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the Authorizers for an API.
" }, "GetDeployment": { "name": "GetDeployment", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", "responseCode": 200 }, "input": { "shape": "GetDeploymentRequest" }, "output": { "shape": "GetDeploymentResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a Deployment.
" }, "GetDeployments": { "name": "GetDeployments", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/deployments", "responseCode": 200 }, "input": { "shape": "GetDeploymentsRequest" }, "output": { "shape": "GetDeploymentsResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the Deployments for an API.
" }, "GetDomainName": { "name": "GetDomainName", "http": { "method": "GET", "requestUri": "/v2/domainnames/{domainName}", "responseCode": 200 }, "input": { "shape": "GetDomainNameRequest" }, "output": { "shape": "GetDomainNameResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a domain name.
" }, "GetDomainNames": { "name": "GetDomainNames", "http": { "method": "GET", "requestUri": "/v2/domainnames", "responseCode": 200 }, "input": { "shape": "GetDomainNamesRequest" }, "output": { "shape": "GetDomainNamesResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the domain names for an AWS account.
" }, "GetIntegration": { "name": "GetIntegration", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", "responseCode": 200 }, "input": { "shape": "GetIntegrationRequest" }, "output": { "shape": "GetIntegrationResult", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets an Integration.
" }, "GetIntegrationResponse": { "name": "GetIntegrationResponse", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", "responseCode": 200 }, "input": { "shape": "GetIntegrationResponseRequest" }, "output": { "shape": "GetIntegrationResponseResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets an IntegrationResponses.
" }, "GetIntegrationResponses": { "name": "GetIntegrationResponses", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", "responseCode": 200 }, "input": { "shape": "GetIntegrationResponsesRequest" }, "output": { "shape": "GetIntegrationResponsesResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the IntegrationResponses for an Integration.
" }, "GetIntegrations": { "name": "GetIntegrations", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/integrations", "responseCode": 200 }, "input": { "shape": "GetIntegrationsRequest" }, "output": { "shape": "GetIntegrationsResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the Integrations for an API.
" }, "GetModel": { "name": "GetModel", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/models/{modelId}", "responseCode": 200 }, "input": { "shape": "GetModelRequest" }, "output": { "shape": "GetModelResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a Model.
" }, "GetModelTemplate": { "name": "GetModelTemplate", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/models/{modelId}/template", "responseCode": 200 }, "input": { "shape": "GetModelTemplateRequest" }, "output": { "shape": "GetModelTemplateResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a model template.
" }, "GetModels": { "name": "GetModels", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/models", "responseCode": 200 }, "input": { "shape": "GetModelsRequest" }, "output": { "shape": "GetModelsResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the Models for an API.
" }, "GetRoute": { "name": "GetRoute", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/routes/{routeId}", "responseCode": 200 }, "input": { "shape": "GetRouteRequest" }, "output": { "shape": "GetRouteResult", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a Route.
" }, "GetRouteResponse": { "name": "GetRouteResponse", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", "responseCode": 200 }, "input": { "shape": "GetRouteResponseRequest" }, "output": { "shape": "GetRouteResponseResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a RouteResponse.
" }, "GetRouteResponses": { "name": "GetRouteResponses", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses", "responseCode": 200 }, "input": { "shape": "GetRouteResponsesRequest" }, "output": { "shape": "GetRouteResponsesResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the RouteResponses for a Route.
" }, "GetRoutes": { "name": "GetRoutes", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/routes", "responseCode": 200 }, "input": { "shape": "GetRoutesRequest" }, "output": { "shape": "GetRoutesResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the Routes for an API.
" }, "GetStage": { "name": "GetStage", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/stages/{stageName}", "responseCode": 200 }, "input": { "shape": "GetStageRequest" }, "output": { "shape": "GetStageResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a Stage.
" }, "GetStages": { "name": "GetStages", "http": { "method": "GET", "requestUri": "/v2/apis/{apiId}/stages", "responseCode": 200 }, "input": { "shape": "GetStagesRequest" }, "output": { "shape": "GetStagesResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Gets the Stages for an API.
" }, "GetTags": { "name": "GetTags", "http": { "method": "GET", "requestUri": "/v2/tags/{resource-arn}", "responseCode": 200 }, "input": { "shape": "GetTagsRequest" }, "output": { "shape": "GetTagsResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Gets a collection of Tag resources.
" }, "GetVpcLink": { "name": "GetVpcLink", "http": { "method": "GET", "requestUri": "/v2/vpclinks/{vpcLinkId}", "responseCode": 200 }, "input": { "shape": "GetVpcLinkRequest" }, "output": { "shape": "GetVpcLinkResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a VPC link.
" }, "GetVpcLinks": { "name": "GetVpcLinks", "http": { "method": "GET", "requestUri": "/v2/vpclinks", "responseCode": 200 }, "input": { "shape": "GetVpcLinksRequest" }, "output": { "shape": "GetVpcLinksResponse", "documentation": "Success
" }, "errors": [ { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" } ], "documentation": "Gets a collection of VPC links.
" }, "ImportApi": { "name": "ImportApi", "http": { "method": "PUT", "requestUri": "/v2/apis", "responseCode": 201 }, "input": { "shape": "ImportApiRequest" }, "output": { "shape": "ImportApiResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Imports an API.
" }, "ReimportApi": { "name": "ReimportApi", "http": { "method": "PUT", "requestUri": "/v2/apis/{apiId}", "responseCode": 201 }, "input": { "shape": "ReimportApiRequest" }, "output": { "shape": "ReimportApiResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Puts an Api resource.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/v2/tags/{resource-arn}", "responseCode": 201 }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse", "documentation": "The request has succeeded and has resulted in the creation of a resource.
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Creates a new Tag resource to represent a tag.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/v2/tags/{resource-arn}", "responseCode": 204 }, "input": { "shape": "UntagResourceRequest" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Deletes a Tag.
" }, "UpdateApi": { "name": "UpdateApi", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}", "responseCode": 200 }, "input": { "shape": "UpdateApiRequest" }, "output": { "shape": "UpdateApiResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates an Api resource.
" }, "UpdateApiMapping": { "name": "UpdateApiMapping", "http": { "method": "PATCH", "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", "responseCode": 200 }, "input": { "shape": "UpdateApiMappingRequest" }, "output": { "shape": "UpdateApiMappingResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "The API mapping.
" }, "UpdateAuthorizer": { "name": "UpdateAuthorizer", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", "responseCode": 200 }, "input": { "shape": "UpdateAuthorizerRequest" }, "output": { "shape": "UpdateAuthorizerResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates an Authorizer.
" }, "UpdateDeployment": { "name": "UpdateDeployment", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", "responseCode": 200 }, "input": { "shape": "UpdateDeploymentRequest" }, "output": { "shape": "UpdateDeploymentResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates a Deployment.
" }, "UpdateDomainName": { "name": "UpdateDomainName", "http": { "method": "PATCH", "requestUri": "/v2/domainnames/{domainName}", "responseCode": 200 }, "input": { "shape": "UpdateDomainNameRequest" }, "output": { "shape": "UpdateDomainNameResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates a domain name.
" }, "UpdateIntegration": { "name": "UpdateIntegration", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", "responseCode": 200 }, "input": { "shape": "UpdateIntegrationRequest" }, "output": { "shape": "UpdateIntegrationResult", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates an Integration.
" }, "UpdateIntegrationResponse": { "name": "UpdateIntegrationResponse", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", "responseCode": 200 }, "input": { "shape": "UpdateIntegrationResponseRequest" }, "output": { "shape": "UpdateIntegrationResponseResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates an IntegrationResponses.
" }, "UpdateModel": { "name": "UpdateModel", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/models/{modelId}", "responseCode": 200 }, "input": { "shape": "UpdateModelRequest" }, "output": { "shape": "UpdateModelResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates a Model.
" }, "UpdateRoute": { "name": "UpdateRoute", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/routes/{routeId}", "responseCode": 200 }, "input": { "shape": "UpdateRouteRequest" }, "output": { "shape": "UpdateRouteResult", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates a Route.
" }, "UpdateRouteResponse": { "name": "UpdateRouteResponse", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", "responseCode": 200 }, "input": { "shape": "UpdateRouteResponseRequest" }, "output": { "shape": "UpdateRouteResponseResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates a RouteResponse.
" }, "UpdateStage": { "name": "UpdateStage", "http": { "method": "PATCH", "requestUri": "/v2/apis/{apiId}/stages/{stageName}", "responseCode": 200 }, "input": { "shape": "UpdateStageRequest" }, "output": { "shape": "UpdateStageResponse", "documentation": "Success
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" }, { "shape": "ConflictException", "documentation": "The resource already exists.
" } ], "documentation": "Updates a Stage.
" }, "UpdateVpcLink": { "name": "UpdateVpcLink", "http": { "method": "PATCH", "requestUri": "/v2/vpclinks/{vpcLinkId}", "responseCode": 200 }, "input": { "shape": "UpdateVpcLinkRequest" }, "output": { "shape": "UpdateVpcLinkResponse", "documentation": "200 response
" }, "errors": [ { "shape": "NotFoundException", "documentation": "The resource specified in the request was not found.
" }, { "shape": "TooManyRequestsException", "documentation": "The client is sending more than the allowed number of requests per unit of time.
" }, { "shape": "BadRequestException", "documentation": "One of the parameters in the request is invalid.
" } ], "documentation": "Updates a VPC link.
" } }, "shapes": { "AccessLogSettings": { "type": "structure", "members": { "DestinationArn": { "shape": "Arn", "locationName": "destinationArn", "documentation": "The ARN of the CloudWatch Logs log group to receive access logs.
" }, "Format": { "shape": "StringWithLengthBetween1And1024", "locationName": "format", "documentation": "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
" } }, "documentation": "Settings for logging access in a stage.
" }, "Api": { "type": "structure", "members": { "ApiEndpoint": { "shape": "__string", "locationName": "apiEndpoint", "documentation": "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
" }, "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API ID.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the API was created.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "ImportInfo": { "shape": "__listOf__string", "locationName": "importInfo", "documentation": "The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A collection of tags associated with the API.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" }, "Warnings": { "shape": "__listOf__string", "locationName": "warnings", "documentation": "The warning messages reported when failonwarnings is turned on during API import.
" } }, "documentation": "Represents an API.
", "required": [ "RouteSelectionExpression", "Name", "ProtocolType" ] }, "ApiMapping": { "type": "structure", "members": { "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiMappingId": { "shape": "Id", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "ApiMappingKey": { "shape": "SelectionKey", "locationName": "apiMappingKey", "documentation": "The API mapping key.
" }, "Stage": { "shape": "StringWithLengthBetween1And128", "locationName": "stage", "documentation": "The API stage.
" } }, "documentation": "Represents an API mapping.
", "required": [ "Stage", "ApiId" ] }, "Arn": { "type": "string", "documentation": "Represents an Amazon Resource Name (ARN).
" }, "AuthorizationScopes": { "type": "list", "documentation": "A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
", "member": { "shape": "StringWithLengthBetween1And64" } }, "AuthorizationType": { "type": "string", "documentation": "The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
", "enum": [ "NONE", "AWS_IAM", "CUSTOM", "JWT" ] }, "Authorizer": { "type": "structure", "members": { "AuthorizerCredentialsArn": { "shape": "Arn", "locationName": "authorizerCredentialsArn", "documentation": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" }, "AuthorizerPayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "authorizerPayloadFormatVersion", "documentation": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
" }, "AuthorizerResultTtlInSeconds": { "shape": "IntegerWithLengthBetween0And3600", "locationName": "authorizerResultTtlInSeconds", "documentation": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
" }, "AuthorizerType": { "shape": "AuthorizerType", "locationName": "authorizerType", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
" }, "AuthorizerUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "authorizerUri", "documentation": "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
" }, "IdentitySource": { "shape": "IdentitySourceList", "locationName": "identitySource", "documentation": "The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
" }, "IdentityValidationExpression": { "shape": "StringWithLengthBetween0And1024", "locationName": "identityValidationExpression", "documentation": "The validation expression does not apply to the REQUEST authorizer.
" }, "JwtConfiguration": { "shape": "JWTConfiguration", "locationName": "jwtConfiguration", "documentation": "Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the authorizer.
" } }, "documentation": "Represents an authorizer.
", "required": [ "Name" ] }, "AuthorizerType": { "type": "string", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
", "enum": [ "REQUEST", "JWT" ] }, "ConnectionType": { "type": "string", "documentation": "Represents a connection type.
", "enum": [ "INTERNET", "VPC_LINK" ] }, "ContentHandlingStrategy": { "type": "string", "documentation": "Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
", "enum": [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ] }, "Cors": { "type": "structure", "members": { "AllowCredentials": { "shape": "__boolean", "locationName": "allowCredentials", "documentation": "Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
" }, "AllowHeaders": { "shape": "CorsHeaderList", "locationName": "allowHeaders", "documentation": "Represents a collection of allowed headers. Supported only for HTTP APIs.
" }, "AllowMethods": { "shape": "CorsMethodList", "locationName": "allowMethods", "documentation": "Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
" }, "AllowOrigins": { "shape": "CorsOriginList", "locationName": "allowOrigins", "documentation": "Represents a collection of allowed origins. Supported only for HTTP APIs.
" }, "ExposeHeaders": { "shape": "CorsHeaderList", "locationName": "exposeHeaders", "documentation": "Represents a collection of exposed headers. Supported only for HTTP APIs.
" }, "MaxAge": { "shape": "IntegerWithLengthBetweenMinus1And86400", "locationName": "maxAge", "documentation": "The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
" } }, "documentation": "Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
" }, "CorsHeaderList": { "type": "list", "documentation": "Represents a collection of allowed headers. Supported only for HTTP APIs.
", "member": { "shape": "__string" } }, "CorsMethodList": { "type": "list", "documentation": "Represents a collection of methods. Supported only for HTTP APIs.
", "member": { "shape": "StringWithLengthBetween1And64" } }, "CorsOriginList": { "type": "list", "documentation": "Represents a collection of origins. Supported only for HTTP APIs.
", "member": { "shape": "__string" } }, "CreateApiMappingRequest": { "type": "structure", "members": { "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiMappingKey": { "shape": "SelectionKey", "locationName": "apiMappingKey", "documentation": "The API mapping key." }, "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" }, "Stage": { "shape": "StringWithLengthBetween1And128", "locationName": "stage", "documentation": "The API stage.
" } }, "documentation": "Creates a new ApiMapping resource to represent an API mapping.
", "required": [ "DomainName", "Stage", "ApiId" ] }, "CreateApiMappingResponse": { "type": "structure", "members": { "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiMappingId": { "shape": "Id", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "ApiMappingKey": { "shape": "SelectionKey", "locationName": "apiMappingKey", "documentation": "The API mapping key.
" }, "Stage": { "shape": "StringWithLengthBetween1And128", "locationName": "stage", "documentation": "The API stage.
" } } }, "CreateApiRequest": { "type": "structure", "members": { "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" }, "Target": { "shape": "UriWithLengthBetween1And2048", "locationName": "target", "documentation": "This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" } }, "documentation": "Creates a new Api resource to represent an API.
", "required": [ "ProtocolType", "Name" ] }, "CreateApiResponse": { "type": "structure", "members": { "ApiEndpoint": { "shape": "__string", "locationName": "apiEndpoint", "documentation": "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
" }, "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API ID.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the API was created.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "ImportInfo": { "shape": "__listOf__string", "locationName": "importInfo", "documentation": "The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A collection of tags associated with the API.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" }, "Warnings": { "shape": "__listOf__string", "locationName": "warnings", "documentation": "The warning messages reported when failonwarnings is turned on during API import.
" } } }, "CreateAuthorizerRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "AuthorizerCredentialsArn": { "shape": "Arn", "locationName": "authorizerCredentialsArn", "documentation": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
" }, "AuthorizerPayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "authorizerPayloadFormatVersion", "documentation": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
" }, "AuthorizerResultTtlInSeconds": { "shape": "IntegerWithLengthBetween0And3600", "locationName": "authorizerResultTtlInSeconds", "documentation": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
" }, "AuthorizerType": { "shape": "AuthorizerType", "locationName": "authorizerType", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
" }, "AuthorizerUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "authorizerUri", "documentation": "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
" }, "IdentitySource": { "shape": "IdentitySourceList", "locationName": "identitySource", "documentation": "The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
" }, "IdentityValidationExpression": { "shape": "StringWithLengthBetween0And1024", "locationName": "identityValidationExpression", "documentation": "This parameter is not used.
" }, "JwtConfiguration": { "shape": "JWTConfiguration", "locationName": "jwtConfiguration", "documentation": "Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the authorizer.
" } }, "documentation": "Creates a new Authorizer resource to represent an authorizer.
", "required": [ "ApiId", "AuthorizerType", "IdentitySource", "Name" ] }, "CreateAuthorizerResponse": { "type": "structure", "members": { "AuthorizerCredentialsArn": { "shape": "Arn", "locationName": "authorizerCredentialsArn", "documentation": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" }, "AuthorizerPayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "authorizerPayloadFormatVersion", "documentation": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
" }, "AuthorizerResultTtlInSeconds": { "shape": "IntegerWithLengthBetween0And3600", "locationName": "authorizerResultTtlInSeconds", "documentation": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
" }, "AuthorizerType": { "shape": "AuthorizerType", "locationName": "authorizerType", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
" }, "AuthorizerUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "authorizerUri", "documentation": "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
" }, "IdentitySource": { "shape": "IdentitySourceList", "locationName": "identitySource", "documentation": "The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
" }, "IdentityValidationExpression": { "shape": "StringWithLengthBetween0And1024", "locationName": "identityValidationExpression", "documentation": "The validation expression does not apply to the REQUEST authorizer.
" }, "JwtConfiguration": { "shape": "JWTConfiguration", "locationName": "jwtConfiguration", "documentation": "Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the authorizer.
" } } }, "CreateDeploymentRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the deployment resource.
" }, "StageName": { "shape": "StringWithLengthBetween1And128", "locationName": "stageName", "documentation": "The name of the Stage resource for the Deployment resource to create.
" } }, "documentation": "Creates a new Deployment resource to represent a deployment.
", "required": [ "ApiId" ] }, "CreateDeploymentResponse": { "type": "structure", "members": { "AutoDeployed": { "shape": "__boolean", "locationName": "autoDeployed", "documentation": "Specifies whether a deployment was automatically released.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The date and time when the Deployment resource was created.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier for the deployment.
" }, "DeploymentStatus": { "shape": "DeploymentStatus", "locationName": "deploymentStatus", "documentation": "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" }, "DeploymentStatusMessage": { "shape": "__string", "locationName": "deploymentStatusMessage", "documentation": "May contain additional feedback on the status of an API deployment.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the deployment.
" } } }, "CreateDomainNameRequest": { "type": "structure", "members": { "DomainName": { "shape": "StringWithLengthBetween1And512", "locationName": "domainName", "documentation": "The domain name.
" }, "DomainNameConfigurations": { "shape": "DomainNameConfigurations", "locationName": "domainNameConfigurations", "documentation": "The domain name configurations.
" }, "MutualTlsAuthentication": { "shape": "MutualTlsAuthenticationInput", "locationName": "mutualTlsAuthentication", "documentation": "The mutual TLS authentication configuration for a custom domain name.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags associated with a domain name.
" } }, "documentation": "Creates a new DomainName resource to represent a domain name.
", "required": [ "DomainName" ] }, "CreateDomainNameResponse": { "type": "structure", "members": { "ApiMappingSelectionExpression": { "shape": "SelectionExpression", "locationName": "apiMappingSelectionExpression", "documentation": "The API mapping selection expression.
" }, "DomainName": { "shape": "StringWithLengthBetween1And512", "locationName": "domainName", "documentation": "The name of the DomainName resource.
" }, "DomainNameConfigurations": { "shape": "DomainNameConfigurations", "locationName": "domainNameConfigurations", "documentation": "The domain name configurations.
" }, "MutualTlsAuthentication": { "shape": "MutualTlsAuthentication", "locationName": "mutualTlsAuthentication", "documentation": "The mutual TLS authentication configuration for a custom domain name.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags associated with a domain name.
" } } }, "CreateIntegrationRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ConnectionId": { "shape": "StringWithLengthBetween1And1024", "locationName": "connectionId", "documentation": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.
" }, "ConnectionType": { "shape": "ConnectionType", "locationName": "connectionType", "documentation": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the integration.
" }, "IntegrationMethod": { "shape": "StringWithLengthBetween1And64", "locationName": "integrationMethod", "documentation": "Specifies the integration's HTTP method type.
" }, "IntegrationSubtype": { "shape": "StringWithLengthBetween1And128", "locationName": "integrationSubtype", "documentation": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
" }, "IntegrationType": { "shape": "IntegrationType", "locationName": "integrationType", "documentation": "The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.
" }, "IntegrationUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "integrationUri", "documentation": "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior": { "shape": "PassthroughBehavior", "locationName": "passthroughBehavior", "documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
" }, "PayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "payloadFormatVersion", "documentation": "Specifies the format of the payload sent to an integration. Required for HTTP APIs.
" }, "RequestParameters": { "shape": "IntegrationParameters", "locationName": "requestParameters", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "RequestTemplates": { "shape": "TemplateMap", "locationName": "requestTemplates", "documentation": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
" }, "ResponseParameters": { "shape": "ResponseParameters", "locationName": "responseParameters", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration.
" }, "TimeoutInMillis": { "shape": "IntegerWithLengthBetween50And30000", "locationName": "timeoutInMillis", "documentation": "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig": { "shape": "TlsConfigInput", "locationName": "tlsConfig", "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" } }, "documentation": "Creates a new Integration resource to represent an integration.
", "required": [ "ApiId", "IntegrationType" ] }, "CreateIntegrationResult": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
" }, "ConnectionId": { "shape": "StringWithLengthBetween1And1024", "locationName": "connectionId", "documentation": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.
" }, "ConnectionType": { "shape": "ConnectionType", "locationName": "connectionType", "documentation": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "Represents the description of an integration.
" }, "IntegrationId": { "shape": "Id", "locationName": "integrationId", "documentation": "Represents the identifier of an integration.
" }, "IntegrationMethod": { "shape": "StringWithLengthBetween1And64", "locationName": "integrationMethod", "documentation": "Specifies the integration's HTTP method type.
" }, "IntegrationResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "integrationResponseSelectionExpression", "documentation": "The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
" }, "IntegrationSubtype": { "shape": "StringWithLengthBetween1And128", "locationName": "integrationSubtype", "documentation": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
" }, "IntegrationType": { "shape": "IntegrationType", "locationName": "integrationType", "documentation": "The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.
" }, "IntegrationUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "integrationUri", "documentation": "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior": { "shape": "PassthroughBehavior", "locationName": "passthroughBehavior", "documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
" }, "PayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "payloadFormatVersion", "documentation": "Specifies the format of the payload sent to an integration. Required for HTTP APIs.
" }, "RequestParameters": { "shape": "IntegrationParameters", "locationName": "requestParameters", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "RequestTemplates": { "shape": "TemplateMap", "locationName": "requestTemplates", "documentation": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
" }, "ResponseParameters": { "shape": "ResponseParameters", "locationName": "responseParameters", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis": { "shape": "IntegerWithLengthBetween50And30000", "locationName": "timeoutInMillis", "documentation": "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig": { "shape": "TlsConfig", "locationName": "tlsConfig", "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" } } }, "CreateIntegrationResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" }, "IntegrationResponseKey": { "shape": "SelectionKey", "locationName": "integrationResponseKey", "documentation": "The integration response key.
" }, "ResponseParameters": { "shape": "IntegrationParameters", "locationName": "responseParameters", "documentation": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
" }, "ResponseTemplates": { "shape": "TemplateMap", "locationName": "responseTemplates", "documentation": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration response. Supported only for WebSocket APIs.
" } }, "documentation": "Creates a new IntegrationResponse resource to represent an integration response.
", "required": [ "ApiId", "IntegrationId", "IntegrationResponseKey" ] }, "CreateIntegrationResponseResponse": { "type": "structure", "members": { "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "IntegrationResponseId": { "shape": "Id", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" }, "IntegrationResponseKey": { "shape": "SelectionKey", "locationName": "integrationResponseKey", "documentation": "The integration response key.
" }, "ResponseParameters": { "shape": "IntegrationParameters", "locationName": "responseParameters", "documentation": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" }, "ResponseTemplates": { "shape": "TemplateMap", "locationName": "responseTemplates", "documentation": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expressions for the integration response.
" } } }, "CreateModelRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ContentType": { "shape": "StringWithLengthBetween1And256", "locationName": "contentType", "documentation": "The content-type for the model, for example, \"application/json\".
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the model.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the model. Must be alphanumeric.
" }, "Schema": { "shape": "StringWithLengthBetween0And32K", "locationName": "schema", "documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" } }, "documentation": "Creates a new Model.
", "required": [ "ApiId", "Schema", "Name" ] }, "CreateModelResponse": { "type": "structure", "members": { "ContentType": { "shape": "StringWithLengthBetween1And256", "locationName": "contentType", "documentation": "The content-type for the model, for example, \"application/json\".
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the model.
" }, "ModelId": { "shape": "Id", "locationName": "modelId", "documentation": "The model identifier.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the model. Must be alphanumeric.
" }, "Schema": { "shape": "StringWithLengthBetween0And32K", "locationName": "schema", "documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" } } }, "CreateRouteRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiKeyRequired": { "shape": "__boolean", "locationName": "apiKeyRequired", "documentation": "Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
" }, "AuthorizationScopes": { "shape": "AuthorizationScopes", "locationName": "authorizationScopes", "documentation": "The authorization scopes supported by this route.
" }, "AuthorizationType": { "shape": "AuthorizationType", "locationName": "authorizationType", "documentation": "The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route. Supported only for WebSocket APIs.
" }, "OperationName": { "shape": "StringWithLengthBetween1And64", "locationName": "operationName", "documentation": "The operation name for the route.
" }, "RequestModels": { "shape": "RouteModels", "locationName": "requestModels", "documentation": "The request models for the route. Supported only for WebSocket APIs.
" }, "RequestParameters": { "shape": "RouteParameters", "locationName": "requestParameters", "documentation": "The request parameters for the route. Supported only for WebSocket APIs.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "The route key for the route.
" }, "RouteResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeResponseSelectionExpression", "documentation": "The route response selection expression for the route. Supported only for WebSocket APIs.
" }, "Target": { "shape": "StringWithLengthBetween1And128", "locationName": "target", "documentation": "The target for the route.
" } }, "documentation": "Creates a new Route resource to represent a route.
", "required": [ "ApiId", "RouteKey" ] }, "CreateRouteResult": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
" }, "ApiKeyRequired": { "shape": "__boolean", "locationName": "apiKeyRequired", "documentation": "Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
" }, "AuthorizationScopes": { "shape": "AuthorizationScopes", "locationName": "authorizationScopes", "documentation": "A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
" }, "AuthorizationType": { "shape": "AuthorizationType", "locationName": "authorizationType", "documentation": "The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route. Supported only for WebSocket APIs.
" }, "OperationName": { "shape": "StringWithLengthBetween1And64", "locationName": "operationName", "documentation": "The operation name for the route.
" }, "RequestModels": { "shape": "RouteModels", "locationName": "requestModels", "documentation": "The request models for the route. Supported only for WebSocket APIs.
" }, "RequestParameters": { "shape": "RouteParameters", "locationName": "requestParameters", "documentation": "The request parameters for the route. Supported only for WebSocket APIs.
" }, "RouteId": { "shape": "Id", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "The route key for the route.
" }, "RouteResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeResponseSelectionExpression", "documentation": "The route response selection expression for the route. Supported only for WebSocket APIs.
" }, "Target": { "shape": "StringWithLengthBetween1And128", "locationName": "target", "documentation": "The target for the route.
" } } }, "CreateRouteResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route response. Supported only for WebSocket APIs.
" }, "ResponseModels": { "shape": "RouteModels", "locationName": "responseModels", "documentation": "The response models for the route response.
" }, "ResponseParameters": { "shape": "RouteParameters", "locationName": "responseParameters", "documentation": "The route response parameters.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteResponseKey": { "shape": "SelectionKey", "locationName": "routeResponseKey", "documentation": "The route response key.
" } }, "documentation": "Creates a new RouteResponse resource to represent a route response.
", "required": [ "ApiId", "RouteId", "RouteResponseKey" ] }, "CreateRouteResponseResponse": { "type": "structure", "members": { "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "Represents the model selection expression of a route response. Supported only for WebSocket APIs.
" }, "ResponseModels": { "shape": "RouteModels", "locationName": "responseModels", "documentation": "Represents the response models of a route response.
" }, "ResponseParameters": { "shape": "RouteParameters", "locationName": "responseParameters", "documentation": "Represents the response parameters of a route response.
" }, "RouteResponseId": { "shape": "Id", "locationName": "routeResponseId", "documentation": "Represents the identifier of a route response.
" }, "RouteResponseKey": { "shape": "SelectionKey", "locationName": "routeResponseKey", "documentation": "Represents the route response key of a route response.
" } } }, "CreateStageRequest": { "type": "structure", "members": { "AccessLogSettings": { "shape": "AccessLogSettings", "locationName": "accessLogSettings", "documentation": "Settings for logging access in this stage.
" }, "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "AutoDeploy": { "shape": "__boolean", "locationName": "autoDeploy", "documentation": "Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
" }, "ClientCertificateId": { "shape": "Id", "locationName": "clientCertificateId", "documentation": "The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
" }, "DefaultRouteSettings": { "shape": "RouteSettings", "locationName": "defaultRouteSettings", "documentation": "The default route settings for the stage.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The deployment identifier of the API stage.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the API stage.
" }, "RouteSettings": { "shape": "RouteSettingsMap", "locationName": "routeSettings", "documentation": "Route settings for the stage, by routeKey.
" }, "StageName": { "shape": "StringWithLengthBetween1And128", "locationName": "stageName", "documentation": "The name of the stage.
" }, "StageVariables": { "shape": "StageVariablesMap", "locationName": "stageVariables", "documentation": "A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" } }, "documentation": "Creates a new Stage resource to represent a stage.
", "required": [ "ApiId", "StageName" ] }, "CreateStageResponse": { "type": "structure", "members": { "AccessLogSettings": { "shape": "AccessLogSettings", "locationName": "accessLogSettings", "documentation": "Settings for logging access in this stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
" }, "AutoDeploy": { "shape": "__boolean", "locationName": "autoDeploy", "documentation": "Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
" }, "ClientCertificateId": { "shape": "Id", "locationName": "clientCertificateId", "documentation": "The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the stage was created.
" }, "DefaultRouteSettings": { "shape": "RouteSettings", "locationName": "defaultRouteSettings", "documentation": "Default route settings for the stage.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the stage.
" }, "LastDeploymentStatusMessage": { "shape": "__string", "locationName": "lastDeploymentStatusMessage", "documentation": "Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
" }, "LastUpdatedDate": { "shape": "__timestampIso8601", "locationName": "lastUpdatedDate", "documentation": "The timestamp when the stage was last updated.
" }, "RouteSettings": { "shape": "RouteSettingsMap", "locationName": "routeSettings", "documentation": "Route settings for the stage, by routeKey.
" }, "StageName": { "shape": "StringWithLengthBetween1And128", "locationName": "stageName", "documentation": "The name of the stage.
" }, "StageVariables": { "shape": "StageVariablesMap", "locationName": "stageVariables", "documentation": "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" } } }, "CreateVpcLinkRequest": { "type": "structure", "members": { "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the VPC link.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "locationName": "securityGroupIds", "documentation": "A list of security group IDs for the VPC link.
" }, "SubnetIds": { "shape": "SubnetIdList", "locationName": "subnetIds", "documentation": "A list of subnet IDs to include in the VPC link.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A list of tags.
" } }, "documentation": "Creates a VPC link
", "required": [ "SubnetIds", "Name" ] }, "CreateVpcLinkResponse": { "type": "structure", "members": { "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the VPC link was created.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the VPC link.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "locationName": "securityGroupIds", "documentation": "A list of security group IDs for the VPC link.
" }, "SubnetIds": { "shape": "SubnetIdList", "locationName": "subnetIds", "documentation": "A list of subnet IDs to include in the VPC link.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "Tags for the VPC link.
" }, "VpcLinkId": { "shape": "Id", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" }, "VpcLinkStatus": { "shape": "VpcLinkStatus", "locationName": "vpcLinkStatus", "documentation": "The status of the VPC link.
" }, "VpcLinkStatusMessage": { "shape": "StringWithLengthBetween0And1024", "locationName": "vpcLinkStatusMessage", "documentation": "A message summarizing the cause of the status of the VPC link.
" }, "VpcLinkVersion": { "shape": "VpcLinkVersion", "locationName": "vpcLinkVersion", "documentation": "The version of the VPC link.
" } } }, "DeleteAccessLogSettingsRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "StageName": { "shape": "__string", "location": "uri", "locationName": "stageName", "documentation": "The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
" } }, "required": [ "StageName", "ApiId" ] }, "DeleteApiMappingRequest": { "type": "structure", "members": { "ApiMappingId": { "shape": "__string", "location": "uri", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" } }, "required": [ "ApiMappingId", "DomainName" ] }, "DeleteApiRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" } }, "required": [ "ApiId" ] }, "DeleteAuthorizerRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "AuthorizerId": { "shape": "__string", "location": "uri", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" } }, "required": [ "AuthorizerId", "ApiId" ] }, "DeleteCorsConfigurationRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" } }, "required": [ "ApiId" ] }, "DeleteDeploymentRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "DeploymentId": { "shape": "__string", "location": "uri", "locationName": "deploymentId", "documentation": "The deployment ID.
" } }, "required": [ "ApiId", "DeploymentId" ] }, "DeleteDomainNameRequest": { "type": "structure", "members": { "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" } }, "required": [ "DomainName" ] }, "DeleteIntegrationRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" } }, "required": [ "ApiId", "IntegrationId" ] }, "DeleteIntegrationResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" }, "IntegrationResponseId": { "shape": "__string", "location": "uri", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" } }, "required": [ "ApiId", "IntegrationResponseId", "IntegrationId" ] }, "DeleteModelRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ModelId": { "shape": "__string", "location": "uri", "locationName": "modelId", "documentation": "The model ID.
" } }, "required": [ "ModelId", "ApiId" ] }, "DeleteRouteRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" } }, "required": [ "ApiId", "RouteId" ] }, "DeleteRouteRequestParameterRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "RequestParameterKey": { "shape": "__string", "location": "uri", "locationName": "requestParameterKey", "documentation": "The route request parameter key.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" } }, "required": [ "RequestParameterKey", "ApiId", "RouteId" ] }, "DeleteRouteResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteResponseId": { "shape": "__string", "location": "uri", "locationName": "routeResponseId", "documentation": "The route response ID.
" } }, "required": [ "RouteResponseId", "ApiId", "RouteId" ] }, "DeleteRouteSettingsRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "RouteKey": { "shape": "__string", "location": "uri", "locationName": "routeKey", "documentation": "The route key.
" }, "StageName": { "shape": "__string", "location": "uri", "locationName": "stageName", "documentation": "The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
" } }, "required": [ "StageName", "RouteKey", "ApiId" ] }, "DeleteStageRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "StageName": { "shape": "__string", "location": "uri", "locationName": "stageName", "documentation": "The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
" } }, "required": [ "StageName", "ApiId" ] }, "DeleteVpcLinkRequest": { "type": "structure", "members": { "VpcLinkId": { "shape": "__string", "location": "uri", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" } }, "required": [ "VpcLinkId" ] }, "DeleteVpcLinkResponse": { "type": "structure", "members": {} }, "Deployment": { "type": "structure", "members": { "AutoDeployed": { "shape": "__boolean", "locationName": "autoDeployed", "documentation": "Specifies whether a deployment was automatically released.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The date and time when the Deployment resource was created.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier for the deployment.
" }, "DeploymentStatus": { "shape": "DeploymentStatus", "locationName": "deploymentStatus", "documentation": "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" }, "DeploymentStatusMessage": { "shape": "__string", "locationName": "deploymentStatusMessage", "documentation": "May contain additional feedback on the status of an API deployment.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the deployment.
" } }, "documentation": "An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
" }, "DeploymentStatus": { "type": "string", "documentation": "Represents a deployment status.
", "enum": [ "PENDING", "FAILED", "DEPLOYED" ] }, "DomainName": { "type": "structure", "members": { "ApiMappingSelectionExpression": { "shape": "SelectionExpression", "locationName": "apiMappingSelectionExpression", "documentation": "The API mapping selection expression.
" }, "DomainName": { "shape": "StringWithLengthBetween1And512", "locationName": "domainName", "documentation": "The name of the DomainName resource.
" }, "DomainNameConfigurations": { "shape": "DomainNameConfigurations", "locationName": "domainNameConfigurations", "documentation": "The domain name configurations.
" }, "MutualTlsAuthentication": { "shape": "MutualTlsAuthentication", "locationName": "mutualTlsAuthentication", "documentation": "The mutual TLS authentication configuration for a custom domain name.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags associated with a domain name.
" } }, "documentation": "Represents a domain name.
", "required": [ "DomainName" ] }, "DomainNameConfiguration": { "type": "structure", "members": { "ApiGatewayDomainName": { "shape": "__string", "locationName": "apiGatewayDomainName", "documentation": "A domain name for the API.
" }, "CertificateArn": { "shape": "Arn", "locationName": "certificateArn", "documentation": "An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
" }, "CertificateName": { "shape": "StringWithLengthBetween1And128", "locationName": "certificateName", "documentation": "The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
" }, "CertificateUploadDate": { "shape": "__timestampIso8601", "locationName": "certificateUploadDate", "documentation": "The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
" }, "DomainNameStatus": { "shape": "DomainNameStatus", "locationName": "domainNameStatus", "documentation": "The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
" }, "DomainNameStatusMessage": { "shape": "__string", "locationName": "domainNameStatusMessage", "documentation": "An optional text message containing detailed information about status of the domain name migration.
" }, "EndpointType": { "shape": "EndpointType", "locationName": "endpointType", "documentation": "The endpoint type.
" }, "HostedZoneId": { "shape": "__string", "locationName": "hostedZoneId", "documentation": "The Amazon Route 53 Hosted Zone ID of the endpoint.
" }, "SecurityPolicy": { "shape": "SecurityPolicy", "locationName": "securityPolicy", "documentation": "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.
" }, "OwnershipVerificationCertificateArn": { "shape": "Arn", "locationName": "ownershipVerificationCertificateArn", "documentation": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn
" } }, "documentation": "The domain name configuration.
" }, "DomainNameConfigurations": { "type": "list", "documentation": "The domain name configurations.
", "member": { "shape": "DomainNameConfiguration" } }, "DomainNameStatus": { "type": "string", "documentation": "The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
", "enum": [ "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION" ] }, "EndpointType": { "type": "string", "documentation": "Represents an endpoint type.
", "enum": [ "REGIONAL", "EDGE" ] }, "ExportApiRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ExportVersion": { "shape": "__string", "location": "querystring", "locationName": "exportVersion", "documentation": "The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
" }, "IncludeExtensions": { "shape": "__boolean", "location": "querystring", "locationName": "includeExtensions", "documentation": "Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
" }, "OutputType": { "shape": "__string", "enum": [ "YAML", "JSON" ], "location": "querystring", "locationName": "outputType", "documentation": "The output type of the exported definition file. Valid values are JSON and YAML.
" }, "Specification": { "shape": "__string", "enum": [ "OAS30" ], "location": "uri", "locationName": "specification", "documentation": "The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
" }, "StageName": { "shape": "__string", "location": "querystring", "locationName": "stageName", "documentation": "The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
" } }, "required": [ "Specification", "OutputType", "ApiId" ] }, "ExportApiResponse": { "type": "structure", "members": { "body": { "shape": "ExportedApi" } }, "payload": "body" }, "ExportedApi": { "type": "blob", "documentation": "Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.
" }, "ResetAuthorizersCacheRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "StageName": { "shape": "__string", "location": "uri", "locationName": "stageName", "documentation": "The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
" } }, "required": [ "StageName", "ApiId" ] }, "GetApiMappingRequest": { "type": "structure", "members": { "ApiMappingId": { "shape": "__string", "location": "uri", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" } }, "required": [ "ApiMappingId", "DomainName" ] }, "GetApiMappingResponse": { "type": "structure", "members": { "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiMappingId": { "shape": "Id", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "ApiMappingKey": { "shape": "SelectionKey", "locationName": "apiMappingKey", "documentation": "The API mapping key.
" }, "Stage": { "shape": "StringWithLengthBetween1And128", "locationName": "stage", "documentation": "The API stage.
" } } }, "GetApiMappingsRequest": { "type": "structure", "members": { "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "DomainName" ] }, "GetApiMappingsResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfApiMapping", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetApiRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" } }, "required": [ "ApiId" ] }, "GetApiResponse": { "type": "structure", "members": { "ApiEndpoint": { "shape": "__string", "locationName": "apiEndpoint", "documentation": "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
" }, "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API ID.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the API was created.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "ImportInfo": { "shape": "__listOf__string", "locationName": "importInfo", "documentation": "The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A collection of tags associated with the API.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" }, "Warnings": { "shape": "__listOf__string", "locationName": "warnings", "documentation": "The warning messages reported when failonwarnings is turned on during API import.
" } } }, "GetApisRequest": { "type": "structure", "members": { "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetApisResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfApi", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetAuthorizerRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "AuthorizerId": { "shape": "__string", "location": "uri", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" } }, "required": [ "AuthorizerId", "ApiId" ] }, "GetAuthorizerResponse": { "type": "structure", "members": { "AuthorizerCredentialsArn": { "shape": "Arn", "locationName": "authorizerCredentialsArn", "documentation": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" }, "AuthorizerPayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "authorizerPayloadFormatVersion", "documentation": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
" }, "AuthorizerResultTtlInSeconds": { "shape": "IntegerWithLengthBetween0And3600", "locationName": "authorizerResultTtlInSeconds", "documentation": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
" }, "AuthorizerType": { "shape": "AuthorizerType", "locationName": "authorizerType", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
" }, "AuthorizerUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "authorizerUri", "documentation": "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
" }, "IdentitySource": { "shape": "IdentitySourceList", "locationName": "identitySource", "documentation": "The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
" }, "IdentityValidationExpression": { "shape": "StringWithLengthBetween0And1024", "locationName": "identityValidationExpression", "documentation": "The validation expression does not apply to the REQUEST authorizer.
" }, "JwtConfiguration": { "shape": "JWTConfiguration", "locationName": "jwtConfiguration", "documentation": "Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the authorizer.
" } } }, "GetAuthorizersRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "ApiId" ] }, "GetAuthorizersResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfAuthorizer", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetDeploymentRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "DeploymentId": { "shape": "__string", "location": "uri", "locationName": "deploymentId", "documentation": "The deployment ID.
" } }, "required": [ "ApiId", "DeploymentId" ] }, "GetDeploymentResponse": { "type": "structure", "members": { "AutoDeployed": { "shape": "__boolean", "locationName": "autoDeployed", "documentation": "Specifies whether a deployment was automatically released.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The date and time when the Deployment resource was created.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier for the deployment.
" }, "DeploymentStatus": { "shape": "DeploymentStatus", "locationName": "deploymentStatus", "documentation": "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" }, "DeploymentStatusMessage": { "shape": "__string", "locationName": "deploymentStatusMessage", "documentation": "May contain additional feedback on the status of an API deployment.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the deployment.
" } } }, "GetDeploymentsRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "ApiId" ] }, "GetDeploymentsResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfDeployment", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetDomainNameRequest": { "type": "structure", "members": { "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" } }, "required": [ "DomainName" ] }, "GetDomainNameResponse": { "type": "structure", "members": { "ApiMappingSelectionExpression": { "shape": "SelectionExpression", "locationName": "apiMappingSelectionExpression", "documentation": "The API mapping selection expression.
" }, "DomainName": { "shape": "StringWithLengthBetween1And512", "locationName": "domainName", "documentation": "The name of the DomainName resource.
" }, "DomainNameConfigurations": { "shape": "DomainNameConfigurations", "locationName": "domainNameConfigurations", "documentation": "The domain name configurations.
" }, "MutualTlsAuthentication": { "shape": "MutualTlsAuthentication", "locationName": "mutualTlsAuthentication", "documentation": "The mutual TLS authentication configuration for a custom domain name.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags associated with a domain name.
" } } }, "GetDomainNamesRequest": { "type": "structure", "members": { "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetDomainNamesResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfDomainName", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetIntegrationRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" } }, "required": [ "ApiId", "IntegrationId" ] }, "GetIntegrationResult": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
" }, "ConnectionId": { "shape": "StringWithLengthBetween1And1024", "locationName": "connectionId", "documentation": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.
" }, "ConnectionType": { "shape": "ConnectionType", "locationName": "connectionType", "documentation": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "Represents the description of an integration.
" }, "IntegrationId": { "shape": "Id", "locationName": "integrationId", "documentation": "Represents the identifier of an integration.
" }, "IntegrationMethod": { "shape": "StringWithLengthBetween1And64", "locationName": "integrationMethod", "documentation": "Specifies the integration's HTTP method type.
" }, "IntegrationResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "integrationResponseSelectionExpression", "documentation": "The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
" }, "IntegrationSubtype": { "shape": "StringWithLengthBetween1And128", "locationName": "integrationSubtype", "documentation": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
" }, "IntegrationType": { "shape": "IntegrationType", "locationName": "integrationType", "documentation": "The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.
" }, "IntegrationUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "integrationUri", "documentation": "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior": { "shape": "PassthroughBehavior", "locationName": "passthroughBehavior", "documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
" }, "PayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "payloadFormatVersion", "documentation": "Specifies the format of the payload sent to an integration. Required for HTTP APIs.
" }, "RequestParameters": { "shape": "IntegrationParameters", "locationName": "requestParameters", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "RequestTemplates": { "shape": "TemplateMap", "locationName": "requestTemplates", "documentation": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
" }, "ResponseParameters": { "shape": "ResponseParameters", "locationName": "responseParameters", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis": { "shape": "IntegerWithLengthBetween50And30000", "locationName": "timeoutInMillis", "documentation": "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig": { "shape": "TlsConfig", "locationName": "tlsConfig", "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" } } }, "GetIntegrationResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" }, "IntegrationResponseId": { "shape": "__string", "location": "uri", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" } }, "required": [ "ApiId", "IntegrationResponseId", "IntegrationId" ] }, "GetIntegrationResponseResponse": { "type": "structure", "members": { "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "IntegrationResponseId": { "shape": "Id", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" }, "IntegrationResponseKey": { "shape": "SelectionKey", "locationName": "integrationResponseKey", "documentation": "The integration response key.
" }, "ResponseParameters": { "shape": "IntegrationParameters", "locationName": "responseParameters", "documentation": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" }, "ResponseTemplates": { "shape": "TemplateMap", "locationName": "responseTemplates", "documentation": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expressions for the integration response.
" } } }, "GetIntegrationResponsesRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "IntegrationId", "ApiId" ] }, "GetIntegrationResponsesResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfIntegrationResponse", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetIntegrationsRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "ApiId" ] }, "GetIntegrationsResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfIntegration", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetModelRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ModelId": { "shape": "__string", "location": "uri", "locationName": "modelId", "documentation": "The model ID.
" } }, "required": [ "ModelId", "ApiId" ] }, "GetModelResponse": { "type": "structure", "members": { "ContentType": { "shape": "StringWithLengthBetween1And256", "locationName": "contentType", "documentation": "The content-type for the model, for example, \"application/json\".
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the model.
" }, "ModelId": { "shape": "Id", "locationName": "modelId", "documentation": "The model identifier.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the model. Must be alphanumeric.
" }, "Schema": { "shape": "StringWithLengthBetween0And32K", "locationName": "schema", "documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" } } }, "GetModelTemplateRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ModelId": { "shape": "__string", "location": "uri", "locationName": "modelId", "documentation": "The model ID.
" } }, "required": [ "ModelId", "ApiId" ] }, "GetModelTemplateResponse": { "type": "structure", "members": { "Value": { "shape": "__string", "locationName": "value", "documentation": "The template value.
" } } }, "GetModelsRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "ApiId" ] }, "GetModelsResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfModel", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetRouteRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" } }, "required": [ "ApiId", "RouteId" ] }, "GetRouteResult": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
" }, "ApiKeyRequired": { "shape": "__boolean", "locationName": "apiKeyRequired", "documentation": "Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
" }, "AuthorizationScopes": { "shape": "AuthorizationScopes", "locationName": "authorizationScopes", "documentation": "A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
" }, "AuthorizationType": { "shape": "AuthorizationType", "locationName": "authorizationType", "documentation": "The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route. Supported only for WebSocket APIs.
" }, "OperationName": { "shape": "StringWithLengthBetween1And64", "locationName": "operationName", "documentation": "The operation name for the route.
" }, "RequestModels": { "shape": "RouteModels", "locationName": "requestModels", "documentation": "The request models for the route. Supported only for WebSocket APIs.
" }, "RequestParameters": { "shape": "RouteParameters", "locationName": "requestParameters", "documentation": "The request parameters for the route. Supported only for WebSocket APIs.
" }, "RouteId": { "shape": "Id", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "The route key for the route.
" }, "RouteResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeResponseSelectionExpression", "documentation": "The route response selection expression for the route. Supported only for WebSocket APIs.
" }, "Target": { "shape": "StringWithLengthBetween1And128", "locationName": "target", "documentation": "The target for the route.
" } } }, "GetRouteResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteResponseId": { "shape": "__string", "location": "uri", "locationName": "routeResponseId", "documentation": "The route response ID.
" } }, "required": [ "RouteResponseId", "ApiId", "RouteId" ] }, "GetRouteResponseResponse": { "type": "structure", "members": { "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "Represents the model selection expression of a route response. Supported only for WebSocket APIs.
" }, "ResponseModels": { "shape": "RouteModels", "locationName": "responseModels", "documentation": "Represents the response models of a route response.
" }, "ResponseParameters": { "shape": "RouteParameters", "locationName": "responseParameters", "documentation": "Represents the response parameters of a route response.
" }, "RouteResponseId": { "shape": "Id", "locationName": "routeResponseId", "documentation": "Represents the identifier of a route response.
" }, "RouteResponseKey": { "shape": "SelectionKey", "locationName": "routeResponseKey", "documentation": "Represents the route response key of a route response.
" } } }, "GetRouteResponsesRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" } }, "required": [ "RouteId", "ApiId" ] }, "GetRouteResponsesResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfRouteResponse", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetRoutesRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "ApiId" ] }, "GetRoutesResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfRoute", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetStageRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "StageName": { "shape": "__string", "location": "uri", "locationName": "stageName", "documentation": "The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
" } }, "required": [ "StageName", "ApiId" ] }, "GetStageResponse": { "type": "structure", "members": { "AccessLogSettings": { "shape": "AccessLogSettings", "locationName": "accessLogSettings", "documentation": "Settings for logging access in this stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
" }, "AutoDeploy": { "shape": "__boolean", "locationName": "autoDeploy", "documentation": "Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
" }, "ClientCertificateId": { "shape": "Id", "locationName": "clientCertificateId", "documentation": "The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the stage was created.
" }, "DefaultRouteSettings": { "shape": "RouteSettings", "locationName": "defaultRouteSettings", "documentation": "Default route settings for the stage.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the stage.
" }, "LastDeploymentStatusMessage": { "shape": "__string", "locationName": "lastDeploymentStatusMessage", "documentation": "Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
" }, "LastUpdatedDate": { "shape": "__timestampIso8601", "locationName": "lastUpdatedDate", "documentation": "The timestamp when the stage was last updated.
" }, "RouteSettings": { "shape": "RouteSettingsMap", "locationName": "routeSettings", "documentation": "Route settings for the stage, by routeKey.
" }, "StageName": { "shape": "StringWithLengthBetween1And128", "locationName": "stageName", "documentation": "The name of the stage.
" }, "StageVariables": { "shape": "StageVariablesMap", "locationName": "stageVariables", "documentation": "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" } } }, "GetStagesRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } }, "required": [ "ApiId" ] }, "GetStagesResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfStage", "locationName": "items", "documentation": "The elements from this collection.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetTagsRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resource-arn", "documentation": "The resource ARN for the tag.
" } }, "required": [ "ResourceArn" ] }, "GetTagsResponse": { "type": "structure", "members": { "Tags": { "shape": "Tags", "locationName": "tags" } } }, "GetVpcLinkRequest": { "type": "structure", "members": { "VpcLinkId": { "shape": "__string", "location": "uri", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" } }, "required": [ "VpcLinkId" ] }, "GetVpcLinkResponse": { "type": "structure", "members": { "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the VPC link was created.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the VPC link.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "locationName": "securityGroupIds", "documentation": "A list of security group IDs for the VPC link.
" }, "SubnetIds": { "shape": "SubnetIdList", "locationName": "subnetIds", "documentation": "A list of subnet IDs to include in the VPC link.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "Tags for the VPC link.
" }, "VpcLinkId": { "shape": "Id", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" }, "VpcLinkStatus": { "shape": "VpcLinkStatus", "locationName": "vpcLinkStatus", "documentation": "The status of the VPC link.
" }, "VpcLinkStatusMessage": { "shape": "StringWithLengthBetween0And1024", "locationName": "vpcLinkStatusMessage", "documentation": "A message summarizing the cause of the status of the VPC link.
" }, "VpcLinkVersion": { "shape": "VpcLinkVersion", "locationName": "vpcLinkVersion", "documentation": "The version of the VPC link.
" } } }, "GetVpcLinksRequest": { "type": "structure", "members": { "MaxResults": { "shape": "__string", "location": "querystring", "locationName": "maxResults", "documentation": "The maximum number of elements to be returned for this resource.
" }, "NextToken": { "shape": "__string", "location": "querystring", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "GetVpcLinksResponse": { "type": "structure", "members": { "Items": { "shape": "__listOfVpcLink", "locationName": "items", "documentation": "A collection of VPC links.
" }, "NextToken": { "shape": "NextToken", "locationName": "nextToken", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" } } }, "Id": { "type": "string", "documentation": "The identifier.
" }, "IdentitySourceList": { "type": "list", "documentation": "The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
", "member": { "shape": "__string" } }, "ImportApiRequest": { "type": "structure", "members": { "Basepath": { "shape": "__string", "location": "querystring", "locationName": "basepath", "documentation": "Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
" }, "Body": { "shape": "__string", "locationName": "body", "documentation": "The OpenAPI definition. Supported only for HTTP APIs.
" }, "FailOnWarnings": { "shape": "__boolean", "location": "querystring", "locationName": "failOnWarnings", "documentation": "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
" } }, "documentation": "", "required": [ "Body" ] }, "ImportApiResponse": { "type": "structure", "members": { "ApiEndpoint": { "shape": "__string", "locationName": "apiEndpoint", "documentation": "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
" }, "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API ID.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the API was created.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "ImportInfo": { "shape": "__listOf__string", "locationName": "importInfo", "documentation": "The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A collection of tags associated with the API.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" }, "Warnings": { "shape": "__listOf__string", "locationName": "warnings", "documentation": "The warning messages reported when failonwarnings is turned on during API import.
" } } }, "IntegerWithLengthBetween0And3600": { "type": "integer", "documentation": "An integer with a value between [0-3600].
", "min": 0, "max": 3600 }, "IntegerWithLengthBetween50And30000": { "type": "integer", "documentation": "An integer with a value between [50-30000].
", "min": 50, "max": 30000 }, "IntegerWithLengthBetweenMinus1And86400": { "type": "integer", "documentation": "An integer with a value between -1 and 86400. Supported only for HTTP APIs.
", "min": -1, "max": 86400 }, "Integration": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
" }, "ConnectionId": { "shape": "StringWithLengthBetween1And1024", "locationName": "connectionId", "documentation": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.
" }, "ConnectionType": { "shape": "ConnectionType", "locationName": "connectionType", "documentation": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "Represents the description of an integration.
" }, "IntegrationId": { "shape": "Id", "locationName": "integrationId", "documentation": "Represents the identifier of an integration.
" }, "IntegrationMethod": { "shape": "StringWithLengthBetween1And64", "locationName": "integrationMethod", "documentation": "Specifies the integration's HTTP method type.
" }, "IntegrationResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "integrationResponseSelectionExpression", "documentation": "The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
" }, "IntegrationSubtype": { "shape": "StringWithLengthBetween1And128", "locationName": "integrationSubtype", "documentation": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
" }, "IntegrationType": { "shape": "IntegrationType", "locationName": "integrationType", "documentation": "The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.
" }, "IntegrationUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "integrationUri", "documentation": "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior": { "shape": "PassthroughBehavior", "locationName": "passthroughBehavior", "documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
" }, "PayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "payloadFormatVersion", "documentation": "Specifies the format of the payload sent to an integration. Required for HTTP APIs.
" }, "RequestParameters": { "shape": "IntegrationParameters", "locationName": "requestParameters", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "RequestTemplates": { "shape": "TemplateMap", "locationName": "requestTemplates", "documentation": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
" }, "ResponseParameters": { "shape": "ResponseParameters", "locationName": "responseParameters", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis": { "shape": "IntegerWithLengthBetween50And30000", "locationName": "timeoutInMillis", "documentation": "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig": { "shape": "TlsConfig", "locationName": "tlsConfig", "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" } }, "documentation": "Represents an integration.
" }, "IntegrationParameters": { "type": "map", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
", "key": { "shape": "__string" }, "value": { "shape": "StringWithLengthBetween1And512" } }, "IntegrationResponse": { "type": "structure", "members": { "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "IntegrationResponseId": { "shape": "Id", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" }, "IntegrationResponseKey": { "shape": "SelectionKey", "locationName": "integrationResponseKey", "documentation": "The integration response key.
" }, "ResponseParameters": { "shape": "IntegrationParameters", "locationName": "responseParameters", "documentation": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" }, "ResponseTemplates": { "shape": "TemplateMap", "locationName": "responseTemplates", "documentation": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expressions for the integration response.
" } }, "documentation": "Represents an integration response.
", "required": [ "IntegrationResponseKey" ] }, "IntegrationType": { "type": "string", "documentation": "Represents an API method integration type.
", "enum": [ "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY" ] }, "JWTConfiguration": { "type": "structure", "members": { "Audience": { "shape": "__listOf__string", "locationName": "audience", "documentation": "A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.
" }, "Issuer": { "shape": "UriWithLengthBetween1And2048", "locationName": "issuer", "documentation": "The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "LoggingLevel": { "type": "string", "documentation": "The logging level.
", "enum": [ "ERROR", "INFO", "OFF" ] }, "Model": { "type": "structure", "members": { "ContentType": { "shape": "StringWithLengthBetween1And256", "locationName": "contentType", "documentation": "The content-type for the model, for example, \"application/json\".
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the model.
" }, "ModelId": { "shape": "Id", "locationName": "modelId", "documentation": "The model identifier.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the model. Must be alphanumeric.
" }, "Schema": { "shape": "StringWithLengthBetween0And32K", "locationName": "schema", "documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" } }, "documentation": "Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
", "required": [ "Name" ] }, "MutualTlsAuthentication": { "type": "structure", "members": { "TruststoreUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "truststoreUri", "documentation": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
" }, "TruststoreWarnings": { "shape": "__listOf__string", "locationName": "truststoreWarnings", "documentation": "A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
" } } }, "MutualTlsAuthenticationInput": { "type": "structure", "members": { "TruststoreUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "truststoreUri", "documentation": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
" } } }, "NextToken": { "type": "string", "documentation": "The next page of elements from this collection. Not valid for the last element of the collection.
" }, "ParameterConstraints": { "type": "structure", "members": { "Required": { "shape": "__boolean", "locationName": "required", "documentation": "Whether or not the parameter is required.
" } }, "documentation": "Validation constraints imposed on parameters of a request (path, query string, headers).
" }, "PassthroughBehavior": { "type": "string", "documentation": "Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
", "enum": [ "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES" ] }, "ProtocolType": { "type": "string", "documentation": "Represents a protocol type.", "enum": [ "WEBSOCKET", "HTTP" ] }, "ReimportApiRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "Basepath": { "shape": "__string", "location": "querystring", "locationName": "basepath", "documentation": "Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
" }, "Body": { "shape": "__string", "locationName": "body", "documentation": "The OpenAPI definition. Supported only for HTTP APIs.
" }, "FailOnWarnings": { "shape": "__boolean", "location": "querystring", "locationName": "failOnWarnings", "documentation": "Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
" } }, "documentation": "", "required": [ "ApiId", "Body" ] }, "ReimportApiResponse": { "type": "structure", "members": { "ApiEndpoint": { "shape": "__string", "locationName": "apiEndpoint", "documentation": "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
" }, "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API ID.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the API was created.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "ImportInfo": { "shape": "__listOf__string", "locationName": "importInfo", "documentation": "The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A collection of tags associated with the API.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" }, "Warnings": { "shape": "__listOf__string", "locationName": "warnings", "documentation": "The warning messages reported when failonwarnings is turned on during API import.
" } } }, "ResponseParameters": { "type": "map", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
", "key": { "shape": "__string" }, "value": { "shape": "IntegrationParameters" } }, "Route": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
" }, "ApiKeyRequired": { "shape": "__boolean", "locationName": "apiKeyRequired", "documentation": "Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
" }, "AuthorizationScopes": { "shape": "AuthorizationScopes", "locationName": "authorizationScopes", "documentation": "A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
" }, "AuthorizationType": { "shape": "AuthorizationType", "locationName": "authorizationType", "documentation": "The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route. Supported only for WebSocket APIs.
" }, "OperationName": { "shape": "StringWithLengthBetween1And64", "locationName": "operationName", "documentation": "The operation name for the route.
" }, "RequestModels": { "shape": "RouteModels", "locationName": "requestModels", "documentation": "The request models for the route. Supported only for WebSocket APIs.
" }, "RequestParameters": { "shape": "RouteParameters", "locationName": "requestParameters", "documentation": "The request parameters for the route. Supported only for WebSocket APIs.
" }, "RouteId": { "shape": "Id", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "The route key for the route.
" }, "RouteResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeResponseSelectionExpression", "documentation": "The route response selection expression for the route. Supported only for WebSocket APIs.
" }, "Target": { "shape": "StringWithLengthBetween1And128", "locationName": "target", "documentation": "The target for the route.
" } }, "documentation": "Represents a route.
", "required": [ "RouteKey" ] }, "RouteModels": { "type": "map", "documentation": "The route models.
", "key": { "shape": "__string" }, "value": { "shape": "StringWithLengthBetween1And128" } }, "RouteParameters": { "type": "map", "documentation": "The route parameters.
", "key": { "shape": "__string" }, "value": { "shape": "ParameterConstraints" } }, "RouteResponse": { "type": "structure", "members": { "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "Represents the model selection expression of a route response. Supported only for WebSocket APIs.
" }, "ResponseModels": { "shape": "RouteModels", "locationName": "responseModels", "documentation": "Represents the response models of a route response.
" }, "ResponseParameters": { "shape": "RouteParameters", "locationName": "responseParameters", "documentation": "Represents the response parameters of a route response.
" }, "RouteResponseId": { "shape": "Id", "locationName": "routeResponseId", "documentation": "Represents the identifier of a route response.
" }, "RouteResponseKey": { "shape": "SelectionKey", "locationName": "routeResponseKey", "documentation": "Represents the route response key of a route response.
" } }, "documentation": "Represents a route response.
", "required": [ "RouteResponseKey" ] }, "RouteSettings": { "type": "structure", "members": { "DataTraceEnabled": { "shape": "__boolean", "locationName": "dataTraceEnabled", "documentation": "Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
" }, "DetailedMetricsEnabled": { "shape": "__boolean", "locationName": "detailedMetricsEnabled", "documentation": "Specifies whether detailed metrics are enabled.
" }, "LoggingLevel": { "shape": "LoggingLevel", "locationName": "loggingLevel", "documentation": "Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
" }, "ThrottlingBurstLimit": { "shape": "__integer", "locationName": "throttlingBurstLimit", "documentation": "Specifies the throttling burst limit.
" }, "ThrottlingRateLimit": { "shape": "__double", "locationName": "throttlingRateLimit", "documentation": "Specifies the throttling rate limit.
" } }, "documentation": "Represents a collection of route settings.
" }, "RouteSettingsMap": { "type": "map", "documentation": "The route settings map.
", "key": { "shape": "__string" }, "value": { "shape": "RouteSettings" } }, "SecurityGroupIdList": { "type": "list", "documentation": "A list of security group IDs for the VPC link.
", "member": { "shape": "__string" } }, "SecurityPolicy": { "type": "string", "documentation": "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.
", "enum": [ "TLS_1_0", "TLS_1_2" ] }, "SelectionExpression": { "type": "string", "documentation": "An expression used to extract information at runtime. See Selection Expressions for more information.
" }, "SelectionKey": { "type": "string", "documentation": "After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
" }, "Stage": { "type": "structure", "members": { "AccessLogSettings": { "shape": "AccessLogSettings", "locationName": "accessLogSettings", "documentation": "Settings for logging access in this stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
" }, "AutoDeploy": { "shape": "__boolean", "locationName": "autoDeploy", "documentation": "Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
" }, "ClientCertificateId": { "shape": "Id", "locationName": "clientCertificateId", "documentation": "The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the stage was created.
" }, "DefaultRouteSettings": { "shape": "RouteSettings", "locationName": "defaultRouteSettings", "documentation": "Default route settings for the stage.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the stage.
" }, "LastDeploymentStatusMessage": { "shape": "__string", "locationName": "lastDeploymentStatusMessage", "documentation": "Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
" }, "LastUpdatedDate": { "shape": "__timestampIso8601", "locationName": "lastUpdatedDate", "documentation": "The timestamp when the stage was last updated.
" }, "RouteSettings": { "shape": "RouteSettingsMap", "locationName": "routeSettings", "documentation": "Route settings for the stage, by routeKey.
" }, "StageName": { "shape": "StringWithLengthBetween1And128", "locationName": "stageName", "documentation": "The name of the stage.
" }, "StageVariables": { "shape": "StageVariablesMap", "locationName": "stageVariables", "documentation": "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" } }, "documentation": "Represents an API stage.
", "required": [ "StageName" ] }, "StageVariablesMap": { "type": "map", "documentation": "The stage variable map.
", "key": { "shape": "__string" }, "value": { "shape": "StringWithLengthBetween0And2048" } }, "StringWithLengthBetween0And1024": { "type": "string", "documentation": "A string with a length between [0-1024].
" }, "StringWithLengthBetween0And2048": { "type": "string", "documentation": "A string with a length between [0-2048].
" }, "StringWithLengthBetween0And32K": { "type": "string", "documentation": "A string with a length between [0-32768].
" }, "StringWithLengthBetween1And1024": { "type": "string", "documentation": "A string with a length between [1-1024].
" }, "StringWithLengthBetween1And128": { "type": "string", "documentation": "A string with a length between [1-128].
" }, "StringWithLengthBetween1And1600": { "type": "string", "documentation": "A string with a length between [0-1600].
" }, "StringWithLengthBetween1And256": { "type": "string", "documentation": "A string with a length between [1-256].
" }, "StringWithLengthBetween1And512": { "type": "string", "documentation": "A string with a length between [1-512].
" }, "StringWithLengthBetween1And64": { "type": "string", "documentation": "A string with a length between [1-64].
" }, "SubnetIdList": { "type": "list", "documentation": "A list of subnet IDs to include in the VPC link.
", "member": { "shape": "__string" } }, "TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resource-arn", "documentation": "The resource ARN for the tag.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" } }, "documentation": "Creates a new Tag resource to represent a tag.
", "required": [ "ResourceArn" ] }, "TagResourceResponse": { "type": "structure", "members": {} }, "Tags": { "type": "map", "documentation": "Represents a collection of tags associated with the resource.
", "key": { "shape": "__string" }, "value": { "shape": "StringWithLengthBetween1And1600" } }, "TemplateMap": { "type": "map", "documentation": "A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
", "key": { "shape": "__string" }, "value": { "shape": "StringWithLengthBetween0And32K" } }, "TlsConfig": { "type": "structure", "members": { "ServerNameToVerify": { "shape": "StringWithLengthBetween1And512", "locationName": "serverNameToVerify", "documentation": "If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
" } }, "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" }, "TlsConfigInput": { "type": "structure", "members": { "ServerNameToVerify": { "shape": "StringWithLengthBetween1And512", "locationName": "serverNameToVerify", "documentation": "If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
" } }, "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" }, "UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "shape": "__string", "location": "uri", "locationName": "resource-arn", "documentation": "The resource ARN for the tag.
" }, "TagKeys": { "shape": "__listOf__string", "location": "querystring", "locationName": "tagKeys", "documentation": "The Tag keys to delete
" } }, "required": [ "ResourceArn", "TagKeys" ] }, "UpdateApiMappingRequest": { "type": "structure", "members": { "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiMappingId": { "shape": "__string", "location": "uri", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "ApiMappingKey": { "shape": "SelectionKey", "locationName": "apiMappingKey", "documentation": "The API mapping key.
" }, "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" }, "Stage": { "shape": "StringWithLengthBetween1And128", "locationName": "stage", "documentation": "The API stage.
" } }, "documentation": "Updates an ApiMapping.
", "required": [ "ApiMappingId", "ApiId", "DomainName" ] }, "UpdateApiMappingResponse": { "type": "structure", "members": { "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiMappingId": { "shape": "Id", "locationName": "apiMappingId", "documentation": "The API mapping identifier.
" }, "ApiMappingKey": { "shape": "SelectionKey", "locationName": "apiMappingKey", "documentation": "The API mapping key.
" }, "Stage": { "shape": "StringWithLengthBetween1And128", "locationName": "stage", "documentation": "The API stage.
" } } }, "UpdateApiRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Target": { "shape": "UriWithLengthBetween1And2048", "locationName": "target", "documentation": "This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" } }, "documentation": "Updates an Api.
", "required": [ "ApiId" ] }, "UpdateApiResponse": { "type": "structure", "members": { "ApiEndpoint": { "shape": "__string", "locationName": "apiEndpoint", "documentation": "The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
" }, "ApiId": { "shape": "Id", "locationName": "apiId", "documentation": "The API ID.
" }, "ApiKeySelectionExpression": { "shape": "SelectionExpression", "locationName": "apiKeySelectionExpression", "documentation": "An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
" }, "CorsConfiguration": { "shape": "Cors", "locationName": "corsConfiguration", "documentation": "A CORS configuration. Supported only for HTTP APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the API was created.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the API.
" }, "DisableSchemaValidation": { "shape": "__boolean", "locationName": "disableSchemaValidation", "documentation": "Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
" }, "DisableExecuteApiEndpoint": { "shape": "__boolean", "locationName": "disableExecuteApiEndpoint", "documentation": "Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
" }, "ImportInfo": { "shape": "__listOf__string", "locationName": "importInfo", "documentation": "The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the API.
" }, "ProtocolType": { "shape": "ProtocolType", "locationName": "protocolType", "documentation": "The API protocol.
" }, "RouteSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeSelectionExpression", "documentation": "The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "A collection of tags associated with the API.
" }, "Version": { "shape": "StringWithLengthBetween1And64", "locationName": "version", "documentation": "A version identifier for the API.
" }, "Warnings": { "shape": "__listOf__string", "locationName": "warnings", "documentation": "The warning messages reported when failonwarnings is turned on during API import.
" } } }, "UpdateAuthorizerRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "AuthorizerCredentialsArn": { "shape": "Arn", "locationName": "authorizerCredentialsArn", "documentation": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.
" }, "AuthorizerId": { "shape": "__string", "location": "uri", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" }, "AuthorizerPayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "authorizerPayloadFormatVersion", "documentation": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
" }, "AuthorizerResultTtlInSeconds": { "shape": "IntegerWithLengthBetween0And3600", "locationName": "authorizerResultTtlInSeconds", "documentation": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
" }, "AuthorizerType": { "shape": "AuthorizerType", "locationName": "authorizerType", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
" }, "AuthorizerUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "authorizerUri", "documentation": "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
" }, "IdentitySource": { "shape": "IdentitySourceList", "locationName": "identitySource", "documentation": "The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
" }, "IdentityValidationExpression": { "shape": "StringWithLengthBetween0And1024", "locationName": "identityValidationExpression", "documentation": "This parameter is not used.
" }, "JwtConfiguration": { "shape": "JWTConfiguration", "locationName": "jwtConfiguration", "documentation": "Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the authorizer.
" } }, "documentation": "Updates an Authorizer.
", "required": [ "AuthorizerId", "ApiId" ] }, "UpdateAuthorizerResponse": { "type": "structure", "members": { "AuthorizerCredentialsArn": { "shape": "Arn", "locationName": "authorizerCredentialsArn", "documentation": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The authorizer identifier.
" }, "AuthorizerPayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "authorizerPayloadFormatVersion", "documentation": "Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
" }, "AuthorizerResultTtlInSeconds": { "shape": "IntegerWithLengthBetween0And3600", "locationName": "authorizerResultTtlInSeconds", "documentation": "The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
" }, "AuthorizerType": { "shape": "AuthorizerType", "locationName": "authorizerType", "documentation": "The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
" }, "AuthorizerUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "authorizerUri", "documentation": "The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
" }, "IdentitySource": { "shape": "IdentitySourceList", "locationName": "identitySource", "documentation": "The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
" }, "IdentityValidationExpression": { "shape": "StringWithLengthBetween0And1024", "locationName": "identityValidationExpression", "documentation": "The validation expression does not apply to the REQUEST authorizer.
" }, "JwtConfiguration": { "shape": "JWTConfiguration", "locationName": "jwtConfiguration", "documentation": "Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the authorizer.
" } } }, "UpdateDeploymentRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "DeploymentId": { "shape": "__string", "location": "uri", "locationName": "deploymentId", "documentation": "The deployment ID.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the deployment resource.
" } }, "documentation": "Updates a Deployment.
", "required": [ "ApiId", "DeploymentId" ] }, "UpdateDeploymentResponse": { "type": "structure", "members": { "AutoDeployed": { "shape": "__boolean", "locationName": "autoDeployed", "documentation": "Specifies whether a deployment was automatically released.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The date and time when the Deployment resource was created.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier for the deployment.
" }, "DeploymentStatus": { "shape": "DeploymentStatus", "locationName": "deploymentStatus", "documentation": "The status of the deployment: PENDING, FAILED, or SUCCEEDED.
" }, "DeploymentStatusMessage": { "shape": "__string", "locationName": "deploymentStatusMessage", "documentation": "May contain additional feedback on the status of an API deployment.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the deployment.
" } } }, "UpdateDomainNameRequest": { "type": "structure", "members": { "DomainName": { "shape": "__string", "location": "uri", "locationName": "domainName", "documentation": "The domain name.
" }, "DomainNameConfigurations": { "shape": "DomainNameConfigurations", "locationName": "domainNameConfigurations", "documentation": "The domain name configurations.
" }, "MutualTlsAuthentication": { "shape": "MutualTlsAuthenticationInput", "locationName": "mutualTlsAuthentication", "documentation": "The mutual TLS authentication configuration for a custom domain name.
" } }, "documentation": "Updates a DomainName.
", "required": [ "DomainName" ] }, "UpdateDomainNameResponse": { "type": "structure", "members": { "ApiMappingSelectionExpression": { "shape": "SelectionExpression", "locationName": "apiMappingSelectionExpression", "documentation": "The API mapping selection expression.
" }, "DomainName": { "shape": "StringWithLengthBetween1And512", "locationName": "domainName", "documentation": "The name of the DomainName resource.
" }, "DomainNameConfigurations": { "shape": "DomainNameConfigurations", "locationName": "domainNameConfigurations", "documentation": "The domain name configurations.
" }, "MutualTlsAuthentication": { "shape": "MutualTlsAuthentication", "locationName": "mutualTlsAuthentication", "documentation": "The mutual TLS authentication configuration for a custom domain name.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags associated with a domain name.
" } } }, "UpdateIntegrationRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ConnectionId": { "shape": "StringWithLengthBetween1And1024", "locationName": "connectionId", "documentation": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.
" }, "ConnectionType": { "shape": "ConnectionType", "locationName": "connectionType", "documentation": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the integration
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" }, "IntegrationMethod": { "shape": "StringWithLengthBetween1And64", "locationName": "integrationMethod", "documentation": "Specifies the integration's HTTP method type.
" }, "IntegrationSubtype": { "shape": "StringWithLengthBetween1And128", "locationName": "integrationSubtype", "documentation": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
" }, "IntegrationType": { "shape": "IntegrationType", "locationName": "integrationType", "documentation": "The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.
" }, "IntegrationUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "integrationUri", "documentation": "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior": { "shape": "PassthroughBehavior", "locationName": "passthroughBehavior", "documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
" }, "PayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "payloadFormatVersion", "documentation": "Specifies the format of the payload sent to an integration. Required for HTTP APIs.
" }, "RequestParameters": { "shape": "IntegrationParameters", "locationName": "requestParameters", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "RequestTemplates": { "shape": "TemplateMap", "locationName": "requestTemplates", "documentation": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
" }, "ResponseParameters": { "shape": "ResponseParameters", "locationName": "responseParameters", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration.
" }, "TimeoutInMillis": { "shape": "IntegerWithLengthBetween50And30000", "locationName": "timeoutInMillis", "documentation": "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig": { "shape": "TlsConfigInput", "locationName": "tlsConfig", "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" } }, "documentation": "Updates an Integration.
", "required": [ "ApiId", "IntegrationId" ] }, "UpdateIntegrationResult": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
" }, "ConnectionId": { "shape": "StringWithLengthBetween1And1024", "locationName": "connectionId", "documentation": "The ID of the VPC link for a private integration. Supported only for HTTP APIs.
" }, "ConnectionType": { "shape": "ConnectionType", "locationName": "connectionType", "documentation": "The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "CredentialsArn": { "shape": "Arn", "locationName": "credentialsArn", "documentation": "Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "Represents the description of an integration.
" }, "IntegrationId": { "shape": "Id", "locationName": "integrationId", "documentation": "Represents the identifier of an integration.
" }, "IntegrationMethod": { "shape": "StringWithLengthBetween1And64", "locationName": "integrationMethod", "documentation": "Specifies the integration's HTTP method type.
" }, "IntegrationResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "integrationResponseSelectionExpression", "documentation": "The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
" }, "IntegrationSubtype": { "shape": "StringWithLengthBetween1And128", "locationName": "integrationSubtype", "documentation": "Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
" }, "IntegrationType": { "shape": "IntegrationType", "locationName": "integrationType", "documentation": "The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.
" }, "IntegrationUri": { "shape": "UriWithLengthBetween1And2048", "locationName": "integrationUri", "documentation": "For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
" }, "PassthroughBehavior": { "shape": "PassthroughBehavior", "locationName": "passthroughBehavior", "documentation": "Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
" }, "PayloadFormatVersion": { "shape": "StringWithLengthBetween1And64", "locationName": "payloadFormatVersion", "documentation": "Specifies the format of the payload sent to an integration. Required for HTTP APIs.
" }, "RequestParameters": { "shape": "IntegrationParameters", "locationName": "requestParameters", "documentation": "For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "RequestTemplates": { "shape": "TemplateMap", "locationName": "requestTemplates", "documentation": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
" }, "ResponseParameters": { "shape": "ResponseParameters", "locationName": "responseParameters", "documentation": "Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration. Supported only for WebSocket APIs.
" }, "TimeoutInMillis": { "shape": "IntegerWithLengthBetween50And30000", "locationName": "timeoutInMillis", "documentation": "Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
" }, "TlsConfig": { "shape": "TlsConfig", "locationName": "tlsConfig", "documentation": "The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
" } } }, "UpdateIntegrationResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "IntegrationId": { "shape": "__string", "location": "uri", "locationName": "integrationId", "documentation": "The integration ID.
" }, "IntegrationResponseId": { "shape": "__string", "location": "uri", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" }, "IntegrationResponseKey": { "shape": "SelectionKey", "locationName": "integrationResponseKey", "documentation": "The integration response key.
" }, "ResponseParameters": { "shape": "IntegrationParameters", "locationName": "responseParameters", "documentation": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expression for the integration response. Supported only for WebSocket APIs.
" } }, "documentation": "Updates an IntegrationResponses.
", "required": [ "ApiId", "IntegrationResponseId", "IntegrationId" ] }, "UpdateIntegrationResponseResponse": { "type": "structure", "members": { "ContentHandlingStrategy": { "shape": "ContentHandlingStrategy", "locationName": "contentHandlingStrategy", "documentation": "Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" }, "IntegrationResponseId": { "shape": "Id", "locationName": "integrationResponseId", "documentation": "The integration response ID.
" }, "IntegrationResponseKey": { "shape": "SelectionKey", "locationName": "integrationResponseKey", "documentation": "The integration response key.
" }, "ResponseParameters": { "shape": "IntegrationParameters", "locationName": "responseParameters", "documentation": "A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
" }, "ResponseTemplates": { "shape": "TemplateMap", "locationName": "responseTemplates", "documentation": "The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
" }, "TemplateSelectionExpression": { "shape": "SelectionExpression", "locationName": "templateSelectionExpression", "documentation": "The template selection expressions for the integration response.
" } } }, "UpdateModelRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ContentType": { "shape": "StringWithLengthBetween1And256", "locationName": "contentType", "documentation": "The content-type for the model, for example, \"application/json\".
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the model.
" }, "ModelId": { "shape": "__string", "location": "uri", "locationName": "modelId", "documentation": "The model ID.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the model.
" }, "Schema": { "shape": "StringWithLengthBetween0And32K", "locationName": "schema", "documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" } }, "documentation": "Updates a Model.
", "required": [ "ModelId", "ApiId" ] }, "UpdateModelResponse": { "type": "structure", "members": { "ContentType": { "shape": "StringWithLengthBetween1And256", "locationName": "contentType", "documentation": "The content-type for the model, for example, \"application/json\".
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the model.
" }, "ModelId": { "shape": "Id", "locationName": "modelId", "documentation": "The model identifier.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the model. Must be alphanumeric.
" }, "Schema": { "shape": "StringWithLengthBetween0And32K", "locationName": "schema", "documentation": "The schema for the model. For application/json models, this should be JSON schema draft 4 model.
" } } }, "UpdateRouteRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ApiKeyRequired": { "shape": "__boolean", "locationName": "apiKeyRequired", "documentation": "Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
" }, "AuthorizationScopes": { "shape": "AuthorizationScopes", "locationName": "authorizationScopes", "documentation": "The authorization scopes supported by this route.
" }, "AuthorizationType": { "shape": "AuthorizationType", "locationName": "authorizationType", "documentation": "The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route. Supported only for WebSocket APIs.
" }, "OperationName": { "shape": "StringWithLengthBetween1And64", "locationName": "operationName", "documentation": "The operation name for the route.
" }, "RequestModels": { "shape": "RouteModels", "locationName": "requestModels", "documentation": "The request models for the route. Supported only for WebSocket APIs.
" }, "RequestParameters": { "shape": "RouteParameters", "locationName": "requestParameters", "documentation": "The request parameters for the route. Supported only for WebSocket APIs.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "The route key for the route.
" }, "RouteResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeResponseSelectionExpression", "documentation": "The route response selection expression for the route. Supported only for WebSocket APIs.
" }, "Target": { "shape": "StringWithLengthBetween1And128", "locationName": "target", "documentation": "The target for the route.
" } }, "documentation": "Updates a Route.
", "required": [ "ApiId", "RouteId" ] }, "UpdateRouteResult": { "type": "structure", "members": { "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
" }, "ApiKeyRequired": { "shape": "__boolean", "locationName": "apiKeyRequired", "documentation": "Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
" }, "AuthorizationScopes": { "shape": "AuthorizationScopes", "locationName": "authorizationScopes", "documentation": "A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
" }, "AuthorizationType": { "shape": "AuthorizationType", "locationName": "authorizationType", "documentation": "The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
" }, "AuthorizerId": { "shape": "Id", "locationName": "authorizerId", "documentation": "The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route. Supported only for WebSocket APIs.
" }, "OperationName": { "shape": "StringWithLengthBetween1And64", "locationName": "operationName", "documentation": "The operation name for the route.
" }, "RequestModels": { "shape": "RouteModels", "locationName": "requestModels", "documentation": "The request models for the route. Supported only for WebSocket APIs.
" }, "RequestParameters": { "shape": "RouteParameters", "locationName": "requestParameters", "documentation": "The request parameters for the route. Supported only for WebSocket APIs.
" }, "RouteId": { "shape": "Id", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteKey": { "shape": "SelectionKey", "locationName": "routeKey", "documentation": "The route key for the route.
" }, "RouteResponseSelectionExpression": { "shape": "SelectionExpression", "locationName": "routeResponseSelectionExpression", "documentation": "The route response selection expression for the route. Supported only for WebSocket APIs.
" }, "Target": { "shape": "StringWithLengthBetween1And128", "locationName": "target", "documentation": "The target for the route.
" } } }, "UpdateRouteResponseRequest": { "type": "structure", "members": { "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "The model selection expression for the route response. Supported only for WebSocket APIs.
" }, "ResponseModels": { "shape": "RouteModels", "locationName": "responseModels", "documentation": "The response models for the route response.
" }, "ResponseParameters": { "shape": "RouteParameters", "locationName": "responseParameters", "documentation": "The route response parameters.
" }, "RouteId": { "shape": "__string", "location": "uri", "locationName": "routeId", "documentation": "The route ID.
" }, "RouteResponseId": { "shape": "__string", "location": "uri", "locationName": "routeResponseId", "documentation": "The route response ID.
" }, "RouteResponseKey": { "shape": "SelectionKey", "locationName": "routeResponseKey", "documentation": "The route response key.
" } }, "documentation": "Updates a RouteResponse.
", "required": [ "RouteResponseId", "ApiId", "RouteId" ] }, "UpdateRouteResponseResponse": { "type": "structure", "members": { "ModelSelectionExpression": { "shape": "SelectionExpression", "locationName": "modelSelectionExpression", "documentation": "Represents the model selection expression of a route response. Supported only for WebSocket APIs.
" }, "ResponseModels": { "shape": "RouteModels", "locationName": "responseModels", "documentation": "Represents the response models of a route response.
" }, "ResponseParameters": { "shape": "RouteParameters", "locationName": "responseParameters", "documentation": "Represents the response parameters of a route response.
" }, "RouteResponseId": { "shape": "Id", "locationName": "routeResponseId", "documentation": "Represents the identifier of a route response.
" }, "RouteResponseKey": { "shape": "SelectionKey", "locationName": "routeResponseKey", "documentation": "Represents the route response key of a route response.
" } } }, "UpdateStageRequest": { "type": "structure", "members": { "AccessLogSettings": { "shape": "AccessLogSettings", "locationName": "accessLogSettings", "documentation": "Settings for logging access in this stage.
" }, "ApiId": { "shape": "__string", "location": "uri", "locationName": "apiId", "documentation": "The API identifier.
" }, "AutoDeploy": { "shape": "__boolean", "locationName": "autoDeploy", "documentation": "Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
" }, "ClientCertificateId": { "shape": "Id", "locationName": "clientCertificateId", "documentation": "The identifier of a client certificate for a Stage.
" }, "DefaultRouteSettings": { "shape": "RouteSettings", "locationName": "defaultRouteSettings", "documentation": "The default route settings for the stage.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description for the API stage.
" }, "RouteSettings": { "shape": "RouteSettingsMap", "locationName": "routeSettings", "documentation": "Route settings for the stage.
" }, "StageName": { "shape": "__string", "location": "uri", "locationName": "stageName", "documentation": "The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
" }, "StageVariables": { "shape": "StageVariablesMap", "locationName": "stageVariables", "documentation": "A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" } }, "documentation": "Updates a Stage.
", "required": [ "StageName", "ApiId" ] }, "UpdateStageResponse": { "type": "structure", "members": { "AccessLogSettings": { "shape": "AccessLogSettings", "locationName": "accessLogSettings", "documentation": "Settings for logging access in this stage.
" }, "ApiGatewayManaged": { "shape": "__boolean", "locationName": "apiGatewayManaged", "documentation": "Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
" }, "AutoDeploy": { "shape": "__boolean", "locationName": "autoDeploy", "documentation": "Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
" }, "ClientCertificateId": { "shape": "Id", "locationName": "clientCertificateId", "documentation": "The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
" }, "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the stage was created.
" }, "DefaultRouteSettings": { "shape": "RouteSettings", "locationName": "defaultRouteSettings", "documentation": "Default route settings for the stage.
" }, "DeploymentId": { "shape": "Id", "locationName": "deploymentId", "documentation": "The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
" }, "Description": { "shape": "StringWithLengthBetween0And1024", "locationName": "description", "documentation": "The description of the stage.
" }, "LastDeploymentStatusMessage": { "shape": "__string", "locationName": "lastDeploymentStatusMessage", "documentation": "Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
" }, "LastUpdatedDate": { "shape": "__timestampIso8601", "locationName": "lastUpdatedDate", "documentation": "The timestamp when the stage was last updated.
" }, "RouteSettings": { "shape": "RouteSettingsMap", "locationName": "routeSettings", "documentation": "Route settings for the stage, by routeKey.
" }, "StageName": { "shape": "StringWithLengthBetween1And128", "locationName": "stageName", "documentation": "The name of the stage.
" }, "StageVariables": { "shape": "StageVariablesMap", "locationName": "stageVariables", "documentation": "A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "The collection of tags. Each tag element is associated with a given resource.
" } } }, "UpdateVpcLinkRequest": { "type": "structure", "members": { "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the VPC link.
" }, "VpcLinkId": { "shape": "__string", "location": "uri", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" } }, "documentation": "Updates a VPC link.
", "required": [ "VpcLinkId" ] }, "UpdateVpcLinkResponse": { "type": "structure", "members": { "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the VPC link was created.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the VPC link.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "locationName": "securityGroupIds", "documentation": "A list of security group IDs for the VPC link.
" }, "SubnetIds": { "shape": "SubnetIdList", "locationName": "subnetIds", "documentation": "A list of subnet IDs to include in the VPC link.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "Tags for the VPC link.
" }, "VpcLinkId": { "shape": "Id", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" }, "VpcLinkStatus": { "shape": "VpcLinkStatus", "locationName": "vpcLinkStatus", "documentation": "The status of the VPC link.
" }, "VpcLinkStatusMessage": { "shape": "StringWithLengthBetween0And1024", "locationName": "vpcLinkStatusMessage", "documentation": "A message summarizing the cause of the status of the VPC link.
" }, "VpcLinkVersion": { "shape": "VpcLinkVersion", "locationName": "vpcLinkVersion", "documentation": "The version of the VPC link.
" } } }, "UriWithLengthBetween1And2048": { "type": "string", "documentation": "A string representation of a URI with a length between [1-2048].
" }, "VpcLink": { "type": "structure", "members": { "CreatedDate": { "shape": "__timestampIso8601", "locationName": "createdDate", "documentation": "The timestamp when the VPC link was created.
" }, "Name": { "shape": "StringWithLengthBetween1And128", "locationName": "name", "documentation": "The name of the VPC link.
" }, "SecurityGroupIds": { "shape": "SecurityGroupIdList", "locationName": "securityGroupIds", "documentation": "A list of security group IDs for the VPC link.
" }, "SubnetIds": { "shape": "SubnetIdList", "locationName": "subnetIds", "documentation": "A list of subnet IDs to include in the VPC link.
" }, "Tags": { "shape": "Tags", "locationName": "tags", "documentation": "Tags for the VPC link.
" }, "VpcLinkId": { "shape": "Id", "locationName": "vpcLinkId", "documentation": "The ID of the VPC link.
" }, "VpcLinkStatus": { "shape": "VpcLinkStatus", "locationName": "vpcLinkStatus", "documentation": "The status of the VPC link.
" }, "VpcLinkStatusMessage": { "shape": "StringWithLengthBetween0And1024", "locationName": "vpcLinkStatusMessage", "documentation": "A message summarizing the cause of the status of the VPC link.
" }, "VpcLinkVersion": { "shape": "VpcLinkVersion", "locationName": "vpcLinkVersion", "documentation": "The version of the VPC link.
" } }, "documentation": "Represents a VPC link.
", "required": [ "VpcLinkId", "SecurityGroupIds", "SubnetIds", "Name" ] }, "VpcLinkStatus": { "type": "string", "documentation": "The status of the VPC link.
", "enum": [ "PENDING", "AVAILABLE", "DELETING", "FAILED", "INACTIVE" ] }, "VpcLinkVersion": { "type": "string", "documentation": "The version of the VPC link.
", "enum": [ "V2" ] }, "__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" } }, "__listOfVpcLink": { "type": "list", "member": { "shape": "VpcLink" } }, "__listOf__string": { "type": "list", "member": { "shape": "__string" } }, "__string": { "type": "string" }, "__timestampIso8601": { "type": "timestamp", "timestampFormat": "iso8601" } }, "documentation": "Amazon API Gateway V2
" }