2020/08/20 - AmazonApiGatewayV2 - 10 updated api methods
Changes Update apigatewayv2 client to latest version
{'ApiGatewayManaged': 'boolean'}
Creates an Api resource.
See also: AWS API Documentation
Request Syntax
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'
)
string
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
dict
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
string
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
string
The description of the API.
boolean
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
string
[REQUIRED]
The name of the API.
string
[REQUIRED]
The API protocol.
string
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
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.
dict
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
A string with a length between [0-1600].
string
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
string
A version identifier for the API.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiGatewayManaged': True|False,
'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.
ApiGatewayManaged (boolean) --
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
ApiId (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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
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.
(string) --
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.
(string) --
{'IntegrationSubtype': 'string'}
Creates an Integration.
See also: AWS API Documentation
Request Syntax
client.create_integration(
ApiId='string',
ConnectionId='string',
ConnectionType='INTERNET'|'VPC_LINK',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
CredentialsArn='string',
Description='string',
IntegrationMethod='string',
IntegrationSubtype='string',
IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
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'
}
)
string
[REQUIRED]
The API identifier.
string
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
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.
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.
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.
string
The description of the integration.
string
Specifies the integration's HTTP method type.
string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
string
[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 a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
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.
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.
string
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
dict
, where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
(string) --
(string) --
A string with a length between [1-512].
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].
string
The template selection expression for the integration.
integer
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
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.
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',
'IntegrationSubtype': '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.
IntegrationSubtype (string) --
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
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 a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationUri (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) --
, where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
(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 for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TlsConfig (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.
{'ApiGatewayManaged': 'boolean'}
Gets an Api resource.
See also: AWS API Documentation
Request Syntax
client.get_api(
ApiId='string'
)
string
[REQUIRED]
The API identifier.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiGatewayManaged': True|False,
'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.
ApiGatewayManaged (boolean) --
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
ApiId (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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
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.
(string) --
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.
(string) --
{'Items': {'ApiGatewayManaged': 'boolean'}}
Gets a collection of Api resources.
See also: AWS API Documentation
Request Syntax
client.get_apis(
MaxResults='string',
NextToken='string'
)
string
The maximum number of elements to be returned for this resource.
string
The next page of elements from this collection. Not valid for the last element of the collection.
dict
Response Syntax
{
'Items': [
{
'ApiEndpoint': 'string',
'ApiGatewayManaged': True|False,
'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.
ApiGatewayManaged (boolean) --
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
ApiId (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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
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.
(string) --
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.
(string) --
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
{'IntegrationSubtype': 'string'}
Gets an Integration.
See also: AWS API Documentation
Request Syntax
client.get_integration(
ApiId='string',
IntegrationId='string'
)
string
[REQUIRED]
The API identifier.
string
[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',
'IntegrationSubtype': '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.
IntegrationSubtype (string) --
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
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 a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationUri (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) --
, where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
(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 for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TlsConfig (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.
{'Items': {'IntegrationSubtype': 'string'}}
Gets the Integrations for an API.
See also: AWS API Documentation
Request Syntax
client.get_integrations(
ApiId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED]
The API identifier.
string
The maximum number of elements to be returned for this resource.
string
The next page of elements from this collection. Not valid for the last element of the collection.
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',
'IntegrationSubtype': '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.
IntegrationSubtype (string) --
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
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 a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationUri (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) --
, where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
(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 for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TlsConfig (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.
{'ApiGatewayManaged': 'boolean'}
Imports an API.
See also: AWS API Documentation
Request Syntax
client.import_api(
Basepath='string',
Body='string',
FailOnWarnings=True|False
)
string
Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
string
[REQUIRED]
The OpenAPI definition. Supported only for HTTP APIs.
boolean
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiGatewayManaged': True|False,
'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.
ApiGatewayManaged (boolean) --
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
ApiId (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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
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.
(string) --
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.
(string) --
{'ApiGatewayManaged': 'boolean'}
Puts an Api resource.
See also: AWS API Documentation
Request Syntax
client.reimport_api(
ApiId='string',
Basepath='string',
Body='string',
FailOnWarnings=True|False
)
string
[REQUIRED]
The API identifier.
string
Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
string
[REQUIRED]
The OpenAPI definition. Supported only for HTTP APIs.
boolean
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiGatewayManaged': True|False,
'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.
ApiGatewayManaged (boolean) --
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
ApiId (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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
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.
(string) --
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.
(string) --
{'ApiGatewayManaged': 'boolean'}
Updates an Api resource.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The API identifier.
string
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
MaxAge (integer) --
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
string
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
string
The description of the API.
boolean
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
string
The name of the API.
string
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
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.
string
This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
string
A version identifier for the API.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiGatewayManaged': True|False,
'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.
ApiGatewayManaged (boolean) --
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
ApiId (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.
(string) --
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.
(string) --
ExposeHeaders (list) --
Represents a collection of exposed headers. Supported only for HTTP APIs.
(string) --
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.
(string) --
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.
(string) --
{'IntegrationSubtype': 'string'}
Updates an Integration.
See also: AWS API Documentation
Request Syntax
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',
IntegrationSubtype='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'
}
)
string
[REQUIRED]
The API identifier.
string
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
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.
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.
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.
string
The description of the integration
string
[REQUIRED]
The integration ID.
string
Specifies the integration's HTTP method type.
string
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
string
The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
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.
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.
string
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
dict
, where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
(string) --
(string) --
A string with a length between [1-512].
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].
string
The template selection expression for the integration.
integer
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
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.
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',
'IntegrationSubtype': '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.
IntegrationSubtype (string) --
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
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 a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
IntegrationUri (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) --
, where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP APIs, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations with a specified integrationSubtype. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
(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 for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TlsConfig (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.