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
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
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
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
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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: identityValidationExpression description: The validation expression does not apply to the REQUEST authorizer. JwtConfiguration: allOf: - "$ref": "#/components/schemas/JWTConfiguration" - xml: name: jwtConfiguration description: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the authorizer. __string: type: string __listOf__string: type: array items: "$ref": "#/components/schemas/__string" UriWithLengthBetween1And2048: type: string description: A string representation of a URI with a length between [1-2048]. CreateDeploymentResponse: type: object properties: AutoDeployed: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeployed description: Specifies whether a deployment was automatically released. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The date and time when the Deployment resource was created. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier for the deployment. DeploymentStatus: allOf: - "$ref": "#/components/schemas/DeploymentStatus" - xml: name: deploymentStatus description: 'The status of the deployment: PENDING, FAILED, or SUCCEEDED.' DeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: deploymentStatusMessage description: May contain additional feedback on the status of an API deployment. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the deployment. CreateDomainNameResponse: type: object properties: ApiMappingSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiMappingSelectionExpression description: The API mapping selection expression. DomainName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And512" - xml: name: domainName description: The name of the DomainName resource. DomainNameConfigurations: allOf: - "$ref": "#/components/schemas/DomainNameConfigurations" - xml: name: domainNameConfigurations description: The domain name configurations. MutualTlsAuthentication: allOf: - "$ref": "#/components/schemas/MutualTlsAuthentication" - xml: name: mutualTlsAuthentication description: The mutual TLS authentication configuration for a custom domain name. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags associated with a domain name. DomainNameConfiguration: type: object properties: ApiGatewayDomainName: allOf: - "$ref": "#/components/schemas/__string" - xml: name: apiGatewayDomainName description: A domain name for the API. CertificateArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: certificateArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: certificateName description: The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name. CertificateUploadDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: certificateUploadDate description: The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded. DomainNameStatus: allOf: - "$ref": "#/components/schemas/DomainNameStatus" - xml: name: domainNameStatus description: 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: allOf: - "$ref": "#/components/schemas/__string" - xml: name: domainNameStatusMessage description: An optional text message containing detailed information about status of the domain name migration. EndpointType: allOf: - "$ref": "#/components/schemas/EndpointType" - xml: name: endpointType description: The endpoint type. HostedZoneId: allOf: - "$ref": "#/components/schemas/__string" - xml: name: hostedZoneId description: The Amazon Route 53 Hosted Zone ID of the endpoint. SecurityPolicy: allOf: - "$ref": "#/components/schemas/SecurityPolicy" - xml: name: securityPolicy description: 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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: ownershipVerificationCertificateArn description: 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 description: The domain name configuration. StringWithLengthBetween1And64: type: string description: A string with a length between [1-64]. AccessDeniedException: {} CreateIntegrationResult: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And1024" - xml: name: connectionId description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - xml: name: connectionType description: 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: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - xml: name: contentHandlingStrategy description: "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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: Represents the description of an integration. IntegrationId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationId description: Represents the identifier of an integration. IntegrationMethod: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: integrationMethod description: Specifies the integration's HTTP method type. IntegrationResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: integrationResponseSelectionExpression description: The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions. IntegrationSubtype: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: integrationSubtype description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. IntegrationType: allOf: - "$ref": "#/components/schemas/IntegrationType" - xml: name: integrationType description: '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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: integrationUri description: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: allOf: - "$ref": "#/components/schemas/PassthroughBehavior" - xml: name: passthroughBehavior description: "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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: payloadFormatVersion description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: requestParameters description: "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
itegrations, 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
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
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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationResponseId description: The integration response ID. IntegrationResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: integrationResponseKey description: The integration response key. ResponseParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: responseParameters description: 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: allOf: - "$ref": "#/components/schemas/TemplateMap" - xml: name: responseTemplates description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: templateSelectionExpression description: The template selection expressions for the integration response. CreateModelResponse: type: object properties: ContentType: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And256" - xml: name: contentType description: The content-type for the model, for example, "application/json". Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the model. ModelId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: modelId description: The model identifier. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the model. Must be alphanumeric. Schema: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And32K" - xml: name: schema description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. CreateRouteResult: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiKeyRequired description: Specifies whether an API key is required for this route. Supported only for WebSocket APIs. AuthorizationScopes: allOf: - "$ref": "#/components/schemas/AuthorizationScopes" - xml: name: authorizationScopes description: 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: allOf: - "$ref": "#/components/schemas/AuthorizationType" - xml: name: authorizationType description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: The model selection expression for the route. Supported only for WebSocket APIs. OperationName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: operationName description: The operation name for the route. RequestModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: requestModels description: The request models for the route. Supported only for WebSocket APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: requestParameters description: The request parameters for the route. Supported only for WebSocket APIs. RouteId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeId description: The route ID. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: The route key for the route. RouteResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeResponseSelectionExpression description: The route response selection expression for the route. Supported only for WebSocket APIs. Target: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: target description: The target for the route. StringWithLengthBetween1And128: type: string description: A string with a length between [1-128]. ParameterConstraints: type: object properties: Required: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: required description: Whether or not the parameter is required. description: Validation constraints imposed on parameters of a request (path, query string, headers). CreateRouteResponseResponse: type: object properties: ModelSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: Represents the model selection expression of a route response. Supported only for WebSocket APIs. ResponseModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: responseModels description: Represents the response models of a route response. ResponseParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: responseParameters description: Represents the response parameters of a route response. RouteResponseId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeResponseId description: Represents the identifier of a route response. RouteResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeResponseKey description: Represents the route response key of a route response. CreateStageResponse: type: object properties: AccessLogSettings: allOf: - "$ref": "#/components/schemas/AccessLogSettings" - xml: name: accessLogSettings description: Settings for logging access in this stage. ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeploy description: Specifies whether updates to an API automatically trigger a new deployment. The default value is false. ClientCertificateId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: clientCertificateId description: The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the stage was created. DefaultRouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettings" - xml: name: defaultRouteSettings description: Default route settings for the stage. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the stage. LastDeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: lastDeploymentStatusMessage description: Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled. LastUpdatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: lastUpdatedDate description: The timestamp when the stage was last updated. RouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettingsMap" - xml: name: routeSettings description: Route settings for the stage, by routeKey. StageName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stageName description: The name of the stage. StageVariables: allOf: - "$ref": "#/components/schemas/StageVariablesMap" - xml: name: stageVariables description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. Arn: type: string description: Represents an Amazon Resource Name (ARN). StringWithLengthBetween1And1024: type: string description: A string with a length between [1-1024]. LoggingLevel: type: string enum: - ERROR - INFO - false description: The logging level. __integer: type: integer __double: type: number format: double RouteSettings: type: object properties: DataTraceEnabled: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: dataTraceEnabled description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: detailedMetricsEnabled description: Specifies whether detailed metrics are enabled. LoggingLevel: allOf: - "$ref": "#/components/schemas/LoggingLevel" - xml: name: loggingLevel description: '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: allOf: - "$ref": "#/components/schemas/__integer" - xml: name: throttlingBurstLimit description: Specifies the throttling burst limit. ThrottlingRateLimit: allOf: - "$ref": "#/components/schemas/__double" - xml: name: throttlingRateLimit description: Specifies the throttling rate limit. description: Represents a collection of route settings. StringWithLengthBetween0And2048: type: string description: A string with a length between [0-2048]. CreateVpcLinkResponse: type: object properties: CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the VPC link was created. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the VPC link. SecurityGroupIds: allOf: - "$ref": "#/components/schemas/SecurityGroupIdList" - xml: name: securityGroupIds description: A list of security group IDs for the VPC link. SubnetIds: allOf: - "$ref": "#/components/schemas/SubnetIdList" - xml: name: subnetIds description: A list of subnet IDs to include in the VPC link. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: Tags for the VPC link. VpcLinkId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: vpcLinkId description: The ID of the VPC link. VpcLinkStatus: allOf: - "$ref": "#/components/schemas/VpcLinkStatus" - xml: name: vpcLinkStatus description: The status of the VPC link. VpcLinkStatusMessage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: vpcLinkStatusMessage description: A message summarizing the cause of the status of the VPC link. VpcLinkVersion: allOf: - "$ref": "#/components/schemas/VpcLinkVersion" - xml: name: vpcLinkVersion description: The version of the VPC link. DeleteVpcLinkResponse: type: object properties: {} ExportApiResponse: type: object properties: body: "$ref": "#/components/schemas/ExportedApi" GetApiResponse: type: object properties: ApiEndpoint: allOf: - "$ref": "#/components/schemas/__string" - xml: name: apiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API ID. ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the API was created. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: importInfo description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. ProtocolType: allOf: - "$ref": "#/components/schemas/ProtocolType" - xml: name: protocolType description: The API protocol. RouteSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: A collection of tags associated with the API. Version: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. Warnings: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: warnings description: The warning messages reported when failonwarnings is turned on during API import. GetApiMappingResponse: type: object properties: ApiId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API identifier. ApiMappingId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiMappingId description: The API mapping identifier. ApiMappingKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: apiMappingKey description: The API mapping key. Stage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stage description: The API stage. GetApiMappingsResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfApiMapping" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetApisResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfApi" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetAuthorizerResponse: type: object properties: AuthorizerCredentialsArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: authorizerCredentialsArn description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: The authorizer identifier. AuthorizerPayloadFormatVersion: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: authorizerPayloadFormatVersion description: 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: allOf: - "$ref": "#/components/schemas/IntegerWithLengthBetween0And3600" - xml: name: authorizerResultTtlInSeconds description: 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: allOf: - "$ref": "#/components/schemas/AuthorizerType" - xml: name: authorizerType description: 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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: authorizerUri description: |- 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: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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: identityValidationExpression description: The validation expression does not apply to the REQUEST authorizer. JwtConfiguration: allOf: - "$ref": "#/components/schemas/JWTConfiguration" - xml: name: jwtConfiguration description: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the authorizer. GetAuthorizersResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfAuthorizer" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetDeploymentResponse: type: object properties: AutoDeployed: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeployed description: Specifies whether a deployment was automatically released. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The date and time when the Deployment resource was created. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier for the deployment. DeploymentStatus: allOf: - "$ref": "#/components/schemas/DeploymentStatus" - xml: name: deploymentStatus description: 'The status of the deployment: PENDING, FAILED, or SUCCEEDED.' DeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: deploymentStatusMessage description: May contain additional feedback on the status of an API deployment. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the deployment. GetDeploymentsResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfDeployment" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetDomainNameResponse: type: object properties: ApiMappingSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiMappingSelectionExpression description: The API mapping selection expression. DomainName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And512" - xml: name: domainName description: The name of the DomainName resource. DomainNameConfigurations: allOf: - "$ref": "#/components/schemas/DomainNameConfigurations" - xml: name: domainNameConfigurations description: The domain name configurations. MutualTlsAuthentication: allOf: - "$ref": "#/components/schemas/MutualTlsAuthentication" - xml: name: mutualTlsAuthentication description: The mutual TLS authentication configuration for a custom domain name. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags associated with a domain name. GetDomainNamesResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfDomainName" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetIntegrationResult: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And1024" - xml: name: connectionId description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - xml: name: connectionType description: 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: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - xml: name: contentHandlingStrategy description: "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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: Represents the description of an integration. IntegrationId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationId description: Represents the identifier of an integration. IntegrationMethod: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: integrationMethod description: Specifies the integration's HTTP method type. IntegrationResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: integrationResponseSelectionExpression description: The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions. IntegrationSubtype: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: integrationSubtype description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. IntegrationType: allOf: - "$ref": "#/components/schemas/IntegrationType" - xml: name: integrationType description: '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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: integrationUri description: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: allOf: - "$ref": "#/components/schemas/PassthroughBehavior" - xml: name: passthroughBehavior description: "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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: payloadFormatVersion description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: requestParameters description: "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
itegrations, 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
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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationResponseId description: The integration response ID. IntegrationResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: integrationResponseKey description: The integration response key. ResponseParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: responseParameters description: 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: allOf: - "$ref": "#/components/schemas/TemplateMap" - xml: name: responseTemplates description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: templateSelectionExpression description: The template selection expressions for the integration response. GetIntegrationResponsesResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfIntegrationResponse" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetIntegrationsResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfIntegration" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetModelResponse: type: object properties: ContentType: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And256" - xml: name: contentType description: The content-type for the model, for example, "application/json". Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the model. ModelId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: modelId description: The model identifier. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the model. Must be alphanumeric. Schema: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And32K" - xml: name: schema description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. GetModelTemplateResponse: type: object properties: Value: allOf: - "$ref": "#/components/schemas/__string" - xml: name: value description: The template value. GetModelsResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfModel" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetRouteResult: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiKeyRequired description: Specifies whether an API key is required for this route. Supported only for WebSocket APIs. AuthorizationScopes: allOf: - "$ref": "#/components/schemas/AuthorizationScopes" - xml: name: authorizationScopes description: 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: allOf: - "$ref": "#/components/schemas/AuthorizationType" - xml: name: authorizationType description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: The model selection expression for the route. Supported only for WebSocket APIs. OperationName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: operationName description: The operation name for the route. RequestModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: requestModels description: The request models for the route. Supported only for WebSocket APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: requestParameters description: The request parameters for the route. Supported only for WebSocket APIs. RouteId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeId description: The route ID. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: The route key for the route. RouteResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeResponseSelectionExpression description: The route response selection expression for the route. Supported only for WebSocket APIs. Target: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: target description: The target for the route. GetRouteResponseResponse: type: object properties: ModelSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: Represents the model selection expression of a route response. Supported only for WebSocket APIs. ResponseModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: responseModels description: Represents the response models of a route response. ResponseParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: responseParameters description: Represents the response parameters of a route response. RouteResponseId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeResponseId description: Represents the identifier of a route response. RouteResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeResponseKey description: Represents the route response key of a route response. GetRouteResponsesResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfRouteResponse" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetRoutesResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfRoute" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetStageResponse: type: object properties: AccessLogSettings: allOf: - "$ref": "#/components/schemas/AccessLogSettings" - xml: name: accessLogSettings description: Settings for logging access in this stage. ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeploy description: Specifies whether updates to an API automatically trigger a new deployment. The default value is false. ClientCertificateId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: clientCertificateId description: The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the stage was created. DefaultRouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettings" - xml: name: defaultRouteSettings description: Default route settings for the stage. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the stage. LastDeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: lastDeploymentStatusMessage description: Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled. LastUpdatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: lastUpdatedDate description: The timestamp when the stage was last updated. RouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettingsMap" - xml: name: routeSettings description: Route settings for the stage, by routeKey. StageName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stageName description: The name of the stage. StageVariables: allOf: - "$ref": "#/components/schemas/StageVariablesMap" - xml: name: stageVariables description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. GetStagesResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfStage" - xml: name: items description: The elements from this collection. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. GetTagsResponse: type: object properties: Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags GetVpcLinkResponse: type: object properties: CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the VPC link was created. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the VPC link. SecurityGroupIds: allOf: - "$ref": "#/components/schemas/SecurityGroupIdList" - xml: name: securityGroupIds description: A list of security group IDs for the VPC link. SubnetIds: allOf: - "$ref": "#/components/schemas/SubnetIdList" - xml: name: subnetIds description: A list of subnet IDs to include in the VPC link. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: Tags for the VPC link. VpcLinkId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: vpcLinkId description: The ID of the VPC link. VpcLinkStatus: allOf: - "$ref": "#/components/schemas/VpcLinkStatus" - xml: name: vpcLinkStatus description: The status of the VPC link. VpcLinkStatusMessage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: vpcLinkStatusMessage description: A message summarizing the cause of the status of the VPC link. VpcLinkVersion: allOf: - "$ref": "#/components/schemas/VpcLinkVersion" - xml: name: vpcLinkVersion description: The version of the VPC link. GetVpcLinksResponse: type: object properties: Items: allOf: - "$ref": "#/components/schemas/__listOfVpcLink" - xml: name: items description: A collection of VPC links. NextToken: allOf: - "$ref": "#/components/schemas/NextToken" - xml: name: nextToken description: The next page of elements from this collection. Not valid for the last element of the collection. ImportApiResponse: type: object properties: ApiEndpoint: allOf: - "$ref": "#/components/schemas/__string" - xml: name: apiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API ID. ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the API was created. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: importInfo description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. ProtocolType: allOf: - "$ref": "#/components/schemas/ProtocolType" - xml: name: protocolType description: The API protocol. RouteSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: A collection of tags associated with the API. Version: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. Warnings: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: warnings description: The warning messages reported when failonwarnings is turned on during API import. ReimportApiResponse: type: object properties: ApiEndpoint: allOf: - "$ref": "#/components/schemas/__string" - xml: name: apiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API ID. ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the API was created. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: importInfo description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. ProtocolType: allOf: - "$ref": "#/components/schemas/ProtocolType" - xml: name: protocolType description: The API protocol. RouteSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: A collection of tags associated with the API. Version: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. Warnings: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: warnings description: The warning messages reported when failonwarnings is turned on during API import. TagResourceResponse: type: object properties: {} UpdateApiResponse: type: object properties: ApiEndpoint: allOf: - "$ref": "#/components/schemas/__string" - xml: name: apiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API ID. ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the API was created. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: importInfo description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. ProtocolType: allOf: - "$ref": "#/components/schemas/ProtocolType" - xml: name: protocolType description: The API protocol. RouteSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: A collection of tags associated with the API. Version: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. Warnings: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: warnings description: The warning messages reported when failonwarnings is turned on during API import. UpdateApiMappingResponse: type: object properties: ApiId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API identifier. ApiMappingId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiMappingId description: The API mapping identifier. ApiMappingKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: apiMappingKey description: The API mapping key. Stage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stage description: The API stage. UpdateAuthorizerResponse: type: object properties: AuthorizerCredentialsArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: authorizerCredentialsArn description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: The authorizer identifier. AuthorizerPayloadFormatVersion: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: authorizerPayloadFormatVersion description: 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: allOf: - "$ref": "#/components/schemas/IntegerWithLengthBetween0And3600" - xml: name: authorizerResultTtlInSeconds description: 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: allOf: - "$ref": "#/components/schemas/AuthorizerType" - xml: name: authorizerType description: 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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: authorizerUri description: |- 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: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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: identityValidationExpression description: The validation expression does not apply to the REQUEST authorizer. JwtConfiguration: allOf: - "$ref": "#/components/schemas/JWTConfiguration" - xml: name: jwtConfiguration description: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the authorizer. UpdateDeploymentResponse: type: object properties: AutoDeployed: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeployed description: Specifies whether a deployment was automatically released. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The date and time when the Deployment resource was created. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier for the deployment. DeploymentStatus: allOf: - "$ref": "#/components/schemas/DeploymentStatus" - xml: name: deploymentStatus description: 'The status of the deployment: PENDING, FAILED, or SUCCEEDED.' DeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: deploymentStatusMessage description: May contain additional feedback on the status of an API deployment. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the deployment. UpdateDomainNameResponse: type: object properties: ApiMappingSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiMappingSelectionExpression description: The API mapping selection expression. DomainName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And512" - xml: name: domainName description: The name of the DomainName resource. DomainNameConfigurations: allOf: - "$ref": "#/components/schemas/DomainNameConfigurations" - xml: name: domainNameConfigurations description: The domain name configurations. MutualTlsAuthentication: allOf: - "$ref": "#/components/schemas/MutualTlsAuthentication" - xml: name: mutualTlsAuthentication description: The mutual TLS authentication configuration for a custom domain name. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags associated with a domain name. UpdateIntegrationResult: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And1024" - xml: name: connectionId description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - xml: name: connectionType description: 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: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - xml: name: contentHandlingStrategy description: "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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: Represents the description of an integration. IntegrationId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationId description: Represents the identifier of an integration. IntegrationMethod: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: integrationMethod description: Specifies the integration's HTTP method type. IntegrationResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: integrationResponseSelectionExpression description: The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions. IntegrationSubtype: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: integrationSubtype description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. IntegrationType: allOf: - "$ref": "#/components/schemas/IntegrationType" - xml: name: integrationType description: '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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: integrationUri description: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: allOf: - "$ref": "#/components/schemas/PassthroughBehavior" - xml: name: passthroughBehavior description: "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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: payloadFormatVersion description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: requestParameters description: "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
itegrations, 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
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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationResponseId description: The integration response ID. IntegrationResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: integrationResponseKey description: The integration response key. ResponseParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: responseParameters description: 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: allOf: - "$ref": "#/components/schemas/TemplateMap" - xml: name: responseTemplates description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: templateSelectionExpression description: The template selection expressions for the integration response. UpdateModelResponse: type: object properties: ContentType: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And256" - xml: name: contentType description: The content-type for the model, for example, "application/json". Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the model. ModelId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: modelId description: The model identifier. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the model. Must be alphanumeric. Schema: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And32K" - xml: name: schema description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. UpdateRouteResult: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiKeyRequired description: Specifies whether an API key is required for this route. Supported only for WebSocket APIs. AuthorizationScopes: allOf: - "$ref": "#/components/schemas/AuthorizationScopes" - xml: name: authorizationScopes description: 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: allOf: - "$ref": "#/components/schemas/AuthorizationType" - xml: name: authorizationType description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: The model selection expression for the route. Supported only for WebSocket APIs. OperationName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: operationName description: The operation name for the route. RequestModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: requestModels description: The request models for the route. Supported only for WebSocket APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: requestParameters description: The request parameters for the route. Supported only for WebSocket APIs. RouteId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeId description: The route ID. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: The route key for the route. RouteResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeResponseSelectionExpression description: The route response selection expression for the route. Supported only for WebSocket APIs. Target: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: target description: The target for the route. UpdateRouteResponseResponse: type: object properties: ModelSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: Represents the model selection expression of a route response. Supported only for WebSocket APIs. ResponseModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: responseModels description: Represents the response models of a route response. ResponseParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: responseParameters description: Represents the response parameters of a route response. RouteResponseId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeResponseId description: Represents the identifier of a route response. RouteResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeResponseKey description: Represents the route response key of a route response. UpdateStageResponse: type: object properties: AccessLogSettings: allOf: - "$ref": "#/components/schemas/AccessLogSettings" - xml: name: accessLogSettings description: Settings for logging access in this stage. ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeploy description: Specifies whether updates to an API automatically trigger a new deployment. The default value is false. ClientCertificateId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: clientCertificateId description: The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the stage was created. DefaultRouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettings" - xml: name: defaultRouteSettings description: Default route settings for the stage. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the stage. LastDeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: lastDeploymentStatusMessage description: Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled. LastUpdatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: lastUpdatedDate description: The timestamp when the stage was last updated. RouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettingsMap" - xml: name: routeSettings description: Route settings for the stage, by routeKey. StageName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stageName description: The name of the stage. StageVariables: allOf: - "$ref": "#/components/schemas/StageVariablesMap" - xml: name: stageVariables description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. UpdateVpcLinkResponse: type: object properties: CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the VPC link was created. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the VPC link. SecurityGroupIds: allOf: - "$ref": "#/components/schemas/SecurityGroupIdList" - xml: name: securityGroupIds description: A list of security group IDs for the VPC link. SubnetIds: allOf: - "$ref": "#/components/schemas/SubnetIdList" - xml: name: subnetIds description: A list of subnet IDs to include in the VPC link. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: Tags for the VPC link. VpcLinkId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: vpcLinkId description: The ID of the VPC link. VpcLinkStatus: allOf: - "$ref": "#/components/schemas/VpcLinkStatus" - xml: name: vpcLinkStatus description: The status of the VPC link. VpcLinkStatusMessage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: vpcLinkStatusMessage description: A message summarizing the cause of the status of the VPC link. VpcLinkVersion: allOf: - "$ref": "#/components/schemas/VpcLinkVersion" - xml: name: vpcLinkVersion description: The version of the VPC link. AccessLogSettings: type: object properties: DestinationArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: destinationArn description: The ARN of the CloudWatch Logs log group to receive access logs. Format: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And1024" - xml: name: format description: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId. description: Settings for logging access in a stage. Id: type: string description: The identifier. SelectionExpression: type: string description: An expression used to extract information at runtime. See Selection Expressions for more information. Cors: type: object properties: AllowCredentials: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: allowCredentials description: Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs. AllowHeaders: allOf: - "$ref": "#/components/schemas/CorsHeaderList" - xml: name: allowHeaders description: Represents a collection of allowed headers. Supported only for HTTP APIs. AllowMethods: allOf: - "$ref": "#/components/schemas/CorsMethodList" - xml: name: allowMethods description: Represents a collection of allowed HTTP methods. Supported only for HTTP APIs. AllowOrigins: allOf: - "$ref": "#/components/schemas/CorsOriginList" - xml: name: allowOrigins description: Represents a collection of allowed origins. Supported only for HTTP APIs. ExposeHeaders: allOf: - "$ref": "#/components/schemas/CorsHeaderList" - xml: name: exposeHeaders description: Represents a collection of exposed headers. Supported only for HTTP APIs. MaxAge: allOf: - "$ref": "#/components/schemas/IntegerWithLengthBetweenMinus1And86400" - xml: name: maxAge description: The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs. description: Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information. __timestampIso8601: type: string format: date-time StringWithLengthBetween0And1024: type: string description: A string with a length between [0-1024]. ProtocolType: type: string enum: - WEBSOCKET - HTTP description: Represents a protocol type. Tags: type: object description: Represents a collection of tags associated with the resource. additionalProperties: "$ref": "#/components/schemas/StringWithLengthBetween1And1600" Api: type: object required: - RouteSelectionExpression - Name - ProtocolType properties: ApiEndpoint: allOf: - "$ref": "#/components/schemas/__string" - xml: name: apiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API ID. ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the API was created. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: importInfo description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. ProtocolType: allOf: - "$ref": "#/components/schemas/ProtocolType" - xml: name: protocolType description: The API protocol. RouteSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: A collection of tags associated with the API. Version: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. Warnings: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: warnings description: The warning messages reported when failonwarnings is turned on during API import. description: Represents an API. SelectionKey: type: string description: 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. ApiMapping: type: object required: - Stage - ApiId properties: ApiId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API identifier. ApiMappingId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiMappingId description: The API mapping identifier. ApiMappingKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: apiMappingKey description: The API mapping key. Stage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stage description: The API stage. description: Represents an API mapping. AuthorizationScopes: type: array description: 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. items: "$ref": "#/components/schemas/StringWithLengthBetween1And64" AuthorizationType: type: string enum: - NONE - AWS_IAM - CUSTOM - JWT description: 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. IntegerWithLengthBetween0And3600: type: integer description: An integer with a value between [0-3600]. minimum: 0 maximum: 3600 AuthorizerType: type: string enum: - REQUEST - JWT description: 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). IdentitySourceList: type: array description: 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. items: "$ref": "#/components/schemas/__string" JWTConfiguration: type: object properties: Audience: allOf: - "$ref": "#/components/schemas/__listOf__string" - xml: name: audience description: 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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: issuer description: |- 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.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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: identityValidationExpression description: The validation expression does not apply to the REQUEST authorizer. JwtConfiguration: allOf: - "$ref": "#/components/schemas/JWTConfiguration" - xml: name: jwtConfiguration description: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the authorizer. description: Represents an authorizer. ConnectionType: type: string enum: - INTERNET - VPC_LINK description: Represents a connection type. ContentHandlingStrategy: type: string enum: - CONVERT_TO_BINARY - CONVERT_TO_TEXT description: Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs. CreateApiMappingRequest: type: object required: - Stage - ApiId title: CreateApiMappingRequest properties: ApiId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API identifier. ApiMappingKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: apiMappingKey description: The API mapping key. Stage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stage description: The API stage. description: Creates a new ApiMapping resource to represent an API mapping. CreateApiRequest: type: object required: - ProtocolType - Name title: CreateApiRequest properties: ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information. CredentialsArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. ProtocolType: allOf: - "$ref": "#/components/schemas/ProtocolType" - xml: name: protocolType description: The API protocol. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. Target: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: target description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. description: Creates a new Api resource to represent an API. CreateAuthorizerRequest: type: object required: - AuthorizerType - IdentitySource - Name title: CreateAuthorizerRequest properties: AuthorizerCredentialsArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: authorizerCredentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: authorizerPayloadFormatVersion description: 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: allOf: - "$ref": "#/components/schemas/IntegerWithLengthBetween0And3600" - xml: name: authorizerResultTtlInSeconds description: 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: allOf: - "$ref": "#/components/schemas/AuthorizerType" - xml: name: authorizerType description: 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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: authorizerUri description: |- 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: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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: identityValidationExpression description: This parameter is not used. JwtConfiguration: allOf: - "$ref": "#/components/schemas/JWTConfiguration" - xml: name: jwtConfiguration description: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the authorizer. description: Creates a new Authorizer resource to represent an authorizer. CreateDeploymentRequest: type: object title: CreateDeploymentRequest properties: Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the deployment resource. StageName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stageName description: The name of the Stage resource for the Deployment resource to create. description: Creates a new Deployment resource to represent a deployment. DeploymentStatus: type: string enum: - PENDING - FAILED - DEPLOYED description: Represents a deployment status. DomainNameConfigurations: type: array description: The domain name configurations. items: "$ref": "#/components/schemas/DomainNameConfiguration" MutualTlsAuthenticationInput: type: object properties: TruststoreUri: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: truststoreUri description: An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the integration. IntegrationMethod: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: integrationMethod description: Specifies the integration's HTTP method type. IntegrationSubtype: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: integrationSubtype description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. IntegrationType: allOf: - "$ref": "#/components/schemas/IntegrationType" - xml: name: integrationType description: '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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: integrationUri description: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: allOf: - "$ref": "#/components/schemas/PassthroughBehavior" - xml: name: passthroughBehavior description: "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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: payloadFormatVersion description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: requestParameters description: "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
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
" IntegrationResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: integrationResponseKey description: The integration response key. ResponseParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: responseParameters description: 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: allOf: - "$ref": "#/components/schemas/TemplateMap" - xml: name: responseTemplates description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: templateSelectionExpression description: The template selection expression for the integration response. Supported only for WebSocket APIs. description: Creates a new IntegrationResponse resource to represent an integration response. StringWithLengthBetween1And256: type: string description: A string with a length between [1-256]. CreateModelRequest: type: object required: - Schema - Name title: CreateModelRequest properties: ContentType: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And256" - xml: name: contentType description: The content-type for the model, for example, "application/json". Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the model. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the model. Must be alphanumeric. Schema: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And32K" - xml: name: schema description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. description: Creates a new Model. RouteModels: type: object description: The route models. additionalProperties: "$ref": "#/components/schemas/StringWithLengthBetween1And128" RouteParameters: type: object description: The route parameters. additionalProperties: "$ref": "#/components/schemas/ParameterConstraints" CreateRouteRequest: type: object required: - RouteKey title: CreateRouteRequest properties: ApiKeyRequired: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiKeyRequired description: Specifies whether an API key is required for the route. Supported only for WebSocket APIs. AuthorizationScopes: allOf: - "$ref": "#/components/schemas/AuthorizationScopes" - xml: name: authorizationScopes description: The authorization scopes supported by this route. AuthorizationType: allOf: - "$ref": "#/components/schemas/AuthorizationType" - xml: name: authorizationType description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: The model selection expression for the route. Supported only for WebSocket APIs. OperationName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: operationName description: The operation name for the route. RequestModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: requestModels description: The request models for the route. Supported only for WebSocket APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: requestParameters description: The request parameters for the route. Supported only for WebSocket APIs. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: The route key for the route. RouteResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeResponseSelectionExpression description: The route response selection expression for the route. Supported only for WebSocket APIs. Target: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: target description: The target for the route. description: Creates a new Route resource to represent a route. CreateRouteResponseRequest: type: object required: - RouteResponseKey title: CreateRouteResponseRequest properties: ModelSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: The model selection expression for the route response. Supported only for WebSocket APIs. ResponseModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: responseModels description: The response models for the route response. ResponseParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: responseParameters description: The route response parameters. RouteResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeResponseKey description: The route response key. description: Creates a new RouteResponse resource to represent a route response. RouteSettingsMap: type: object description: The route settings map. additionalProperties: "$ref": "#/components/schemas/RouteSettings" StageVariablesMap: type: object description: The stage variable map. additionalProperties: "$ref": "#/components/schemas/StringWithLengthBetween0And2048" CreateStageRequest: type: object required: - StageName title: CreateStageRequest properties: AccessLogSettings: allOf: - "$ref": "#/components/schemas/AccessLogSettings" - xml: name: accessLogSettings description: Settings for logging access in this stage. AutoDeploy: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeploy description: Specifies whether updates to an API automatically trigger a new deployment. The default value is false. ClientCertificateId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: clientCertificateId description: The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. DefaultRouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettings" - xml: name: defaultRouteSettings description: The default route settings for the stage. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The deployment identifier of the API stage. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the API stage. RouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettingsMap" - xml: name: routeSettings description: Route settings for the stage, by routeKey. StageName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stageName description: The name of the stage. StageVariables: allOf: - "$ref": "#/components/schemas/StageVariablesMap" - xml: name: stageVariables description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. description: Creates a new Stage resource to represent a stage. SecurityGroupIdList: type: array description: A list of security group IDs for the VPC link. items: "$ref": "#/components/schemas/__string" SubnetIdList: type: array description: A list of subnet IDs to include in the VPC link. items: "$ref": "#/components/schemas/__string" CreateVpcLinkRequest: type: object required: - SubnetIds - Name title: CreateVpcLinkRequest properties: Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the VPC link. SecurityGroupIds: allOf: - "$ref": "#/components/schemas/SecurityGroupIdList" - xml: name: securityGroupIds description: A list of security group IDs for the VPC link. SubnetIds: allOf: - "$ref": "#/components/schemas/SubnetIdList" - xml: name: subnetIds description: A list of subnet IDs to include in the VPC link. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: A list of tags. description: Creates a VPC link VpcLinkStatus: type: string enum: - PENDING - AVAILABLE - DELETING - FAILED - INACTIVE description: The status of the VPC link. VpcLinkVersion: type: string enum: - V2 description: The version of the VPC link. DeleteAccessLogSettingsRequest: type: object title: DeleteAccessLogSettingsRequest properties: {} DeleteApiMappingRequest: type: object title: DeleteApiMappingRequest properties: {} DeleteApiRequest: type: object title: DeleteApiRequest properties: {} DeleteAuthorizerRequest: type: object title: DeleteAuthorizerRequest properties: {} DeleteCorsConfigurationRequest: type: object title: DeleteCorsConfigurationRequest properties: {} DeleteDeploymentRequest: type: object title: DeleteDeploymentRequest properties: {} DeleteDomainNameRequest: type: object title: DeleteDomainNameRequest properties: {} DeleteIntegrationRequest: type: object title: DeleteIntegrationRequest properties: {} DeleteIntegrationResponseRequest: type: object title: DeleteIntegrationResponseRequest properties: {} DeleteModelRequest: type: object title: DeleteModelRequest properties: {} DeleteRouteRequest: type: object title: DeleteRouteRequest properties: {} DeleteRouteRequestParameterRequest: type: object title: DeleteRouteRequestParameterRequest properties: {} DeleteRouteResponseRequest: type: object title: DeleteRouteResponseRequest properties: {} DeleteRouteSettingsRequest: type: object title: DeleteRouteSettingsRequest properties: {} DeleteStageRequest: type: object title: DeleteStageRequest properties: {} DeleteVpcLinkRequest: type: object title: DeleteVpcLinkRequest properties: {} Deployment: type: object properties: AutoDeployed: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeployed description: Specifies whether a deployment was automatically released. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The date and time when the Deployment resource was created. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier for the deployment. DeploymentStatus: allOf: - "$ref": "#/components/schemas/DeploymentStatus" - xml: name: deploymentStatus description: 'The status of the deployment: PENDING, FAILED, or SUCCEEDED.' DeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: deploymentStatusMessage description: May contain additional feedback on the status of an API deployment. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the deployment. description: 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. DomainName: type: object required: - DomainName properties: ApiMappingSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiMappingSelectionExpression description: The API mapping selection expression. DomainName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And512" - xml: name: domainName description: The name of the DomainName resource. DomainNameConfigurations: allOf: - "$ref": "#/components/schemas/DomainNameConfigurations" - xml: name: domainNameConfigurations description: The domain name configurations. MutualTlsAuthentication: allOf: - "$ref": "#/components/schemas/MutualTlsAuthentication" - xml: name: mutualTlsAuthentication description: The mutual TLS authentication configuration for a custom domain name. Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags associated with a domain name. description: Represents a domain name. DomainNameStatus: type: string enum: - AVAILABLE - UPDATING - PENDING_CERTIFICATE_REIMPORT - PENDING_OWNERSHIP_VERIFICATION description: 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. EndpointType: type: string enum: - REGIONAL - EDGE description: Represents an endpoint type. SecurityPolicy: type: string enum: - TLS_1_0 - TLS_1_2 description: 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. ExportApiRequest: type: object title: ExportApiRequest properties: {} ExportedApi: type: string description: 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: object title: ResetAuthorizersCacheRequest properties: {} GetApiMappingRequest: type: object title: GetApiMappingRequest properties: {} GetApiMappingsRequest: type: object title: GetApiMappingsRequest properties: {} __listOfApiMapping: type: array items: "$ref": "#/components/schemas/ApiMapping" NextToken: type: string description: The next page of elements from this collection. Not valid for the last element of the collection. GetApiRequest: type: object title: GetApiRequest properties: {} GetApisRequest: type: object title: GetApisRequest properties: {} __listOfApi: type: array items: "$ref": "#/components/schemas/Api" GetAuthorizerRequest: type: object title: GetAuthorizerRequest properties: {} GetAuthorizersRequest: type: object title: GetAuthorizersRequest properties: {} __listOfAuthorizer: type: array items: "$ref": "#/components/schemas/Authorizer" GetDeploymentRequest: type: object title: GetDeploymentRequest properties: {} GetDeploymentsRequest: type: object title: GetDeploymentsRequest properties: {} __listOfDeployment: type: array items: "$ref": "#/components/schemas/Deployment" GetDomainNameRequest: type: object title: GetDomainNameRequest properties: {} GetDomainNamesRequest: type: object title: GetDomainNamesRequest properties: {} __listOfDomainName: type: array items: "$ref": "#/components/schemas/DomainName" GetIntegrationRequest: type: object title: GetIntegrationRequest properties: {} GetIntegrationResponseRequest: type: object title: GetIntegrationResponseRequest properties: {} GetIntegrationResponsesRequest: type: object title: GetIntegrationResponsesRequest properties: {} __listOfIntegrationResponse: type: array items: "$ref": "#/components/schemas/IntegrationResponse" GetIntegrationsRequest: type: object title: GetIntegrationsRequest properties: {} __listOfIntegration: type: array items: "$ref": "#/components/schemas/Integration" GetModelRequest: type: object title: GetModelRequest properties: {} GetModelTemplateRequest: type: object title: GetModelTemplateRequest properties: {} GetModelsRequest: type: object title: GetModelsRequest properties: {} __listOfModel: type: array items: "$ref": "#/components/schemas/Model" GetRouteRequest: type: object title: GetRouteRequest properties: {} GetRouteResponseRequest: type: object title: GetRouteResponseRequest properties: {} GetRouteResponsesRequest: type: object title: GetRouteResponsesRequest properties: {} __listOfRouteResponse: type: array items: "$ref": "#/components/schemas/RouteResponse" GetRoutesRequest: type: object title: GetRoutesRequest properties: {} __listOfRoute: type: array items: "$ref": "#/components/schemas/Route" GetStageRequest: type: object title: GetStageRequest properties: {} GetStagesRequest: type: object title: GetStagesRequest properties: {} __listOfStage: type: array items: "$ref": "#/components/schemas/Stage" GetTagsRequest: type: object title: GetTagsRequest properties: {} GetVpcLinkRequest: type: object title: GetVpcLinkRequest properties: {} GetVpcLinksRequest: type: object title: GetVpcLinksRequest properties: {} __listOfVpcLink: type: array items: "$ref": "#/components/schemas/VpcLink" ImportApiRequest: type: object required: - Body title: ImportApiRequest properties: Body: allOf: - "$ref": "#/components/schemas/__string" - xml: name: body description: The OpenAPI definition. Supported only for HTTP APIs. description: '' Integration: type: object properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And1024" - xml: name: connectionId description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - xml: name: connectionType description: 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: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - xml: name: contentHandlingStrategy description: "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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: Represents the description of an integration. IntegrationId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationId description: Represents the identifier of an integration. IntegrationMethod: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: integrationMethod description: Specifies the integration's HTTP method type. IntegrationResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: integrationResponseSelectionExpression description: The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions. IntegrationSubtype: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: integrationSubtype description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. IntegrationType: allOf: - "$ref": "#/components/schemas/IntegrationType" - xml: name: integrationType description: '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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: integrationUri description: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: allOf: - "$ref": "#/components/schemas/PassthroughBehavior" - xml: name: passthroughBehavior description: "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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: payloadFormatVersion description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: requestParameters description: "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
itegrations, 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
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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: integrationResponseId description: The integration response ID. IntegrationResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: integrationResponseKey description: The integration response key. ResponseParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: responseParameters description: 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: allOf: - "$ref": "#/components/schemas/TemplateMap" - xml: name: responseTemplates description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: templateSelectionExpression description: The template selection expressions for the integration response. description: Represents an integration response. Model: type: object required: - Name properties: ContentType: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And256" - xml: name: contentType description: The content-type for the model, for example, "application/json". Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the model. ModelId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: modelId description: The model identifier. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the model. Must be alphanumeric. Schema: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And32K" - xml: name: schema description: The schema for the model. For application/json models, this should be JSON schema draft 4 model. description: Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings. ReimportApiRequest: type: object required: - Body title: ReimportApiRequest properties: Body: allOf: - "$ref": "#/components/schemas/__string" - xml: name: body description: The OpenAPI definition. Supported only for HTTP APIs. description: '' Route: type: object required: - RouteKey properties: ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiKeyRequired description: Specifies whether an API key is required for this route. Supported only for WebSocket APIs. AuthorizationScopes: allOf: - "$ref": "#/components/schemas/AuthorizationScopes" - xml: name: authorizationScopes description: 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: allOf: - "$ref": "#/components/schemas/AuthorizationType" - xml: name: authorizationType description: 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: allOf: - "$ref": "#/components/schemas/Id" - xml: name: authorizerId description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: The model selection expression for the route. Supported only for WebSocket APIs. OperationName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: operationName description: The operation name for the route. RequestModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: requestModels description: The request models for the route. Supported only for WebSocket APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: requestParameters description: The request parameters for the route. Supported only for WebSocket APIs. RouteId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeId description: The route ID. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: The route key for the route. RouteResponseSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeResponseSelectionExpression description: The route response selection expression for the route. Supported only for WebSocket APIs. Target: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: target description: The target for the route. description: Represents a route. RouteResponse: type: object required: - RouteResponseKey properties: ModelSelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: modelSelectionExpression description: Represents the model selection expression of a route response. Supported only for WebSocket APIs. ResponseModels: allOf: - "$ref": "#/components/schemas/RouteModels" - xml: name: responseModels description: Represents the response models of a route response. ResponseParameters: allOf: - "$ref": "#/components/schemas/RouteParameters" - xml: name: responseParameters description: Represents the response parameters of a route response. RouteResponseId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: routeResponseId description: Represents the identifier of a route response. RouteResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeResponseKey description: Represents the route response key of a route response. description: Represents a route response. Stage: type: object required: - StageName properties: AccessLogSettings: allOf: - "$ref": "#/components/schemas/AccessLogSettings" - xml: name: accessLogSettings description: Settings for logging access in this stage. ApiGatewayManaged: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: apiGatewayManaged description: 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: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: autoDeploy description: Specifies whether updates to an API automatically trigger a new deployment. The default value is false. ClientCertificateId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: clientCertificateId description: The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. CreatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: createdDate description: The timestamp when the stage was created. DefaultRouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettings" - xml: name: defaultRouteSettings description: Default route settings for the stage. DeploymentId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: deploymentId description: The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled. Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the stage. LastDeploymentStatusMessage: allOf: - "$ref": "#/components/schemas/__string" - xml: name: lastDeploymentStatusMessage description: Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled. LastUpdatedDate: allOf: - "$ref": "#/components/schemas/__timestampIso8601" - xml: name: lastUpdatedDate description: The timestamp when the stage was last updated. RouteSettings: allOf: - "$ref": "#/components/schemas/RouteSettingsMap" - xml: name: routeSettings description: Route settings for the stage, by routeKey. StageName: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stageName description: The name of the stage. StageVariables: allOf: - "$ref": "#/components/schemas/StageVariablesMap" - xml: name: stageVariables description: 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: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. description: Represents an API stage. TagResourceRequest: type: object title: TagResourceRequest properties: Tags: allOf: - "$ref": "#/components/schemas/Tags" - xml: name: tags description: The collection of tags. Each tag element is associated with a given resource. description: Creates a new Tag resource to represent a tag. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateApiMappingRequest: type: object required: - ApiId title: UpdateApiMappingRequest properties: ApiId: allOf: - "$ref": "#/components/schemas/Id" - xml: name: apiId description: The API identifier. ApiMappingKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: apiMappingKey description: The API mapping key. Stage: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: stage description: The API stage. description: Updates an ApiMapping. UpdateApiRequest: type: object title: UpdateApiRequest properties: ApiKeySelectionExpression: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: apiKeySelectionExpression description: An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. CorsConfiguration: allOf: - "$ref": "#/components/schemas/Cors" - xml: name: corsConfiguration description: A CORS configuration. Supported only for HTTP APIs. CredentialsArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the API. DisableSchemaValidation: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableSchemaValidation description: Avoid validating models when creating a deployment. Supported only for WebSocket APIs. DisableExecuteApiEndpoint: allOf: - "$ref": "#/components/schemas/__boolean" - xml: name: disableExecuteApiEndpoint description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the API. RouteKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: routeKey description: 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: allOf: - "$ref": "#/components/schemas/SelectionExpression" - xml: name: routeSelectionExpression description: 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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: target description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: version description: A version identifier for the API. description: Updates an Api. UpdateAuthorizerRequest: type: object title: UpdateAuthorizerRequest properties: AuthorizerCredentialsArn: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: authorizerCredentialsArn description: 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. AuthorizerPayloadFormatVersion: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: authorizerPayloadFormatVersion description: 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: allOf: - "$ref": "#/components/schemas/IntegerWithLengthBetween0And3600" - xml: name: authorizerResultTtlInSeconds description: 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: allOf: - "$ref": "#/components/schemas/AuthorizerType" - xml: name: authorizerType description: 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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: authorizerUri description: |- 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: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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: identityValidationExpression description: This parameter is not used. JwtConfiguration: allOf: - "$ref": "#/components/schemas/JWTConfiguration" - xml: name: jwtConfiguration description: Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs. Name: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: name description: The name of the authorizer. description: Updates an Authorizer. UpdateDeploymentRequest: type: object title: UpdateDeploymentRequest properties: Description: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description for the deployment resource. description: Updates a Deployment. UpdateDomainNameRequest: type: object title: UpdateDomainNameRequest properties: DomainNameConfigurations: allOf: - "$ref": "#/components/schemas/DomainNameConfigurations" - xml: name: domainNameConfigurations description: The domain name configurations. MutualTlsAuthentication: allOf: - "$ref": "#/components/schemas/MutualTlsAuthenticationInput" - xml: name: mutualTlsAuthentication description: The mutual TLS authentication configuration for a custom domain name. description: Updates a DomainName. UpdateIntegrationRequest: type: object title: UpdateIntegrationRequest properties: ConnectionId: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And1024" - xml: name: connectionId description: The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionType: allOf: - "$ref": "#/components/schemas/ConnectionType" - xml: name: connectionType description: 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: allOf: - "$ref": "#/components/schemas/ContentHandlingStrategy" - xml: name: contentHandlingStrategy description: "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: allOf: - "$ref": "#/components/schemas/Arn" - xml: name: credentialsArn description: 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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween0And1024" - xml: name: description description: The description of the integration IntegrationMethod: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: integrationMethod description: Specifies the integration's HTTP method type. IntegrationSubtype: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And128" - xml: name: integrationSubtype description: Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference. IntegrationType: allOf: - "$ref": "#/components/schemas/IntegrationType" - xml: name: integrationType description: '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: allOf: - "$ref": "#/components/schemas/UriWithLengthBetween1And2048" - xml: name: integrationUri description: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: allOf: - "$ref": "#/components/schemas/PassthroughBehavior" - xml: name: passthroughBehavior description: "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: allOf: - "$ref": "#/components/schemas/StringWithLengthBetween1And64" - xml: name: payloadFormatVersion description: Specifies the format of the payload sent to an integration. Required for HTTP APIs. RequestParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: requestParameters description: "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
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.
" IntegrationResponseKey: allOf: - "$ref": "#/components/schemas/SelectionKey" - xml: name: integrationResponseKey description: The integration response key. ResponseParameters: allOf: - "$ref": "#/components/schemas/IntegrationParameters" - xml: name: responseParameters description: "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.