ApiGatewayV2

Table of Contents

Client

class ApiGatewayV2.Client

A low-level client representing AmazonApiGatewayV2:

client = session.create_client('apigatewayv2')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_api(**kwargs)

Creates an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.create_api(
    ApiKeySelectionExpression='string',
    Description='string',
    DisableSchemaValidation=True|False,
    Name='string',
    ProtocolType='WEBSOCKET',
    RouteSelectionExpression='string',
    Version='string'
)
Parameters
  • ApiKeySelectionExpression (string) -- An API key selection expression. See API Key Selection Expressions .
  • Description (string) -- The description of the API.
  • DisableSchemaValidation (boolean) -- Avoid validating models when creating a deployment.
  • Name (string) --

    [REQUIRED]

    The name of the API.

  • ProtocolType (string) --

    [REQUIRED]

    The API protocol: Currently only WEBSOCKET is supported.

  • RouteSelectionExpression (string) --

    [REQUIRED]

    The route selection expression for the API.

  • Version (string) -- A version identifier for the API.
Return type

dict

Returns

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: Currently only WEBSOCKET is supported.

    • 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) --

create_api_mapping(**kwargs)

Creates an API mapping.

See also: AWS API Documentation

Request Syntax

response = client.create_api_mapping(
    ApiId='string',
    ApiMappingKey='string',
    DomainName='string',
    Stage='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ApiMappingKey (string) --
  • DomainName (string) --

    [REQUIRED]

    The domain name.

  • Stage (string) --

    [REQUIRED]

    The API stage.

Return type

dict

Returns

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.

create_authorizer(**kwargs)

Creates an Authorizer for an API.

See also: AWS API Documentation

Request Syntax

response = client.create_authorizer(
    ApiId='string',
    AuthorizerCredentialsArn='string',
    AuthorizerResultTtlInSeconds=123,
    AuthorizerType='REQUEST',
    AuthorizerUri='string',
    IdentitySource=[
        'string',
    ],
    IdentityValidationExpression='string',
    Name='string',
    ProviderArns=[
        'string',
    ]
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • 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.
  • 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) --

    [REQUIRED]

    The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

  • AuthorizerUri (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.

  • IdentitySource (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) --
  • IdentityValidationExpression (string) -- The validation expression does not apply to the REQUEST authorizer.
  • Name (string) --

    [REQUIRED]

    The name of the authorizer.

  • ProviderArns (list) --

    For REQUEST authorizer, this is not defined.

    • (string) --

      Represents an Amazon Resource Name (ARN).

Return type

dict

Returns

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).

create_deployment(**kwargs)

Creates a Deployment for an API.

See also: AWS API Documentation

Request Syntax

response = client.create_deployment(
    ApiId='string',
    Description='string',
    StageName='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • Description (string) -- The description for the deployment resource.
  • StageName (string) -- The name of the Stage resource for the Deployment resource to create.
Return type

dict

Returns

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.

create_domain_name(**kwargs)

Creates a domain name.

See also: AWS API Documentation

Request Syntax

response = client.create_domain_name(
    DomainName='string',
    DomainNameConfigurations=[
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string'
        },
    ]
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The domain name.

  • 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.

Return type

dict

Returns

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.

create_integration(**kwargs)

Creates an Integration.

See also: AWS API Documentation

Request Syntax

response = client.create_integration(
    ApiId='string',
    ConnectionId='string',
    ConnectionType='INTERNET'|'VPC_LINK',
    ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    CredentialsArn='string',
    Description='string',
    IntegrationMethod='string',
    IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    IntegrationUri='string',
    PassthroughBehavior='WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    RequestParameters={
        'string': 'string'
    },
    RequestTemplates={
        'string': 'string'
    },
    TemplateSelectionExpression='string',
    TimeoutInMillis=123
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ConnectionId (string) -- The connection ID.
  • ConnectionType (string) -- The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) -- The description of the integration.
  • IntegrationMethod (string) -- Specifies the integration's HTTP method type.
  • IntegrationType (string) --

    [REQUIRED]

    The integration type of an integration. One of the following:

    AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

    AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

    HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration.

    HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

    MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

  • IntegrationUri (string) -- For a Lambda proxy integration, this is the URI of the Lambda function.
  • 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.
Return type

dict

Returns

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 connection ID.

    • ConnectionType (string) --

      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) --

      The integration response selection expression for the integration. See Integration Response Selection Expressions .

    • IntegrationType (string) --

      The integration type of an integration. One of the following:

      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

    • IntegrationUri (string) --

      For a Lambda proxy integration, this is the URI of the Lambda function.

    • 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.

