AmazonApiGatewayV2 2018-11-29
- Client: Aws\ApiGatewayV2\ApiGatewayV2Client
- Service ID: apigatewayv2
- Version: 2018-11-29
This page describes the parameters and results for the operations of the AmazonApiGatewayV2 (2018-11-29), and shows how to use the Aws\ApiGatewayV2\ApiGatewayV2Client object to call the described operations. This documentation is specific to the 2018-11-29 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateApi ( array $params = [] )
Creates an Api resource.
- CreateApiMapping ( array $params = [] )
Creates an API mapping.
- CreateAuthorizer ( array $params = [] )
Creates an Authorizer for an API.
- CreateDeployment ( array $params = [] )
Creates a Deployment for an API.
- CreateDomainName ( array $params = [] )
Creates a domain name.
- CreateIntegration ( array $params = [] )
Creates an Integration.
- CreateIntegrationResponse ( array $params = [] )
Creates an IntegrationResponses.
- CreateModel ( array $params = [] )
Creates a Model for an API.
- CreateRoute ( array $params = [] )
Creates a Route for an API.
- CreateRouteResponse ( array $params = [] )
Creates a RouteResponse for a Route.
- CreateStage ( array $params = [] )
Creates a Stage for an API.
- CreateVpcLink ( array $params = [] )
Creates a VPC link.
- DeleteAccessLogSettings ( array $params = [] )
Deletes the AccessLogSettings for a Stage.
- DeleteApi ( array $params = [] )
Deletes an Api resource.
- DeleteApiMapping ( array $params = [] )
Deletes an API mapping.
- DeleteAuthorizer ( array $params = [] )
Deletes an Authorizer.
- DeleteCorsConfiguration ( array $params = [] )
Deletes a CORS configuration.
- DeleteDeployment ( array $params = [] )
Deletes a Deployment.
- DeleteDomainName ( array $params = [] )
Deletes a domain name.
- DeleteIntegration ( array $params = [] )
Deletes an Integration.
- DeleteIntegrationResponse ( array $params = [] )
Deletes an IntegrationResponses.
- DeleteModel ( array $params = [] )
Deletes a Model.
- DeleteRoute ( array $params = [] )
Deletes a Route.
- DeleteRouteRequestParameter ( array $params = [] )
Deletes a route request parameter.
- DeleteRouteResponse ( array $params = [] )
Deletes a RouteResponse.
- DeleteRouteSettings ( array $params = [] )
Deletes the RouteSettings for a stage.
- DeleteStage ( array $params = [] )
Deletes a Stage.
- DeleteVpcLink ( array $params = [] )
Deletes a VPC link.
- ExportApi ( array $params = [] )
Exports a definition of an API in a particular output format and specification.
- GetApiMapping ( array $params = [] )
Gets an API mapping.
- GetApiMappings ( array $params = [] )
Gets API mappings.
- GetApiResource ( array $params = [] )
Gets an Api resource.
- GetApis ( array $params = [] )
Gets a collection of Api resources.
- GetAuthorizer ( array $params = [] )
Gets an Authorizer.
- GetAuthorizers ( array $params = [] )
Gets the Authorizers for an API.
- GetDeployment ( array $params = [] )
Gets a Deployment.
- GetDeployments ( array $params = [] )
Gets the Deployments for an API.
- GetDomainName ( array $params = [] )
Gets a domain name.
- GetDomainNames ( array $params = [] )
Gets the domain names for an AWS account.
- GetIntegration ( array $params = [] )
Gets an Integration.
- GetIntegrationResponse ( array $params = [] )
Gets an IntegrationResponses.
- GetIntegrationResponses ( array $params = [] )
Gets the IntegrationResponses for an Integration.
- GetIntegrations ( array $params = [] )
Gets the Integrations for an API.
- GetModel ( array $params = [] )
Gets a Model.
- GetModelTemplate ( array $params = [] )
Gets a model template.
- GetModels ( array $params = [] )
Gets the Models for an API.
- GetRoute ( array $params = [] )
Gets a Route.
- GetRouteResponse ( array $params = [] )
Gets a RouteResponse.
- GetRouteResponses ( array $params = [] )
Gets the RouteResponses for a Route.
- GetRoutes ( array $params = [] )
Gets the Routes for an API.
- GetStage ( array $params = [] )
Gets a Stage.
- GetStages ( array $params = [] )
Gets the Stages for an API.
- GetTags ( array $params = [] )
Gets a collection of Tag resources.
- GetVpcLink ( array $params = [] )
Gets a VPC link.
- GetVpcLinks ( array $params = [] )
Gets a collection of VPC links.
- ImportApi ( array $params = [] )
Imports an API.
- ReimportApi ( array $params = [] )
Puts an Api resource.
- ResetAuthorizersCache ( array $params = [] )
Resets all authorizer cache entries for the specified stage.
- TagResource ( array $params = [] )
Creates a new Tag resource to represent a tag.
- UntagResource ( array $params = [] )
Deletes a Tag.
- UpdateApi ( array $params = [] )
Updates an Api resource.
- UpdateApiMapping ( array $params = [] )
The API mapping.
- UpdateAuthorizer ( array $params = [] )
Updates an Authorizer.
- UpdateDeployment ( array $params = [] )
Updates a Deployment.
- UpdateDomainName ( array $params = [] )
Updates a domain name.
- UpdateIntegration ( array $params = [] )
Updates an Integration.
- UpdateIntegrationResponse ( array $params = [] )
Updates an IntegrationResponses.
- UpdateModel ( array $params = [] )
Updates a Model.
- UpdateRoute ( array $params = [] )
Updates a Route.
- UpdateRouteResponse ( array $params = [] )
Updates a RouteResponse.
- UpdateStage ( array $params = [] )
Updates a Stage.
- UpdateVpcLink ( array $params = [] )
Updates a VPC link.
Operations
CreateApi
$result = $client->createApi([/* ... */]); $promise = $client->createApiAsync([/* ... */]);
Creates an Api resource.
Parameter Syntax
$result = $client->createApi([
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CredentialsArn' => '<string>',
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'Name' => '<string>', // REQUIRED
'ProtocolType' => 'WEBSOCKET|HTTP', // REQUIRED
'RouteKey' => '<string>',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Target' => '<string>',
'Version' => '<string>',
]);
Parameter Details
Members
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- Name
-
- Required: Yes
- Type: string
A string with a length between [1-128].
- ProtocolType
-
- Required: Yes
- Type: string
Represents a protocol type. - RouteKey
-
- Type: string
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.
- RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- Target
-
- Type: string
A string representation of a URI with a length between [1-2048].
- Version
-
- Type: string
A string with a length between [1-64].
Result Syntax
[
'ApiEndpoint' => '<string>',
'ApiGatewayManaged' => true || false,
'ApiId' => '<string>',
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'ImportInfo' => ['<string>', ...],
'Name' => '<string>',
'ProtocolType' => 'WEBSOCKET|HTTP',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Version' => '<string>',
'Warnings' => ['<string>', ...],
]
Result Details
Members
- ApiEndpoint
-
- Type: string
- ApiGatewayManaged
-
- Type: boolean
- ApiId
-
- Type: string
The identifier.
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- ImportInfo
-
- Type: Array of strings
- Name
-
- Type: string
A string with a length between [1-128].
- ProtocolType
-
- Type: string
Represents a protocol type. - RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- Version
-
- Type: string
A string with a length between [1-64].
- Warnings
-
- Type: Array of strings
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateApiMapping
$result = $client->createApiMapping([/* ... */]); $promise = $client->createApiMappingAsync([/* ... */]);
Creates an API mapping.
Parameter Syntax
$result = $client->createApiMapping([
'ApiId' => '<string>', // REQUIRED
'ApiMappingKey' => '<string>',
'DomainName' => '<string>', // REQUIRED
'Stage' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
The identifier.
- ApiMappingKey
-
- Type: string
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.
- DomainName
-
- Required: Yes
- Type: string
- Stage
-
- Required: Yes
- Type: string
A string with a length between [1-128].
Result Syntax
[
'ApiId' => '<string>',
'ApiMappingId' => '<string>',
'ApiMappingKey' => '<string>',
'Stage' => '<string>',
]
Result Details
Members
- ApiId
-
- Type: string
The identifier.
- ApiMappingId
-
- Type: string
The identifier.
- ApiMappingKey
-
- Type: string
After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
- Stage
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateAuthorizer
$result = $client->createAuthorizer([/* ... */]); $promise = $client->createAuthorizerAsync([/* ... */]);
Creates an Authorizer for an API.
Parameter Syntax
$result = $client->createAuthorizer([
'ApiId' => '<string>', // REQUIRED
'AuthorizerCredentialsArn' => '<string>',
'AuthorizerPayloadFormatVersion' => '<string>',
'AuthorizerResultTtlInSeconds' => <integer>,
'AuthorizerType' => 'REQUEST|JWT', // REQUIRED
'AuthorizerUri' => '<string>',
'EnableSimpleResponses' => true || false,
'IdentitySource' => ['<string>', ...], // REQUIRED
'IdentityValidationExpression' => '<string>',
'JwtConfiguration' => [
'Audience' => ['<string>', ...],
'Issuer' => '<string>',
],
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- AuthorizerCredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- AuthorizerPayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- AuthorizerResultTtlInSeconds
-
- Type: int
An integer with a value between [0-3600].
- AuthorizerType
-
- Required: Yes
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- EnableSimpleResponses
-
- Type: boolean
- IdentitySource
-
- Required: Yes
- Type: Array of strings
The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- IdentityValidationExpression
-
- Type: string
A string with a length between [0-1024].
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Required: Yes
- Type: string
A string with a length between [1-128].
Result Syntax
[
'AuthorizerCredentialsArn' => '<string>',
'AuthorizerId' => '<string>',
'AuthorizerPayloadFormatVersion' => '<string>',
'AuthorizerResultTtlInSeconds' => <integer>,
'AuthorizerType' => 'REQUEST|JWT',
'AuthorizerUri' => '<string>',
'EnableSimpleResponses' => true || false,
'IdentitySource' => ['<string>', ...],
'IdentityValidationExpression' => '<string>',
'JwtConfiguration' => [
'Audience' => ['<string>', ...],
'Issuer' => '<string>',
],
'Name' => '<string>',
]
Result Details
Members
- AuthorizerCredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- AuthorizerId
-
- Type: string
The identifier.
- AuthorizerPayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- AuthorizerResultTtlInSeconds
-
- Type: int
An integer with a value between [0-3600].
- AuthorizerType
-
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- EnableSimpleResponses
-
- Type: boolean
- IdentitySource
-
- Type: Array of strings
The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- IdentityValidationExpression
-
- Type: string
A string with a length between [0-1024].
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateDeployment
$result = $client->createDeployment([/* ... */]); $promise = $client->createDeploymentAsync([/* ... */]);
Creates a Deployment for an API.
Parameter Syntax
$result = $client->createDeployment([
'ApiId' => '<string>', // REQUIRED
'Description' => '<string>',
'StageName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AutoDeployed' => true || false,
'CreatedDate' => <DateTime>,
'DeploymentId' => '<string>',
'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
'DeploymentStatusMessage' => '<string>',
'Description' => '<string>',
]
Result Details
Members
- AutoDeployed
-
- Type: boolean
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DeploymentId
-
- Type: string
The identifier.
- DeploymentStatus
-
- Type: string
Represents a deployment status.
- DeploymentStatusMessage
-
- Type: string
- Description
-
- Type: string
A string with a length between [0-1024].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateDomainName
$result = $client->createDomainName([/* ... */]); $promise = $client->createDomainNameAsync([/* ... */]);
Creates a domain name.
Parameter Syntax
$result = $client->createDomainName([
'DomainName' => '<string>', // REQUIRED
'DomainNameConfigurations' => [
[
'ApiGatewayDomainName' => '<string>',
'CertificateArn' => '<string>',
'CertificateName' => '<string>',
'CertificateUploadDate' => <integer || string || DateTime>,
'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
'DomainNameStatusMessage' => '<string>',
'EndpointType' => 'REGIONAL|EDGE',
'HostedZoneId' => '<string>',
'OwnershipVerificationCertificateArn' => '<string>',
'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
],
// ...
],
'MutualTlsAuthentication' => [
'TruststoreUri' => '<string>',
'TruststoreVersion' => '<string>',
],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string with a length between [1-512].
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthenticationInput structure
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Result Syntax
[
'ApiMappingSelectionExpression' => '<string>',
'DomainName' => '<string>',
'DomainNameConfigurations' => [
[
'ApiGatewayDomainName' => '<string>',
'CertificateArn' => '<string>',
'CertificateName' => '<string>',
'CertificateUploadDate' => <DateTime>,
'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
'DomainNameStatusMessage' => '<string>',
'EndpointType' => 'REGIONAL|EDGE',
'HostedZoneId' => '<string>',
'OwnershipVerificationCertificateArn' => '<string>',
'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
],
// ...
],
'MutualTlsAuthentication' => [
'TruststoreUri' => '<string>',
'TruststoreVersion' => '<string>',
'TruststoreWarnings' => ['<string>', ...],
],
'Tags' => ['<string>', ...],
]
Result Details
Members
- ApiMappingSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- DomainName
-
- Type: string
A string with a length between [1-512].
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
-
This error does not currently have a description.
CreateIntegration
$result = $client->createIntegration([/* ... */]); $promise = $client->createIntegrationAsync([/* ... */]);
Creates an Integration.
Parameter Syntax
$result = $client->createIntegration([
'ApiId' => '<string>', // REQUIRED
'ConnectionId' => '<string>',
'ConnectionType' => 'INTERNET|VPC_LINK',
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'CredentialsArn' => '<string>',
'Description' => '<string>',
'IntegrationMethod' => '<string>',
'IntegrationSubtype' => '<string>',
'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY', // REQUIRED
'IntegrationUri' => '<string>',
'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
'PayloadFormatVersion' => '<string>',
'RequestParameters' => ['<string>', ...],
'RequestTemplates' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => ['<string>', ...],
// ...
],
'TemplateSelectionExpression' => '<string>',
'TimeoutInMillis' => <integer>,
'TlsConfig' => [
'ServerNameToVerify' => '<string>',
],
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ConnectionId
-
- Type: string
A string with a length between [1-1024].
- ConnectionType
-
- Type: string
Represents a connection type.
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- IntegrationMethod
-
- Type: string
A string with a length between [1-64].
- IntegrationSubtype
-
- Type: string
A string with a length between [1-128].
- IntegrationType
-
- Required: Yes
- Type: string
Represents an API method integration type.
- IntegrationUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- PassthroughBehavior
-
- Type: string
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
- PayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- TimeoutInMillis
-
- Type: int
An integer with a value between [50-30000].
- TlsConfig
-
- Type: TlsConfigInput structure
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.
Result Syntax
[
'ApiGatewayManaged' => true || false,
'ConnectionId' => '<string>',
'ConnectionType' => 'INTERNET|VPC_LINK',
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'CredentialsArn' => '<string>',
'Description' => '<string>',
'IntegrationId' => '<string>',
'IntegrationMethod' => '<string>',
'IntegrationResponseSelectionExpression' => '<string>',
'IntegrationSubtype' => '<string>',
'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
'IntegrationUri' => '<string>',
'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
'PayloadFormatVersion' => '<string>',
'RequestParameters' => ['<string>', ...],
'RequestTemplates' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => ['<string>', ...],
// ...
],
'TemplateSelectionExpression' => '<string>',
'TimeoutInMillis' => <integer>,
'TlsConfig' => [
'ServerNameToVerify' => '<string>',
],
]
Result Details
Members
- ApiGatewayManaged
-
- Type: boolean
- ConnectionId
-
- Type: string
A string with a length between [1-1024].
- ConnectionType
-
- Type: string
Represents a connection type.
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- IntegrationId
-
- Type: string
The identifier.
- IntegrationMethod
-
- Type: string
A string with a length between [1-64].
- IntegrationResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- IntegrationSubtype
-
- Type: string
A string with a length between [1-128].
- IntegrationType
-
- Type: string
Represents an API method integration type.
- IntegrationUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- PassthroughBehavior
-
- Type: string
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
- PayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- TimeoutInMillis
-
- Type: int
An integer with a value between [50-30000].
- TlsConfig
-
- Type: TlsConfig structure
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.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateIntegrationResponse
$result = $client->createIntegrationResponse([/* ... */]); $promise = $client->createIntegrationResponseAsync([/* ... */]);
Creates an IntegrationResponses.
Parameter Syntax
$result = $client->createIntegrationResponse([
'ApiId' => '<string>', // REQUIRED
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'IntegrationId' => '<string>', // REQUIRED
'IntegrationResponseKey' => '<string>', // REQUIRED
'ResponseParameters' => ['<string>', ...],
'ResponseTemplates' => ['<string>', ...],
'TemplateSelectionExpression' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- IntegrationId
-
- Required: Yes
- Type: string
- IntegrationResponseKey
-
- Required: Yes
- Type: string
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
Result Syntax
[
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'IntegrationResponseId' => '<string>',
'IntegrationResponseKey' => '<string>',
'ResponseParameters' => ['<string>', ...],
'ResponseTemplates' => ['<string>', ...],
'TemplateSelectionExpression' => '<string>',
]
Result Details
Members
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- IntegrationResponseId
-
- Type: string
The identifier.
- IntegrationResponseKey
-
- Type: string
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateModel
$result = $client->createModel([/* ... */]); $promise = $client->createModelAsync([/* ... */]);
Creates a Model for an API.
Parameter Syntax
$result = $client->createModel([
'ApiId' => '<string>', // REQUIRED
'ContentType' => '<string>',
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'Schema' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ContentType
-
- Type: string
A string with a length between [1-256].
- Description
-
- Type: string
A string with a length between [0-1024].
- Name
-
- Required: Yes
- Type: string
A string with a length between [1-128].
- Schema
-
- Required: Yes
- Type: string
A string with a length between [0-32768].
Result Syntax
[
'ContentType' => '<string>',
'Description' => '<string>',
'ModelId' => '<string>',
'Name' => '<string>',
'Schema' => '<string>',
]
Result Details
Members
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateRoute
$result = $client->createRoute([/* ... */]); $promise = $client->createRouteAsync([/* ... */]);
Creates a Route for an API.
Parameter Syntax
$result = $client->createRoute([
'ApiId' => '<string>', // REQUIRED
'ApiKeyRequired' => true || false,
'AuthorizationScopes' => ['<string>', ...],
'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
'AuthorizerId' => '<string>',
'ModelSelectionExpression' => '<string>',
'OperationName' => '<string>',
'RequestModels' => ['<string>', ...],
'RequestParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteKey' => '<string>', // REQUIRED
'RouteResponseSelectionExpression' => '<string>',
'Target' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ApiKeyRequired
-
- Type: boolean
- AuthorizationScopes
-
- Type: Array of strings
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- AuthorizationType
-
- Type: string
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.
- AuthorizerId
-
- Type: string
The identifier.
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- OperationName
-
- Type: string
A string with a length between [1-64].
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteKey
-
- Required: Yes
- Type: string
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.
- RouteResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Target
-
- Type: string
A string with a length between [1-128].
Result Syntax
[
'ApiGatewayManaged' => true || false,
'ApiKeyRequired' => true || false,
'AuthorizationScopes' => ['<string>', ...],
'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
'AuthorizerId' => '<string>',
'ModelSelectionExpression' => '<string>',
'OperationName' => '<string>',
'RequestModels' => ['<string>', ...],
'RequestParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>',
'RouteKey' => '<string>',
'RouteResponseSelectionExpression' => '<string>',
'Target' => '<string>',
]
Result Details
Members
- ApiGatewayManaged
-
- Type: boolean
- ApiKeyRequired
-
- Type: boolean
- AuthorizationScopes
-
- Type: Array of strings
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- AuthorizationType
-
- Type: string
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.
- AuthorizerId
-
- Type: string
The identifier.
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- OperationName
-
- Type: string
A string with a length between [1-64].
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteId
-
- Type: string
The identifier.
- RouteKey
-
- Type: string
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.
- RouteResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Target
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateRouteResponse
$result = $client->createRouteResponse([/* ... */]); $promise = $client->createRouteResponseAsync([/* ... */]);
Creates a RouteResponse for a Route.
Parameter Syntax
$result = $client->createRouteResponse([
'ApiId' => '<string>', // REQUIRED
'ModelSelectionExpression' => '<string>',
'ResponseModels' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>', // REQUIRED
'RouteResponseKey' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteId
-
- Required: Yes
- Type: string
- RouteResponseKey
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'ModelSelectionExpression' => '<string>',
'ResponseModels' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteResponseId' => '<string>',
'RouteResponseKey' => '<string>',
]
Result Details
Members
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteResponseId
-
- Type: string
The identifier.
- RouteResponseKey
-
- Type: string
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.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateStage
$result = $client->createStage([/* ... */]); $promise = $client->createStageAsync([/* ... */]);
Creates a Stage for an API.
Parameter Syntax
$result = $client->createStage([
'AccessLogSettings' => [
'DestinationArn' => '<string>',
'Format' => '<string>',
],
'ApiId' => '<string>', // REQUIRED
'AutoDeploy' => true || false,
'ClientCertificateId' => '<string>',
'DefaultRouteSettings' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
'DeploymentId' => '<string>',
'Description' => '<string>',
'RouteSettings' => [
'<__string>' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
// ...
],
'StageName' => '<string>', // REQUIRED
'StageVariables' => ['<string>', ...],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in a stage.
- ApiId
-
- Required: Yes
- Type: string
- AutoDeploy
-
- Type: boolean
- ClientCertificateId
-
- Type: string
The identifier.
- DefaultRouteSettings
-
- Type: RouteSettings structure
Represents a collection of route settings.
- DeploymentId
-
- Type: string
The identifier.
- Description
-
- Type: string
A string with a length between [0-1024].
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
The route settings map.
- StageName
-
- Required: Yes
- Type: string
A string with a length between [1-128].
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
The stage variable map.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Result Syntax
[
'AccessLogSettings' => [
'DestinationArn' => '<string>',
'Format' => '<string>',
],
'ApiGatewayManaged' => true || false,
'AutoDeploy' => true || false,
'ClientCertificateId' => '<string>',
'CreatedDate' => <DateTime>,
'DefaultRouteSettings' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
'DeploymentId' => '<string>',
'Description' => '<string>',
'LastDeploymentStatusMessage' => '<string>',
'LastUpdatedDate' => <DateTime>,
'RouteSettings' => [
'<__string>' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
// ...
],
'StageName' => '<string>',
'StageVariables' => ['<string>', ...],
'Tags' => ['<string>', ...],
]
Result Details
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in a stage.
- ApiGatewayManaged
-
- Type: boolean
- AutoDeploy
-
- Type: boolean
- ClientCertificateId
-
- Type: string
The identifier.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DefaultRouteSettings
-
- Type: RouteSettings structure
Represents a collection of route settings.
- DeploymentId
-
- Type: string
The identifier.
- Description
-
- Type: string
A string with a length between [0-1024].
- LastDeploymentStatusMessage
-
- Type: string
- LastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
The route settings map.
- StageName
-
- Type: string
A string with a length between [1-128].
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
The stage variable map.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
CreateVpcLink
$result = $client->createVpcLink([/* ... */]); $promise = $client->createVpcLinkAsync([/* ... */]);
Creates a VPC link.
Parameter Syntax
$result = $client->createVpcLink([
'Name' => '<string>', // REQUIRED
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...], // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
A string with a length between [1-128].
- SecurityGroupIds
-
- Type: Array of strings
A list of security group IDs for the VPC link.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
A list of subnet IDs to include in the VPC link.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Result Syntax
[
'CreatedDate' => <DateTime>,
'Name' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'Tags' => ['<string>', ...],
'VpcLinkId' => '<string>',
'VpcLinkStatus' => 'PENDING|AVAILABLE|DELETING|FAILED|INACTIVE',
'VpcLinkStatusMessage' => '<string>',
'VpcLinkVersion' => 'V2',
]
Result Details
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
A string with a length between [1-128].
- SecurityGroupIds
-
- Type: Array of strings
A list of security group IDs for the VPC link.
- SubnetIds
-
- Type: Array of strings
A list of subnet IDs to include in the VPC link.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- VpcLinkId
-
- Type: string
The identifier.
- VpcLinkStatus
-
- Type: string
The status of the VPC link.
- VpcLinkStatusMessage
-
- Type: string
A string with a length between [0-1024].
- VpcLinkVersion
-
- Type: string
The version of the VPC link.
Errors
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteAccessLogSettings
$result = $client->deleteAccessLogSettings([/* ... */]); $promise = $client->deleteAccessLogSettingsAsync([/* ... */]);
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
Parameter Syntax
$result = $client->deleteAccessLogSettings([
'ApiId' => '<string>', // REQUIRED
'StageName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteApi
$result = $client->deleteApi([/* ... */]); $promise = $client->deleteApiAsync([/* ... */]);
Deletes an Api resource.
Parameter Syntax
$result = $client->deleteApi([
'ApiId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteApiMapping
$result = $client->deleteApiMapping([/* ... */]); $promise = $client->deleteApiMappingAsync([/* ... */]);
Deletes an API mapping.
Parameter Syntax
$result = $client->deleteApiMapping([
'ApiMappingId' => '<string>', // REQUIRED
'DomainName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
DeleteAuthorizer
$result = $client->deleteAuthorizer([/* ... */]); $promise = $client->deleteAuthorizerAsync([/* ... */]);
Deletes an Authorizer.
Parameter Syntax
$result = $client->deleteAuthorizer([
'ApiId' => '<string>', // REQUIRED
'AuthorizerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteCorsConfiguration
$result = $client->deleteCorsConfiguration([/* ... */]); $promise = $client->deleteCorsConfigurationAsync([/* ... */]);
Deletes a CORS configuration.
Parameter Syntax
$result = $client->deleteCorsConfiguration([
'ApiId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteDeployment
$result = $client->deleteDeployment([/* ... */]); $promise = $client->deleteDeploymentAsync([/* ... */]);
Deletes a Deployment.
Parameter Syntax
$result = $client->deleteDeployment([
'ApiId' => '<string>', // REQUIRED
'DeploymentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteDomainName
$result = $client->deleteDomainName([/* ... */]); $promise = $client->deleteDomainNameAsync([/* ... */]);
Deletes a domain name.
Parameter Syntax
$result = $client->deleteDomainName([
'DomainName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteIntegration
$result = $client->deleteIntegration([/* ... */]); $promise = $client->deleteIntegrationAsync([/* ... */]);
Deletes an Integration.
Parameter Syntax
$result = $client->deleteIntegration([
'ApiId' => '<string>', // REQUIRED
'IntegrationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteIntegrationResponse
$result = $client->deleteIntegrationResponse([/* ... */]); $promise = $client->deleteIntegrationResponseAsync([/* ... */]);
Deletes an IntegrationResponses.
Parameter Syntax
$result = $client->deleteIntegrationResponse([
'ApiId' => '<string>', // REQUIRED
'IntegrationId' => '<string>', // REQUIRED
'IntegrationResponseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteModel
$result = $client->deleteModel([/* ... */]); $promise = $client->deleteModelAsync([/* ... */]);
Deletes a Model.
Parameter Syntax
$result = $client->deleteModel([
'ApiId' => '<string>', // REQUIRED
'ModelId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteRoute
$result = $client->deleteRoute([/* ... */]); $promise = $client->deleteRouteAsync([/* ... */]);
Deletes a Route.
Parameter Syntax
$result = $client->deleteRoute([
'ApiId' => '<string>', // REQUIRED
'RouteId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteRouteRequestParameter
$result = $client->deleteRouteRequestParameter([/* ... */]); $promise = $client->deleteRouteRequestParameterAsync([/* ... */]);
Deletes a route request parameter.
Parameter Syntax
$result = $client->deleteRouteRequestParameter([
'ApiId' => '<string>', // REQUIRED
'RequestParameterKey' => '<string>', // REQUIRED
'RouteId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteRouteResponse
$result = $client->deleteRouteResponse([/* ... */]); $promise = $client->deleteRouteResponseAsync([/* ... */]);
Deletes a RouteResponse.
Parameter Syntax
$result = $client->deleteRouteResponse([
'ApiId' => '<string>', // REQUIRED
'RouteId' => '<string>', // REQUIRED
'RouteResponseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteRouteSettings
$result = $client->deleteRouteSettings([/* ... */]); $promise = $client->deleteRouteSettingsAsync([/* ... */]);
Deletes the RouteSettings for a stage.
Parameter Syntax
$result = $client->deleteRouteSettings([
'ApiId' => '<string>', // REQUIRED
'RouteKey' => '<string>', // REQUIRED
'StageName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteStage
$result = $client->deleteStage([/* ... */]); $promise = $client->deleteStageAsync([/* ... */]);
Deletes a Stage.
Parameter Syntax
$result = $client->deleteStage([
'ApiId' => '<string>', // REQUIRED
'StageName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
DeleteVpcLink
$result = $client->deleteVpcLink([/* ... */]); $promise = $client->deleteVpcLinkAsync([/* ... */]);
Deletes a VPC link.
Parameter Syntax
$result = $client->deleteVpcLink([
'VpcLinkId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
ExportApi
$result = $client->exportApi([/* ... */]); $promise = $client->exportApiAsync([/* ... */]);
Exports a definition of an API in a particular output format and specification.
Parameter Syntax
$result = $client->exportApi([
'ApiId' => '<string>', // REQUIRED
'ExportVersion' => '<string>',
'IncludeExtensions' => true || false,
'OutputType' => 'YAML|JSON', // REQUIRED
'Specification' => 'OAS30', // REQUIRED
'StageName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'body' => <string || resource || Psr\Http\Message\StreamInterface>,
]
Result Details
Members
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetApiMapping
$result = $client->getApiMapping([/* ... */]); $promise = $client->getApiMappingAsync([/* ... */]);
Gets an API mapping.
Parameter Syntax
$result = $client->getApiMapping([
'ApiMappingId' => '<string>', // REQUIRED
'DomainName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApiId' => '<string>',
'ApiMappingId' => '<string>',
'ApiMappingKey' => '<string>',
'Stage' => '<string>',
]
Result Details
Members
- ApiId
-
- Type: string
The identifier.
- ApiMappingId
-
- Type: string
The identifier.
- ApiMappingKey
-
- Type: string
After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
- Stage
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetApiMappings
$result = $client->getApiMappings([/* ... */]); $promise = $client->getApiMappingsAsync([/* ... */]);
Gets API mappings.
Parameter Syntax
$result = $client->getApiMappings([
'DomainName' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'ApiId' => '<string>',
'ApiMappingId' => '<string>',
'ApiMappingKey' => '<string>',
'Stage' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of ApiMapping structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetApiResource
$result = $client->getApiResource([/* ... */]); $promise = $client->getApiResourceAsync([/* ... */]);
Gets an Api resource.
Parameter Syntax
$result = $client->getApiResource([
'ApiId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApiEndpoint' => '<string>',
'ApiGatewayManaged' => true || false,
'ApiId' => '<string>',
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'ImportInfo' => ['<string>', ...],
'Name' => '<string>',
'ProtocolType' => 'WEBSOCKET|HTTP',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Version' => '<string>',
'Warnings' => ['<string>', ...],
]
Result Details
Members
- ApiEndpoint
-
- Type: string
- ApiGatewayManaged
-
- Type: boolean
- ApiId
-
- Type: string
The identifier.
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- ImportInfo
-
- Type: Array of strings
- Name
-
- Type: string
A string with a length between [1-128].
- ProtocolType
-
- Type: string
Represents a protocol type. - RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- Version
-
- Type: string
A string with a length between [1-64].
- Warnings
-
- Type: Array of strings
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetApis
$result = $client->getApis([/* ... */]); $promise = $client->getApisAsync([/* ... */]);
Gets a collection of Api resources.
Parameter Syntax
$result = $client->getApis([
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'ApiEndpoint' => '<string>',
'ApiGatewayManaged' => true || false,
'ApiId' => '<string>',
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'ImportInfo' => ['<string>', ...],
'Name' => '<string>',
'ProtocolType' => 'WEBSOCKET|HTTP',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Version' => '<string>',
'Warnings' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Api structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetAuthorizer
$result = $client->getAuthorizer([/* ... */]); $promise = $client->getAuthorizerAsync([/* ... */]);
Gets an Authorizer.
Parameter Syntax
$result = $client->getAuthorizer([
'ApiId' => '<string>', // REQUIRED
'AuthorizerId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AuthorizerCredentialsArn' => '<string>',
'AuthorizerId' => '<string>',
'AuthorizerPayloadFormatVersion' => '<string>',
'AuthorizerResultTtlInSeconds' => <integer>,
'AuthorizerType' => 'REQUEST|JWT',
'AuthorizerUri' => '<string>',
'EnableSimpleResponses' => true || false,
'IdentitySource' => ['<string>', ...],
'IdentityValidationExpression' => '<string>',
'JwtConfiguration' => [
'Audience' => ['<string>', ...],
'Issuer' => '<string>',
],
'Name' => '<string>',
]
Result Details
Members
- AuthorizerCredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- AuthorizerId
-
- Type: string
The identifier.
- AuthorizerPayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- AuthorizerResultTtlInSeconds
-
- Type: int
An integer with a value between [0-3600].
- AuthorizerType
-
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- EnableSimpleResponses
-
- Type: boolean
- IdentitySource
-
- Type: Array of strings
The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- IdentityValidationExpression
-
- Type: string
A string with a length between [0-1024].
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetAuthorizers
$result = $client->getAuthorizers([/* ... */]); $promise = $client->getAuthorizersAsync([/* ... */]);
Gets the Authorizers for an API.
Parameter Syntax
$result = $client->getAuthorizers([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'AuthorizerCredentialsArn' => '<string>',
'AuthorizerId' => '<string>',
'AuthorizerPayloadFormatVersion' => '<string>',
'AuthorizerResultTtlInSeconds' => <integer>,
'AuthorizerType' => 'REQUEST|JWT',
'AuthorizerUri' => '<string>',
'EnableSimpleResponses' => true || false,
'IdentitySource' => ['<string>', ...],
'IdentityValidationExpression' => '<string>',
'JwtConfiguration' => [
'Audience' => ['<string>', ...],
'Issuer' => '<string>',
],
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Authorizer structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetDeployment
$result = $client->getDeployment([/* ... */]); $promise = $client->getDeploymentAsync([/* ... */]);
Gets a Deployment.
Parameter Syntax
$result = $client->getDeployment([
'ApiId' => '<string>', // REQUIRED
'DeploymentId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AutoDeployed' => true || false,
'CreatedDate' => <DateTime>,
'DeploymentId' => '<string>',
'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
'DeploymentStatusMessage' => '<string>',
'Description' => '<string>',
]
Result Details
Members
- AutoDeployed
-
- Type: boolean
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DeploymentId
-
- Type: string
The identifier.
- DeploymentStatus
-
- Type: string
Represents a deployment status.
- DeploymentStatusMessage
-
- Type: string
- Description
-
- Type: string
A string with a length between [0-1024].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetDeployments
$result = $client->getDeployments([/* ... */]); $promise = $client->getDeploymentsAsync([/* ... */]);
Gets the Deployments for an API.
Parameter Syntax
$result = $client->getDeployments([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'AutoDeployed' => true || false,
'CreatedDate' => <DateTime>,
'DeploymentId' => '<string>',
'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
'DeploymentStatusMessage' => '<string>',
'Description' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Deployment structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetDomainName
$result = $client->getDomainName([/* ... */]); $promise = $client->getDomainNameAsync([/* ... */]);
Gets a domain name.
Parameter Syntax
$result = $client->getDomainName([
'DomainName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApiMappingSelectionExpression' => '<string>',
'DomainName' => '<string>',
'DomainNameConfigurations' => [
[
'ApiGatewayDomainName' => '<string>',
'CertificateArn' => '<string>',
'CertificateName' => '<string>',
'CertificateUploadDate' => <DateTime>,
'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
'DomainNameStatusMessage' => '<string>',
'EndpointType' => 'REGIONAL|EDGE',
'HostedZoneId' => '<string>',
'OwnershipVerificationCertificateArn' => '<string>',
'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
],
// ...
],
'MutualTlsAuthentication' => [
'TruststoreUri' => '<string>',
'TruststoreVersion' => '<string>',
'TruststoreWarnings' => ['<string>', ...],
],
'Tags' => ['<string>', ...],
]
Result Details
Members
- ApiMappingSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- DomainName
-
- Type: string
A string with a length between [1-512].
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetDomainNames
$result = $client->getDomainNames([/* ... */]); $promise = $client->getDomainNamesAsync([/* ... */]);
Gets the domain names for an AWS account.
Parameter Syntax
$result = $client->getDomainNames([
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'ApiMappingSelectionExpression' => '<string>',
'DomainName' => '<string>',
'DomainNameConfigurations' => [
[
'ApiGatewayDomainName' => '<string>',
'CertificateArn' => '<string>',
'CertificateName' => '<string>',
'CertificateUploadDate' => <DateTime>,
'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
'DomainNameStatusMessage' => '<string>',
'EndpointType' => 'REGIONAL|EDGE',
'HostedZoneId' => '<string>',
'OwnershipVerificationCertificateArn' => '<string>',
'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
],
// ...
],
'MutualTlsAuthentication' => [
'TruststoreUri' => '<string>',
'TruststoreVersion' => '<string>',
'TruststoreWarnings' => ['<string>', ...],
],
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of DomainName structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetIntegration
$result = $client->getIntegration([/* ... */]); $promise = $client->getIntegrationAsync([/* ... */]);
Gets an Integration.
Parameter Syntax
$result = $client->getIntegration([
'ApiId' => '<string>', // REQUIRED
'IntegrationId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApiGatewayManaged' => true || false,
'ConnectionId' => '<string>',
'ConnectionType' => 'INTERNET|VPC_LINK',
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'CredentialsArn' => '<string>',
'Description' => '<string>',
'IntegrationId' => '<string>',
'IntegrationMethod' => '<string>',
'IntegrationResponseSelectionExpression' => '<string>',
'IntegrationSubtype' => '<string>',
'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
'IntegrationUri' => '<string>',
'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
'PayloadFormatVersion' => '<string>',
'RequestParameters' => ['<string>', ...],
'RequestTemplates' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => ['<string>', ...],
// ...
],
'TemplateSelectionExpression' => '<string>',
'TimeoutInMillis' => <integer>,
'TlsConfig' => [
'ServerNameToVerify' => '<string>',
],
]
Result Details
Members
- ApiGatewayManaged
-
- Type: boolean
- ConnectionId
-
- Type: string
A string with a length between [1-1024].
- ConnectionType
-
- Type: string
Represents a connection type.
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- IntegrationId
-
- Type: string
The identifier.
- IntegrationMethod
-
- Type: string
A string with a length between [1-64].
- IntegrationResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- IntegrationSubtype
-
- Type: string
A string with a length between [1-128].
- IntegrationType
-
- Type: string
Represents an API method integration type.
- IntegrationUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- PassthroughBehavior
-
- Type: string
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
- PayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- TimeoutInMillis
-
- Type: int
An integer with a value between [50-30000].
- TlsConfig
-
- Type: TlsConfig structure
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.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetIntegrationResponse
$result = $client->getIntegrationResponse([/* ... */]); $promise = $client->getIntegrationResponseAsync([/* ... */]);
Gets an IntegrationResponses.
Parameter Syntax
$result = $client->getIntegrationResponse([
'ApiId' => '<string>', // REQUIRED
'IntegrationId' => '<string>', // REQUIRED
'IntegrationResponseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'IntegrationResponseId' => '<string>',
'IntegrationResponseKey' => '<string>',
'ResponseParameters' => ['<string>', ...],
'ResponseTemplates' => ['<string>', ...],
'TemplateSelectionExpression' => '<string>',
]
Result Details
Members
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- IntegrationResponseId
-
- Type: string
The identifier.
- IntegrationResponseKey
-
- Type: string
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetIntegrationResponses
$result = $client->getIntegrationResponses([/* ... */]); $promise = $client->getIntegrationResponsesAsync([/* ... */]);
Gets the IntegrationResponses for an Integration.
Parameter Syntax
$result = $client->getIntegrationResponses([
'ApiId' => '<string>', // REQUIRED
'IntegrationId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'IntegrationResponseId' => '<string>',
'IntegrationResponseKey' => '<string>',
'ResponseParameters' => ['<string>', ...],
'ResponseTemplates' => ['<string>', ...],
'TemplateSelectionExpression' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of IntegrationResponse structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetIntegrations
$result = $client->getIntegrations([/* ... */]); $promise = $client->getIntegrationsAsync([/* ... */]);
Gets the Integrations for an API.
Parameter Syntax
$result = $client->getIntegrations([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'ApiGatewayManaged' => true || false,
'ConnectionId' => '<string>',
'ConnectionType' => 'INTERNET|VPC_LINK',
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'CredentialsArn' => '<string>',
'Description' => '<string>',
'IntegrationId' => '<string>',
'IntegrationMethod' => '<string>',
'IntegrationResponseSelectionExpression' => '<string>',
'IntegrationSubtype' => '<string>',
'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
'IntegrationUri' => '<string>',
'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
'PayloadFormatVersion' => '<string>',
'RequestParameters' => ['<string>', ...],
'RequestTemplates' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => ['<string>', ...],
// ...
],
'TemplateSelectionExpression' => '<string>',
'TimeoutInMillis' => <integer>,
'TlsConfig' => [
'ServerNameToVerify' => '<string>',
],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Integration structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetModel
$result = $client->getModel([/* ... */]); $promise = $client->getModelAsync([/* ... */]);
Gets a Model.
Parameter Syntax
$result = $client->getModel([
'ApiId' => '<string>', // REQUIRED
'ModelId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ContentType' => '<string>',
'Description' => '<string>',
'ModelId' => '<string>',
'Name' => '<string>',
'Schema' => '<string>',
]
Result Details
Members
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetModelTemplate
$result = $client->getModelTemplate([/* ... */]); $promise = $client->getModelTemplateAsync([/* ... */]);
Gets a model template.
Parameter Syntax
$result = $client->getModelTemplate([
'ApiId' => '<string>', // REQUIRED
'ModelId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Value' => '<string>',
]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetModels
$result = $client->getModels([/* ... */]); $promise = $client->getModelsAsync([/* ... */]);
Gets the Models for an API.
Parameter Syntax
$result = $client->getModels([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'ContentType' => '<string>',
'Description' => '<string>',
'ModelId' => '<string>',
'Name' => '<string>',
'Schema' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Model structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetRoute
$result = $client->getRoute([/* ... */]); $promise = $client->getRouteAsync([/* ... */]);
Gets a Route.
Parameter Syntax
$result = $client->getRoute([
'ApiId' => '<string>', // REQUIRED
'RouteId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'ApiGatewayManaged' => true || false,
'ApiKeyRequired' => true || false,
'AuthorizationScopes' => ['<string>', ...],
'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
'AuthorizerId' => '<string>',
'ModelSelectionExpression' => '<string>',
'OperationName' => '<string>',
'RequestModels' => ['<string>', ...],
'RequestParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>',
'RouteKey' => '<string>',
'RouteResponseSelectionExpression' => '<string>',
'Target' => '<string>',
]
Result Details
Members
- ApiGatewayManaged
-
- Type: boolean
- ApiKeyRequired
-
- Type: boolean
- AuthorizationScopes
-
- Type: Array of strings
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- AuthorizationType
-
- Type: string
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.
- AuthorizerId
-
- Type: string
The identifier.
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- OperationName
-
- Type: string
A string with a length between [1-64].
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteId
-
- Type: string
The identifier.
- RouteKey
-
- Type: string
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.
- RouteResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Target
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetRouteResponse
$result = $client->getRouteResponse([/* ... */]); $promise = $client->getRouteResponseAsync([/* ... */]);
Gets a RouteResponse.
Parameter Syntax
$result = $client->getRouteResponse([
'ApiId' => '<string>', // REQUIRED
'RouteId' => '<string>', // REQUIRED
'RouteResponseId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ModelSelectionExpression' => '<string>',
'ResponseModels' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteResponseId' => '<string>',
'RouteResponseKey' => '<string>',
]
Result Details
Members
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteResponseId
-
- Type: string
The identifier.
- RouteResponseKey
-
- Type: string
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.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetRouteResponses
$result = $client->getRouteResponses([/* ... */]); $promise = $client->getRouteResponsesAsync([/* ... */]);
Gets the RouteResponses for a Route.
Parameter Syntax
$result = $client->getRouteResponses([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
'RouteId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Items' => [
[
'ModelSelectionExpression' => '<string>',
'ResponseModels' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteResponseId' => '<string>',
'RouteResponseKey' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of RouteResponse structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetRoutes
$result = $client->getRoutes([/* ... */]); $promise = $client->getRoutesAsync([/* ... */]);
Gets the Routes for an API.
Parameter Syntax
$result = $client->getRoutes([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'ApiGatewayManaged' => true || false,
'ApiKeyRequired' => true || false,
'AuthorizationScopes' => ['<string>', ...],
'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
'AuthorizerId' => '<string>',
'ModelSelectionExpression' => '<string>',
'OperationName' => '<string>',
'RequestModels' => ['<string>', ...],
'RequestParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>',
'RouteKey' => '<string>',
'RouteResponseSelectionExpression' => '<string>',
'Target' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Route structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetStage
$result = $client->getStage([/* ... */]); $promise = $client->getStageAsync([/* ... */]);
Gets a Stage.
Parameter Syntax
$result = $client->getStage([
'ApiId' => '<string>', // REQUIRED
'StageName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AccessLogSettings' => [
'DestinationArn' => '<string>',
'Format' => '<string>',
],
'ApiGatewayManaged' => true || false,
'AutoDeploy' => true || false,
'ClientCertificateId' => '<string>',
'CreatedDate' => <DateTime>,
'DefaultRouteSettings' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
'DeploymentId' => '<string>',
'Description' => '<string>',
'LastDeploymentStatusMessage' => '<string>',
'LastUpdatedDate' => <DateTime>,
'RouteSettings' => [
'<__string>' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
// ...
],
'StageName' => '<string>',
'StageVariables' => ['<string>', ...],
'Tags' => ['<string>', ...],
]
Result Details
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in a stage.
- ApiGatewayManaged
-
- Type: boolean
- AutoDeploy
-
- Type: boolean
- ClientCertificateId
-
- Type: string
The identifier.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DefaultRouteSettings
-
- Type: RouteSettings structure
Represents a collection of route settings.
- DeploymentId
-
- Type: string
The identifier.
- Description
-
- Type: string
A string with a length between [0-1024].
- LastDeploymentStatusMessage
-
- Type: string
- LastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
The route settings map.
- StageName
-
- Type: string
A string with a length between [1-128].
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
The stage variable map.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetStages
$result = $client->getStages([/* ... */]); $promise = $client->getStagesAsync([/* ... */]);
Gets the Stages for an API.
Parameter Syntax
$result = $client->getStages([
'ApiId' => '<string>', // REQUIRED
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'AccessLogSettings' => [
'DestinationArn' => '<string>',
'Format' => '<string>',
],
'ApiGatewayManaged' => true || false,
'AutoDeploy' => true || false,
'ClientCertificateId' => '<string>',
'CreatedDate' => <DateTime>,
'DefaultRouteSettings' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
'DeploymentId' => '<string>',
'Description' => '<string>',
'LastDeploymentStatusMessage' => '<string>',
'LastUpdatedDate' => <DateTime>,
'RouteSettings' => [
'<__string>' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
// ...
],
'StageName' => '<string>',
'StageVariables' => ['<string>', ...],
'Tags' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of Stage structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
GetTags
$result = $client->getTags([/* ... */]); $promise = $client->getTagsAsync([/* ... */]);
Gets a collection of Tag resources.
Parameter Syntax
$result = $client->getTags([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
GetVpcLink
$result = $client->getVpcLink([/* ... */]); $promise = $client->getVpcLinkAsync([/* ... */]);
Gets a VPC link.
Parameter Syntax
$result = $client->getVpcLink([
'VpcLinkId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CreatedDate' => <DateTime>,
'Name' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'Tags' => ['<string>', ...],
'VpcLinkId' => '<string>',
'VpcLinkStatus' => 'PENDING|AVAILABLE|DELETING|FAILED|INACTIVE',
'VpcLinkStatusMessage' => '<string>',
'VpcLinkVersion' => 'V2',
]
Result Details
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
A string with a length between [1-128].
- SecurityGroupIds
-
- Type: Array of strings
A list of security group IDs for the VPC link.
- SubnetIds
-
- Type: Array of strings
A list of subnet IDs to include in the VPC link.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- VpcLinkId
-
- Type: string
The identifier.
- VpcLinkStatus
-
- Type: string
The status of the VPC link.
- VpcLinkStatusMessage
-
- Type: string
A string with a length between [0-1024].
- VpcLinkVersion
-
- Type: string
The version of the VPC link.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
GetVpcLinks
$result = $client->getVpcLinks([/* ... */]); $promise = $client->getVpcLinksAsync([/* ... */]);
Gets a collection of VPC links.
Parameter Syntax
$result = $client->getVpcLinks([
'MaxResults' => '<string>',
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Items' => [
[
'CreatedDate' => <DateTime>,
'Name' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'Tags' => ['<string>', ...],
'VpcLinkId' => '<string>',
'VpcLinkStatus' => 'PENDING|AVAILABLE|DELETING|FAILED|INACTIVE',
'VpcLinkStatusMessage' => '<string>',
'VpcLinkVersion' => 'V2',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Items
-
- Type: Array of VpcLink structures
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Errors
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
A limit has been exceeded. See the accompanying error message for details.
ImportApi
$result = $client->importApi([/* ... */]); $promise = $client->importApiAsync([/* ... */]);
Imports an API.
Parameter Syntax
$result = $client->importApi([
'Basepath' => '<string>',
'Body' => '<string>', // REQUIRED
'FailOnWarnings' => true || false,
]);
Parameter Details
Result Syntax
[
'ApiEndpoint' => '<string>',
'ApiGatewayManaged' => true || false,
'ApiId' => '<string>',
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'ImportInfo' => ['<string>', ...],
'Name' => '<string>',
'ProtocolType' => 'WEBSOCKET|HTTP',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Version' => '<string>',
'Warnings' => ['<string>', ...],
]
Result Details
Members
- ApiEndpoint
-
- Type: string
- ApiGatewayManaged
-
- Type: boolean
- ApiId
-
- Type: string
The identifier.
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- ImportInfo
-
- Type: Array of strings
- Name
-
- Type: string
A string with a length between [1-128].
- ProtocolType
-
- Type: string
Represents a protocol type. - RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- Version
-
- Type: string
A string with a length between [1-64].
- Warnings
-
- Type: Array of strings
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
ReimportApi
$result = $client->reimportApi([/* ... */]); $promise = $client->reimportApiAsync([/* ... */]);
Puts an Api resource.
Parameter Syntax
$result = $client->reimportApi([
'ApiId' => '<string>', // REQUIRED
'Basepath' => '<string>',
'Body' => '<string>', // REQUIRED
'FailOnWarnings' => true || false,
]);
Parameter Details
Members
Result Syntax
[
'ApiEndpoint' => '<string>',
'ApiGatewayManaged' => true || false,
'ApiId' => '<string>',
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'ImportInfo' => ['<string>', ...],
'Name' => '<string>',
'ProtocolType' => 'WEBSOCKET|HTTP',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Version' => '<string>',
'Warnings' => ['<string>', ...],
]
Result Details
Members
- ApiEndpoint
-
- Type: string
- ApiGatewayManaged
-
- Type: boolean
- ApiId
-
- Type: string
The identifier.
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- ImportInfo
-
- Type: Array of strings
- Name
-
- Type: string
A string with a length between [1-128].
- ProtocolType
-
- Type: string
Represents a protocol type. - RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- Version
-
- Type: string
A string with a length between [1-64].
- Warnings
-
- Type: Array of strings
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
ResetAuthorizersCache
$result = $client->resetAuthorizersCache([/* ... */]); $promise = $client->resetAuthorizersCacheAsync([/* ... */]);
Resets all authorizer cache entries for the specified stage. Supported only for HTTP API Lambda authorizers.
Parameter Syntax
$result = $client->resetAuthorizersCache([
'ApiId' => '<string>', // REQUIRED
'StageName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Creates a new Tag resource to represent a tag.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Deletes a Tag.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateApi
$result = $client->updateApi([/* ... */]); $promise = $client->updateApiAsync([/* ... */]);
Updates an Api resource.
Parameter Syntax
$result = $client->updateApi([
'ApiId' => '<string>', // REQUIRED
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CredentialsArn' => '<string>',
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'Name' => '<string>',
'RouteKey' => '<string>',
'RouteSelectionExpression' => '<string>',
'Target' => '<string>',
'Version' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- Name
-
- Type: string
A string with a length between [1-128].
- RouteKey
-
- Type: string
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.
- RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Target
-
- Type: string
A string representation of a URI with a length between [1-2048].
- Version
-
- Type: string
A string with a length between [1-64].
Result Syntax
[
'ApiEndpoint' => '<string>',
'ApiGatewayManaged' => true || false,
'ApiId' => '<string>',
'ApiKeySelectionExpression' => '<string>',
'CorsConfiguration' => [
'AllowCredentials' => true || false,
'AllowHeaders' => ['<string>', ...],
'AllowMethods' => ['<string>', ...],
'AllowOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'MaxAge' => <integer>,
],
'CreatedDate' => <DateTime>,
'Description' => '<string>',
'DisableExecuteApiEndpoint' => true || false,
'DisableSchemaValidation' => true || false,
'ImportInfo' => ['<string>', ...],
'Name' => '<string>',
'ProtocolType' => 'WEBSOCKET|HTTP',
'RouteSelectionExpression' => '<string>',
'Tags' => ['<string>', ...],
'Version' => '<string>',
'Warnings' => ['<string>', ...],
]
Result Details
Members
- ApiEndpoint
-
- Type: string
- ApiGatewayManaged
-
- Type: boolean
- ApiId
-
- Type: string
The identifier.
- ApiKeySelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- CorsConfiguration
-
- Type: Cors structure
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Description
-
- Type: string
A string with a length between [0-1024].
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
- ImportInfo
-
- Type: Array of strings
- Name
-
- Type: string
A string with a length between [1-128].
- ProtocolType
-
- Type: string
Represents a protocol type. - RouteSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- Version
-
- Type: string
A string with a length between [1-64].
- Warnings
-
- Type: Array of strings
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateApiMapping
$result = $client->updateApiMapping([/* ... */]); $promise = $client->updateApiMappingAsync([/* ... */]);
The API mapping.
Parameter Syntax
$result = $client->updateApiMapping([
'ApiId' => '<string>', // REQUIRED
'ApiMappingId' => '<string>', // REQUIRED
'ApiMappingKey' => '<string>',
'DomainName' => '<string>', // REQUIRED
'Stage' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
The identifier.
- ApiMappingId
-
- Required: Yes
- Type: string
- ApiMappingKey
-
- Type: string
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.
- DomainName
-
- Required: Yes
- Type: string
- Stage
-
- Type: string
A string with a length between [1-128].
Result Syntax
[
'ApiId' => '<string>',
'ApiMappingId' => '<string>',
'ApiMappingKey' => '<string>',
'Stage' => '<string>',
]
Result Details
Members
- ApiId
-
- Type: string
The identifier.
- ApiMappingId
-
- Type: string
The identifier.
- ApiMappingKey
-
- Type: string
After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.
- Stage
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateAuthorizer
$result = $client->updateAuthorizer([/* ... */]); $promise = $client->updateAuthorizerAsync([/* ... */]);
Updates an Authorizer.
Parameter Syntax
$result = $client->updateAuthorizer([
'ApiId' => '<string>', // REQUIRED
'AuthorizerCredentialsArn' => '<string>',
'AuthorizerId' => '<string>', // REQUIRED
'AuthorizerPayloadFormatVersion' => '<string>',
'AuthorizerResultTtlInSeconds' => <integer>,
'AuthorizerType' => 'REQUEST|JWT',
'AuthorizerUri' => '<string>',
'EnableSimpleResponses' => true || false,
'IdentitySource' => ['<string>', ...],
'IdentityValidationExpression' => '<string>',
'JwtConfiguration' => [
'Audience' => ['<string>', ...],
'Issuer' => '<string>',
],
'Name' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- AuthorizerCredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- AuthorizerId
-
- Required: Yes
- Type: string
- AuthorizerPayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- AuthorizerResultTtlInSeconds
-
- Type: int
An integer with a value between [0-3600].
- AuthorizerType
-
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- EnableSimpleResponses
-
- Type: boolean
- IdentitySource
-
- Type: Array of strings
The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- IdentityValidationExpression
-
- Type: string
A string with a length between [0-1024].
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Type: string
A string with a length between [1-128].
Result Syntax
[
'AuthorizerCredentialsArn' => '<string>',
'AuthorizerId' => '<string>',
'AuthorizerPayloadFormatVersion' => '<string>',
'AuthorizerResultTtlInSeconds' => <integer>,
'AuthorizerType' => 'REQUEST|JWT',
'AuthorizerUri' => '<string>',
'EnableSimpleResponses' => true || false,
'IdentitySource' => ['<string>', ...],
'IdentityValidationExpression' => '<string>',
'JwtConfiguration' => [
'Audience' => ['<string>', ...],
'Issuer' => '<string>',
],
'Name' => '<string>',
]
Result Details
Members
- AuthorizerCredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- AuthorizerId
-
- Type: string
The identifier.
- AuthorizerPayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- AuthorizerResultTtlInSeconds
-
- Type: int
An integer with a value between [0-3600].
- AuthorizerType
-
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- EnableSimpleResponses
-
- Type: boolean
- IdentitySource
-
- Type: Array of strings
The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- IdentityValidationExpression
-
- Type: string
A string with a length between [0-1024].
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateDeployment
$result = $client->updateDeployment([/* ... */]); $promise = $client->updateDeploymentAsync([/* ... */]);
Updates a Deployment.
Parameter Syntax
$result = $client->updateDeployment([
'ApiId' => '<string>', // REQUIRED
'DeploymentId' => '<string>', // REQUIRED
'Description' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AutoDeployed' => true || false,
'CreatedDate' => <DateTime>,
'DeploymentId' => '<string>',
'DeploymentStatus' => 'PENDING|FAILED|DEPLOYED',
'DeploymentStatusMessage' => '<string>',
'Description' => '<string>',
]
Result Details
Members
- AutoDeployed
-
- Type: boolean
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DeploymentId
-
- Type: string
The identifier.
- DeploymentStatus
-
- Type: string
Represents a deployment status.
- DeploymentStatusMessage
-
- Type: string
- Description
-
- Type: string
A string with a length between [0-1024].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateDomainName
$result = $client->updateDomainName([/* ... */]); $promise = $client->updateDomainNameAsync([/* ... */]);
Updates a domain name.
Parameter Syntax
$result = $client->updateDomainName([
'DomainName' => '<string>', // REQUIRED
'DomainNameConfigurations' => [
[
'ApiGatewayDomainName' => '<string>',
'CertificateArn' => '<string>',
'CertificateName' => '<string>',
'CertificateUploadDate' => <integer || string || DateTime>,
'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
'DomainNameStatusMessage' => '<string>',
'EndpointType' => 'REGIONAL|EDGE',
'HostedZoneId' => '<string>',
'OwnershipVerificationCertificateArn' => '<string>',
'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
],
// ...
],
'MutualTlsAuthentication' => [
'TruststoreUri' => '<string>',
'TruststoreVersion' => '<string>',
],
]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthenticationInput structure
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
Result Syntax
[
'ApiMappingSelectionExpression' => '<string>',
'DomainName' => '<string>',
'DomainNameConfigurations' => [
[
'ApiGatewayDomainName' => '<string>',
'CertificateArn' => '<string>',
'CertificateName' => '<string>',
'CertificateUploadDate' => <DateTime>,
'DomainNameStatus' => 'AVAILABLE|UPDATING|PENDING_CERTIFICATE_REIMPORT|PENDING_OWNERSHIP_VERIFICATION',
'DomainNameStatusMessage' => '<string>',
'EndpointType' => 'REGIONAL|EDGE',
'HostedZoneId' => '<string>',
'OwnershipVerificationCertificateArn' => '<string>',
'SecurityPolicy' => 'TLS_1_0|TLS_1_2',
],
// ...
],
'MutualTlsAuthentication' => [
'TruststoreUri' => '<string>',
'TruststoreVersion' => '<string>',
'TruststoreWarnings' => ['<string>', ...],
],
'Tags' => ['<string>', ...],
]
Result Details
Members
- ApiMappingSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- DomainName
-
- Type: string
A string with a length between [1-512].
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateIntegration
$result = $client->updateIntegration([/* ... */]); $promise = $client->updateIntegrationAsync([/* ... */]);
Updates an Integration.
Parameter Syntax
$result = $client->updateIntegration([
'ApiId' => '<string>', // REQUIRED
'ConnectionId' => '<string>',
'ConnectionType' => 'INTERNET|VPC_LINK',
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'CredentialsArn' => '<string>',
'Description' => '<string>',
'IntegrationId' => '<string>', // REQUIRED
'IntegrationMethod' => '<string>',
'IntegrationSubtype' => '<string>',
'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
'IntegrationUri' => '<string>',
'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
'PayloadFormatVersion' => '<string>',
'RequestParameters' => ['<string>', ...],
'RequestTemplates' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => ['<string>', ...],
// ...
],
'TemplateSelectionExpression' => '<string>',
'TimeoutInMillis' => <integer>,
'TlsConfig' => [
'ServerNameToVerify' => '<string>',
],
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ConnectionId
-
- Type: string
A string with a length between [1-1024].
- ConnectionType
-
- Type: string
Represents a connection type.
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- IntegrationId
-
- Required: Yes
- Type: string
- IntegrationMethod
-
- Type: string
A string with a length between [1-64].
- IntegrationSubtype
-
- Type: string
A string with a length between [1-128].
- IntegrationType
-
- Type: string
Represents an API method integration type.
- IntegrationUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- PassthroughBehavior
-
- Type: string
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
- PayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- TimeoutInMillis
-
- Type: int
An integer with a value between [50-30000].
- TlsConfig
-
- Type: TlsConfigInput structure
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.
Result Syntax
[
'ApiGatewayManaged' => true || false,
'ConnectionId' => '<string>',
'ConnectionType' => 'INTERNET|VPC_LINK',
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'CredentialsArn' => '<string>',
'Description' => '<string>',
'IntegrationId' => '<string>',
'IntegrationMethod' => '<string>',
'IntegrationResponseSelectionExpression' => '<string>',
'IntegrationSubtype' => '<string>',
'IntegrationType' => 'AWS|HTTP|MOCK|HTTP_PROXY|AWS_PROXY',
'IntegrationUri' => '<string>',
'PassthroughBehavior' => 'WHEN_NO_MATCH|NEVER|WHEN_NO_TEMPLATES',
'PayloadFormatVersion' => '<string>',
'RequestParameters' => ['<string>', ...],
'RequestTemplates' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => ['<string>', ...],
// ...
],
'TemplateSelectionExpression' => '<string>',
'TimeoutInMillis' => <integer>,
'TlsConfig' => [
'ServerNameToVerify' => '<string>',
],
]
Result Details
Members
- ApiGatewayManaged
-
- Type: boolean
- ConnectionId
-
- Type: string
A string with a length between [1-1024].
- ConnectionType
-
- Type: string
Represents a connection type.
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- CredentialsArn
-
- Type: string
Represents an Amazon Resource Name (ARN).
- Description
-
- Type: string
A string with a length between [0-1024].
- IntegrationId
-
- Type: string
The identifier.
- IntegrationMethod
-
- Type: string
A string with a length between [1-64].
- IntegrationResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- IntegrationSubtype
-
- Type: string
A string with a length between [1-128].
- IntegrationType
-
- Type: string
Represents an API method integration type.
- IntegrationUri
-
- Type: string
A string representation of a URI with a length between [1-2048].
- PassthroughBehavior
-
- Type: string
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
- PayloadFormatVersion
-
- Type: string
A string with a length between [1-64].
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- TimeoutInMillis
-
- Type: int
An integer with a value between [50-30000].
- TlsConfig
-
- Type: TlsConfig structure
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.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateIntegrationResponse
$result = $client->updateIntegrationResponse([/* ... */]); $promise = $client->updateIntegrationResponseAsync([/* ... */]);
Updates an IntegrationResponses.
Parameter Syntax
$result = $client->updateIntegrationResponse([
'ApiId' => '<string>', // REQUIRED
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'IntegrationId' => '<string>', // REQUIRED
'IntegrationResponseId' => '<string>', // REQUIRED
'IntegrationResponseKey' => '<string>',
'ResponseParameters' => ['<string>', ...],
'ResponseTemplates' => ['<string>', ...],
'TemplateSelectionExpression' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- IntegrationId
-
- Required: Yes
- Type: string
- IntegrationResponseId
-
- Required: Yes
- Type: string
- IntegrationResponseKey
-
- Type: string
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
Result Syntax
[
'ContentHandlingStrategy' => 'CONVERT_TO_BINARY|CONVERT_TO_TEXT',
'IntegrationResponseId' => '<string>',
'IntegrationResponseKey' => '<string>',
'ResponseParameters' => ['<string>', ...],
'ResponseTemplates' => ['<string>', ...],
'TemplateSelectionExpression' => '<string>',
]
Result Details
Members
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
- IntegrationResponseId
-
- Type: string
The identifier.
- IntegrationResponseKey
-
- Type: string
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.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
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.
- TemplateSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateModel
$result = $client->updateModel([/* ... */]); $promise = $client->updateModelAsync([/* ... */]);
Updates a Model.
Parameter Syntax
$result = $client->updateModel([
'ApiId' => '<string>', // REQUIRED
'ContentType' => '<string>',
'Description' => '<string>',
'ModelId' => '<string>', // REQUIRED
'Name' => '<string>',
'Schema' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ContentType
-
- Type: string
A string with a length between [1-256].
- Description
-
- Type: string
A string with a length between [0-1024].
- ModelId
-
- Required: Yes
- Type: string
- Name
-
- Type: string
A string with a length between [1-128].
- Schema
-
- Type: string
A string with a length between [0-32768].
Result Syntax
[
'ContentType' => '<string>',
'Description' => '<string>',
'ModelId' => '<string>',
'Name' => '<string>',
'Schema' => '<string>',
]
Result Details
Members
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateRoute
$result = $client->updateRoute([/* ... */]); $promise = $client->updateRouteAsync([/* ... */]);
Updates a Route.
Parameter Syntax
$result = $client->updateRoute([
'ApiId' => '<string>', // REQUIRED
'ApiKeyRequired' => true || false,
'AuthorizationScopes' => ['<string>', ...],
'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
'AuthorizerId' => '<string>',
'ModelSelectionExpression' => '<string>',
'OperationName' => '<string>',
'RequestModels' => ['<string>', ...],
'RequestParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>', // REQUIRED
'RouteKey' => '<string>',
'RouteResponseSelectionExpression' => '<string>',
'Target' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ApiKeyRequired
-
- Type: boolean
- AuthorizationScopes
-
- Type: Array of strings
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- AuthorizationType
-
- Type: string
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.
- AuthorizerId
-
- Type: string
The identifier.
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- OperationName
-
- Type: string
A string with a length between [1-64].
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteId
-
- Required: Yes
- Type: string
- RouteKey
-
- Type: string
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.
- RouteResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Target
-
- Type: string
A string with a length between [1-128].
Result Syntax
[
'ApiGatewayManaged' => true || false,
'ApiKeyRequired' => true || false,
'AuthorizationScopes' => ['<string>', ...],
'AuthorizationType' => 'NONE|AWS_IAM|CUSTOM|JWT',
'AuthorizerId' => '<string>',
'ModelSelectionExpression' => '<string>',
'OperationName' => '<string>',
'RequestModels' => ['<string>', ...],
'RequestParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>',
'RouteKey' => '<string>',
'RouteResponseSelectionExpression' => '<string>',
'Target' => '<string>',
]
Result Details
Members
- ApiGatewayManaged
-
- Type: boolean
- ApiKeyRequired
-
- Type: boolean
- AuthorizationScopes
-
- Type: Array of strings
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- AuthorizationType
-
- Type: string
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.
- AuthorizerId
-
- Type: string
The identifier.
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- OperationName
-
- Type: string
A string with a length between [1-64].
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteId
-
- Type: string
The identifier.
- RouteKey
-
- Type: string
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.
- RouteResponseSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- Target
-
- Type: string
A string with a length between [1-128].
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateRouteResponse
$result = $client->updateRouteResponse([/* ... */]); $promise = $client->updateRouteResponseAsync([/* ... */]);
Updates a RouteResponse.
Parameter Syntax
$result = $client->updateRouteResponse([
'ApiId' => '<string>', // REQUIRED
'ModelSelectionExpression' => '<string>',
'ResponseModels' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteId' => '<string>', // REQUIRED
'RouteResponseId' => '<string>', // REQUIRED
'RouteResponseKey' => '<string>',
]);
Parameter Details
Members
- ApiId
-
- Required: Yes
- Type: string
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteId
-
- Required: Yes
- Type: string
- RouteResponseId
-
- Required: Yes
- Type: string
- RouteResponseKey
-
- Type: string
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.
Result Syntax
[
'ModelSelectionExpression' => '<string>',
'ResponseModels' => ['<string>', ...],
'ResponseParameters' => [
'<__string>' => [
'Required' => true || false,
],
// ...
],
'RouteResponseId' => '<string>',
'RouteResponseKey' => '<string>',
]
Result Details
Members
- ModelSelectionExpression
-
- Type: string
An expression used to extract information at runtime. See Selection Expressions for more information.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The route models.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route parameters.
- RouteResponseId
-
- Type: string
The identifier.
- RouteResponseKey
-
- Type: string
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.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateStage
$result = $client->updateStage([/* ... */]); $promise = $client->updateStageAsync([/* ... */]);
Updates a Stage.
Parameter Syntax
$result = $client->updateStage([
'AccessLogSettings' => [
'DestinationArn' => '<string>',
'Format' => '<string>',
],
'ApiId' => '<string>', // REQUIRED
'AutoDeploy' => true || false,
'ClientCertificateId' => '<string>',
'DefaultRouteSettings' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
'DeploymentId' => '<string>',
'Description' => '<string>',
'RouteSettings' => [
'<__string>' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
// ...
],
'StageName' => '<string>', // REQUIRED
'StageVariables' => ['<string>', ...],
]);
Parameter Details
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in a stage.
- ApiId
-
- Required: Yes
- Type: string
- AutoDeploy
-
- Type: boolean
- ClientCertificateId
-
- Type: string
The identifier.
- DefaultRouteSettings
-
- Type: RouteSettings structure
Represents a collection of route settings.
- DeploymentId
-
- Type: string
The identifier.
- Description
-
- Type: string
A string with a length between [0-1024].
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
The route settings map.
- StageName
-
- Required: Yes
- Type: string
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
The stage variable map.
Result Syntax
[
'AccessLogSettings' => [
'DestinationArn' => '<string>',
'Format' => '<string>',
],
'ApiGatewayManaged' => true || false,
'AutoDeploy' => true || false,
'ClientCertificateId' => '<string>',
'CreatedDate' => <DateTime>,
'DefaultRouteSettings' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
'DeploymentId' => '<string>',
'Description' => '<string>',
'LastDeploymentStatusMessage' => '<string>',
'LastUpdatedDate' => <DateTime>,
'RouteSettings' => [
'<__string>' => [
'DataTraceEnabled' => true || false,
'DetailedMetricsEnabled' => true || false,
'LoggingLevel' => 'ERROR|INFO|OFF',
'ThrottlingBurstLimit' => <integer>,
'ThrottlingRateLimit' => <float>,
],
// ...
],
'StageName' => '<string>',
'StageVariables' => ['<string>', ...],
'Tags' => ['<string>', ...],
]
Result Details
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in a stage.
- ApiGatewayManaged
-
- Type: boolean
- AutoDeploy
-
- Type: boolean
- ClientCertificateId
-
- Type: string
The identifier.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- DefaultRouteSettings
-
- Type: RouteSettings structure
Represents a collection of route settings.
- DeploymentId
-
- Type: string
The identifier.
- Description
-
- Type: string
A string with a length between [0-1024].
- LastDeploymentStatusMessage
-
- Type: string
- LastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
The route settings map.
- StageName
-
- Type: string
A string with a length between [1-128].
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
The stage variable map.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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.
UpdateVpcLink
$result = $client->updateVpcLink([/* ... */]); $promise = $client->updateVpcLinkAsync([/* ... */]);
Updates a VPC link.
Parameter Syntax
$result = $client->updateVpcLink([
'Name' => '<string>',
'VpcLinkId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CreatedDate' => <DateTime>,
'Name' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'Tags' => ['<string>', ...],
'VpcLinkId' => '<string>',
'VpcLinkStatus' => 'PENDING|AVAILABLE|DELETING|FAILED|INACTIVE',
'VpcLinkStatusMessage' => '<string>',
'VpcLinkVersion' => 'V2',
]
Result Details
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- Name
-
- Type: string
A string with a length between [1-128].
- SecurityGroupIds
-
- Type: Array of strings
A list of security group IDs for the VPC link.
- SubnetIds
-
- Type: Array of strings
A list of subnet IDs to include in the VPC link.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a collection of tags associated with the resource.
- VpcLinkId
-
- Type: string
The identifier.
- VpcLinkStatus
-
- Type: string
The status of the VPC link.
- VpcLinkStatusMessage
-
- Type: string
A string with a length between [0-1024].
- VpcLinkVersion
-
- Type: string
The version of the VPC link.
Errors
-
The resource specified in the request was not found. See the message field for more information.
-
A limit has been exceeded. See the accompanying error message for details.
-
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
Shapes
AccessDeniedException
AccessLogSettings
Description
Settings for logging access in a stage.
Members
Api
Description
Represents an API.
Members
- ApiEndpoint
-
- Type: string
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
- ApiGatewayManaged
-
- Type: boolean
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
- ApiId
-
- Type: string
The API ID.
- ApiKeySelectionExpression
-
- Type: string
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- CorsConfiguration
-
- Type: Cors structure
A CORS configuration. Supported only for HTTP APIs.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the API was created.
- Description
-
- Type: string
The description of the API.
- DisableExecuteApiEndpoint
-
- Type: boolean
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.
- DisableSchemaValidation
-
- Type: boolean
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- ImportInfo
-
- Type: Array of strings
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
- Name
-
- Required: Yes
- Type: string
The name of the API.
- ProtocolType
-
- Required: Yes
- Type: string
The API protocol.
- RouteSelectionExpression
-
- Required: Yes
- Type: string
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A collection of tags associated with the API.
- Version
-
- Type: string
A version identifier for the API.
- Warnings
-
- Type: Array of strings
The warning messages reported when failonwarnings is turned on during API import.
ApiMapping
Description
Represents an API mapping.
Members
ApiMappings
Description
Represents a collection of ApiMappings resources.
Members
- Items
-
- Type: Array of ApiMapping structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Apis
Description
Represents a collection of APIs.
Members
- Items
-
- Type: Array of Api structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Authorizer
Description
Represents an authorizer.
Members
- AuthorizerCredentialsArn
-
- Type: string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
- AuthorizerId
-
- Type: string
The authorizer identifier.
- AuthorizerPayloadFormatVersion
-
- Type: string
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
- AuthorizerResultTtlInSeconds
-
- Type: int
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
- AuthorizerType
-
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
{account_id} :function:{lambda_function_name} /invocations. In general, the URI has this form: arn:aws:apigateway:{region} :lambda:path/{service_api} , where{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. - EnableSimpleResponses
-
- Type: boolean
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
- IdentitySource
-
- Type: Array of strings
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
- IdentityValidationExpression
-
- Type: string
The validation expression does not apply to the REQUEST authorizer.
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Required: Yes
- Type: string
The name of the authorizer.
Authorizers
Description
Represents a collection of authorizers.
Members
- Items
-
- Type: Array of Authorizer structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
BadRequestException
Description
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
Members
ConflictException
Description
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.
Members
Cors
Description
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
Members
- AllowCredentials
-
- Type: boolean
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
- AllowHeaders
-
- Type: Array of strings
Represents a collection of allowed headers. Supported only for HTTP APIs.
- AllowMethods
-
- Type: Array of strings
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
- AllowOrigins
-
- Type: Array of strings
Represents a collection of allowed origins. Supported only for HTTP APIs.
- ExposeHeaders
-
- Type: Array of strings
Represents a collection of exposed headers. Supported only for HTTP APIs.
- MaxAge
-
- Type: int
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CreateApiInput
Description
Represents the input parameters for a CreateApi request.
Members
- ApiKeySelectionExpression
-
- Type: string
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- CorsConfiguration
-
- Type: Cors structure
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- CredentialsArn
-
- Type: string
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
- Description
-
- Type: string
The description of the API.
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- Name
-
- Required: Yes
- Type: string
The name of the API.
- ProtocolType
-
- Required: Yes
- Type: string
The API protocol.
- RouteKey
-
- Type: string
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
- RouteSelectionExpression
-
- Type: string
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of tags. Each tag element is associated with a given resource.
- Target
-
- Type: string
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
- Version
-
- Type: string
A version identifier for the API.
CreateApiMappingInput
Description
Represents the input parameters for a CreateApiMapping request.
Members
CreateAuthorizerInput
Description
Represents the input parameters for a CreateAuthorizer request.
Members
- AuthorizerCredentialsArn
-
- Type: string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
- AuthorizerPayloadFormatVersion
-
- Type: string
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
- AuthorizerResultTtlInSeconds
-
- Type: int
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
- AuthorizerType
-
- Required: Yes
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
{account_id} :function:{lambda_function_name} /invocations. In general, the URI has this form: arn:aws:apigateway:{region} :lambda:path/{service_api} , where{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. - EnableSimpleResponses
-
- Type: boolean
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
- IdentitySource
-
- Required: Yes
- Type: Array of strings
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
- IdentityValidationExpression
-
- Type: string
This parameter is not used.
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Required: Yes
- Type: string
The name of the authorizer.
CreateDeploymentInput
Description
Represents the input parameters for a CreateDeployment request.
Members
CreateDomainNameInput
Description
Represents the input parameters for a CreateDomainName request.
Members
- DomainName
-
- Required: Yes
- Type: string
The domain name.
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthenticationInput structure
The mutual TLS authentication configuration for a custom domain name.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of tags associated with a domain name.
CreateIntegrationInput
Description
Represents the input parameters for a CreateIntegration request.
Members
- ConnectionId
-
- Type: string
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
- ConnectionType
-
- Type: string
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
-
- Type: string
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- CredentialsArn
-
- Type: string
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
- Description
-
- Type: string
The description of the integration.
- IntegrationMethod
-
- Type: string
Specifies the integration's HTTP method type.
- IntegrationSubtype
-
- Type: string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
- IntegrationType
-
- Required: Yes
- Type: string
The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
- IntegrationUri
-
- Type: string
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
- PassthroughBehavior
-
- Type: string
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
- PayloadFormatVersion
-
- Type: string
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
- TemplateSelectionExpression
-
- Type: string
The template selection expression for the integration.
- TimeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
- TlsConfig
-
- Type: TlsConfigInput structure
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.
CreateIntegrationResponseInput
Description
Represents the input parameters for a CreateIntegrationResponse request.
Members
- ContentHandlingStrategy
-
- Type: string
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- IntegrationResponseKey
-
- Required: Yes
- Type: string
The integration response key.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
- TemplateSelectionExpression
-
- Type: string
The template selection expression for the integration response. Supported only for WebSocket APIs.
CreateModelInput
Description
Represents the input parameters for a CreateModel request.
Members
- ContentType
-
- Type: string
The content-type for the model, for example, "application/json".
- Description
-
- Type: string
The description of the model.
- Name
-
- Required: Yes
- Type: string
The name of the model. Must be alphanumeric.
- Schema
-
- Required: Yes
- Type: string
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
CreateRouteInput
Description
Represents the input parameters for a CreateRoute request.
Members
- ApiKeyRequired
-
- Type: boolean
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
- AuthorizationScopes
-
- Type: Array of strings
The authorization scopes supported by this route.
- AuthorizationType
-
- Type: string
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
- AuthorizerId
-
- Type: string
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
- ModelSelectionExpression
-
- Type: string
The model selection expression for the route. Supported only for WebSocket APIs.
- OperationName
-
- Type: string
The operation name for the route.
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The request models for the route. Supported only for WebSocket APIs.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The request parameters for the route. Supported only for WebSocket APIs.
- RouteKey
-
- Required: Yes
- Type: string
The route key for the route.
- RouteResponseSelectionExpression
-
- Type: string
The route response selection expression for the route. Supported only for WebSocket APIs.
- Target
-
- Type: string
The target for the route.
CreateRouteResponseInput
Description
Represents the input parameters for an CreateRouteResponse request.
Members
- ModelSelectionExpression
-
- Type: string
The model selection expression for the route response. Supported only for WebSocket APIs.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The response models for the route response.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route response parameters.
- RouteResponseKey
-
- Required: Yes
- Type: string
The route response key.
CreateStageInput
Description
Represents the input parameters for a CreateStage request.
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in this stage.
- AutoDeploy
-
- Type: boolean
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
- ClientCertificateId
-
- Type: string
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
- DefaultRouteSettings
-
- Type: RouteSettings structure
The default route settings for the stage.
- DeploymentId
-
- Type: string
The deployment identifier of the API stage.
- Description
-
- Type: string
The description for the API stage.
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
Route settings for the stage, by routeKey.
- StageName
-
- Required: Yes
- Type: string
The name of the stage.
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of tags. Each tag element is associated with a given resource.
CreateVpcLinkInput
Description
Represents the input parameters for a CreateVpcLink request.
Members
- Name
-
- Required: Yes
- Type: string
The name of the VPC link.
- SecurityGroupIds
-
- Type: Array of strings
A list of security group IDs for the VPC link.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
A list of subnet IDs to include in the VPC link.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
A list of tags.
Deployment
Description
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
Members
- AutoDeployed
-
- Type: boolean
Specifies whether a deployment was automatically released.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the Deployment resource was created.
- DeploymentId
-
- Type: string
The identifier for the deployment.
- DeploymentStatus
-
- Type: string
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
- DeploymentStatusMessage
-
- Type: string
May contain additional feedback on the status of an API deployment.
- Description
-
- Type: string
The description for the deployment.
Deployments
Description
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.
Members
- Items
-
- Type: Array of Deployment structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
DomainName
Description
Represents a domain name.
Members
- ApiMappingSelectionExpression
-
- Type: string
The API mapping selection expression.
- DomainName
-
- Required: Yes
- Type: string
The name of the DomainName resource.
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthentication structure
The mutual TLS authentication configuration for a custom domain name.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of tags associated with a domain name.
DomainNameConfiguration
Description
The domain name configuration.
Members
- ApiGatewayDomainName
-
- Type: string
A domain name for the API.
- CertificateArn
-
- Type: string
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
- CertificateName
-
- Type: string
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
- CertificateUploadDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
- DomainNameStatus
-
- Type: string
The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
- DomainNameStatusMessage
-
- Type: string
An optional text message containing detailed information about status of the domain name migration.
- EndpointType
-
- Type: string
The endpoint type.
- HostedZoneId
-
- Type: string
The Amazon Route 53 Hosted Zone ID of the endpoint.
- OwnershipVerificationCertificateArn
-
- Type: string
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
- SecurityPolicy
-
- Type: string
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.
DomainNames
Description
Represents a collection of domain names.
Members
- Items
-
- Type: Array of DomainName structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
ImportApiInput
Description
Represents the input to ImportAPI. Supported only for HTTP APIs.
Members
Integration
Description
Represents an integration.
Members
- ApiGatewayManaged
-
- Type: boolean
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
- ConnectionId
-
- Type: string
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
- ConnectionType
-
- Type: string
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
-
- Type: string
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- CredentialsArn
-
- Type: string
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
- Description
-
- Type: string
Represents the description of an integration.
- IntegrationId
-
- Type: string
Represents the identifier of an integration.
- IntegrationMethod
-
- Type: string
Specifies the integration's HTTP method type.
- IntegrationResponseSelectionExpression
-
- Type: string
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
- IntegrationSubtype
-
- Type: string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
- IntegrationType
-
- Type: string
The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
- IntegrationUri
-
- Type: string
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
- PassthroughBehavior
-
- Type: string
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
- PayloadFormatVersion
-
- Type: string
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
- TemplateSelectionExpression
-
- Type: string
The template selection expression for the integration. Supported only for WebSocket APIs.
- TimeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
- TlsConfig
-
- Type: TlsConfig structure
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.
IntegrationResponse
Description
Represents an integration response.
Members
- ContentHandlingStrategy
-
- Type: string
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- IntegrationResponseId
-
- Type: string
The integration response ID.
- IntegrationResponseKey
-
- Required: Yes
- Type: string
The integration response key.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
- ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
- TemplateSelectionExpression
-
- Type: string
The template selection expressions for the integration response.
IntegrationResponses
Description
Represents a collection of integration responses.
Members
- Items
-
- Type: Array of IntegrationResponse structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Integrations
Description
Represents a collection of integrations.
Members
- Items
-
- Type: Array of Integration structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
JWTConfiguration
Description
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
Members
- Audience
-
- Type: Array of strings
A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.
- Issuer
-
- Type: string
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.
{region} .amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.
LimitExceededException
Description
A limit has been exceeded. See the accompanying error message for details.
Members
Model
Description
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
Members
- ContentType
-
- Type: string
The content-type for the model, for example, "application/json".
- Description
-
- Type: string
The description of the model.
- ModelId
-
- Type: string
The model identifier.
- Name
-
- Required: Yes
- Type: string
The name of the model. Must be alphanumeric.
- Schema
-
- Type: string
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Models
Description
Represents a collection of data models. See Create Models and Mapping Templates for Request and Response Mappings.
Members
- Items
-
- Type: Array of Model structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
MutualTlsAuthentication
Description
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
Members
- TruststoreUri
-
- Type: string
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://
bucket-name /key-name . 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. - TruststoreVersion
-
- Type: string
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
- TruststoreWarnings
-
- Type: Array of strings
A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
MutualTlsAuthenticationInput
Description
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
Members
- TruststoreUri
-
- Type: string
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://
bucket-name /key-name . 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. - TruststoreVersion
-
- Type: string
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
NotFoundException
Description
The resource specified in the request was not found. See the message field for more information.
Members
ParameterConstraints
Description
Validation constraints imposed on parameters of a request (path, query string, headers).
Members
ReimportApiInput
Description
Overwrites the configuration of an existing API using the provided definition. Supported only for HTTP APIs.
Members
Route
Description
Represents a route.
Members
- ApiGatewayManaged
-
- Type: boolean
Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
- ApiKeyRequired
-
- Type: boolean
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
- AuthorizationScopes
-
- Type: Array of strings
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- AuthorizationType
-
- Type: string
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
- AuthorizerId
-
- Type: string
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
- ModelSelectionExpression
-
- Type: string
The model selection expression for the route. Supported only for WebSocket APIs.
- OperationName
-
- Type: string
The operation name for the route.
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The request models for the route. Supported only for WebSocket APIs.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The request parameters for the route. Supported only for WebSocket APIs.
- RouteId
-
- Type: string
The route ID.
- RouteKey
-
- Required: Yes
- Type: string
The route key for the route.
- RouteResponseSelectionExpression
-
- Type: string
The route response selection expression for the route. Supported only for WebSocket APIs.
- Target
-
- Type: string
The target for the route.
RouteResponse
Description
Represents a route response.
Members
- ModelSelectionExpression
-
- Type: string
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
Represents the response models of a route response.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
Represents the response parameters of a route response.
- RouteResponseId
-
- Type: string
Represents the identifier of a route response.
- RouteResponseKey
-
- Required: Yes
- Type: string
Represents the route response key of a route response.
RouteResponses
Description
Represents a collection of route responses.
Members
- Items
-
- Type: Array of RouteResponse structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
RouteSettings
Description
Represents a collection of route settings.
Members
- DataTraceEnabled
-
- Type: boolean
Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- DetailedMetricsEnabled
-
- Type: boolean
Specifies whether detailed metrics are enabled.
- LoggingLevel
-
- Type: string
Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
- ThrottlingBurstLimit
-
- Type: int
Specifies the throttling burst limit.
- ThrottlingRateLimit
-
- Type: double
Specifies the throttling rate limit.
Routes
Description
Represents a collection of routes.
Members
- Items
-
- Type: Array of Route structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
Stage
Description
Represents an API stage.
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in this stage.
- ApiGatewayManaged
-
- Type: boolean
Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
- AutoDeploy
-
- Type: boolean
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
- ClientCertificateId
-
- Type: string
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage was created.
- DefaultRouteSettings
-
- Type: RouteSettings structure
Default route settings for the stage.
- DeploymentId
-
- Type: string
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
- Description
-
- Type: string
The description of the stage.
- LastDeploymentStatusMessage
-
- Type: string
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
- LastUpdatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the stage was last updated.
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
Route settings for the stage, by routeKey.
- StageName
-
- Required: Yes
- Type: string
The name of the stage.
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of tags. Each tag element is associated with a given resource.
Stages
Description
A collection of Stage resources that are associated with the ApiKey resource.
Members
- Items
-
- Type: Array of Stage structures
The elements from this collection.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.
TagResourceInput
Description
Represents the input parameters for a TagResource request.
Members
Template
TlsConfig
Description
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.
Members
TlsConfigInput
Description
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.
Members
TooManyRequestsException
Description
A limit has been exceeded. See the accompanying error message for details.
Members
UpdateApiInput
Description
Represents the input parameters for an UpdateApi request.
Members
- ApiKeySelectionExpression
-
- Type: string
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- CorsConfiguration
-
- Type: Cors structure
A CORS configuration. Supported only for HTTP APIs.
- CredentialsArn
-
- Type: string
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.
- Description
-
- Type: string
The description of the API.
- DisableExecuteApiEndpoint
-
- Type: boolean
- DisableSchemaValidation
-
- Type: boolean
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- Name
-
- Type: string
The name of the API.
- RouteKey
-
- Type: string
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
- RouteSelectionExpression
-
- Type: string
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
- Target
-
- Type: string
This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
- Version
-
- Type: string
A version identifier for the API.
UpdateApiMappingInput
Description
Represents the input parameters for an UpdateApiMapping request.
Members
UpdateAuthorizerInput
Description
The input parameters for an UpdateAuthorizer request.
Members
- AuthorizerCredentialsArn
-
- Type: string
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.
- AuthorizerPayloadFormatVersion
-
- Type: string
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
- AuthorizerResultTtlInSeconds
-
- Type: int
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
- AuthorizerType
-
- Type: string
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
- AuthorizerUri
-
- Type: string
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:
{account_id} :function:{lambda_function_name} /invocations. In general, the URI has this form: arn:aws:apigateway:{region} :lambda:path/{service_api} , where{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers. - EnableSimpleResponses
-
- Type: boolean
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
- IdentitySource
-
- Type: Array of strings
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
- IdentityValidationExpression
-
- Type: string
This parameter is not used.
- JwtConfiguration
-
- Type: JWTConfiguration structure
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Name
-
- Type: string
The name of the authorizer.
UpdateDeploymentInput
Description
Represents the input parameters for an UpdateDeployment request.
Members
UpdateDomainNameInput
Description
Represents the input parameters for an UpdateDomainName request.
Members
- DomainNameConfigurations
-
- Type: Array of DomainNameConfiguration structures
The domain name configurations.
- MutualTlsAuthentication
-
- Type: MutualTlsAuthenticationInput structure
The mutual TLS authentication configuration for a custom domain name.
UpdateIntegrationInput
Description
Represents the input parameters for an UpdateIntegration request.
Members
- ConnectionId
-
- Type: string
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
- ConnectionType
-
- Type: string
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
-
- Type: string
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- CredentialsArn
-
- Type: string
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
- Description
-
- Type: string
The description of the integration
- IntegrationMethod
-
- Type: string
Specifies the integration's HTTP method type.
- IntegrationSubtype
-
- Type: string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
- IntegrationType
-
- Type: string
The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
- IntegrationUri
-
- Type: string
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
- PassthroughBehavior
-
- Type: string
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
- PayloadFormatVersion
-
- Type: string
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to strings
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.
{location} .{name} , where{location} is querystring, path, or header; and{name} 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.
- RequestTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to stringss
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
- TemplateSelectionExpression
-
- Type: string
The template selection expression for the integration.
- TimeoutInMillis
-
- Type: int
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
- TlsConfig
-
- Type: TlsConfigInput structure
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.
UpdateIntegrationResponseInput
Description
Represents the input parameters for an UpdateIntegrationResponse request.
Members
- ContentHandlingStrategy
-
- Type: string
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
- IntegrationResponseKey
-
- Type: string
The integration response key.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to strings
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.
{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where{name} is a valid and unique response header name and{JSON-expression} is a valid JSON expression without the $ prefix. - ResponseTemplates
-
- Type: Associative array of custom strings keys (__string) to strings
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
- TemplateSelectionExpression
-
- Type: string
The template selection expression for the integration response. Supported only for WebSocket APIs.
UpdateModelInput
Description
Represents the input parameters for an UpdateModel request. Supported only for WebSocket APIs.
Members
- ContentType
-
- Type: string
The content-type for the model, for example, "application/json".
- Description
-
- Type: string
The description of the model.
- Name
-
- Type: string
The name of the model.
- Schema
-
- Type: string
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
UpdateRouteInput
Description
Represents the input parameters for an UpdateRoute request.
Members
- ApiKeyRequired
-
- Type: boolean
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
- AuthorizationScopes
-
- Type: Array of strings
The authorization scopes supported by this route.
- AuthorizationType
-
- Type: string
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
- AuthorizerId
-
- Type: string
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
- ModelSelectionExpression
-
- Type: string
The model selection expression for the route. Supported only for WebSocket APIs.
- OperationName
-
- Type: string
The operation name for the route.
- RequestModels
-
- Type: Associative array of custom strings keys (__string) to strings
The request models for the route. Supported only for WebSocket APIs.
- RequestParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The request parameters for the route. Supported only for WebSocket APIs.
- RouteKey
-
- Type: string
The route key for the route.
- RouteResponseSelectionExpression
-
- Type: string
The route response selection expression for the route. Supported only for WebSocket APIs.
- Target
-
- Type: string
The target for the route.
UpdateRouteResponseInput
Description
Represents the input parameters for an UpdateRouteResponse request.
Members
- ModelSelectionExpression
-
- Type: string
The model selection expression for the route response. Supported only for WebSocket APIs.
- ResponseModels
-
- Type: Associative array of custom strings keys (__string) to strings
The response models for the route response.
- ResponseParameters
-
- Type: Associative array of custom strings keys (__string) to ParameterConstraints structures
The route response parameters.
- RouteResponseKey
-
- Type: string
The route response key.
UpdateStageInput
Description
Represents the input parameters for an UpdateStage request.
Members
- AccessLogSettings
-
- Type: AccessLogSettings structure
Settings for logging access in this stage.
- AutoDeploy
-
- Type: boolean
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
- ClientCertificateId
-
- Type: string
The identifier of a client certificate for a Stage.
- DefaultRouteSettings
-
- Type: RouteSettings structure
The default route settings for the stage.
- DeploymentId
-
- Type: string
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
- Description
-
- Type: string
The description for the API stage.
- RouteSettings
-
- Type: Associative array of custom strings keys (__string) to RouteSettings structures
Route settings for the stage.
- StageVariables
-
- Type: Associative array of custom strings keys (__string) to strings
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-._~:/?#&=,]+.
UpdateVpcLinkInput
Description
Represents the input parameters for an UpdateVpcLink request.
Members
VpcLink
Description
Represents a VPC link.
Members
- CreatedDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the VPC link was created.
- Name
-
- Required: Yes
- Type: string
The name of the VPC link.
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of security group IDs for the VPC link.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
A list of subnet IDs to include in the VPC link.
- Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tags for the VPC link.
- VpcLinkId
-
- Required: Yes
- Type: string
The ID of the VPC link.
- VpcLinkStatus
-
- Type: string
The status of the VPC link.
- VpcLinkStatusMessage
-
- Type: string
A message summarizing the cause of the status of the VPC link.
- VpcLinkVersion
-
- Type: string
The version of the VPC link.
VpcLinks
Description
Represents a collection of VPCLinks.
Members
- Items
-
- Type: Array of VpcLink structures
A collection of VPC links.
- NextToken
-
- Type: string
The next page of elements from this collection. Not valid for the last element of the collection.