<?php
// This file was auto-generated from sdk-root/src/data/apigatewayv2/2018-11-29/docs-2.json
return [ 'version' => '2.0', 'service' => '
Amazon API Gateway V2
', 'operations' => [ 'CreateApi' => '
Creates an Api resource.
', 'CreateApiMapping' => '
Creates an API mapping.
', 'CreateAuthorizer' => '
Creates an Authorizer for an API.
', 'CreateDeployment' => '
Creates a Deployment for an API.
', 'CreateDomainName' => '
Creates a domain name.
', 'CreateIntegration' => '
Creates an Integration.
', 'CreateIntegrationResponse' => '
Creates an IntegrationResponses.
', 'CreateModel' => '
Creates a Model for an API.
', 'CreateRoute' => '
Creates a Route for an API.
', 'CreateRouteResponse' => '
Creates a RouteResponse for a Route.
', 'CreateStage' => '
Creates a Stage for an API.
', 'CreateVpcLink' => '
Creates a VPC link.
', 'DeleteAccessLogSettings' => '
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
', 'DeleteApi' => '
Deletes an Api resource.
', 'DeleteApiMapping' => '
Deletes an API mapping.
', 'DeleteAuthorizer' => '
Deletes an Authorizer.
', 'DeleteCorsConfiguration' => '
Deletes a CORS configuration.
', 'DeleteDeployment' => '
Deletes a Deployment.
', 'DeleteDomainName' => '
Deletes a domain name.
', 'DeleteIntegration' => '
Deletes an Integration.
', 'DeleteIntegrationResponse' => '
Deletes an IntegrationResponses.
', 'DeleteModel' => '
Deletes a Model.
', 'DeleteRoute' => '
Deletes a Route.
', 'DeleteRouteRequestParameter' => '
Deletes a route request parameter.
', 'DeleteRouteResponse' => '
Deletes a RouteResponse.
', 'DeleteRouteSettings' => '
Deletes the RouteSettings for a stage.
', 'DeleteStage' => '
Deletes a Stage.
', 'DeleteVpcLink' => '
Deletes a VPC link.
', 'ExportApi' => '
Exports a definition of an API in a particular output format and specification.
', 'ResetAuthorizersCache' => '
Resets all authorizer cache entries for the specified stage. Supported only for HTTP API Lambda authorizers.
', 'GetApi' => '
Gets an Api resource.
', 'GetApiMapping' => '
Gets an API mapping.
', 'GetApiMappings' => '
Gets API mappings.
', 'GetApis' => '
Gets a collection of Api resources.
', 'GetAuthorizer' => '
Gets an Authorizer.
', 'GetAuthorizers' => '
Gets the Authorizers for an API.
', 'GetDeployment' => '
Gets a Deployment.
', 'GetDeployments' => '
Gets the Deployments for an API.
', 'GetDomainName' => '
Gets a domain name.
', 'GetDomainNames' => '
Gets the domain names for an AWS account.
', 'GetIntegration' => '
Gets an Integration.
', 'GetIntegrationResponse' => '
Gets an IntegrationResponses.
', 'GetIntegrationResponses' => '
Gets the IntegrationResponses for an Integration.
', 'GetIntegrations' => '
Gets the Integrations for an API.
', 'GetModel' => '
Gets a Model.
', 'GetModelTemplate' => '
Gets a model template.
', 'GetModels' => '
Gets the Models for an API.
', 'GetRoute' => '
Gets a Route.
', 'GetRouteResponse' => '
Gets a RouteResponse.
', 'GetRouteResponses' => '
Gets the RouteResponses for a Route.
', 'GetRoutes' => '
Gets the Routes for an API.
', 'GetStage' => '
Gets a Stage.
', 'GetStages' => '
Gets the Stages for an API.
', 'GetTags' => '
Gets a collection of Tag resources.
', 'GetVpcLink' => '
Gets a VPC link.
', 'GetVpcLinks' => '
Gets a collection of VPC links.
', 'ImportApi' => '
Imports an API.
', 'ReimportApi' => '
Puts an Api resource.
', 'TagResource' => '
Creates a new Tag resource to represent a tag.
', 'UntagResource' => '
Deletes a Tag.
', 'UpdateApi' => '
Updates an Api resource.
', 'UpdateApiMapping' => '
The API mapping.
', 'UpdateAuthorizer' => '
Updates an Authorizer.
', 'UpdateDeployment' => '
Updates a Deployment.
', 'UpdateDomainName' => '
Updates a domain name.
', 'UpdateIntegration' => '
Updates an Integration.
', 'UpdateIntegrationResponse' => '
Updates an IntegrationResponses.
', 'UpdateModel' => '
Updates a Model.
', 'UpdateRoute' => '
Updates a Route.
', 'UpdateRouteResponse' => '
Updates a RouteResponse.
', 'UpdateStage' => '
Updates a Stage.
', 'UpdateVpcLink' => '
Updates a VPC link.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => NULL, 'refs' => [], ], 'AccessLogSettings' => [ 'base' => '
Settings for logging access in a stage.
', 'refs' => [ 'CreateStageInput$AccessLogSettings' => '
Settings for logging access in this stage.
', 'Stage$AccessLogSettings' => '
Settings for logging access in this stage.
', 'UpdateStageInput$AccessLogSettings' => '
Settings for logging access in this stage.
', ], ], 'Api' => [ 'base' => '
Represents an API.
', 'refs' => [ '__listOfApi$member' => NULL, ], ], 'ApiMapping' => [ 'base' => '
Represents an API mapping.
', 'refs' => [ '__listOfApiMapping$member' => NULL, ], ], 'ApiMappings' => [ 'base' => '
Represents a collection of ApiMappings resources.
', 'refs' => [], ], 'Apis' => [ 'base' => '
Represents a collection of APIs.
', 'refs' => [], ], 'Arn' => [ 'base' => '
Represents an Amazon Resource Name (ARN).
', 'refs' => [ 'AccessLogSettings$DestinationArn' => '
The ARN of the CloudWatch Logs log group to receive access logs.
', 'Authorizer$AuthorizerCredentialsArn' => '
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.
', 'CreateApiInput$CredentialsArn' => '
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.
', 'CreateAuthorizerInput$AuthorizerCredentialsArn' => '
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.
', 'CreateIntegrationInput$CredentialsArn' => '
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.
', 'DomainNameConfiguration$CertificateArn' => '
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.
', 'DomainNameConfiguration$OwnershipVerificationCertificateArn' => '
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
', 'Integration$CredentialsArn' => '
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.
', 'UpdateApiInput$CredentialsArn' => '
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. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
', 'UpdateAuthorizerInput$AuthorizerCredentialsArn' => '
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role\'s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
', 'UpdateIntegrationInput$CredentialsArn' => '
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.
', ], ], 'AuthorizationScopes' => [ 'base' => '
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.
', 'refs' => [ 'CreateRouteInput$AuthorizationScopes' => '
The authorization scopes supported by this route.
', 'Route$AuthorizationScopes' => '
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.
', 'UpdateRouteInput$AuthorizationScopes' => '
The authorization scopes supported by this route.
', ], ], 'AuthorizationType' => [ 'base' => '
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.
', 'refs' => [ 'CreateRouteInput$AuthorizationType' => '
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.
', 'Route$AuthorizationType' => '
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.
', 'UpdateRouteInput$AuthorizationType' => '
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.
', ], ], 'Authorizer' => [ 'base' => '
Represents an authorizer.
', 'refs' => [ '__listOfAuthorizer$member' => NULL, ], ], 'AuthorizerType' => [ 'base' => '
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).
', 'refs' => [ 'Authorizer$AuthorizerType' => '
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).
', 'CreateAuthorizerInput$AuthorizerType' => '
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).
', 'UpdateAuthorizerInput$AuthorizerType' => '
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).
', ], ], 'Authorizers' => [ 'base' => '
Represents a collection of authorizers.
', 'refs' => [], ], 'BadRequestException' => [ 'base' => '
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
', 'refs' => [], ], 'ConflictException' => [ 'base' => '
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
', 'refs' => [], ], 'ConnectionType' => [ 'base' => '
Represents a connection type.
', 'refs' => [ 'CreateIntegrationInput$ConnectionType' => '
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.
', 'Integration$ConnectionType' => '
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.
', 'UpdateIntegrationInput$ConnectionType' => '
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' => [ 'base' => '
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
', 'refs' => [ 'CreateIntegrationInput$ContentHandlingStrategy' => '
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.
', 'CreateIntegrationResponseInput$ContentHandlingStrategy' => '
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.
', 'Integration$ContentHandlingStrategy' => '
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.
', 'IntegrationResponse$ContentHandlingStrategy' => '
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.
', 'UpdateIntegrationInput$ContentHandlingStrategy' => '
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.
', 'UpdateIntegrationResponseInput$ContentHandlingStrategy' => '
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.
', ], ], 'Cors' => [ 'base' => '
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
', 'refs' => [ 'Api$CorsConfiguration' => '
A CORS configuration. Supported only for HTTP APIs.
', 'CreateApiInput$CorsConfiguration' => '
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
', 'UpdateApiInput$CorsConfiguration' => '
A CORS configuration. Supported only for HTTP APIs.
', ], ], 'CorsHeaderList' => [ 'base' => '
Represents a collection of allowed headers. Supported only for HTTP APIs.
', 'refs' => [ 'Cors$AllowHeaders' => '
Represents a collection of allowed headers. Supported only for HTTP APIs.
', 'Cors$ExposeHeaders' => '
Represents a collection of exposed headers. Supported only for HTTP APIs.
', ], ], 'CorsMethodList' => [ 'base' => '
Represents a collection of methods. Supported only for HTTP APIs.
', 'refs' => [ 'Cors$AllowMethods' => '
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
', ], ], 'CorsOriginList' => [ 'base' => '
Represents a collection of origins. Supported only for HTTP APIs.
', 'refs' => [ 'Cors$AllowOrigins' => '
Represents a collection of allowed origins. Supported only for HTTP APIs.
', ], ], 'CreateApiInput' => [ 'base' => '
Represents the input parameters for a CreateApi request.
', 'refs' => [], ], 'CreateApiMappingInput' => [ 'base' => '
Represents the input parameters for a CreateApiMapping request.
', 'refs' => [], ], 'CreateAuthorizerInput' => [ 'base' => '
Represents the input parameters for a CreateAuthorizer request.
', 'refs' => [], ], 'CreateDeploymentInput' => [ 'base' => '
Represents the input parameters for a CreateDeployment request.
', 'refs' => [], ], 'CreateDomainNameInput' => [ 'base' => '
Represents the input parameters for a CreateDomainName request.
', 'refs' => [], ], 'CreateIntegrationInput' => [ 'base' => '
Represents the input parameters for a CreateIntegration request.
', 'refs' => [], ], 'CreateIntegrationResponseInput' => [ 'base' => '
Represents the input parameters for a CreateIntegrationResponse request.
', 'refs' => [], ], 'CreateModelInput' => [ 'base' => '
Represents the input parameters for a CreateModel request.
', 'refs' => [], ], 'CreateRouteInput' => [ 'base' => '
Represents the input parameters for a CreateRoute request.
', 'refs' => [], ], 'CreateRouteResponseInput' => [ 'base' => '
Represents the input parameters for an CreateRouteResponse request.
', 'refs' => [], ], 'CreateStageInput' => [ 'base' => '
Represents the input parameters for a CreateStage request.
', 'refs' => [], ], 'CreateVpcLinkInput' => [ 'base' => '
Represents the input parameters for a CreateVpcLink request.
', 'refs' => [], ], 'Deployment' => [ 'base' => '
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.
', 'refs' => [ '__listOfDeployment$member' => NULL, ], ], 'DeploymentStatus' => [ 'base' => '
Represents a deployment status.
', 'refs' => [ 'Deployment$DeploymentStatus' => '
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
', ], ], 'Deployments' => [ 'base' => '
A collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.
', 'refs' => [], ], 'DomainName' => [ 'base' => '
Represents a domain name.
', 'refs' => [ '__listOfDomainName$member' => NULL, ], ], 'DomainNameConfiguration' => [ 'base' => '
The domain name configuration.
', 'refs' => [ 'DomainNameConfigurations$member' => NULL, ], ], 'DomainNameConfigurations' => [ 'base' => '
The domain name configurations.
', 'refs' => [ 'CreateDomainNameInput$DomainNameConfigurations' => '
The domain name configurations.
', 'DomainName$DomainNameConfigurations' => '
The domain name configurations.
', 'UpdateDomainNameInput$DomainNameConfigurations' => '
The domain name configurations.
', ], ], 'DomainNameStatus' => [ 'base' => '
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.
', 'refs' => [ 'DomainNameConfiguration$DomainNameStatus' => '
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.
', ], ], 'DomainNames' => [ 'base' => '
Represents a collection of domain names.
', 'refs' => [], ], 'EndpointType' => [ 'base' => '
Represents an endpoint type.
', 'refs' => [ 'DomainNameConfiguration$EndpointType' => '
The endpoint type.
', ], ], 'ExportedApi' => [ 'base' => '
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.
', 'refs' => [], ], 'Id' => [ 'base' => '
The identifier.
', 'refs' => [ 'Api$ApiId' => '
The API ID.
', 'ApiMapping$ApiId' => '
The API identifier.
', 'ApiMapping$ApiMappingId' => '
The API mapping identifier.
', 'Authorizer$AuthorizerId' => '
The authorizer identifier.
', 'CreateApiMappingInput$ApiId' => '
The API identifier.
', 'CreateRouteInput$AuthorizerId' => '
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.
', 'CreateStageInput$ClientCertificateId' => '
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
', 'CreateStageInput$DeploymentId' => '
The deployment identifier of the API stage.
', 'Deployment$DeploymentId' => '
The identifier for the deployment.
', 'Integration$IntegrationId' => '
Represents the identifier of an integration.
', 'IntegrationResponse$IntegrationResponseId' => '
The integration response ID.
', 'Model$ModelId' => '
The model identifier.
', 'Route$AuthorizerId' => '
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.
', 'Route$RouteId' => '
The route ID.
', 'RouteResponse$RouteResponseId' => '
Represents the identifier of a route response.
', 'Stage$ClientCertificateId' => '
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
', 'Stage$DeploymentId' => '
The identifier of the Deployment that the Stage is associated with. Can\'t be updated if autoDeploy is enabled.
', 'UpdateApiMappingInput$ApiId' => '
The API identifier.
', 'UpdateRouteInput$AuthorizerId' => '
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.
', 'UpdateStageInput$ClientCertificateId' => '
The identifier of a client certificate for a Stage.
', 'UpdateStageInput$DeploymentId' => '
The deployment identifier for the API stage. Can\'t be updated if autoDeploy is enabled.
', 'VpcLink$VpcLinkId' => '
The ID of the VPC link.
', ], ], 'IdentitySourceList' => [ 'base' => '
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.
', 'refs' => [ 'Authorizer$IdentitySource' => '
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.
', 'CreateAuthorizerInput$IdentitySource' => '
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.
', 'UpdateAuthorizerInput$IdentitySource' => '
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.
', ], ], 'ImportApiInput' => [ 'base' => '
Represents the input to ImportAPI. Supported only for HTTP APIs.
', 'refs' => [], ], 'IntegerWithLengthBetween0And3600' => [ 'base' => '
An integer with a value between [0-3600].
', 'refs' => [ 'Authorizer$AuthorizerResultTtlInSeconds' => '
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.
', 'CreateAuthorizerInput$AuthorizerResultTtlInSeconds' => '
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.
', 'UpdateAuthorizerInput$AuthorizerResultTtlInSeconds' => '
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.
', ], ], 'IntegerWithLengthBetween50And30000' => [ 'base' => '
An integer with a value between [50-30000].
', 'refs' => [ 'CreateIntegrationInput$TimeoutInMillis' => '
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
', 'Integration$TimeoutInMillis' => '
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
', 'UpdateIntegrationInput$TimeoutInMillis' => '
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
', ], ], 'IntegerWithLengthBetweenMinus1And86400' => [ 'base' => '
An integer with a value between -1 and 86400. Supported only for HTTP APIs.
', 'refs' => [ 'Cors$MaxAge' => '
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
', ], ], 'Integration' => [ 'base' => '
Represents an integration.
', 'refs' => [ '__listOfIntegration$member' => NULL, ], ], 'IntegrationParameters' => [ 'base' => '
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.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable> , where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', 'refs' => [ 'CreateIntegrationInput$RequestParameters' => '
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.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable> , where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', 'CreateIntegrationResponseInput$ResponseParameters' => '
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.
', 'Integration$RequestParameters' => '
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.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable> , where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

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 <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', 'IntegrationResponse$ResponseParameters' => '
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.
', 'ResponseParameters$member' => NULL, 'UpdateIntegrationInput$RequestParameters' => '
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.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable> , where <replaceable>{location}</replaceable> is querystring, path, or header; and <replaceable>{name}</replaceable> must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', 'UpdateIntegrationResponseInput$ResponseParameters' => '
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.<replaceable>{name}</replaceable> , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable> or integration.response.body.<replaceable>{JSON-expression}</replaceable> , where <replaceable>{name}</replaceable> is a valid and unique response header name and <replaceable>{JSON-expression}</replaceable> is a valid JSON expression without the $ prefix.
', ], ], 'IntegrationResponse' => [ 'base' => '
Represents an integration response.
', 'refs' => [ '__listOfIntegrationResponse$member' => NULL, ], ], 'IntegrationResponses' => [ 'base' => '
Represents a collection of integration responses.
', 'refs' => [], ], 'IntegrationType' => [ 'base' => '
Represents an API method integration type.
', 'refs' => [ 'CreateIntegrationInput$IntegrationType' => '
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.
', 'Integration$IntegrationType' => '
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.
', 'UpdateIntegrationInput$IntegrationType' => '
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.
', ], ], 'Integrations' => [ 'base' => '
Represents a collection of integrations.
', 'refs' => [], ], 'JWTConfiguration' => [ 'base' => '
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
', 'refs' => [ 'Authorizer$JwtConfiguration' => '
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
', 'CreateAuthorizerInput$JwtConfiguration' => '
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
', 'UpdateAuthorizerInput$JwtConfiguration' => '
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
', ], ], 'LimitExceededException' => [ 'base' => '
A limit has been exceeded. See the accompanying error message for details.
', 'refs' => [], ], 'LoggingLevel' => [ 'base' => '
The logging level.
', 'refs' => [ 'RouteSettings$LoggingLevel' => '
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.
', ], ], 'Model' => [ 'base' => '
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
', 'refs' => [ '__listOfModel$member' => NULL, ], ], 'Models' => [ 'base' => '
Represents a collection of data models. See Create Models and Mapping Templates for Request and Response Mappings.
', 'refs' => [], ], 'MutualTlsAuthentication' => [ 'base' => '
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
', 'refs' => [ 'DomainName$MutualTlsAuthentication' => '
The mutual TLS authentication configuration for a custom domain name.
', ], ], 'MutualTlsAuthenticationInput' => [ 'base' => '
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
', 'refs' => [ 'CreateDomainNameInput$MutualTlsAuthentication' => '
The mutual TLS authentication configuration for a custom domain name.
', 'UpdateDomainNameInput$MutualTlsAuthentication' => '
The mutual TLS authentication configuration for a custom domain name.
', ], ], 'NextToken' => [ 'base' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'refs' => [ 'ApiMappings$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Apis$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Authorizers$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Deployments$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'DomainNames$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'IntegrationResponses$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Integrations$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Models$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'RouteResponses$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Routes$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'Stages$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', 'VpcLinks$NextToken' => '
The next page of elements from this collection. Not valid for the last element of the collection.
', ], ], 'NotFoundException' => [ 'base' => '
The resource specified in the request was not found. See the message field for more information.
', 'refs' => [], ], 'ParameterConstraints' => [ 'base' => '
Validation constraints imposed on parameters of a request (path, query string, headers).
', 'refs' => [ 'RouteParameters$member' => NULL, ], ], 'PassthroughBehavior' => [ 'base' => '
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
', 'refs' => [ 'CreateIntegrationInput$PassthroughBehavior' => '
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.
', 'Integration$PassthroughBehavior' => '
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.
', 'UpdateIntegrationInput$PassthroughBehavior' => '
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.
', ], ], 'ProtocolType' => [ 'base' => 'Represents a protocol type.', 'refs' => [ 'Api$ProtocolType' => '
The API protocol.
', 'CreateApiInput$ProtocolType' => '
The API protocol.
', ], ], 'ReimportApiInput' => [ 'base' => '
Overwrites the configuration of an existing API using the provided definition. Supported only for HTTP APIs.
', 'refs' => [], ], 'ResponseParameters' => [ 'base' => '
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
', 'refs' => [ 'CreateIntegrationInput$ResponseParameters' => '
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', 'Integration$ResponseParameters' => '
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', 'UpdateIntegrationInput$ResponseParameters' => '
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
', ], ], 'Route' => [ 'base' => '
Represents a route.
', 'refs' => [ '__listOfRoute$member' => NULL, ], ], 'RouteModels' => [ 'base' => '
The route models.
', 'refs' => [ 'CreateRouteInput$RequestModels' => '
The request models for the route. Supported only for WebSocket APIs.
', 'CreateRouteResponseInput$ResponseModels' => '
The response models for the route response.
', 'Route$RequestModels' => '
The request models for the route. Supported only for WebSocket APIs.
', 'RouteResponse$ResponseModels' => '
Represents the response models of a route response.
', 'UpdateRouteInput$RequestModels' => '
The request models for the route. Supported only for WebSocket APIs.
', 'UpdateRouteResponseInput$ResponseModels' => '
The response models for the route response.
', ], ], 'RouteParameters' => [ 'base' => '
The route parameters.
', 'refs' => [ 'CreateRouteInput$RequestParameters' => '
The request parameters for the route. Supported only for WebSocket APIs.
', 'CreateRouteResponseInput$ResponseParameters' => '
The route response parameters.
', 'Route$RequestParameters' => '
The request parameters for the route. Supported only for WebSocket APIs.
', 'RouteResponse$ResponseParameters' => '
Represents the response parameters of a route response.
', 'UpdateRouteInput$RequestParameters' => '
The request parameters for the route. Supported only for WebSocket APIs.
', 'UpdateRouteResponseInput$ResponseParameters' => '
The route response parameters.
', ], ], 'RouteResponse' => [ 'base' => '
Represents a route response.
', 'refs' => [ '__listOfRouteResponse$member' => NULL, ], ], 'RouteResponses' => [ 'base' => '
Represents a collection of route responses.
', 'refs' => [], ], 'RouteSettings' => [ 'base' => '
Represents a collection of route settings.
', 'refs' => [ 'CreateStageInput$DefaultRouteSettings' => '
The default route settings for the stage.
', 'RouteSettingsMap$member' => NULL, 'Stage$DefaultRouteSettings' => '
Default route settings for the stage.
', 'UpdateStageInput$DefaultRouteSettings' => '
The default route settings for the stage.
', ], ], 'RouteSettingsMap' => [ 'base' => '
The route settings map.
', 'refs' => [ 'CreateStageInput$RouteSettings' => '
Route settings for the stage, by routeKey.
', 'Stage$RouteSettings' => '
Route settings for the stage, by routeKey.
', 'UpdateStageInput$RouteSettings' => '
Route settings for the stage.
', ], ], 'Routes' => [ 'base' => '
Represents a collection of routes.
', 'refs' => [], ], 'SecurityGroupIdList' => [ 'base' => '
A list of security group IDs for the VPC link.
', 'refs' => [ 'CreateVpcLinkInput$SecurityGroupIds' => '
A list of security group IDs for the VPC link.
', 'VpcLink$SecurityGroupIds' => '
A list of security group IDs for the VPC link.
', ], ], 'SecurityPolicy' => [ 'base' => '
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.
', 'refs' => [ 'DomainNameConfiguration$SecurityPolicy' => '
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.
', ], ], 'SelectionExpression' => [ 'base' => '
An expression used to extract information at runtime. See Selection Expressions for more information.
', 'refs' => [ 'Api$ApiKeySelectionExpression' => '
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
', 'Api$RouteSelectionExpression' => '
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.
', 'CreateApiInput$ApiKeySelectionExpression' => '
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
', 'CreateApiInput$RouteSelectionExpression' => '
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.
', 'CreateIntegrationInput$TemplateSelectionExpression' => '
The template selection expression for the integration.
', 'CreateIntegrationResponseInput$TemplateSelectionExpression' => '
The template selection expression for the integration response. Supported only for WebSocket APIs.
', 'CreateRouteInput$ModelSelectionExpression' => '
The model selection expression for the route. Supported only for WebSocket APIs.
', 'CreateRouteInput$RouteResponseSelectionExpression' => '
The route response selection expression for the route. Supported only for WebSocket APIs.
', 'CreateRouteResponseInput$ModelSelectionExpression' => '
The model selection expression for the route response. Supported only for WebSocket APIs.
', 'DomainName$ApiMappingSelectionExpression' => '
The API mapping selection expression.
', 'Integration$IntegrationResponseSelectionExpression' => '
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
', 'Integration$TemplateSelectionExpression' => '
The template selection expression for the integration. Supported only for WebSocket APIs.
', 'IntegrationResponse$TemplateSelectionExpression' => '
The template selection expressions for the integration response.
', 'Route$ModelSelectionExpression' => '
The model selection expression for the route. Supported only for WebSocket APIs.
', 'Route$RouteResponseSelectionExpression' => '
The route response selection expression for the route. Supported only for WebSocket APIs.
', 'RouteResponse$ModelSelectionExpression' => '
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
', 'UpdateApiInput$ApiKeySelectionExpression' => '
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
', 'UpdateApiInput$RouteSelectionExpression' => '
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.
', 'UpdateIntegrationInput$TemplateSelectionExpression' => '
The template selection expression for the integration.
', 'UpdateIntegrationResponseInput$TemplateSelectionExpression' => '
The template selection expression for the integration response. Supported only for WebSocket APIs.
', 'UpdateRouteInput$ModelSelectionExpression' => '
The model selection expression for the route. Supported only for WebSocket APIs.
', 'UpdateRouteInput$RouteResponseSelectionExpression' => '
The route response selection expression for the route. Supported only for WebSocket APIs.
', 'UpdateRouteResponseInput$ModelSelectionExpression' => '
The model selection expression for the route response. Supported only for WebSocket APIs.
', ], ], 'SelectionKey' => [ 'base' => '
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.
', 'refs' => [ 'ApiMapping$ApiMappingKey' => '
The API mapping key.
', 'CreateApiInput$RouteKey' => '
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.
', 'CreateApiMappingInput$ApiMappingKey' => 'The API mapping key.', 'CreateIntegrationResponseInput$IntegrationResponseKey' => '
The integration response key.
', 'CreateRouteInput$RouteKey' => '
The route key for the route.
', 'CreateRouteResponseInput$RouteResponseKey' => '
The route response key.
', 'IntegrationResponse$IntegrationResponseKey' => '
The integration response key.
', 'Route$RouteKey' => '
The route key for the route.
', 'RouteResponse$RouteResponseKey' => '
Represents the route response key of a route response.
', 'UpdateApiInput$RouteKey' => '
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.
', 'UpdateApiMappingInput$ApiMappingKey' => '
The API mapping key.
', 'UpdateIntegrationResponseInput$IntegrationResponseKey' => '
The integration response key.
', 'UpdateRouteInput$RouteKey' => '
The route key for the route.
', 'UpdateRouteResponseInput$RouteResponseKey' => '
The route response key.
', ], ], 'Stage' => [ 'base' => '
Represents an API stage.
', 'refs' => [ '__listOfStage$member' => NULL, ], ], 'StageVariablesMap' => [ 'base' => '
The stage variable map.
', 'refs' => [ 'CreateStageInput$StageVariables' => '
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-._~:/?#&=,]+.
', 'Stage$StageVariables' => '
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-._~:/?#&=,]+.
', 'UpdateStageInput$StageVariables' => '
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-._~:/?#&=,]+.
', ], ], 'Stages' => [ 'base' => '
A collection of Stage resources that are associated with the ApiKey resource.
', 'refs' => [], ], 'StringWithLengthBetween0And1024' => [ 'base' => '
A string with a length between [0-1024].
', 'refs' => [ 'Api$Description' => '
The description of the API.
', 'Authorizer$IdentityValidationExpression' => '
The validation expression does not apply to the REQUEST authorizer.
', 'CreateApiInput$Description' => '
The description of the API.
', 'CreateAuthorizerInput$IdentityValidationExpression' => '
This parameter is not used.
', 'CreateDeploymentInput$Description' => '
The description for the deployment resource.
', 'CreateIntegrationInput$Description' => '
The description of the integration.
', 'CreateModelInput$Description' => '
The description of the model.
', 'CreateStageInput$Description' => '
The description for the API stage.
', 'Deployment$Description' => '
The description for the deployment.
', 'Integration$Description' => '
Represents the description of an integration.
', 'Model$Description' => '
The description of the model.
', 'Stage$Description' => '
The description of the stage.
', 'UpdateApiInput$Description' => '
The description of the API.
', 'UpdateAuthorizerInput$IdentityValidationExpression' => '
This parameter is not used.
', 'UpdateDeploymentInput$Description' => '
The description for the deployment resource.
', 'UpdateIntegrationInput$Description' => '
The description of the integration
', 'UpdateModelInput$Description' => '
The description of the model.
', 'UpdateStageInput$Description' => '
The description for the API stage.
', 'VpcLink$VpcLinkStatusMessage' => '
A message summarizing the cause of the status of the VPC link.
', ], ], 'StringWithLengthBetween0And2048' => [ 'base' => '
A string with a length between [0-2048].
', 'refs' => [ 'StageVariablesMap$member' => NULL, ], ], 'StringWithLengthBetween0And32K' => [ 'base' => '
A string with a length between [0-32768].
', 'refs' => [ 'CreateModelInput$Schema' => '
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
', 'Model$Schema' => '
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
', 'TemplateMap$member' => NULL, 'UpdateModelInput$Schema' => '
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
', ], ], 'StringWithLengthBetween1And1024' => [ 'base' => '
A string with a length between [1-1024].
', 'refs' => [ 'AccessLogSettings$Format' => '
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
', 'CreateIntegrationInput$ConnectionId' => '
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
', 'Integration$ConnectionId' => '
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
', 'UpdateIntegrationInput$ConnectionId' => '
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
', ], ], 'StringWithLengthBetween1And128' => [ 'base' => '
A string with a length between [1-128].
', 'refs' => [ 'Api$Name' => '
The name of the API.
', 'ApiMapping$Stage' => '
The API stage.
', 'Authorizer$Name' => '
The name of the authorizer.
', 'CreateApiInput$Name' => '
The name of the API.
', 'CreateApiMappingInput$Stage' => '
The API stage.
', 'CreateAuthorizerInput$Name' => '
The name of the authorizer.
', 'CreateDeploymentInput$StageName' => '
The name of the Stage resource for the Deployment resource to create.
', 'CreateIntegrationInput$IntegrationSubtype' => '
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
', 'CreateModelInput$Name' => '
The name of the model. Must be alphanumeric.
', 'CreateRouteInput$Target' => '
The target for the route.
', 'CreateStageInput$StageName' => '
The name of the stage.
', 'CreateVpcLinkInput$Name' => '
The name of the VPC link.
', 'DomainNameConfiguration$CertificateName' => '
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
', 'Integration$IntegrationSubtype' => '
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
', 'Model$Name' => '
The name of the model. Must be alphanumeric.
', 'Route$Target' => '
The target for the route.
', 'RouteModels$member' => NULL, 'Stage$StageName' => '
The name of the stage.
', 'UpdateApiInput$Name' => '
The name of the API.
', 'UpdateApiMappingInput$Stage' => '
The API stage.
', 'UpdateAuthorizerInput$Name' => '
The name of the authorizer.
', 'UpdateIntegrationInput$IntegrationSubtype' => '
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
', 'UpdateModelInput$Name' => '
The name of the model.
', 'UpdateRouteInput$Target' => '
The target for the route.
', 'UpdateVpcLinkInput$Name' => '
The name of the VPC link.
', 'VpcLink$Name' => '
The name of the VPC link.
', ], ], 'StringWithLengthBetween1And1600' => [ 'base' => '
A string with a length between [0-1600].
', 'refs' => [ 'Tags$member' => NULL, ], ], 'StringWithLengthBetween1And256' => [ 'base' => '
A string with a length between [1-256].
', 'refs' => [ 'CreateModelInput$ContentType' => '
The content-type for the model, for example, "application/json".
', 'Model$ContentType' => '
The content-type for the model, for example, "application/json".
', 'UpdateModelInput$ContentType' => '
The content-type for the model, for example, "application/json".
', ], ], 'StringWithLengthBetween1And512' => [ 'base' => '
A string with a length between [1-512].
', 'refs' => [ 'CreateDomainNameInput$DomainName' => '
The domain name.
', 'DomainName$DomainName' => '
The name of the DomainName resource.
', 'IntegrationParameters$member' => NULL, 'TlsConfig$ServerNameToVerify' => '
If you specify a server name, API Gateway uses it to verify the hostname on the integration\'s certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
', 'TlsConfigInput$ServerNameToVerify' => '
If you specify a server name, API Gateway uses it to verify the hostname on the integration\'s certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
', ], ], 'StringWithLengthBetween1And64' => [ 'base' => '
A string with a length between [1-64].
', 'refs' => [ 'Api$Version' => '
A version identifier for the API.
', 'AuthorizationScopes$member' => NULL, 'Authorizer$AuthorizerPayloadFormatVersion' => '
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.
', 'CorsMethodList$member' => NULL, 'CreateApiInput$Version' => '
A version identifier for the API.
', 'CreateAuthorizerInput$AuthorizerPayloadFormatVersion' => '
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.
', 'CreateIntegrationInput$IntegrationMethod' => '
Specifies the integration\'s HTTP method type.
', 'CreateIntegrationInput$PayloadFormatVersion' => '
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
', 'CreateRouteInput$OperationName' => '
The operation name for the route.
', 'Integration$IntegrationMethod' => '
Specifies the integration\'s HTTP method type.
', 'Integration$PayloadFormatVersion' => '
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
', 'MutualTlsAuthentication$TruststoreVersion' => '
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
', 'MutualTlsAuthenticationInput$TruststoreVersion' => '
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
', 'Route$OperationName' => '
The operation name for the route.
', 'UpdateApiInput$Version' => '
A version identifier for the API.
', 'UpdateAuthorizerInput$AuthorizerPayloadFormatVersion' => '
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.
', 'UpdateIntegrationInput$IntegrationMethod' => '
Specifies the integration\'s HTTP method type.
', 'UpdateIntegrationInput$PayloadFormatVersion' => '
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
', 'UpdateRouteInput$OperationName' => '
The operation name for the route.
', ], ], 'SubnetIdList' => [ 'base' => '
A list of subnet IDs to include in the VPC link.
', 'refs' => [ 'CreateVpcLinkInput$SubnetIds' => '
A list of subnet IDs to include in the VPC link.
', 'VpcLink$SubnetIds' => '
A list of subnet IDs to include in the VPC link.
', ], ], 'TagResourceInput' => [ 'base' => '
Represents the input parameters for a TagResource request.
', 'refs' => [], ], 'Tags' => [ 'base' => '
Represents a collection of tags associated with the resource.
', 'refs' => [ 'Api$Tags' => '
A collection of tags associated with the API.
', 'CreateApiInput$Tags' => '
The collection of tags. Each tag element is associated with a given resource.
', 'CreateDomainNameInput$Tags' => '
The collection of tags associated with a domain name.
', 'CreateStageInput$Tags' => '
The collection of tags. Each tag element is associated with a given resource.
', 'CreateVpcLinkInput$Tags' => '
A list of tags.
', 'DomainName$Tags' => '
The collection of tags associated with a domain name.
', 'Stage$Tags' => '
The collection of tags. Each tag element is associated with a given resource.
', 'TagResourceInput$Tags' => '
The collection of tags. Each tag element is associated with a given resource.
', 'VpcLink$Tags' => '
Tags for the VPC link.
', ], ], 'Template' => [ 'base' => '
Represents a template.
', 'refs' => [], ], 'TemplateMap' => [ 'base' => '
A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
', 'refs' => [ 'CreateIntegrationInput$RequestTemplates' => '
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
', 'CreateIntegrationResponseInput$ResponseTemplates' => '
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.
', 'Integration$RequestTemplates' => '
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
', 'IntegrationResponse$ResponseTemplates' => '
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.
', 'UpdateIntegrationInput$RequestTemplates' => '
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
', 'UpdateIntegrationResponseInput$ResponseTemplates' => '
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.
', ], ], 'TlsConfig' => [ 'base' => '
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
', 'refs' => [ 'Integration$TlsConfig' => '
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
', ], ], 'TlsConfigInput' => [ 'base' => '
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
', 'refs' => [ 'CreateIntegrationInput$TlsConfig' => '
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
', 'UpdateIntegrationInput$TlsConfig' => '
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
', ], ], 'TooManyRequestsException' => [ 'base' => '
A limit has been exceeded. See the accompanying error message for details.
', 'refs' => [], ], 'UpdateApiInput' => [ 'base' => '
Represents the input parameters for an UpdateApi request.
', 'refs' => [], ], 'UpdateApiMappingInput' => [ 'base' => '
Represents the input parameters for an UpdateApiMapping request.
', 'refs' => [], ], 'UpdateAuthorizerInput' => [ 'base' => '
The input parameters for an UpdateAuthorizer request.
', 'refs' => [], ], 'UpdateDeploymentInput' => [ 'base' => '
Represents the input parameters for an UpdateDeployment request.
', 'refs' => [], ], 'UpdateDomainNameInput' => [ 'base' => '
Represents the input parameters for an UpdateDomainName request.
', 'refs' => [], ], 'UpdateIntegrationInput' => [ 'base' => '
Represents the input parameters for an UpdateIntegration request.
', 'refs' => [], ], 'UpdateIntegrationResponseInput' => [ 'base' => '
Represents the input parameters for an UpdateIntegrationResponse request.
', 'refs' => [], ], 'UpdateModelInput' => [ 'base' => '
Represents the input parameters for an UpdateModel request. Supported only for WebSocket APIs.
', 'refs' => [], ], 'UpdateRouteInput' => [ 'base' => '
Represents the input parameters for an UpdateRoute request.
', 'refs' => [], ], 'UpdateRouteResponseInput' => [ 'base' => '
Represents the input parameters for an UpdateRouteResponse request.
', 'refs' => [], ], 'UpdateStageInput' => [ 'base' => '
Represents the input parameters for an UpdateStage request.
', 'refs' => [], ], 'UpdateVpcLinkInput' => [ 'base' => '
Represents the input parameters for an UpdateVpcLink request.
', 'refs' => [], ], 'UriWithLengthBetween1And2048' => [ 'base' => '
A string representation of a URI with a length between [1-2048].
', 'refs' => [ 'Authorizer$AuthorizerUri' => '
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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
', 'CreateApiInput$Target' => '
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.
', 'CreateAuthorizerInput$AuthorizerUri' => '
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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
', 'CreateIntegrationInput$IntegrationUri' => '
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.
', 'Integration$IntegrationUri' => '
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.
', 'JWTConfiguration$Issuer' => '
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.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.
', 'MutualTlsAuthentication$TruststoreUri' => '
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable> . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
', 'MutualTlsAuthenticationInput$TruststoreUri' => '
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable> . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
', 'UpdateApiInput$Target' => '
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.
', 'UpdateAuthorizerInput$AuthorizerUri' => '
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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
', 'UpdateIntegrationInput$IntegrationUri' => '
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.
', ], ], 'VpcLink' => [ 'base' => '
Represents a VPC link.
', 'refs' => [ '__listOfVpcLink$member' => NULL, ], ], 'VpcLinkStatus' => [ 'base' => '
The status of the VPC link.
', 'refs' => [ 'VpcLink$VpcLinkStatus' => '
The status of the VPC link.
', ], ], 'VpcLinkVersion' => [ 'base' => '
The version of the VPC link.
', 'refs' => [ 'VpcLink$VpcLinkVersion' => '
The version of the VPC link.
', ], ], 'VpcLinks' => [ 'base' => '
Represents a collection of VPCLinks.
', 'refs' => [], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'Api$ApiGatewayManaged' => '
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.
', 'Api$DisableSchemaValidation' => '
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
', 'Authorizer$EnableSimpleResponses' => '
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
', 'Api$DisableExecuteApiEndpoint' => '
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.
', 'Cors$AllowCredentials' => '
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
', 'CreateApiInput$DisableSchemaValidation' => '
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
', 'CreateAuthorizerInput$EnableSimpleResponses' => '
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
', 'CreateRouteInput$ApiKeyRequired' => '
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
', 'CreateStageInput$AutoDeploy' => '
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
', 'Deployment$AutoDeployed' => '
Specifies whether a deployment was automatically released.
', 'Integration$ApiGatewayManaged' => '
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.
', 'ParameterConstraints$Required' => '
Whether or not the parameter is required.
', 'Route$ApiGatewayManaged' => '
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.
', 'Route$ApiKeyRequired' => '
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
', 'RouteSettings$DataTraceEnabled' => '
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.
', 'RouteSettings$DetailedMetricsEnabled' => '
Specifies whether detailed metrics are enabled.
', 'Stage$ApiGatewayManaged' => '
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.
', 'Stage$AutoDeploy' => '
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
', 'UpdateApiInput$DisableSchemaValidation' => '
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
', 'UpdateAuthorizerInput$EnableSimpleResponses' => '
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
', 'UpdateRouteInput$ApiKeyRequired' => '
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
', 'UpdateStageInput$AutoDeploy' => '
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
', ], ], '__double' => [ 'base' => NULL, 'refs' => [ 'RouteSettings$ThrottlingRateLimit' => '
Specifies the throttling rate limit.
', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'RouteSettings$ThrottlingBurstLimit' => '
Specifies the throttling burst limit.
', ], ], '__listOfApi' => [ 'base' => NULL, 'refs' => [ 'Apis$Items' => '
The elements from this collection.
', ], ], '__listOfApiMapping' => [ 'base' => NULL, 'refs' => [ 'ApiMappings$Items' => '
The elements from this collection.
', ], ], '__listOfAuthorizer' => [ 'base' => NULL, 'refs' => [ 'Authorizers$Items' => '
The elements from this collection.
', ], ], '__listOfDeployment' => [ 'base' => NULL, 'refs' => [ 'Deployments$Items' => '
The elements from this collection.
', ], ], '__listOfDomainName' => [ 'base' => NULL, 'refs' => [ 'DomainNames$Items' => '
The elements from this collection.
', ], ], '__listOfIntegration' => [ 'base' => NULL, 'refs' => [ 'Integrations$Items' => '
The elements from this collection.
', ], ], '__listOfIntegrationResponse' => [ 'base' => NULL, 'refs' => [ 'IntegrationResponses$Items' => '
The elements from this collection.
', ], ], '__listOfModel' => [ 'base' => NULL, 'refs' => [ 'Models$Items' => '
The elements from this collection.
', ], ], '__listOfRoute' => [ 'base' => NULL, 'refs' => [ 'Routes$Items' => '
The elements from this collection.
', ], ], '__listOfRouteResponse' => [ 'base' => NULL, 'refs' => [ 'RouteResponses$Items' => '
The elements from this collection.
', ], ], '__listOfStage' => [ 'base' => NULL, 'refs' => [ 'Stages$Items' => '
The elements from this collection.
', ], ], '__listOfVpcLink' => [ 'base' => NULL, 'refs' => [ 'VpcLinks$Items' => '
A collection of VPC links.
', ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'Api$ImportInfo' => '
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.
', 'Api$Warnings' => '
The warning messages reported when failonwarnings is turned on during API import.
', 'JWTConfiguration$Audience' => '
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.
', 'MutualTlsAuthentication$TruststoreWarnings' => '
A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'Api$ApiEndpoint' => '
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.
', 'BadRequestException$Message' => '
Describes the error encountered.
', 'ConflictException$Message' => '
Describes the error encountered.
', 'CorsHeaderList$member' => NULL, 'CorsOriginList$member' => NULL, 'Deployment$DeploymentStatusMessage' => '
May contain additional feedback on the status of an API deployment.
', 'DomainNameConfiguration$ApiGatewayDomainName' => '
A domain name for the API.
', 'DomainNameConfiguration$DomainNameStatusMessage' => '
An optional text message containing detailed information about status of the domain name migration.
', 'DomainNameConfiguration$HostedZoneId' => '
The Amazon Route 53 Hosted Zone ID of the endpoint.
', 'IdentitySourceList$member' => NULL, 'ImportApiInput$Body' => '
The OpenAPI definition. Supported only for HTTP APIs.
', 'LimitExceededException$LimitType' => '
The limit type.
', 'LimitExceededException$Message' => '
Describes the error encountered.
', 'NotFoundException$Message' => '
Describes the error encountered.
', 'NotFoundException$ResourceType' => '
The resource type.
', 'ReimportApiInput$Body' => '
The OpenAPI definition. Supported only for HTTP APIs.
', 'SecurityGroupIdList$member' => NULL, 'Stage$LastDeploymentStatusMessage' => '
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
', 'SubnetIdList$member' => NULL, 'Template$Value' => '
The template value.
', '__listOf__string$member' => NULL, ], ], '__timestampIso8601' => [ 'base' => NULL, 'refs' => [ 'Api$CreatedDate' => '
The timestamp when the API was created.
', 'Deployment$CreatedDate' => '
The date and time when the Deployment resource was created.
', 'DomainNameConfiguration$CertificateUploadDate' => '
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
', 'Stage$CreatedDate' => '
The timestamp when the stage was created.
', 'Stage$LastUpdatedDate' => '
The timestamp when the stage was last updated.
', 'VpcLink$CreatedDate' => '
The timestamp when the VPC link was created.
', ], ], ],];