create_integration_response(**kwargs)

Creates an IntegrationResponses.

See also: AWS API Documentation

Request Syntax

response = client.create_integration_response(
    ApiId='string',
    ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    IntegrationId='string',
    IntegrationResponseKey='string',
    ResponseParameters={
        'string': 'string'
    },
    ResponseTemplates={
        'string': 'string'
    },
    TemplateSelectionExpression='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • 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.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • IntegrationResponseKey (string) --

    [REQUIRED]

    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 expression for the integration response.
Return type

dict

Returns

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.

create_model(**kwargs)

Creates a Model for an API.

See also: AWS API Documentation

Request Syntax

response = client.create_model(
    ApiId='string',
    ContentType='string',
    Description='string',
    Name='string',
    Schema='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ContentType (string) -- The content-type for the model, for example, "application/json".
  • Description (string) -- The description of the model.
  • Name (string) --

    [REQUIRED]

    The name of the model. Must be alphanumeric.

  • Schema (string) --

    [REQUIRED]

    The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Return type

dict

Returns

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.

create_route(**kwargs)

Creates a Route for an API.

See also: AWS API Documentation

Request Syntax

response = client.create_route(
    ApiId='string',
    ApiKeyRequired=True|False,
    AuthorizationScopes=[
        'string',
    ],
    AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM',
    AuthorizerId='string',
    ModelSelectionExpression='string',
    OperationName='string',
    RequestModels={
        'string': 'string'
    },
    RequestParameters={
        'string': {
            'Required': True|False
        }
    },
    RouteKey='string',
    RouteResponseSelectionExpression='string',
    Target='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ApiKeyRequired (boolean) -- Specifies whether an API key is required for the 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, and CUSTOM for using a Lambda authorizer.
  • AuthorizerId (string) -- The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
  • 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.

  • RouteKey (string) --

    [REQUIRED]

    The route key for the route.

  • RouteResponseSelectionExpression (string) -- The route response selection expression for the route.
  • Target (string) -- The target for the route.
Return type

dict

Returns

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) --

      A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

      • (string) --

        A string with a length between [1-64].

    • AuthorizationType (string) --

      The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

    • AuthorizerId (string) --

      The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

    • 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.

create_route_response(**kwargs)

Creates a RouteResponse for a Route.

See also: AWS API Documentation

Request Syntax

response = client.create_route_response(
    ApiId='string',
    ModelSelectionExpression='string',
    ResponseModels={
        'string': 'string'
    },
    ResponseParameters={
        'string': {
            'Required': True|False
        }
    },
    RouteId='string',
    RouteResponseKey='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ModelSelectionExpression (string) -- The model selection expression for the route response.
  • ResponseModels (dict) --

    The response models for the route response.

    • (string) --
      • (string) --

        A string with a length between [1-128].

  • ResponseParameters (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.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

  • RouteResponseKey (string) --

    [REQUIRED]

    The route response key.

Return type

dict

Returns

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.

create_stage(**kwargs)

Creates a Stage for an API.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters
  • 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.

  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ClientCertificateId (string) -- The identifier of a client certificate for a Stage.
  • DefaultRouteSettings (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.

  • DeploymentId (string) -- The deployment identifier of the API stage.
  • Description (string) -- The description for the API stage.
  • 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) --

    [REQUIRED]

    The name of the stage.

  • StageVariables (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].

Return type

dict

Returns

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].

delete_api(**kwargs)

Deletes an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_api(
    ApiId='string'
)
Parameters
ApiId (string) --

[REQUIRED]

The API identifier.

Returns
None
delete_api_mapping(**kwargs)

Deletes an API mapping.

See also: AWS API Documentation

Request Syntax

response = client.delete_api_mapping(
    ApiMappingId='string',
    DomainName='string'
)
Parameters
  • ApiMappingId (string) --

    [REQUIRED]

    The API mapping identifier.

  • DomainName (string) --

    [REQUIRED]

    The domain name.

Returns

None

delete_authorizer(**kwargs)

Deletes an Authorizer.

See also: AWS API Documentation

Request Syntax

response = client.delete_authorizer(
    ApiId='string',
    AuthorizerId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • AuthorizerId (string) --

    [REQUIRED]

    The authorizer identifier.

Returns

None

delete_deployment(**kwargs)

Deletes a Deployment.

See also: AWS API Documentation

Request Syntax

response = client.delete_deployment(
    ApiId='string',
    DeploymentId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • DeploymentId (string) --

    [REQUIRED]

    The deployment ID.

Returns

None

delete_domain_name(**kwargs)

Deletes a domain name.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain_name(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The domain name.

Returns
None
delete_integration(**kwargs)

Deletes an Integration.

See also: AWS API Documentation

Request Syntax

response = client.delete_integration(
    ApiId='string',
    IntegrationId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

Returns

None

delete_integration_response(**kwargs)

Deletes an IntegrationResponses.

See also: AWS API Documentation

Request Syntax

response = client.delete_integration_response(
    ApiId='string',
    IntegrationId='string',
    IntegrationResponseId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • IntegrationResponseId (string) --

    [REQUIRED]

    The integration response ID.

Returns

None

delete_model(**kwargs)

Deletes a Model.

See also: AWS API Documentation

Request Syntax

response = client.delete_model(
    ApiId='string',
    ModelId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ModelId (string) --

    [REQUIRED]

    The model ID.

Returns

None

delete_route(**kwargs)

Deletes a Route.

See also: AWS API Documentation

Request Syntax

response = client.delete_route(
    ApiId='string',
    RouteId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

Returns

None

delete_route_response(**kwargs)

Deletes a RouteResponse.

See also: AWS API Documentation

Request Syntax

response = client.delete_route_response(
    ApiId='string',
    RouteId='string',
    RouteResponseId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

  • RouteResponseId (string) --

    [REQUIRED]

    The route response ID.

Returns

None

delete_stage(**kwargs)

Deletes a Stage.

See also: AWS API Documentation

Request Syntax

response = client.delete_stage(
    ApiId='string',
    StageName='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • StageName (string) --

    [REQUIRED]

    The stage name.

Returns

None

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_api(**kwargs)

Gets an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.get_api(
    ApiId='string'
)
Parameters
ApiId (string) --

[REQUIRED]

The API identifier.

Return type
dict
Returns
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: Currently only WEBSOCKET is supported.

    • 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) --
get_api_mapping(**kwargs)

The API mapping.

See also: AWS API Documentation

Request Syntax

response = client.get_api_mapping(
    ApiMappingId='string',
    DomainName='string'
)
Parameters
  • ApiMappingId (string) --

    [REQUIRED]

    The API mapping identifier.

  • DomainName (string) --

    [REQUIRED]

    The domain name.

Return type

dict

Returns

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.

get_api_mappings(**kwargs)

The API mappings.

See also: AWS API Documentation

Request Syntax

response = client.get_api_mappings(
    DomainName='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The domain name.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'ApiId': 'string',
            'ApiMappingId': 'string',
            'ApiMappingKey': 'string',
            'Stage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an API mapping.

        • ApiId (string) --

          The API identifier.

        • ApiMappingId (string) --

          The API mapping identifier.

        • ApiMappingKey (string) --

          The API mapping key.

        • Stage (string) --

          The API stage.

    • NextToken (string) --

      The next page of elements from this collection. Not valid for the last element of the collection.

get_apis(**kwargs)

Gets a collection of Api resources.

See also: AWS API Documentation

Request Syntax

response = client.get_apis(
    MaxResults='string',
    NextToken='string'
)
Parameters
  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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: Currently only WEBSOCKET is supported.

        • 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.

get_authorizer(**kwargs)

Gets an Authorizer.

See also: AWS API Documentation

Request Syntax

response = client.get_authorizer(
    ApiId='string',
    AuthorizerId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • AuthorizerId (string) --

    [REQUIRED]

    The authorizer identifier.

Return type

dict

Returns

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).

get_authorizers(**kwargs)

Gets the Authorizers for an API.

See also: AWS API Documentation

Request Syntax

response = client.get_authorizers(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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.

get_deployment(**kwargs)

Gets a Deployment.

See also: AWS API Documentation

Request Syntax

response = client.get_deployment(
    ApiId='string',
    DeploymentId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • DeploymentId (string) --

    [REQUIRED]

    The deployment ID.

Return type

dict

Returns

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.

get_deployments(**kwargs)

Gets the Deployments for an API.

See also: AWS API Documentation

Request Syntax

response = client.get_deployments(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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.

get_domain_name(**kwargs)

Gets a domain name.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_name(
    DomainName='string'
)
Parameters
DomainName (string) --

[REQUIRED]

The domain name.

Return type
dict
Returns
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.

get_domain_names(**kwargs)

Gets the domain names for an AWS account.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_names(
    MaxResults='string',
    NextToken='string'
)
Parameters
  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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.

    • NextToken (string) --

      The next page of elements from this collection. Not valid for the last element of the collection.

get_integration(**kwargs)

Gets an Integration.

See also: AWS API Documentation

Request Syntax

response = client.get_integration(
    ApiId='string',
    IntegrationId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

Return type

dict

Returns

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 connection ID.

    • ConnectionType (string) --

      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) --

      The integration response selection expression for the integration. See Integration Response Selection Expressions .

    • IntegrationType (string) --

      The integration type of an integration. One of the following:

      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

    • IntegrationUri (string) --

      For a Lambda proxy integration, this is the URI of the Lambda function.

    • 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.

get_integration_response(**kwargs)

Gets an IntegrationResponses.

See also: AWS API Documentation

Request Syntax

response = client.get_integration_response(
    ApiId='string',
    IntegrationId='string',
    IntegrationResponseId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • IntegrationResponseId (string) -- [REQUIRED] The integration response ID.
Return type

dict

Returns

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.

get_integration_responses(**kwargs)

Gets the IntegrationResponses for an Integration.

See also: AWS API Documentation

Request Syntax

response = client.get_integration_responses(
    ApiId='string',
    IntegrationId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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.

get_integrations(**kwargs)

Gets the Integrations for an API.

See also: AWS API Documentation

Request Syntax

response = client.get_integrations(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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 connection ID.

        • ConnectionType (string) --

          The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) --

          The integration response selection expression for the integration. See Integration Response Selection Expressions .

        • IntegrationType (string) --

          The integration type of an integration. One of the following:

          AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

          AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

          HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

          HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

          MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

        • IntegrationUri (string) --

          For a Lambda proxy integration, this is the URI of the Lambda function.

        • 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.

get_model(**kwargs)

Gets a Model.

See also: AWS API Documentation

Request Syntax

response = client.get_model(
    ApiId='string',
    ModelId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ModelId (string) --

    [REQUIRED]

    The model ID.

Return type

dict

Returns

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.

get_model_template(**kwargs)

Gets a model template.

See also: AWS API Documentation

Request Syntax

response = client.get_model_template(
    ApiId='string',
    ModelId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ModelId (string) --

    [REQUIRED]

    The model ID.

Return type

dict

Returns

Response Syntax

{
    'Value': 'string'
}

Response Structure

  • (dict) --

    Success

    • Value (string) --

      The template value.

get_models(**kwargs)

Gets the Models for an API.

See also: AWS API Documentation

Request Syntax

response = client.get_models(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_route(**kwargs)

Gets a Route.

See also: AWS API Documentation

Request Syntax

response = client.get_route(
    ApiId='string',
    RouteId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

Return type

dict

Returns

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) --

      A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

      • (string) --

        A string with a length between [1-64].

    • AuthorizationType (string) --

      The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

    • AuthorizerId (string) --

      The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

    • 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.

get_route_response(**kwargs)

Gets a RouteResponse.

See also: AWS API Documentation

Request Syntax

response = client.get_route_response(
    ApiId='string',
    RouteId='string',
    RouteResponseId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

  • RouteResponseId (string) --

    [REQUIRED]

    The route response ID.

Return type

dict

Returns

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.

get_route_responses(**kwargs)

Gets the RouteResponses for a Route.

See also: AWS API Documentation

Request Syntax

response = client.get_route_responses(
    ApiId='string',
    MaxResults='string',
    NextToken='string',
    RouteId='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
  • RouteId (string) --

    [REQUIRED]

    The route ID.

Return type

dict

Returns

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.

get_routes(**kwargs)

Gets the Routes for an API.

See also: AWS API Documentation

Request Syntax

response = client.get_routes(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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) --

          A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

          • (string) --

            A string with a length between [1-64].

        • AuthorizationType (string) --

          The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

        • AuthorizerId (string) --

          The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

        • 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.

get_stage(**kwargs)

Gets a Stage.

See also: AWS API Documentation

Request Syntax

response = client.get_stage(
    ApiId='string',
    StageName='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • StageName (string) --

    [REQUIRED]

    The stage name.

Return type

dict

Returns

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].

get_stages(**kwargs)

Gets the Stages for an API.

See also: AWS API Documentation

Request Syntax

response = client.get_stages(
    ApiId='string',
    MaxResults='string',
    NextToken='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • MaxResults (string) -- The maximum number of elements to be returned for this resource.
  • NextToken (string) -- The next page of elements from this collection. Not valid for the last element of the collection.
Return type

dict

Returns

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.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
update_api(**kwargs)

Updates an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.update_api(
    ApiId='string',
    ApiKeySelectionExpression='string',
    Description='string',
    DisableSchemaValidation=True|False,
    Name='string',
    RouteSelectionExpression='string',
    Version='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ApiKeySelectionExpression (string) -- An API key selection expression. See API Key Selection Expressions .
  • Description (string) -- The description of the API.
  • DisableSchemaValidation (boolean) -- Avoid validating models when creating a deployment.
  • Name (string) -- The name of the API.
  • RouteSelectionExpression (string) -- The route selection expression for the API.
  • Version (string) -- A version identifier for the API.
Return type

dict

Returns

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: Currently only WEBSOCKET is supported.

    • 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) --

update_api_mapping(**kwargs)

The API mapping.

See also: AWS API Documentation

Request Syntax

response = client.update_api_mapping(
    ApiId='string',
    ApiMappingId='string',
    ApiMappingKey='string',
    DomainName='string',
    Stage='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ApiMappingId (string) --

    [REQUIRED]

    The API mapping identifier.

  • ApiMappingKey (string) -- The API mapping key.
  • DomainName (string) --

    [REQUIRED]

    The domain name.

  • Stage (string) -- The API stage.
Return type

dict

Returns

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.

update_authorizer(**kwargs)

Updates an Authorizer.

See also: AWS API Documentation

Request Syntax

response = client.update_authorizer(
    ApiId='string',
    AuthorizerCredentialsArn='string',
    AuthorizerId='string',
    AuthorizerResultTtlInSeconds=123,
    AuthorizerType='REQUEST',
    AuthorizerUri='string',
    IdentitySource=[
        'string',
    ],
    IdentityValidationExpression='string',
    Name='string',
    ProviderArns=[
        'string',
    ]
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • 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) --

    [REQUIRED]

    The authorizer identifier.

  • AuthorizerResultTtlInSeconds (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.
  • 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). 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.
  • 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, 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) --
  • 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).

Return type

dict

Returns

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).

update_deployment(**kwargs)

Updates a Deployment.

See also: AWS API Documentation

Request Syntax

response = client.update_deployment(
    ApiId='string',
    DeploymentId='string',
    Description='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • DeploymentId (string) --

    [REQUIRED]

    The deployment ID.

  • Description (string) -- The description for the deployment resource.
Return type

dict

Returns

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.

update_domain_name(**kwargs)

Updates a domain name.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_name(
    DomainName='string',
    DomainNameConfigurations=[
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string'
        },
    ]
)
Parameters
  • DomainName (string) --

    [REQUIRED]

    The domain name.

  • 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.

Return type

dict

Returns

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.

update_integration(**kwargs)

Updates an Integration.

See also: AWS API Documentation

Request Syntax

response = client.update_integration(
    ApiId='string',
    ConnectionId='string',
    ConnectionType='INTERNET'|'VPC_LINK',
    ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    CredentialsArn='string',
    Description='string',
    IntegrationId='string',
    IntegrationMethod='string',
    IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    IntegrationUri='string',
    PassthroughBehavior='WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    RequestParameters={
        'string': 'string'
    },
    RequestTemplates={
        'string': 'string'
    },
    TemplateSelectionExpression='string',
    TimeoutInMillis=123
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ConnectionId (string) -- The connection ID.
  • ConnectionType (string) -- The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) -- The description of the integration
  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • IntegrationMethod (string) -- Specifies the integration's HTTP method type.
  • 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. This integration is also referred to as the HTTP custom integration.

    HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

    MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

  • IntegrationUri (string) -- For a Lambda proxy integration, this is the URI of the Lambda function.
  • 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.
Return type

dict

Returns

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 connection ID.

    • ConnectionType (string) --

      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) --

      The integration response selection expression for the integration. See Integration Response Selection Expressions .

    • IntegrationType (string) --

      The integration type of an integration. One of the following:

      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

    • IntegrationUri (string) --

      For a Lambda proxy integration, this is the URI of the Lambda function.

    • 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.

update_integration_response(**kwargs)

Updates an IntegrationResponses.

See also: AWS API Documentation

Request Syntax

response = client.update_integration_response(
    ApiId='string',
    ContentHandlingStrategy='CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    IntegrationId='string',
    IntegrationResponseId='string',
    IntegrationResponseKey='string',
    ResponseParameters={
        'string': 'string'
    },
    ResponseTemplates={
        'string': 'string'
    },
    TemplateSelectionExpression='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • 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.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • IntegrationResponseId (string) -- [REQUIRED] 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 expression for the integration response.
Return type

dict

Returns

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.

update_model(**kwargs)

Updates a Model.

See also: AWS API Documentation

Request Syntax

response = client.update_model(
    ApiId='string',
    ContentType='string',
    Description='string',
    ModelId='string',
    Name='string',
    Schema='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ContentType (string) -- The content-type for the model, for example, "application/json".
  • Description (string) -- The description of the model.
  • ModelId (string) --

    [REQUIRED]

    The model ID.

  • Name (string) -- The name of the model.
  • Schema (string) -- The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Return type

dict

Returns

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.

update_route(**kwargs)

Updates a Route.

See also: AWS API Documentation

Request Syntax

response = client.update_route(
    ApiId='string',
    ApiKeyRequired=True|False,
    AuthorizationScopes=[
        'string',
    ],
    AuthorizationType='NONE'|'AWS_IAM'|'CUSTOM',
    AuthorizerId='string',
    ModelSelectionExpression='string',
    OperationName='string',
    RequestModels={
        'string': 'string'
    },
    RequestParameters={
        'string': {
            'Required': True|False
        }
    },
    RouteId='string',
    RouteKey='string',
    RouteResponseSelectionExpression='string',
    Target='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ApiKeyRequired (boolean) -- Specifies whether an API key is required for the 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, and CUSTOM for using a Lambda authorizer.
  • AuthorizerId (string) -- The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
  • 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) --

    [REQUIRED]

    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.
Return type

dict

Returns

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) --

      A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

      • (string) --

        A string with a length between [1-64].

    • AuthorizationType (string) --

      The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

    • AuthorizerId (string) --

      The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

    • 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.

update_route_response(**kwargs)

Updates a RouteResponse.

See also: AWS API Documentation

Request Syntax

response = client.update_route_response(
    ApiId='string',
    ModelSelectionExpression='string',
    ResponseModels={
        'string': 'string'
    },
    ResponseParameters={
        'string': {
            'Required': True|False
        }
    },
    RouteId='string',
    RouteResponseId='string',
    RouteResponseKey='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ModelSelectionExpression (string) -- The model selection expression for the route response.
  • ResponseModels (dict) --

    The response models for the route response.

    • (string) --
      • (string) --

        A string with a length between [1-128].

  • ResponseParameters (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.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

  • RouteResponseId (string) --

    [REQUIRED]

    The route response ID.

  • RouteResponseKey (string) -- The route response key.
Return type

dict

Returns

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.

update_stage(**kwargs)

Updates a Stage.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters
  • 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.

  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ClientCertificateId (string) -- The identifier of a client certificate for a Stage.
  • DefaultRouteSettings (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.

  • DeploymentId (string) -- The deployment identifier for the API stage.
  • Description (string) -- The description for the API stage.
  • 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) --

    [REQUIRED]

    The stage name.

  • StageVariables (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].

Return type

dict

Returns

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].

Paginators

The available paginators are:

class ApiGatewayV2.Paginator.GetApis
paginator = client.get_paginator('get_apis')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_apis().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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',
            ]
        },
    ],

}

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: Currently only WEBSOCKET is supported.

        • 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) --
class ApiGatewayV2.Paginator.GetAuthorizers
paginator = client.get_paginator('get_authorizers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_authorizers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'AuthorizerCredentialsArn': 'string',
            'AuthorizerId': 'string',
            'AuthorizerResultTtlInSeconds': 123,
            'AuthorizerType': 'REQUEST',
            'AuthorizerUri': 'string',
            'IdentitySource': [
                'string',
            ],
            'IdentityValidationExpression': 'string',
            'Name': 'string',
            'ProviderArns': [
                '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).

class ApiGatewayV2.Paginator.GetDeployments
paginator = client.get_paginator('get_deployments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'CreatedDate': datetime(2015, 1, 1),
            'DeploymentId': 'string',
            'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
            'DeploymentStatusMessage': 'string',
            'Description': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

        • 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.

class ApiGatewayV2.Paginator.GetDomainNames
paginator = client.get_paginator('get_domain_names')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_domain_names().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Items': [
        {
            '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

    • 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.

class ApiGatewayV2.Paginator.GetIntegrationResponses
paginator = client.get_paginator('get_integration_responses')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_integration_responses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    IntegrationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
            'IntegrationResponseId': 'string',
            'IntegrationResponseKey': 'string',
            'ResponseParameters': {
                'string': 'string'
            },
            'ResponseTemplates': {
                'string': 'string'
            },
            'TemplateSelectionExpression': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an integration response.

        • ContentHandlingStrategy (string) --

          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.

class ApiGatewayV2.Paginator.GetIntegrations
paginator = client.get_paginator('get_integrations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_integrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an integration.

        • ConnectionId (string) --

          The connection ID.

        • ConnectionType (string) --

          The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable 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) --

          The integration response selection expression for the integration. See Integration Response Selection Expressions .

        • IntegrationType (string) --

          The integration type of an integration. One of the following:

          AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

          AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

          HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

          HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

          MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

        • IntegrationUri (string) --

          For a Lambda proxy integration, this is the URI of the Lambda function.

        • 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.

class ApiGatewayV2.Paginator.GetModels
paginator = client.get_paginator('get_models')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_models().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'ContentType': 'string',
            'Description': 'string',
            'ModelId': 'string',
            'Name': 'string',
            'Schema': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a data model for an API. 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.

class ApiGatewayV2.Paginator.GetRouteResponses
paginator = client.get_paginator('get_route_responses')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_route_responses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    RouteId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Items': [
        {
            'ModelSelectionExpression': 'string',
            'ResponseModels': {
                'string': 'string'
            },
            'ResponseParameters': {
                'string': {
                    'Required': True|False
                }
            },
            'RouteResponseId': 'string',
            'RouteResponseKey': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a route response.

        • ModelSelectionExpression (string) --

          Represents the model selection expression of a route response.

        • 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.

class ApiGatewayV2.Paginator.GetRoutes
paginator = client.get_paginator('get_routes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_routes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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'
        },
    ],

}

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) --

          A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

          • (string) --

            A string with a length between [1-64].

        • AuthorizationType (string) --

          The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

        • AuthorizerId (string) --

          The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

        • 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.

class ApiGatewayV2.Paginator.GetStages
paginator = client.get_paginator('get_stages')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_stages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApiId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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'
            }
        },
    ],

}

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].