Table of Contents
A low-level client representing AmazonApiGatewayV2:
import boto3
client = boto3.client('apigatewayv2')
These are the available methods:
Check if an operation can be paginated.
Creates an Api resource.
See also: AWS API Documentation
Request Syntax
response = client.create_api(
ApiKeySelectionExpression='string',
CorsConfiguration={
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
CredentialsArn='string',
Description='string',
DisableSchemaValidation=True|False,
Name='string',
ProtocolType='WEBSOCKET'|'HTTP',
RouteKey='string',
RouteSelectionExpression='string',
Tags={
'string': 'string'
},
Target='string',
Version='string'
)
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
Represents a collection of allowed headers. Supported only for HTTP APIs.
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
A string with a length between [1-64].
Represents a collection of allowed origins. Supported only for HTTP APIs.
Represents a collection of exposed headers. Supported only for HTTP APIs.
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
[REQUIRED]
The name of the API.
[REQUIRED]
The API protocol.
The collection of tags. Each tag element is associated with a given resource.
A string with a length between [0-1600].
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiEndpoint (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.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
CorsConfiguration (dict) --
A CORS configuration. Supported only for HTTP APIs.
AllowCredentials (boolean) --
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
AllowHeaders (list) --
Represents a collection of allowed headers. Supported only for HTTP APIs.
AllowMethods (list) --
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
(string) --
A string with a length between [1-64].
AllowOrigins (list) --
Represents a collection of allowed origins. Supported only for HTTP APIs.
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CreatedDate (datetime) --
The timestamp when the API was created.
Description (string) --
The description of the API.
DisableSchemaValidation (boolean) --
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
ImportInfo (list) --
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 (string) --
The name of the API.
ProtocolType (string) --
The API protocol.
RouteSelectionExpression (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 (dict) --
A collection of tags associated with the API.
(string) --
(string) --
A string with a length between [0-1600].
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
Creates an API mapping.
See also: AWS API Documentation
Request Syntax
response = client.create_api_mapping(
ApiId='string',
ApiMappingKey='string',
DomainName='string',
Stage='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The domain name.
[REQUIRED]
The API stage.
dict
Response Syntax
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
Creates an Authorizer for an API.
See also: AWS API Documentation
Request Syntax
response = client.create_authorizer(
ApiId='string',
AuthorizerCredentialsArn='string',
AuthorizerResultTtlInSeconds=123,
AuthorizerType='REQUEST'|'JWT',
AuthorizerUri='string',
IdentitySource=[
'string',
],
IdentityValidationExpression='string',
JwtConfiguration={
'Audience': [
'string',
],
'Issuer': 'string'
},
Name='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
[REQUIRED]
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. Currently, 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. These parameters will be 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 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".
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
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.
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.
[REQUIRED]
The name of the authorizer.
dict
Response Syntax
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST'|'JWT',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'JwtConfiguration': {
'Audience': [
'string',
],
'Issuer': 'string'
},
'Name': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
AuthorizerCredentialsArn (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. Supported only for REQUEST authorizers.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
Authorizer caching is not currently supported. Don't specify this value for authorizers.
AuthorizerType (string) --
The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.
IdentitySource (list) --
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. Currently, 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. These parameters will be 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 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 (string) --
The validation expression does not apply to the REQUEST authorizer.
JwtConfiguration (dict) --
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
Audience (list) --
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 (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.
Name (string) --
The name of the authorizer.
Creates a Deployment for an API.
See also: AWS API Documentation
Request Syntax
response = client.create_deployment(
ApiId='string',
Description='string',
StageName='string'
)
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'AutoDeployed': True|False,
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
AutoDeployed (boolean) --
Specifies whether a deployment was automatically released.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
Creates a domain name.
See also: AWS API Documentation
Request Syntax
response = client.create_domain_name(
DomainName='string',
DomainNameConfigurations=[
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
],
Tags={
'string': 'string'
}
)
[REQUIRED]
The domain name.
The domain name configurations.
The domain name configuration.
A domain name for the API.
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.
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
An optional text message containing detailed information about status of the domain name migration.
The endpoint type.
The Amazon Route 53 Hosted Zone ID of the endpoint.
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.
The collection of tags associated with a domain name.
A string with a length between [0-1600].
dict
Response Syntax
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the API.
CertificateArn (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 (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
DomainNameStatus (string) --
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
DomainNameStatusMessage (string) --
An optional text message containing detailed information about status of the domain name migration.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint.
SecurityPolicy (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.
Tags (dict) --
The collection of tags associated with a domain name.
(string) --
(string) --
A string with a length between [0-1600].
Creates an Integration.
See also: AWS API Documentation
Request Syntax
response = client.create_integration(
ApiId='string',
ConnectionId='string',
ConnectionType='INTERNET'|'VPC_LINK',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
CredentialsArn='string',
Description='string',
IntegrationMethod='string',
IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
IntegrationUri='string',
PassthroughBehavior='WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
PayloadFormatVersion='string',
RequestParameters={
'string': 'string'
},
RequestTemplates={
'string': 'string'
},
TemplateSelectionExpression='string',
TimeoutInMillis=123,
TlsConfig={
'ServerNameToVerify': 'string'
}
)
[REQUIRED]
The API identifier.
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.
[REQUIRED]
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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
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.
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.
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. Supported only for WebSocket APIs.
A string with a length between [1-512].
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.
A string with a length between [0-32768].
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.
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
dict
Response 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',
'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
'IntegrationUri': 'string',
'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
'PayloadFormatVersion': 'string',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123,
'TlsConfig': {
'ServerNameToVerify': 'string'
}
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiGatewayManaged (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 (string) --
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionType (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 (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 (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 (string) --
Represents the description of an integration.
IntegrationId (string) --
Represents the identifier of an integration.
IntegrationMethod (string) --
Specifies the integration's HTTP method type.
IntegrationResponseSelectionExpression (string) --
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions .
IntegrationType (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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 (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 (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 (string) --
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
RequestParameters (dict) --
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. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-512].
RequestTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
TlsConfig (dict) --
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.
ServerNameToVerify (string) --
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
Creates an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
response = client.create_integration_response(
ApiId='string',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
IntegrationId='string',
IntegrationResponseKey='string',
ResponseParameters={
'string': 'string'
},
ResponseTemplates={
'string': 'string'
},
TemplateSelectionExpression='string'
)
[REQUIRED]
The API identifier.
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.
[REQUIRED]
The integration ID.
[REQUIRED]
The integration response key.
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.
A string with a length between [1-512].
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.
A string with a length between [0-32768].
dict
Response Syntax
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ContentHandlingStrategy (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 (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
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.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
Creates a Model for an API.
See also: AWS API Documentation
Request Syntax
response = client.create_model(
ApiId='string',
ContentType='string',
Description='string',
Name='string',
Schema='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The name of the model. Must be alphanumeric.
[REQUIRED]
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
dict
Response Syntax
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Creates a Route for an API.
See also: AWS API Documentation
Request Syntax
response = client.create_route(
ApiId='string',
ApiKeyRequired=True|False,
AuthorizationScopes=[
'string',
],
AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
AuthorizerId='string',
ModelSelectionExpression='string',
OperationName='string',
RequestModels={
'string': 'string'
},
RequestParameters={
'string': {
'Required': True|False
}
},
RouteKey='string',
RouteResponseSelectionExpression='string',
Target='string'
)
[REQUIRED]
The API identifier.
The authorization scopes supported by this route.
A string with a length between [1-64].
The request models for the route. Supported only for WebSocket APIs.
A string with a length between [1-128].
The request parameters for the route. Supported only for WebSocket APIs.
Validation constraints imposed on parameters of a request (path, query string, headers).
Whether or not the parameter is required.
[REQUIRED]
The route key for the route.
dict
Response Syntax
{
'ApiGatewayManaged': True|False,
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiGatewayManaged (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 (boolean) --
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
AuthorizationScopes (list) --
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.
(string) --
A string with a length between [1-64].
AuthorizationType (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, or JWT for using JSON Web Tokens.
AuthorizerId (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 (string) --
The model selection expression for the route. Supported only for WebSocket APIs.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route. Supported only for WebSocket APIs.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route. Supported only for WebSocket APIs.
Target (string) --
The target for the route.
Creates a RouteResponse for a Route.
See also: AWS API Documentation
Request Syntax
response = client.create_route_response(
ApiId='string',
ModelSelectionExpression='string',
ResponseModels={
'string': 'string'
},
ResponseParameters={
'string': {
'Required': True|False
}
},
RouteId='string',
RouteResponseKey='string'
)
[REQUIRED]
The API identifier.
The response models for the route response.
A string with a length between [1-128].
The route response parameters.
Validation constraints imposed on parameters of a request (path, query string, headers).
Whether or not the parameter is required.
[REQUIRED]
The route ID.
[REQUIRED]
The route response key.
dict
Response Syntax
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ModelSelectionExpression (string) --
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
Creates a Stage for an API.
See also: AWS API Documentation
Request Syntax
response = client.create_stage(
AccessLogSettings={
'DestinationArn': 'string',
'Format': 'string'
},
ApiId='string',
AutoDeploy=True|False,
ClientCertificateId='string',
DefaultRouteSettings={
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
DeploymentId='string',
Description='string',
RouteSettings={
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
StageName='string',
StageVariables={
'string': 'string'
},
Tags={
'string': 'string'
}
)
Settings for logging access in this stage.
The ARN of the CloudWatch Logs log group to receive access logs.
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
[REQUIRED]
The API identifier.
The default route settings for the stage.
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.
Specifies whether detailed metrics are enabled.
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.
Specifies the throttling burst limit.
Specifies the throttling rate limit.
Route settings for the stage, by routeKey.
Represents a collection of route settings.
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.
Specifies whether detailed metrics are enabled.
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.
Specifies the throttling burst limit.
Specifies the throttling rate limit.
[REQUIRED]
The name of the stage.
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-._~:/?#&=,]+.
A string with a length between [0-2048].
The collection of tags. Each tag element is associated with a given resource.
A string with a length between [0-1600].
dict
Response Syntax
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ApiGatewayManaged': True|False,
'AutoDeploy': True|False,
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastDeploymentStatusMessage': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
AccessLogSettings (dict) --
Settings for logging access in this stage.
DestinationArn (string) --
The ARN of the CloudWatch Logs log group to receive access logs.
Format (string) --
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
ApiGatewayManaged (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 (boolean) --
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
CreatedDate (datetime) --
The timestamp when the stage was created.
DefaultRouteSettings (dict) --
Default route settings for the stage.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
DeploymentId (string) --
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
Description (string) --
The description of the stage.
LastDeploymentStatusMessage (string) --
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (dict) --
Route settings for the stage, by routeKey.
(string) --
(dict) --
Represents a collection of route settings.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
StageName (string) --
The name of the stage.
StageVariables (dict) --
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-._~:/?#&=,]+.
(string) --
(string) --
A string with a length between [0-2048].
Tags (dict) --
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
A string with a length between [0-1600].
Creates a VPC link.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_link(
Name='string',
SecurityGroupIds=[
'string',
],
SubnetIds=[
'string',
],
Tags={
'string': 'string'
}
)
[REQUIRED]
The name of the VPC link.
A list of security group IDs for the VPC link.
[REQUIRED]
A list of subnet IDs to include in the VPC link.
A list of tags.
A string with a length between [0-1600].
dict
Response Syntax
{
'CreatedDate': datetime(2015, 1, 1),
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
],
'Tags': {
'string': 'string'
},
'VpcLinkId': 'string',
'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
'VpcLinkStatusMessage': 'string',
'VpcLinkVersion': 'V2'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
CreatedDate (datetime) --
The timestamp when the VPC link was created.
Name (string) --
The name of the VPC link.
SecurityGroupIds (list) --
A list of security group IDs for the VPC link.
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
Tags (dict) --
Tags for the VPC link.
(string) --
(string) --
A string with a length between [0-1600].
VpcLinkId (string) --
The ID of the VPC link.
VpcLinkStatus (string) --
The status of the VPC link.
VpcLinkStatusMessage (string) --
A message summarizing the cause of the status of the VPC link.
VpcLinkVersion (string) --
The version of the VPC link.
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
See also: AWS API Documentation
Request Syntax
response = client.delete_access_log_settings(
ApiId='string',
StageName='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
None
Deletes an Api resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_api(
ApiId='string'
)
[REQUIRED]
The API identifier.
Deletes an API mapping.
See also: AWS API Documentation
Request Syntax
response = client.delete_api_mapping(
ApiMappingId='string',
DomainName='string'
)
[REQUIRED]
The API mapping identifier.
[REQUIRED]
The domain name.
None
Deletes an Authorizer.
See also: AWS API Documentation
Request Syntax
response = client.delete_authorizer(
ApiId='string',
AuthorizerId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The authorizer identifier.
None
Deletes a CORS configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_cors_configuration(
ApiId='string'
)
[REQUIRED]
The API identifier.
Deletes a Deployment.
See also: AWS API Documentation
Request Syntax
response = client.delete_deployment(
ApiId='string',
DeploymentId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The deployment ID.
None
Deletes a domain name.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain_name(
DomainName='string'
)
[REQUIRED]
The domain name.
Deletes an Integration.
See also: AWS API Documentation
Request Syntax
response = client.delete_integration(
ApiId='string',
IntegrationId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The integration ID.
None
Deletes an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
response = client.delete_integration_response(
ApiId='string',
IntegrationId='string',
IntegrationResponseId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The integration ID.
[REQUIRED]
The integration response ID.
None
Deletes a Model.
See also: AWS API Documentation
Request Syntax
response = client.delete_model(
ApiId='string',
ModelId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The model ID.
None
Deletes a Route.
See also: AWS API Documentation
Request Syntax
response = client.delete_route(
ApiId='string',
RouteId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route ID.
None
Deletes a route request parameter.
See also: AWS API Documentation
Request Syntax
response = client.delete_route_request_parameter(
ApiId='string',
RequestParameterKey='string',
RouteId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route request parameter key.
[REQUIRED]
The route ID.
None
Deletes a RouteResponse.
See also: AWS API Documentation
Request Syntax
response = client.delete_route_response(
ApiId='string',
RouteId='string',
RouteResponseId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route ID.
[REQUIRED]
The route response ID.
None
Deletes the RouteSettings for a stage.
See also: AWS API Documentation
Request Syntax
response = client.delete_route_settings(
ApiId='string',
RouteKey='string',
StageName='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route key.
[REQUIRED]
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
None
Deletes a Stage.
See also: AWS API Documentation
Request Syntax
response = client.delete_stage(
ApiId='string',
StageName='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
None
Deletes a VPC link.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_link(
VpcLinkId='string'
)
[REQUIRED]
The ID of the VPC link.
{}
Response Structure
202 response
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets an Api resource.
See also: AWS API Documentation
Request Syntax
response = client.get_api(
ApiId='string'
)
[REQUIRED]
The API identifier.
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
Success
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.
The API ID.
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
A CORS configuration. Supported only for HTTP APIs.
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
Represents a collection of allowed headers. Supported only for HTTP APIs.
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
A string with a length between [1-64].
Represents a collection of allowed origins. Supported only for HTTP APIs.
Represents a collection of exposed headers. Supported only for HTTP APIs.
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
The timestamp when the API was created.
The description of the API.
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
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.
The name of the API.
The API protocol.
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.
A collection of tags associated with the API.
A string with a length between [0-1600].
A version identifier for the API.
The warning messages reported when failonwarnings is turned on during API import.
Gets an API mapping.
See also: AWS API Documentation
Request Syntax
response = client.get_api_mapping(
ApiMappingId='string',
DomainName='string'
)
[REQUIRED]
The API mapping identifier.
[REQUIRED]
The domain name.
dict
Response Syntax
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
Success
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
Gets API mappings.
See also: AWS API Documentation
Request Syntax
response = client.get_api_mappings(
DomainName='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The domain name.
dict
Response Syntax
{
'Items': [
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an API mapping.
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a collection of Api resources.
See also: AWS API Documentation
Request Syntax
response = client.get_apis(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Items': [
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an API.
ApiEndpoint (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.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
CorsConfiguration (dict) --
A CORS configuration. Supported only for HTTP APIs.
AllowCredentials (boolean) --
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
AllowHeaders (list) --
Represents a collection of allowed headers. Supported only for HTTP APIs.
AllowMethods (list) --
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
(string) --
A string with a length between [1-64].
AllowOrigins (list) --
Represents a collection of allowed origins. Supported only for HTTP APIs.
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CreatedDate (datetime) --
The timestamp when the API was created.
Description (string) --
The description of the API.
DisableSchemaValidation (boolean) --
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
ImportInfo (list) --
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 (string) --
The name of the API.
ProtocolType (string) --
The API protocol.
RouteSelectionExpression (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 (dict) --
A collection of tags associated with the API.
(string) --
(string) --
A string with a length between [0-1600].
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets an Authorizer.
See also: AWS API Documentation
Request Syntax
response = client.get_authorizer(
ApiId='string',
AuthorizerId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The authorizer identifier.
dict
Response Syntax
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST'|'JWT',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'JwtConfiguration': {
'Audience': [
'string',
],
'Issuer': 'string'
},
'Name': 'string'
}
Response Structure
(dict) --
Success
AuthorizerCredentialsArn (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. Supported only for REQUEST authorizers.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
Authorizer caching is not currently supported. Don't specify this value for authorizers.
AuthorizerType (string) --
The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.
IdentitySource (list) --
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. Currently, 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. These parameters will be 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 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 (string) --
The validation expression does not apply to the REQUEST authorizer.
JwtConfiguration (dict) --
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
Audience (list) --
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 (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.
Name (string) --
The name of the authorizer.
Gets the Authorizers for an API.
See also: AWS API Documentation
Request Syntax
response = client.get_authorizers(
ApiId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'Items': [
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST'|'JWT',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'JwtConfiguration': {
'Audience': [
'string',
],
'Issuer': 'string'
},
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an authorizer.
AuthorizerCredentialsArn (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. Supported only for REQUEST authorizers.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
Authorizer caching is not currently supported. Don't specify this value for authorizers.
AuthorizerType (string) --
The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.
IdentitySource (list) --
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. Currently, 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. These parameters will be 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 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 (string) --
The validation expression does not apply to the REQUEST authorizer.
JwtConfiguration (dict) --
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
Audience (list) --
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 (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.
Name (string) --
The name of the authorizer.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a Deployment.
See also: AWS API Documentation
Request Syntax
response = client.get_deployment(
ApiId='string',
DeploymentId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The deployment ID.
dict
Response Syntax
{
'AutoDeployed': True|False,
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Success
AutoDeployed (boolean) --
Specifies whether a deployment was automatically released.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
Gets the Deployments for an API.
See also: AWS API Documentation
Request Syntax
response = client.get_deployments(
ApiId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'Items': [
{
'AutoDeployed': True|False,
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
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.
AutoDeployed (boolean) --
Specifies whether a deployment was automatically released.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a domain name.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_name(
DomainName='string'
)
[REQUIRED]
The domain name.
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
Success
The API mapping selection expression.
The name of the DomainName resource.
The domain name configurations.
The domain name configuration.
A domain name for the API.
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.
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
An optional text message containing detailed information about status of the domain name migration.
The endpoint type.
The Amazon Route 53 Hosted Zone ID of the endpoint.
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.
The collection of tags associated with a domain name.
A string with a length between [0-1600].
Gets the domain names for an AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_names(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Items': [
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
],
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a domain name.
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the API.
CertificateArn (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 (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
DomainNameStatus (string) --
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
DomainNameStatusMessage (string) --
An optional text message containing detailed information about status of the domain name migration.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint.
SecurityPolicy (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.
Tags (dict) --
The collection of tags associated with a domain name.
(string) --
(string) --
A string with a length between [0-1600].
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets an Integration.
See also: AWS API Documentation
Request Syntax
response = client.get_integration(
ApiId='string',
IntegrationId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The integration ID.
dict
Response 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',
'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
'IntegrationUri': 'string',
'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
'PayloadFormatVersion': 'string',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123,
'TlsConfig': {
'ServerNameToVerify': 'string'
}
}
Response Structure
(dict) --
Success
ApiGatewayManaged (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 (string) --
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionType (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 (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 (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 (string) --
Represents the description of an integration.
IntegrationId (string) --
Represents the identifier of an integration.
IntegrationMethod (string) --
Specifies the integration's HTTP method type.
IntegrationResponseSelectionExpression (string) --
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions .
IntegrationType (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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 (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 (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 (string) --
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
RequestParameters (dict) --
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. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-512].
RequestTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
TlsConfig (dict) --
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.
ServerNameToVerify (string) --
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
Gets an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
response = client.get_integration_response(
ApiId='string',
IntegrationId='string',
IntegrationResponseId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The integration ID.
[REQUIRED]
The integration response ID.
dict
Response Syntax
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
}
Response Structure
(dict) --
Success
ContentHandlingStrategy (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 (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
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.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
Gets the IntegrationResponses for an Integration.
See also: AWS API Documentation
Request Syntax
response = client.get_integration_responses(
ApiId='string',
IntegrationId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The integration ID.
dict
Response Syntax
{
'Items': [
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an integration response.
ContentHandlingStrategy (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 (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
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.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets the Integrations for an API.
See also: AWS API Documentation
Request Syntax
response = client.get_integrations(
ApiId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
dict
Response 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',
'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
'IntegrationUri': 'string',
'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
'PayloadFormatVersion': 'string',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123,
'TlsConfig': {
'ServerNameToVerify': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an integration.
ApiGatewayManaged (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 (string) --
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionType (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 (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 (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 (string) --
Represents the description of an integration.
IntegrationId (string) --
Represents the identifier of an integration.
IntegrationMethod (string) --
Specifies the integration's HTTP method type.
IntegrationResponseSelectionExpression (string) --
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions .
IntegrationType (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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 (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 (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 (string) --
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
RequestParameters (dict) --
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. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-512].
RequestTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
TlsConfig (dict) --
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.
ServerNameToVerify (string) --
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a Model.
See also: AWS API Documentation
Request Syntax
response = client.get_model(
ApiId='string',
ModelId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The model ID.
dict
Response Syntax
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
Success
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Gets a model template.
See also: AWS API Documentation
Request Syntax
response = client.get_model_template(
ApiId='string',
ModelId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The model ID.
dict
Response Syntax
{
'Value': 'string'
}
Response Structure
(dict) --
Success
Value (string) --
The template value.
Gets the Models for an API.
See also: AWS API Documentation
Request Syntax
response = client.get_models(
ApiId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'Items': [
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings .
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Create a paginator for an operation.
Gets a Route.
See also: AWS API Documentation
Request Syntax
response = client.get_route(
ApiId='string',
RouteId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route ID.
dict
Response Syntax
{
'ApiGatewayManaged': True|False,
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
}
Response Structure
(dict) --
Success
ApiGatewayManaged (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 (boolean) --
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
AuthorizationScopes (list) --
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.
(string) --
A string with a length between [1-64].
AuthorizationType (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, or JWT for using JSON Web Tokens.
AuthorizerId (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 (string) --
The model selection expression for the route. Supported only for WebSocket APIs.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route. Supported only for WebSocket APIs.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route. Supported only for WebSocket APIs.
Target (string) --
The target for the route.
Gets a RouteResponse.
See also: AWS API Documentation
Request Syntax
response = client.get_route_response(
ApiId='string',
RouteId='string',
RouteResponseId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route ID.
[REQUIRED]
The route response ID.
dict
Response Syntax
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
}
Response Structure
(dict) --
Success
ModelSelectionExpression (string) --
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
Gets the RouteResponses for a Route.
See also: AWS API Documentation
Request Syntax
response = client.get_route_responses(
ApiId='string',
MaxResults='string',
NextToken='string',
RouteId='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route ID.
dict
Response Syntax
{
'Items': [
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a route response.
ModelSelectionExpression (string) --
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets the Routes for an API.
See also: AWS API Documentation
Request Syntax
response = client.get_routes(
ApiId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'Items': [
{
'ApiGatewayManaged': True|False,
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a route.
ApiGatewayManaged (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 (boolean) --
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
AuthorizationScopes (list) --
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.
(string) --
A string with a length between [1-64].
AuthorizationType (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, or JWT for using JSON Web Tokens.
AuthorizerId (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 (string) --
The model selection expression for the route. Supported only for WebSocket APIs.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route. Supported only for WebSocket APIs.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route. Supported only for WebSocket APIs.
Target (string) --
The target for the route.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a Stage.
See also: AWS API Documentation
Request Syntax
response = client.get_stage(
ApiId='string',
StageName='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
dict
Response Syntax
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ApiGatewayManaged': True|False,
'AutoDeploy': True|False,
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastDeploymentStatusMessage': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success
AccessLogSettings (dict) --
Settings for logging access in this stage.
DestinationArn (string) --
The ARN of the CloudWatch Logs log group to receive access logs.
Format (string) --
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
ApiGatewayManaged (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 (boolean) --
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
CreatedDate (datetime) --
The timestamp when the stage was created.
DefaultRouteSettings (dict) --
Default route settings for the stage.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
DeploymentId (string) --
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
Description (string) --
The description of the stage.
LastDeploymentStatusMessage (string) --
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (dict) --
Route settings for the stage, by routeKey.
(string) --
(dict) --
Represents a collection of route settings.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
StageName (string) --
The name of the stage.
StageVariables (dict) --
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-._~:/?#&=,]+.
(string) --
(string) --
A string with a length between [0-2048].
Tags (dict) --
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
A string with a length between [0-1600].
Gets the Stages for an API.
See also: AWS API Documentation
Request Syntax
response = client.get_stages(
ApiId='string',
MaxResults='string',
NextToken='string'
)
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'Items': [
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ApiGatewayManaged': True|False,
'AutoDeploy': True|False,
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastDeploymentStatusMessage': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an API stage.
AccessLogSettings (dict) --
Settings for logging access in this stage.
DestinationArn (string) --
The ARN of the CloudWatch Logs log group to receive access logs.
Format (string) --
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
ApiGatewayManaged (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 (boolean) --
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
CreatedDate (datetime) --
The timestamp when the stage was created.
DefaultRouteSettings (dict) --
Default route settings for the stage.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
DeploymentId (string) --
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
Description (string) --
The description of the stage.
LastDeploymentStatusMessage (string) --
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (dict) --
Route settings for the stage, by routeKey.
(string) --
(dict) --
Represents a collection of route settings.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
StageName (string) --
The name of the stage.
StageVariables (dict) --
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-._~:/?#&=,]+.
(string) --
(string) --
A string with a length between [0-2048].
Tags (dict) --
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
A string with a length between [0-1600].
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a collection of Tag resources.
See also: AWS API Documentation
Request Syntax
response = client.get_tags(
ResourceArn='string'
)
[REQUIRED]
The resource ARN for the tag.
{
'Tags': {
'string': 'string'
}
}
Response Structure
Success
Represents a collection of tags associated with the resource.
A string with a length between [0-1600].
Gets a VPC link.
See also: AWS API Documentation
Request Syntax
response = client.get_vpc_link(
VpcLinkId='string'
)
[REQUIRED]
The ID of the VPC link.
{
'CreatedDate': datetime(2015, 1, 1),
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
],
'Tags': {
'string': 'string'
},
'VpcLinkId': 'string',
'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
'VpcLinkStatusMessage': 'string',
'VpcLinkVersion': 'V2'
}
Response Structure
Success
The timestamp when the VPC link was created.
The name of the VPC link.
A list of security group IDs for the VPC link.
A list of subnet IDs to include in the VPC link.
Tags for the VPC link.
A string with a length between [0-1600].
The ID of the VPC link.
The status of the VPC link.
A message summarizing the cause of the status of the VPC link.
The version of the VPC link.
Gets a collection of VPC links.
See also: AWS API Documentation
Request Syntax
response = client.get_vpc_links(
MaxResults='string',
NextToken='string'
)
dict
Response Syntax
{
'Items': [
{
'CreatedDate': datetime(2015, 1, 1),
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
],
'Tags': {
'string': 'string'
},
'VpcLinkId': 'string',
'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
'VpcLinkStatusMessage': 'string',
'VpcLinkVersion': 'V2'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
A collection of VPC links.
(dict) --
Represents a VPC link.
CreatedDate (datetime) --
The timestamp when the VPC link was created.
Name (string) --
The name of the VPC link.
SecurityGroupIds (list) --
A list of security group IDs for the VPC link.
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
Tags (dict) --
Tags for the VPC link.
(string) --
(string) --
A string with a length between [0-1600].
VpcLinkId (string) --
The ID of the VPC link.
VpcLinkStatus (string) --
The status of the VPC link.
VpcLinkStatusMessage (string) --
A message summarizing the cause of the status of the VPC link.
VpcLinkVersion (string) --
The version of the VPC link.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Returns an object that can wait for some condition.
Imports an API.
See also: AWS API Documentation
Request Syntax
response = client.import_api(
Basepath='string',
Body='string',
FailOnWarnings=True|False
)
[REQUIRED]
The OpenAPI definition. Supported only for HTTP APIs.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiEndpoint (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.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
CorsConfiguration (dict) --
A CORS configuration. Supported only for HTTP APIs.
AllowCredentials (boolean) --
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
AllowHeaders (list) --
Represents a collection of allowed headers. Supported only for HTTP APIs.
AllowMethods (list) --
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
(string) --
A string with a length between [1-64].
AllowOrigins (list) --
Represents a collection of allowed origins. Supported only for HTTP APIs.
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CreatedDate (datetime) --
The timestamp when the API was created.
Description (string) --
The description of the API.
DisableSchemaValidation (boolean) --
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
ImportInfo (list) --
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 (string) --
The name of the API.
ProtocolType (string) --
The API protocol.
RouteSelectionExpression (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 (dict) --
A collection of tags associated with the API.
(string) --
(string) --
A string with a length between [0-1600].
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
Puts an Api resource.
See also: AWS API Documentation
Request Syntax
response = client.reimport_api(
ApiId='string',
Basepath='string',
Body='string',
FailOnWarnings=True|False
)
[REQUIRED]
The API identifier.
[REQUIRED]
The OpenAPI definition. Supported only for HTTP APIs.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiEndpoint (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.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
CorsConfiguration (dict) --
A CORS configuration. Supported only for HTTP APIs.
AllowCredentials (boolean) --
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
AllowHeaders (list) --
Represents a collection of allowed headers. Supported only for HTTP APIs.
AllowMethods (list) --
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
(string) --
A string with a length between [1-64].
AllowOrigins (list) --
Represents a collection of allowed origins. Supported only for HTTP APIs.
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CreatedDate (datetime) --
The timestamp when the API was created.
Description (string) --
The description of the API.
DisableSchemaValidation (boolean) --
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
ImportInfo (list) --
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 (string) --
The name of the API.
ProtocolType (string) --
The API protocol.
RouteSelectionExpression (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 (dict) --
A collection of tags associated with the API.
(string) --
(string) --
A string with a length between [0-1600].
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
Creates a new Tag resource to represent a tag.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The resource ARN for the tag.
The collection of tags. Each tag element is associated with a given resource.
A string with a length between [0-1600].
dict
Response Syntax
{}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
Deletes a Tag.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The resource ARN for the tag.
[REQUIRED]
The Tag keys to delete
None
Updates an Api resource.
See also: AWS API Documentation
Request Syntax
response = client.update_api(
ApiId='string',
ApiKeySelectionExpression='string',
CorsConfiguration={
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
CredentialsArn='string',
Description='string',
DisableSchemaValidation=True|False,
Name='string',
RouteKey='string',
RouteSelectionExpression='string',
Target='string',
Version='string'
)
[REQUIRED]
The API identifier.
A CORS configuration. Supported only for HTTP APIs.
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
Represents a collection of allowed headers. Supported only for HTTP APIs.
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
A string with a length between [1-64].
Represents a collection of allowed origins. Supported only for HTTP APIs.
Represents a collection of exposed headers. Supported only for HTTP APIs.
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
Success
ApiEndpoint (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.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
CorsConfiguration (dict) --
A CORS configuration. Supported only for HTTP APIs.
AllowCredentials (boolean) --
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
AllowHeaders (list) --
Represents a collection of allowed headers. Supported only for HTTP APIs.
AllowMethods (list) --
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
(string) --
A string with a length between [1-64].
AllowOrigins (list) --
Represents a collection of allowed origins. Supported only for HTTP APIs.
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CreatedDate (datetime) --
The timestamp when the API was created.
Description (string) --
The description of the API.
DisableSchemaValidation (boolean) --
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
ImportInfo (list) --
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 (string) --
The name of the API.
ProtocolType (string) --
The API protocol.
RouteSelectionExpression (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 (dict) --
A collection of tags associated with the API.
(string) --
(string) --
A string with a length between [0-1600].
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
The API mapping.
See also: AWS API Documentation
Request Syntax
response = client.update_api_mapping(
ApiId='string',
ApiMappingId='string',
ApiMappingKey='string',
DomainName='string',
Stage='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The API mapping identifier.
[REQUIRED]
The domain name.
dict
Response Syntax
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
Success
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
Updates an Authorizer.
See also: AWS API Documentation
Request Syntax
response = client.update_authorizer(
ApiId='string',
AuthorizerCredentialsArn='string',
AuthorizerId='string',
AuthorizerResultTtlInSeconds=123,
AuthorizerType='REQUEST'|'JWT',
AuthorizerUri='string',
IdentitySource=[
'string',
],
IdentityValidationExpression='string',
JwtConfiguration={
'Audience': [
'string',
],
'Issuer': 'string'
},
Name='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The authorizer identifier.
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. Currently, 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. These parameters will be 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 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".
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
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.
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.
dict
Response Syntax
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST'|'JWT',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'JwtConfiguration': {
'Audience': [
'string',
],
'Issuer': 'string'
},
'Name': 'string'
}
Response Structure
(dict) --
Success
AuthorizerCredentialsArn (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. Supported only for REQUEST authorizers.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
Authorizer caching is not currently supported. Don't specify this value for authorizers.
AuthorizerType (string) --
The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.
IdentitySource (list) --
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. Currently, 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. These parameters will be 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 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 (string) --
The validation expression does not apply to the REQUEST authorizer.
JwtConfiguration (dict) --
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
Audience (list) --
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 (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.
Name (string) --
The name of the authorizer.
Updates a Deployment.
See also: AWS API Documentation
Request Syntax
response = client.update_deployment(
ApiId='string',
DeploymentId='string',
Description='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The deployment ID.
dict
Response Syntax
{
'AutoDeployed': True|False,
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Success
AutoDeployed (boolean) --
Specifies whether a deployment was automatically released.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
Updates a domain name.
See also: AWS API Documentation
Request Syntax
response = client.update_domain_name(
DomainName='string',
DomainNameConfigurations=[
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
]
)
[REQUIRED]
The domain name.
The domain name configurations.
The domain name configuration.
A domain name for the API.
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.
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
An optional text message containing detailed information about status of the domain name migration.
The endpoint type.
The Amazon Route 53 Hosted Zone ID of the endpoint.
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.
dict
Response Syntax
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the API.
CertificateArn (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 (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
DomainNameStatus (string) --
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
DomainNameStatusMessage (string) --
An optional text message containing detailed information about status of the domain name migration.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint.
SecurityPolicy (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.
Tags (dict) --
The collection of tags associated with a domain name.
(string) --
(string) --
A string with a length between [0-1600].
Updates an Integration.
See also: AWS API Documentation
Request Syntax
response = client.update_integration(
ApiId='string',
ConnectionId='string',
ConnectionType='INTERNET'|'VPC_LINK',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
CredentialsArn='string',
Description='string',
IntegrationId='string',
IntegrationMethod='string',
IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
IntegrationUri='string',
PassthroughBehavior='WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
PayloadFormatVersion='string',
RequestParameters={
'string': 'string'
},
RequestTemplates={
'string': 'string'
},
TemplateSelectionExpression='string',
TimeoutInMillis=123,
TlsConfig={
'ServerNameToVerify': 'string'
}
)
[REQUIRED]
The API identifier.
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.
[REQUIRED]
The integration ID.
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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
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.
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.
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. Supported only for WebSocket APIs.
A string with a length between [1-512].
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.
A string with a length between [0-32768].
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.
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
dict
Response 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',
'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
'IntegrationUri': 'string',
'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
'PayloadFormatVersion': 'string',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123,
'TlsConfig': {
'ServerNameToVerify': 'string'
}
}
Response Structure
(dict) --
Success
ApiGatewayManaged (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 (string) --
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionType (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 (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 (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 (string) --
Represents the description of an integration.
IntegrationId (string) --
Represents the identifier of an integration.
IntegrationMethod (string) --
Specifies the integration's HTTP method type.
IntegrationResponseSelectionExpression (string) --
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions .
IntegrationType (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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 (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 (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 (string) --
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
RequestParameters (dict) --
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. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-512].
RequestTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
TlsConfig (dict) --
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.
ServerNameToVerify (string) --
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
Updates an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
response = client.update_integration_response(
ApiId='string',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
IntegrationId='string',
IntegrationResponseId='string',
IntegrationResponseKey='string',
ResponseParameters={
'string': 'string'
},
ResponseTemplates={
'string': 'string'
},
TemplateSelectionExpression='string'
)
[REQUIRED]
The API identifier.
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.
[REQUIRED]
The integration ID.
[REQUIRED]
The integration response ID.
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.
A string with a length between [1-512].
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.
A string with a length between [0-32768].
dict
Response Syntax
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
}
Response Structure
(dict) --
Success
ContentHandlingStrategy (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 (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
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.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
Updates a Model.
See also: AWS API Documentation
Request Syntax
response = client.update_model(
ApiId='string',
ContentType='string',
Description='string',
ModelId='string',
Name='string',
Schema='string'
)
[REQUIRED]
The API identifier.
[REQUIRED]
The model ID.
dict
Response Syntax
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
Success
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Updates a Route.
See also: AWS API Documentation
Request Syntax
response = client.update_route(
ApiId='string',
ApiKeyRequired=True|False,
AuthorizationScopes=[
'string',
],
AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
AuthorizerId='string',
ModelSelectionExpression='string',
OperationName='string',
RequestModels={
'string': 'string'
},
RequestParameters={
'string': {
'Required': True|False
}
},
RouteId='string',
RouteKey='string',
RouteResponseSelectionExpression='string',
Target='string'
)
[REQUIRED]
The API identifier.
The authorization scopes supported by this route.
A string with a length between [1-64].
The request models for the route. Supported only for WebSocket APIs.
A string with a length between [1-128].
The request parameters for the route. Supported only for WebSocket APIs.
Validation constraints imposed on parameters of a request (path, query string, headers).
Whether or not the parameter is required.
[REQUIRED]
The route ID.
dict
Response Syntax
{
'ApiGatewayManaged': True|False,
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
}
Response Structure
(dict) --
Success
ApiGatewayManaged (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 (boolean) --
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
AuthorizationScopes (list) --
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.
(string) --
A string with a length between [1-64].
AuthorizationType (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, or JWT for using JSON Web Tokens.
AuthorizerId (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 (string) --
The model selection expression for the route. Supported only for WebSocket APIs.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route. Supported only for WebSocket APIs.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route. Supported only for WebSocket APIs.
Target (string) --
The target for the route.
Updates a RouteResponse.
See also: AWS API Documentation
Request Syntax
response = client.update_route_response(
ApiId='string',
ModelSelectionExpression='string',
ResponseModels={
'string': 'string'
},
ResponseParameters={
'string': {
'Required': True|False
}
},
RouteId='string',
RouteResponseId='string',
RouteResponseKey='string'
)
[REQUIRED]
The API identifier.
The response models for the route response.
A string with a length between [1-128].
The route response parameters.
Validation constraints imposed on parameters of a request (path, query string, headers).
Whether or not the parameter is required.
[REQUIRED]
The route ID.
[REQUIRED]
The route response ID.
dict
Response Syntax
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
}
Response Structure
(dict) --
Success
ModelSelectionExpression (string) --
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
Updates a Stage.
See also: AWS API Documentation
Request Syntax
response = client.update_stage(
AccessLogSettings={
'DestinationArn': 'string',
'Format': 'string'
},
ApiId='string',
AutoDeploy=True|False,
ClientCertificateId='string',
DefaultRouteSettings={
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
DeploymentId='string',
Description='string',
RouteSettings={
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
StageName='string',
StageVariables={
'string': 'string'
}
)
Settings for logging access in this stage.
The ARN of the CloudWatch Logs log group to receive access logs.
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
[REQUIRED]
The API identifier.
The default route settings for the stage.
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.
Specifies whether detailed metrics are enabled.
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.
Specifies the throttling burst limit.
Specifies the throttling rate limit.
Route settings for the stage.
Represents a collection of route settings.
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.
Specifies whether detailed metrics are enabled.
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.
Specifies the throttling burst limit.
Specifies the throttling rate limit.
[REQUIRED]
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
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-._~:/?#&=,]+.
A string with a length between [0-2048].
dict
Response Syntax
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ApiGatewayManaged': True|False,
'AutoDeploy': True|False,
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastDeploymentStatusMessage': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success
AccessLogSettings (dict) --
Settings for logging access in this stage.
DestinationArn (string) --
The ARN of the CloudWatch Logs log group to receive access logs.
Format (string) --
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
ApiGatewayManaged (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 (boolean) --
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
CreatedDate (datetime) --
The timestamp when the stage was created.
DefaultRouteSettings (dict) --
Default route settings for the stage.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
DeploymentId (string) --
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
Description (string) --
The description of the stage.
LastDeploymentStatusMessage (string) --
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (dict) --
Route settings for the stage, by routeKey.
(string) --
(dict) --
Represents a collection of route settings.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
StageName (string) --
The name of the stage.
StageVariables (dict) --
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-._~:/?#&=,]+.
(string) --
(string) --
A string with a length between [0-2048].
Tags (dict) --
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
A string with a length between [0-1600].
Updates a VPC link.
See also: AWS API Documentation
Request Syntax
response = client.update_vpc_link(
Name='string',
VpcLinkId='string'
)
[REQUIRED]
The ID of the VPC link.
dict
Response Syntax
{
'CreatedDate': datetime(2015, 1, 1),
'Name': 'string',
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
],
'Tags': {
'string': 'string'
},
'VpcLinkId': 'string',
'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
'VpcLinkStatusMessage': 'string',
'VpcLinkVersion': 'V2'
}
Response Structure
(dict) --
200 response
CreatedDate (datetime) --
The timestamp when the VPC link was created.
Name (string) --
The name of the VPC link.
SecurityGroupIds (list) --
A list of security group IDs for the VPC link.
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
Tags (dict) --
Tags for the VPC link.
(string) --
(string) --
A string with a length between [0-1600].
VpcLinkId (string) --
The ID of the VPC link.
VpcLinkStatus (string) --
The status of the VPC link.
VpcLinkStatusMessage (string) --
A message summarizing the cause of the status of the VPC link.
VpcLinkVersion (string) --
The version of the VPC link.
The available paginators are:
paginator = client.get_paginator('get_apis')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_apis().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Items': [
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CorsConfiguration': {
'AllowCredentials': True|False,
'AllowHeaders': [
'string',
],
'AllowMethods': [
'string',
],
'AllowOrigins': [
'string',
],
'ExposeHeaders': [
'string',
],
'MaxAge': 123
},
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'ImportInfo': [
'string',
],
'Name': 'string',
'ProtocolType': 'WEBSOCKET'|'HTTP',
'RouteSelectionExpression': 'string',
'Tags': {
'string': 'string'
},
'Version': 'string',
'Warnings': [
'string',
]
},
],
}
Response Structure
Success
The elements from this collection.
Represents an API.
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.
The API ID.
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
A CORS configuration. Supported only for HTTP APIs.
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
Represents a collection of allowed headers. Supported only for HTTP APIs.
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
A string with a length between [1-64].
Represents a collection of allowed origins. Supported only for HTTP APIs.
Represents a collection of exposed headers. Supported only for HTTP APIs.
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
The timestamp when the API was created.
The description of the API.
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
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.
The name of the API.
The API protocol.
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.
A collection of tags associated with the API.
A string with a length between [0-1600].
A version identifier for the API.
The warning messages reported when failonwarnings is turned on during API import.
paginator = client.get_paginator('get_authorizers')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_authorizers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST'|'JWT',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'JwtConfiguration': {
'Audience': [
'string',
],
'Issuer': 'string'
},
'Name': 'string'
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an authorizer.
AuthorizerCredentialsArn (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. Supported only for REQUEST authorizers.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
Authorizer caching is not currently supported. Don't specify this value for authorizers.
AuthorizerType (string) --
The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST 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.
IdentitySource (list) --
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. Currently, 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. These parameters will be 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 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 (string) --
The validation expression does not apply to the REQUEST authorizer.
JwtConfiguration (dict) --
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
Audience (list) --
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 (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.
Name (string) --
The name of the authorizer.
paginator = client.get_paginator('get_deployments')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_deployments().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'AutoDeployed': True|False,
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
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.
AutoDeployed (boolean) --
Specifies whether a deployment was automatically released.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
paginator = client.get_paginator('get_domain_names')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_domain_names().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Items': [
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'DomainNameStatus': 'AVAILABLE'|'UPDATING',
'DomainNameStatusMessage': 'string',
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string',
'SecurityPolicy': 'TLS_1_0'|'TLS_1_2'
},
],
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
Success
The elements from this collection.
Represents a domain name.
The API mapping selection expression.
The name of the DomainName resource.
The domain name configurations.
The domain name configuration.
A domain name for the API.
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.
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
An optional text message containing detailed information about status of the domain name migration.
The endpoint type.
The Amazon Route 53 Hosted Zone ID of the endpoint.
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.
The collection of tags associated with a domain name.
A string with a length between [0-1600].
paginator = client.get_paginator('get_integration_responses')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_integration_responses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
IntegrationId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
[REQUIRED]
The integration ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an integration response.
ContentHandlingStrategy (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 (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
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.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
paginator = client.get_paginator('get_integrations')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_integrations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response 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',
'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
'IntegrationUri': 'string',
'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
'PayloadFormatVersion': 'string',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123,
'TlsConfig': {
'ServerNameToVerify': 'string'
}
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an integration.
ApiGatewayManaged (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 (string) --
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionType (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 (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 (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 (string) --
Represents the description of an integration.
IntegrationId (string) --
Represents the identifier of an integration.
IntegrationMethod (string) --
Specifies the integration's HTTP method type.
IntegrationResponseSelectionExpression (string) --
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions .
IntegrationType (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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 (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 (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 (string) --
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
RequestParameters (dict) --
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. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-512].
RequestTemplates (dict) --
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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
TlsConfig (dict) --
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.
ServerNameToVerify (string) --
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
paginator = client.get_paginator('get_models')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_models().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings .
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
paginator = client.get_paginator('get_route_responses')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_route_responses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
RouteId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
[REQUIRED]
The route ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a route response.
ModelSelectionExpression (string) --
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
paginator = client.get_paginator('get_routes')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_routes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'ApiGatewayManaged': True|False,
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a route.
ApiGatewayManaged (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 (boolean) --
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
AuthorizationScopes (list) --
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.
(string) --
A string with a length between [1-64].
AuthorizationType (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, or JWT for using JSON Web Tokens.
AuthorizerId (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 (string) --
The model selection expression for the route. Supported only for WebSocket APIs.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route. Supported only for WebSocket APIs.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route. Supported only for WebSocket APIs.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route. Supported only for WebSocket APIs.
Target (string) --
The target for the route.
paginator = client.get_paginator('get_stages')
Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_stages().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ApiId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The API identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Items': [
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ApiGatewayManaged': True|False,
'AutoDeploy': True|False,
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastDeploymentStatusMessage': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'OFF',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'string': 'string'
},
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an API stage.
AccessLogSettings (dict) --
Settings for logging access in this stage.
DestinationArn (string) --
The ARN of the CloudWatch Logs log group to receive access logs.
Format (string) --
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
ApiGatewayManaged (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 (boolean) --
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
CreatedDate (datetime) --
The timestamp when the stage was created.
DefaultRouteSettings (dict) --
Default route settings for the stage.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
DeploymentId (string) --
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
Description (string) --
The description of the stage.
LastDeploymentStatusMessage (string) --
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (dict) --
Route settings for the stage, by routeKey.
(string) --
(dict) --
Represents a collection of route settings.
DataTraceEnabled (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 (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (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 (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
StageName (string) --
The name of the stage.
StageVariables (dict) --
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-._~:/?#&=,]+.
(string) --
(string) --
A string with a length between [0-2048].
Tags (dict) --
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
A string with a length between [0-1600].