2018/12/18 - AmazonApiGatewayV2 - 56 new api methods
Changes This is the initial SDK release for the Amazon API Gateway v2 APIs. This SDK will allow you to manage and configure APIs in Amazon API Gateway; this first release provides the capabilities that allow you to programmatically setup and manage WebSocket APIs end to end.
Gets the domain names for an AWS account.
See also: AWS API Documentation
Request Syntax
client.get_domain_names(
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': [
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a domain name.
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the WebSocket API.
CertificateArn (string) --
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
CertificateName (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway .
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets a Stage.
See also: AWS API Documentation
Request Syntax
client.get_stage(
ApiId='string',
StageName='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The stage name.
dict
Response Syntax
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'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.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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.
Description (string) --
The description of the stage.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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].
Deletes an Integration.
See also: AWS API Documentation
Request Syntax
client.delete_integration(
ApiId='string',
IntegrationId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The integration ID.
None
Updates a RouteResponse.
See also: AWS API Documentation
Request Syntax
client.update_route_response(
ApiId='string',
ModelSelectionExpression='string',
ResponseModels={
'string': 'string'
},
ResponseParameters={
'string': {
'Required': True|False
}
},
RouteId='string',
RouteResponseId='string',
RouteResponseKey='string'
)
string
[REQUIRED]
The API identifier.
string
The model selection expression for the route response.
dict
The response models for the route response.
(string) --
(string) --
A string with a length between [1-128].
dict
The route response parameters.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
string
[REQUIRED]
The route ID.
string
[REQUIRED]
The route response ID.
string
The route response key.
dict
Response Syntax
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
}
Response Structure
(dict) --
Success
ModelSelectionExpression (string) --
Represents the model selection expression of a route response.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
Gets the Models for an API.
See also: AWS API Documentation
Request Syntax
client.get_models(
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': [
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a data model for an API. See Create Models and Mapping Templates for Request and Response Mappings .
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets the RouteResponses for a Route.
See also: AWS API Documentation
Request Syntax
client.get_route_responses(
ApiId='string',
MaxResults='string',
NextToken='string',
RouteId='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.
string
[REQUIRED]
The route ID.
dict
Response Syntax
{
'Items': [
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a route response.
ModelSelectionExpression (string) --
Represents the model selection expression of a route response.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Creates a Stage for an API.
See also: AWS API Documentation
Request Syntax
client.create_stage(
AccessLogSettings={
'DestinationArn': 'string',
'Format': 'string'
},
ApiId='string',
ClientCertificateId='string',
DefaultRouteSettings={
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
DeploymentId='string',
Description='string',
RouteSettings={
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'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.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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.
(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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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
Response Syntax
{
'AccessLogSettings': {
'DestinationArn': 'string',
'Format': 'string'
},
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'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.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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.
Description (string) --
The description of the stage.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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].
Deletes a domain name.
See also: AWS API Documentation
Request Syntax
client.delete_domain_name(
DomainName='string'
)
string
[REQUIRED]
The domain name.
None
The API mappings.
See also: AWS API Documentation
Request Syntax
client.get_api_mappings(
DomainName='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED]
The domain name.
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
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
Success
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
Gets a domain name.
See also: AWS API Documentation
Request Syntax
client.get_domain_name(
DomainName='string'
)
string
[REQUIRED]
The domain name.
dict
Response Syntax
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string'
},
]
}
Response Structure
(dict) --
Success
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the WebSocket API.
CertificateArn (string) --
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
CertificateName (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway .
Deletes a Stage.
See also: AWS API Documentation
Request Syntax
client.delete_stage(
ApiId='string',
StageName='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The stage name.
None
Deletes a Route.
See also: AWS API Documentation
Request Syntax
client.delete_route(
ApiId='string',
RouteId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The route ID.
None
Deletes a Deployment.
See also: AWS API Documentation
Request Syntax
client.delete_deployment(
ApiId='string',
DeploymentId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The deployment ID.
None
Gets the IntegrationResponses for an Integration.
See also: AWS API Documentation
Request Syntax
client.get_integration_responses(
ApiId='string',
IntegrationId='string',
MaxResults='string',
NextToken='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The integration ID.
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': [
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an integration response.
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
IntegrationResponseId (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Updates a Stage.
See also: AWS API Documentation
Request Syntax
client.update_stage(
AccessLogSettings={
'DestinationArn': 'string',
'Format': 'string'
},
ApiId='string',
ClientCertificateId='string',
DefaultRouteSettings={
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
DeploymentId='string',
Description='string',
RouteSettings={
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'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.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
ThrottlingBurstLimit (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
string
The deployment identifier for the API stage.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
ThrottlingBurstLimit (integer) --
Specifies the throttling burst limit.
ThrottlingRateLimit (float) --
Specifies the throttling rate limit.
string
[REQUIRED]
The stage name.
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'
},
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'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.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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.
Description (string) --
The description of the stage.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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].
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',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'Name': 'string',
'ProtocolType': 'WEBSOCKET',
'RouteSelectionExpression': 'string',
'Version': 'string',
'Warnings': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an API.
ApiEndpoint (string) --
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. See API Key Selection Expressions .
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.
Name (string) --
The name of the API.
ProtocolType (string) --
The API protocol: HTTP or WEBSOCKET.
RouteSelectionExpression (string) --
The route selection expression for the API.
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.
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
{
'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',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123
}
Response Structure
(dict) --
Success
ConnectionId (string) --
The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
ConnectionType (string) --
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
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) --
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.
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, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating route or method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, 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.
IntegrationUri (string) --
Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the URI can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
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.
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.
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.
(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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
Updates an Authorizer.
See also: AWS API Documentation
Request Syntax
client.update_authorizer(
ApiId='string',
AuthorizerCredentialsArn='string',
AuthorizerId='string',
AuthorizerResultTtlInSeconds=123,
AuthorizerType='REQUEST',
AuthorizerUri='string',
IdentitySource=[
'string',
],
IdentityValidationExpression='string',
Name='string',
ProviderArns=[
'string',
]
)
string
[REQUIRED]
The API identifier.
string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
string
[REQUIRED]
The authorizer identifier.
integer
The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
string
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
string
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
list
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
(string) --
string
The validation expression does not apply to the REQUEST authorizer.
string
The name of the authorizer.
list
For REQUEST authorizer, this is not defined.
(string) --
Represents an Amazon Resource Name (ARN).
dict
Response Syntax
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'Name': 'string',
'ProviderArns': [
'string',
]
}
Response Structure
(dict) --
Success
AuthorizerCredentialsArn (string) --
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
AuthorizerType (string) --
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
IdentitySource (list) --
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
(string) --
IdentityValidationExpression (string) --
The validation expression does not apply to the REQUEST authorizer.
Name (string) --
The name of the authorizer.
ProviderArns (list) --
For REQUEST authorizer, this is not defined.
(string) --
Represents an Amazon Resource Name (ARN).
Gets the Deployments for an API.
See also: AWS API Documentation
Request Syntax
client.get_deployments(
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': [
{
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Updates an Api resource.
See also: AWS API Documentation
Request Syntax
client.update_api(
ApiId='string',
ApiKeySelectionExpression='string',
Description='string',
DisableSchemaValidation=True|False,
Name='string',
RouteSelectionExpression='string',
Version='string'
)
string
[REQUIRED]
The API identifier.
string
An API key selection expression. See API Key Selection Expressions .
string
The description of the API.
boolean
Avoid validating models when creating a deployment.
string
The name of the API.
string
The route selection expression for the API.
string
A version identifier for the API.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'Name': 'string',
'ProtocolType': 'WEBSOCKET',
'RouteSelectionExpression': 'string',
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
Success
ApiEndpoint (string) --
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. See API Key Selection Expressions .
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.
Name (string) --
The name of the API.
ProtocolType (string) --
The API protocol: HTTP or WEBSOCKET.
RouteSelectionExpression (string) --
The route selection expression for the API.
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
(string) --
Creates an Api resource.
See also: AWS API Documentation
Request Syntax
client.create_api(
ApiKeySelectionExpression='string',
Description='string',
DisableSchemaValidation=True|False,
Name='string',
ProtocolType='WEBSOCKET',
RouteSelectionExpression='string',
Version='string'
)
string
An API key selection expression. See API Key Selection Expressions .
string
The description of the API.
boolean
Avoid validating models when creating a deployment.
string
[REQUIRED]
The name of the API.
string
[REQUIRED]
The API protocol: HTTP or WEBSOCKET.
string
[REQUIRED]
The route selection expression for the API.
string
A version identifier for the API.
dict
Response Syntax
{
'ApiEndpoint': 'string',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'Name': 'string',
'ProtocolType': 'WEBSOCKET',
'RouteSelectionExpression': 'string',
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiEndpoint (string) --
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. See API Key Selection Expressions .
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.
Name (string) --
The name of the API.
ProtocolType (string) --
The API protocol: HTTP or WEBSOCKET.
RouteSelectionExpression (string) --
The route selection expression for the API.
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
(string) --
Creates an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
client.create_integration_response(
ApiId='string',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
IntegrationId='string',
IntegrationResponseKey='string',
ResponseParameters={
'string': 'string'
},
ResponseTemplates={
'string': 'string'
},
TemplateSelectionExpression='string'
)
string
[REQUIRED]
The API identifier.
string
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
string
[REQUIRED]
The integration ID.
string
[REQUIRED]
The integration response key.
dict
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
(string) --
(string) --
A string with a length between [1-512].
dict
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
(string) --
(string) --
A string with a length between [0-32768].
string
The template selection expression for the integration response.
dict
Response Syntax
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
IntegrationResponseId (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
The API mapping.
See also: AWS API Documentation
Request Syntax
client.update_api_mapping(
ApiId='string',
ApiMappingId='string',
ApiMappingKey='string',
DomainName='string',
Stage='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The API mapping identifier.
string
The API mapping key.
string
[REQUIRED]
The domain name.
string
The API stage.
dict
Response Syntax
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
Success
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
Creates an Authorizer for an API.
See also: AWS API Documentation
Request Syntax
client.create_authorizer(
ApiId='string',
AuthorizerCredentialsArn='string',
AuthorizerResultTtlInSeconds=123,
AuthorizerType='REQUEST',
AuthorizerUri='string',
IdentitySource=[
'string',
],
IdentityValidationExpression='string',
Name='string',
ProviderArns=[
'string',
]
)
string
[REQUIRED]
The API identifier.
string
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
integer
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
string
[REQUIRED]
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
string
[REQUIRED]
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
list
[REQUIRED]
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
(string) --
string
The validation expression does not apply to the REQUEST authorizer.
string
[REQUIRED]
The name of the authorizer.
list
For REQUEST authorizer, this is not defined.
(string) --
Represents an Amazon Resource Name (ARN).
dict
Response Syntax
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'Name': 'string',
'ProviderArns': [
'string',
]
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
AuthorizerCredentialsArn (string) --
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
AuthorizerType (string) --
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
IdentitySource (list) --
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
(string) --
IdentityValidationExpression (string) --
The validation expression does not apply to the REQUEST authorizer.
Name (string) --
The name of the authorizer.
ProviderArns (list) --
For REQUEST authorizer, this is not defined.
(string) --
Represents an Amazon Resource Name (ARN).
Deletes a Model.
See also: AWS API Documentation
Request Syntax
client.delete_model(
ApiId='string',
ModelId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The model ID.
None
Deletes an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
client.delete_integration_response(
ApiId='string',
IntegrationId='string',
IntegrationResponseId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The integration ID.
string
[REQUIRED]
The integration response ID.
None
Creates a RouteResponse for a Route.
See also: AWS API Documentation
Request Syntax
client.create_route_response(
ApiId='string',
ModelSelectionExpression='string',
ResponseModels={
'string': 'string'
},
ResponseParameters={
'string': {
'Required': True|False
}
},
RouteId='string',
RouteResponseKey='string'
)
string
[REQUIRED]
The API identifier.
string
The model selection expression for the route response.
dict
The response models for the route response.
(string) --
(string) --
A string with a length between [1-128].
dict
The route response parameters.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
string
[REQUIRED]
The route ID.
string
[REQUIRED]
The route response key.
dict
Response Syntax
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ModelSelectionExpression (string) --
Represents the model selection expression of a route response.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
Gets the 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': [
{
'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',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an integration.
ConnectionId (string) --
The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
ConnectionType (string) --
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
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) --
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.
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, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating route or method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, 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.
IntegrationUri (string) --
Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the URI can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
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.
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.
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.
(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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Deletes an API mapping.
See also: AWS API Documentation
Request Syntax
client.delete_api_mapping(
ApiId='string',
ApiMappingId='string',
DomainName='string'
)
string
[REQUIRED]
The identifier of the API.
string
[REQUIRED]
The API mapping identifier.
string
[REQUIRED]
The domain name.
None
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',
'ApiId': 'string',
'ApiKeySelectionExpression': 'string',
'CreatedDate': datetime(2015, 1, 1),
'Description': 'string',
'DisableSchemaValidation': True|False,
'Name': 'string',
'ProtocolType': 'WEBSOCKET',
'RouteSelectionExpression': 'string',
'Version': 'string',
'Warnings': [
'string',
]
}
Response Structure
(dict) --
Success
ApiEndpoint (string) --
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
ApiId (string) --
The API ID.
ApiKeySelectionExpression (string) --
An API key selection expression. See API Key Selection Expressions .
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.
Name (string) --
The name of the API.
ProtocolType (string) --
The API protocol: HTTP or WEBSOCKET.
RouteSelectionExpression (string) --
The route selection expression for the API.
Version (string) --
A version identifier for the API.
Warnings (list) --
The warning messages reported when failonwarnings is turned on during API import.
(string) --
Gets a RouteResponse.
See also: AWS API Documentation
Request Syntax
client.get_route_response(
ApiId='string',
RouteId='string',
RouteResponseId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The route ID.
string
[REQUIRED]
The route response ID.
dict
Response Syntax
{
'ModelSelectionExpression': 'string',
'ResponseModels': {
'string': 'string'
},
'ResponseParameters': {
'string': {
'Required': True|False
}
},
'RouteResponseId': 'string',
'RouteResponseKey': 'string'
}
Response Structure
(dict) --
Success
ModelSelectionExpression (string) --
Represents the model selection expression of a route response.
ResponseModels (dict) --
Represents the response models of a route response.
(string) --
(string) --
A string with a length between [1-128].
ResponseParameters (dict) --
Represents the response parameters of a route response.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteResponseId (string) --
Represents the identifier of a route response.
RouteResponseKey (string) --
Represents the route response key of a route response.
Updates a Route.
See also: AWS API Documentation
Request Syntax
client.update_route(
ApiId='string',
ApiKeyRequired=True|False,
AuthorizationScopes=[
'string',
],
AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM',
AuthorizerId='string',
ModelSelectionExpression='string',
OperationName='string',
RequestModels={
'string': 'string'
},
RequestParameters={
'string': {
'Required': True|False
}
},
RouteId='string',
RouteKey='string',
RouteResponseSelectionExpression='string',
Target='string'
)
string
[REQUIRED]
The API identifier.
boolean
Specifies whether an API key is required for the route.
list
The authorization scopes supported by this route.
(string) --
A string with a length between [1-64].
string
The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
string
The identifier of the Authorizer resource to be associated with this route.
string
The model selection expression for the route.
string
The operation name for the route.
dict
The request models for the route.
(string) --
(string) --
A string with a length between [1-128].
dict
The request parameters for the route.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
string
[REQUIRED]
The route ID.
string
The route key for the route.
string
The route response selection expression for the route.
string
The target for the route.
dict
Response Syntax
{
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
}
Response Structure
(dict) --
Success
ApiKeyRequired (boolean) --
Specifies whether an API key is required for this route.
AuthorizationScopes (list) --
The authorization scopes supported by this route.
(string) --
A string with a length between [1-64].
AuthorizationType (string) --
The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
AuthorizerId (string) --
The identifier of the Authorizer resource to be associated with this route.
ModelSelectionExpression (string) --
The model selection expression for the route.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route.
Target (string) --
The target for the route.
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',
RequestParameters={
'string': 'string'
},
RequestTemplates={
'string': 'string'
},
TemplateSelectionExpression='string',
TimeoutInMillis=123
)
string
[REQUIRED]
The API identifier.
string
The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
string
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
string
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
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
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.
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, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating route or method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, 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.
string
Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the URI can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
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.
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.
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.
(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.
(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.
dict
Response Syntax
{
'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',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ConnectionId (string) --
The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
ConnectionType (string) --
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
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) --
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.
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, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating route or method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, 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.
IntegrationUri (string) --
Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the URI can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
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.
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.
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.
(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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
Creates a domain name.
See also: AWS API Documentation
Request Syntax
client.create_domain_name(
DomainName='string',
DomainNameConfigurations=[
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string'
},
]
)
string
[REQUIRED]
The domain name.
list
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the WebSocket API.
CertificateArn (string) --
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
CertificateName (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway .
dict
Response Syntax
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string'
},
]
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the WebSocket API.
CertificateArn (string) --
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
CertificateName (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway .
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',
RequestParameters={
'string': 'string'
},
RequestTemplates={
'string': 'string'
},
TemplateSelectionExpression='string',
TimeoutInMillis=123
)
string
[REQUIRED]
The API identifier.
string
The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
string
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
string
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
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.
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, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating route or method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, 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.
string
Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the URI can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
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.
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.
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.
(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.
(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.
dict
Response Syntax
{
'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',
'RequestParameters': {
'string': 'string'
},
'RequestTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string',
'TimeoutInMillis': 123
}
Response Structure
(dict) --
Success
ConnectionId (string) --
The identifier of the VpcLink used for the integration when the connectionType is VPC_LINK; otherwise undefined.
ConnectionType (string) --
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
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) --
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.
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, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
HTTP_PROXY: for integrating route or method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, 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.
IntegrationUri (string) --
Specifies the Uniform Resource Identifier (URI) of the integration endpoint.
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the URI can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
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.
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.
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.
(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.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expression for the integration.
TimeoutInMillis (integer) --
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
Updates a domain name.
See also: AWS API Documentation
Request Syntax
client.update_domain_name(
DomainName='string',
DomainNameConfigurations=[
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string'
},
]
)
string
[REQUIRED]
The domain name.
list
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the WebSocket API.
CertificateArn (string) --
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
CertificateName (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway .
dict
Response Syntax
{
'ApiMappingSelectionExpression': 'string',
'DomainName': 'string',
'DomainNameConfigurations': [
{
'ApiGatewayDomainName': 'string',
'CertificateArn': 'string',
'CertificateName': 'string',
'CertificateUploadDate': datetime(2015, 1, 1),
'EndpointType': 'REGIONAL'|'EDGE',
'HostedZoneId': 'string'
},
]
}
Response Structure
(dict) --
Success
ApiMappingSelectionExpression (string) --
The API mapping selection expression.
DomainName (string) --
The name of the DomainName resource.
DomainNameConfigurations (list) --
The domain name configurations.
(dict) --
The domain name configuration.
ApiGatewayDomainName (string) --
A domain name for the WebSocket API.
CertificateArn (string) --
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
CertificateName (string) --
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
CertificateUploadDate (datetime) --
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
EndpointType (string) --
The endpoint type.
HostedZoneId (string) --
The Amazon Route 53 Hosted Zone ID of the endpoint. See AWS Regions and Endpoints for API Gateway .
Gets the Authorizers for an API.
See also: AWS API Documentation
Request Syntax
client.get_authorizers(
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': [
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'Name': 'string',
'ProviderArns': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents an authorizer.
AuthorizerCredentialsArn (string) --
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
AuthorizerType (string) --
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
IdentitySource (list) --
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
(string) --
IdentityValidationExpression (string) --
The validation expression does not apply to the REQUEST authorizer.
Name (string) --
The name of the authorizer.
ProviderArns (list) --
For REQUEST authorizer, this is not defined.
(string) --
Represents an Amazon Resource Name (ARN).
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Deletes an Api resource.
See also: AWS API Documentation
Request Syntax
client.delete_api(
ApiId='string'
)
string
[REQUIRED]
The API identifier.
None
The API mapping.
See also: AWS API Documentation
Request Syntax
client.get_api_mapping(
ApiId='string',
ApiMappingId='string',
DomainName='string'
)
string
[REQUIRED]
The identifier of the API.
string
[REQUIRED]
The API mapping identifier.
string
[REQUIRED]
The domain name.
dict
Response Syntax
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
Success
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
Gets a Deployment.
See also: AWS API Documentation
Request Syntax
client.get_deployment(
ApiId='string',
DeploymentId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The deployment ID.
dict
Response Syntax
{
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Success
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
Deletes an Authorizer.
See also: AWS API Documentation
Request Syntax
client.delete_authorizer(
ApiId='string',
AuthorizerId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The authorizer identifier.
None
Creates a Model for an API.
See also: AWS API Documentation
Request Syntax
client.create_model(
ApiId='string',
ContentType='string',
Description='string',
Name='string',
Schema='string'
)
string
[REQUIRED]
The API identifier.
string
The content-type for the model, for example, "application/json".
string
The description of the model.
string
[REQUIRED]
The name of the model. Must be alphanumeric.
string
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
dict
Response Syntax
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Gets a model template.
See also: AWS API Documentation
Request Syntax
client.get_model_template(
ApiId='string',
ModelId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The model ID.
dict
Response Syntax
{
'Value': 'string'
}
Response Structure
(dict) --
Success
Value (string) --
The template value.
Gets a Model.
See also: AWS API Documentation
Request Syntax
client.get_model(
ApiId='string',
ModelId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The model ID.
dict
Response Syntax
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
Success
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Deletes a RouteResponse.
See also: AWS API Documentation
Request Syntax
client.delete_route_response(
ApiId='string',
RouteId='string',
RouteResponseId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The route ID.
string
[REQUIRED]
The route response ID.
None
Gets a Route.
See also: AWS API Documentation
Request Syntax
client.get_route(
ApiId='string',
RouteId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The route ID.
dict
Response Syntax
{
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
}
Response Structure
(dict) --
Success
ApiKeyRequired (boolean) --
Specifies whether an API key is required for this route.
AuthorizationScopes (list) --
The authorization scopes supported by this route.
(string) --
A string with a length between [1-64].
AuthorizationType (string) --
The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
AuthorizerId (string) --
The identifier of the Authorizer resource to be associated with this route.
ModelSelectionExpression (string) --
The model selection expression for the route.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route.
Target (string) --
The target for the route.
Updates a Deployment.
See also: AWS API Documentation
Request Syntax
client.update_deployment(
ApiId='string',
DeploymentId='string',
Description='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The deployment ID.
string
The description for the deployment resource.
dict
Response Syntax
{
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
}
Response Structure
(dict) --
Success
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
Creates a Route for an API.
See also: AWS API Documentation
Request Syntax
client.create_route(
ApiId='string',
ApiKeyRequired=True|False,
AuthorizationScopes=[
'string',
],
AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM',
AuthorizerId='string',
ModelSelectionExpression='string',
OperationName='string',
RequestModels={
'string': 'string'
},
RequestParameters={
'string': {
'Required': True|False
}
},
RouteKey='string',
RouteResponseSelectionExpression='string',
Target='string'
)
string
[REQUIRED]
The API identifier.
boolean
Specifies whether an API key is required for the route.
list
The authorization scopes supported by this route.
(string) --
A string with a length between [1-64].
string
The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
string
The identifier of the Authorizer resource to be associated with this route.
string
The model selection expression for the route.
string
The operation name for the route.
dict
The request models for the route.
(string) --
(string) --
A string with a length between [1-128].
dict
The request parameters for the route.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
string
[REQUIRED]
The route key for the route.
string
The route response selection expression for the route.
string
The target for the route.
dict
Response Syntax
{
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiKeyRequired (boolean) --
Specifies whether an API key is required for this route.
AuthorizationScopes (list) --
The authorization scopes supported by this route.
(string) --
A string with a length between [1-64].
AuthorizationType (string) --
The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
AuthorizerId (string) --
The identifier of the Authorizer resource to be associated with this route.
ModelSelectionExpression (string) --
The model selection expression for the route.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route.
Target (string) --
The target for the route.
Updates a Model.
See also: AWS API Documentation
Request Syntax
client.update_model(
ApiId='string',
ContentType='string',
Description='string',
ModelId='string',
Name='string',
Schema='string'
)
string
[REQUIRED]
The API identifier.
string
The content-type for the model, for example, "application/json".
string
The description of the model.
string
[REQUIRED]
The model ID.
string
The name of the model.
string
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
dict
Response Syntax
{
'ContentType': 'string',
'Description': 'string',
'ModelId': 'string',
'Name': 'string',
'Schema': 'string'
}
Response Structure
(dict) --
Success
ContentType (string) --
The content-type for the model, for example, "application/json".
Description (string) --
The description of the model.
ModelId (string) --
The model identifier.
Name (string) --
The name of the model. Must be alphanumeric.
Schema (string) --
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Creates a Deployment for an API.
See also: AWS API Documentation
Request Syntax
client.create_deployment(
ApiId='string',
Description='string',
StageName='string'
)
string
[REQUIRED]
The API identifier.
string
The description for the deployment resource.
string
The name of the Stage resource for the Deployment resource to create.
dict
Response Syntax
{
'CreatedDate': datetime(2015, 1, 1),
'DeploymentId': 'string',
'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
'DeploymentStatusMessage': 'string',
'Description': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
CreatedDate (datetime) --
The date and time when the Deployment resource was created.
DeploymentId (string) --
The identifier for the deployment.
DeploymentStatus (string) --
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
DeploymentStatusMessage (string) --
May contain additional feedback on the status of an API deployment.
Description (string) --
The description for the deployment.
Creates an API mapping.
See also: AWS API Documentation
Request Syntax
client.create_api_mapping(
ApiId='string',
ApiMappingKey='string',
DomainName='string',
Stage='string'
)
string
[REQUIRED]
The API identifier.
string
string
[REQUIRED]
The domain name.
string
[REQUIRED]
The API stage.
dict
Response Syntax
{
'ApiId': 'string',
'ApiMappingId': 'string',
'ApiMappingKey': 'string',
'Stage': 'string'
}
Response Structure
(dict) --
The request has succeeded and has resulted in the creation of a resource.
ApiId (string) --
The API identifier.
ApiMappingId (string) --
The API mapping identifier.
ApiMappingKey (string) --
The API mapping key.
Stage (string) --
The API stage.
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'
},
'ClientCertificateId': 'string',
'CreatedDate': datetime(2015, 1, 1),
'DefaultRouteSettings': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
},
'DeploymentId': 'string',
'Description': 'string',
'LastUpdatedDate': datetime(2015, 1, 1),
'RouteSettings': {
'string': {
'DataTraceEnabled': True|False,
'DetailedMetricsEnabled': True|False,
'LoggingLevel': 'ERROR'|'INFO'|'false',
'ThrottlingBurstLimit': 123,
'ThrottlingRateLimit': 123.0
}
},
'StageName': 'string',
'StageVariables': {
'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.
ClientCertificateId (string) --
The identifier of a client certificate for a Stage.
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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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.
Description (string) --
The description of the stage.
LastUpdatedDate (datetime) --
The timestamp when the stage was last updated.
RouteSettings (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.
DetailedMetricsEnabled (boolean) --
Specifies whether detailed metrics are enabled.
LoggingLevel (string) --
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
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].
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.
Gets an Authorizer.
See also: AWS API Documentation
Request Syntax
client.get_authorizer(
ApiId='string',
AuthorizerId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The authorizer identifier.
dict
Response Syntax
{
'AuthorizerCredentialsArn': 'string',
'AuthorizerId': 'string',
'AuthorizerResultTtlInSeconds': 123,
'AuthorizerType': 'REQUEST',
'AuthorizerUri': 'string',
'IdentitySource': [
'string',
],
'IdentityValidationExpression': 'string',
'Name': 'string',
'ProviderArns': [
'string',
]
}
Response Structure
(dict) --
Success
AuthorizerCredentialsArn (string) --
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
AuthorizerId (string) --
The authorizer identifier.
AuthorizerResultTtlInSeconds (integer) --
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
AuthorizerType (string) --
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
AuthorizerUri (string) --
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
IdentitySource (list) --
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
(string) --
IdentityValidationExpression (string) --
The validation expression does not apply to the REQUEST authorizer.
Name (string) --
The name of the authorizer.
ProviderArns (list) --
For REQUEST authorizer, this is not defined.
(string) --
Represents an Amazon Resource Name (ARN).
Gets an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
client.get_integration_response(
ApiId='string',
IntegrationId='string',
IntegrationResponseId='string'
)
string
[REQUIRED]
The API identifier.
string
[REQUIRED]
The integration ID.
string
[REQUIRED]
The integration response ID.
dict
Response Syntax
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
}
Response Structure
(dict) --
Success
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
IntegrationResponseId (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
Updates an IntegrationResponses.
See also: AWS API Documentation
Request Syntax
client.update_integration_response(
ApiId='string',
ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
IntegrationId='string',
IntegrationResponseId='string',
IntegrationResponseKey='string',
ResponseParameters={
'string': 'string'
},
ResponseTemplates={
'string': 'string'
},
TemplateSelectionExpression='string'
)
string
[REQUIRED]
The API identifier.
string
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
string
[REQUIRED]
The integration ID.
string
[REQUIRED]
The integration response ID.
string
The integration response key.
dict
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
(string) --
(string) --
A string with a length between [1-512].
dict
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
(string) --
(string) --
A string with a length between [0-32768].
string
The template selection expression for the integration response.
dict
Response Syntax
{
'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
'IntegrationResponseId': 'string',
'IntegrationResponseKey': 'string',
'ResponseParameters': {
'string': 'string'
},
'ResponseTemplates': {
'string': 'string'
},
'TemplateSelectionExpression': 'string'
}
Response Structure
(dict) --
Success
ContentHandlingStrategy (string) --
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
IntegrationResponseId (string) --
The integration response ID.
IntegrationResponseKey (string) --
The integration response key.
ResponseParameters (dict) --
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
(string) --
(string) --
A string with a length between [1-512].
ResponseTemplates (dict) --
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
(string) --
(string) --
A string with a length between [0-32768].
TemplateSelectionExpression (string) --
The template selection expressions for the integration response.
Gets the Routes for an API.
See also: AWS API Documentation
Request Syntax
client.get_routes(
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': [
{
'ApiKeyRequired': True|False,
'AuthorizationScopes': [
'string',
],
'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM',
'AuthorizerId': 'string',
'ModelSelectionExpression': 'string',
'OperationName': 'string',
'RequestModels': {
'string': 'string'
},
'RequestParameters': {
'string': {
'Required': True|False
}
},
'RouteId': 'string',
'RouteKey': 'string',
'RouteResponseSelectionExpression': 'string',
'Target': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success
Items (list) --
The elements from this collection.
(dict) --
Represents a route.
ApiKeyRequired (boolean) --
Specifies whether an API key is required for this route.
AuthorizationScopes (list) --
The authorization scopes supported by this route.
(string) --
A string with a length between [1-64].
AuthorizationType (string) --
The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions.
AuthorizerId (string) --
The identifier of the Authorizer resource to be associated with this route.
ModelSelectionExpression (string) --
The model selection expression for the route.
OperationName (string) --
The operation name for the route.
RequestModels (dict) --
The request models for the route.
(string) --
(string) --
A string with a length between [1-128].
RequestParameters (dict) --
The request parameters for the route.
(string) --
(dict) --
Validation constraints imposed on parameters of a request (path, query string, headers).
Required (boolean) --
Whether or not the parameter is required.
RouteId (string) --
The route ID.
RouteKey (string) --
The route key for the route.
RouteResponseSelectionExpression (string) --
The route response selection expression for the route.
Target (string) --
The target for the route.
NextToken (string) --
The next page of elements from this collection. Not valid for the last element of the collection.