2020/03/12 - AmazonApiGatewayV2 - 7 new 8 updated api methods
Changes Amazon API Gateway HTTP APIs is now generally available. HTTP APIs offer the core functionality of REST API at up to 71% lower price compared to REST API, 60% lower p99 latency, and is significantly easier to use. As part of general availability, we added new features to route requests to private backends such as private ALBs, NLBs, and IP/ports. We also brought over a set of features from REST API such as Stage Variables, and Stage/Route level throttling. Custom domain names can also now be used with both REST And HTTP APIs.
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
See also: AWS API Documentation
Request Syntax
client.delete_access_log_settings(
ApiId='string',
StageName='string'
)
string
[REQUIRED]
The API identifier.
string
[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
client.delete_vpc_link(
VpcLinkId='string'
)
string
[REQUIRED]
The ID of the VPC link.
dict
Response Syntax
{}
Response Structure
(dict) --
202 response
Updates a VPC link.
See also: AWS API Documentation
Request Syntax
client.update_vpc_link(
Name='string',
VpcLinkId='string'
)
string
The name of the VPC link.
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.
(string) --
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
(string) --
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 a route request parameter.
See also: AWS API Documentation
Request Syntax
client.delete_route_request_parameter(
ApiId='string',
RequestParameterKey='string',
RouteId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The route request parameter key.
string
[REQUIRED]
The route ID.
None
Gets a collection of VPC links.
See also: AWS API Documentation
Request Syntax
client.get_vpc_links(
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': [
{
'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.
(string) --
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
(string) --
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.
Creates a VPC link.
See also: AWS API Documentation
Request Syntax
client.create_vpc_link(
Name='string',
SecurityGroupIds=[
'string',
],
SubnetIds=[
'string',
],
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the VPC link.
list
A list of security group IDs for the VPC link.
(string) --
list
[REQUIRED]
A list of subnet IDs to include in the VPC link.
(string) --
dict
A list of tags.
(string) --
(string) --
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.
(string) --
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
(string) --
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.
Gets a VPC link.
See also: AWS API Documentation
Request Syntax
client.get_vpc_link(
VpcLinkId='string'
)
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) --
Success
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.
(string) --
SubnetIds (list) --
A list of subnet IDs to include in the VPC link.
(string) --
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.
{'TlsConfig': {'ServerNameToVerify': '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',
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
[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.
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
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].
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. 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.
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',
'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.
{'DefaultRouteSettings': {'LoggingLevel': {'OFF'}},
'RouteSettings': {'LoggingLevel': {'OFF'}}}
Creates a Stage for an API.
See also: AWS API Documentation
Request Syntax
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'
}
)
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.
string
[REQUIRED]
The API identifier.
boolean
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
string
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
dict
The 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.
string
The deployment identifier of the API stage.
string
The description for the API stage.
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.
string
[REQUIRED]
The name of the stage.
dict
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-._~:/?#&=,]+.
(string) --
(string) --
A string with a length between [0-2048].
dict
The collection of tags. Each tag element is associated with a given resource.
(string) --
(string) --
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].
{'TlsConfig': {'ServerNameToVerify': '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',
'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.
{'Items': {'TlsConfig': {'ServerNameToVerify': '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',
'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.
{'DefaultRouteSettings': {'LoggingLevel': {'OFF'}},
'RouteSettings': {'LoggingLevel': {'OFF'}}}
Gets a Stage.
See also: AWS API Documentation
Request Syntax
client.get_stage(
ApiId='string',
StageName='string'
)
string
[REQUIRED]
The API identifier.
string
[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].
{'Items': {'DefaultRouteSettings': {'LoggingLevel': {'OFF'}},
'RouteSettings': {'LoggingLevel': {'OFF'}}}}
Gets the Stages for an API.
See also: AWS API Documentation
Request Syntax
client.get_stages(
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': [
{
'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.
{'TlsConfig': {'ServerNameToVerify': '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',
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
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.
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
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].
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. 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.
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',
'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.
{'DefaultRouteSettings': {'LoggingLevel': {'OFF'}},
'RouteSettings': {'LoggingLevel': {'OFF'}}}
Updates a Stage.
See also: AWS API Documentation
Request Syntax
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'
}
)
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.
string
[REQUIRED]
The API identifier.
boolean
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
string
The identifier of a client certificate for a Stage.
dict
The 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.
string
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
string
The description for the API stage.
dict
Route settings for the stage.
(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.
string
[REQUIRED]
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
dict
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-._~:/?#&=,]+.
(string) --
(string) --
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].