ApiGatewayV2

Table of Contents

Client

class ApiGatewayV2.Client

A low-level client representing AmazonApiGatewayV2

Amazon API Gateway V2

import boto3

client = boto3.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.
close()

Closes underlying endpoint connections.

create_api(**kwargs)

Creates an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.create_api(
    ApiKeySelectionExpression='string',
    CorsConfiguration={
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    CredentialsArn='string',
    Description='string',
    DisableSchemaValidation=True|False,
    DisableExecuteApiEndpoint=True|False,
    Name='string',
    ProtocolType='WEBSOCKET'|'HTTP',
    RouteKey='string',
    RouteSelectionExpression='string',
    Tags={
        'string': 'string'
    },
    Target='string',
    Version='string'
)
Parameters
  • ApiKeySelectionExpression (string) -- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
  • CorsConfiguration (dict) --

    A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

    • AllowCredentials (boolean) --

      Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

    • AllowHeaders (list) --

      Represents a collection of allowed headers. Supported only for HTTP APIs.

      • (string) --
    • AllowMethods (list) --

      Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

      • (string) --

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

    • AllowOrigins (list) --

      Represents a collection of allowed origins. Supported only for HTTP APIs.

      • (string) --
    • ExposeHeaders (list) --

      Represents a collection of exposed headers. Supported only for HTTP APIs.

      • (string) --
    • MaxAge (integer) --

      The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

  • CredentialsArn (string) -- This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
  • Description (string) -- The description of the API.
  • DisableSchemaValidation (boolean) -- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
  • DisableExecuteApiEndpoint (boolean) -- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
  • Name (string) --

    [REQUIRED]

    The name of the API.

  • ProtocolType (string) --

    [REQUIRED]

    The API protocol.

  • RouteKey (string) -- This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
  • RouteSelectionExpression (string) -- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
  • Tags (dict) --

    The collection of tags. Each tag element is associated with a given resource.

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

        A string with a length between [0-1600].

  • Target (string) -- This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
  • Version (string) -- A version identifier for the API.
Return type

dict

Returns

Response Syntax

{
    'ApiEndpoint': 'string',
    'ApiGatewayManaged': True|False,
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CorsConfiguration': {
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'DisableExecuteApiEndpoint': True|False,
    'ImportInfo': [
        'string',
    ],
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET'|'HTTP',
    'RouteSelectionExpression': 'string',
    'Tags': {
        'string': 'string'
    },
    'Version': 'string',
    'Warnings': [
        'string',
    ]
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • ApiEndpoint (string) --

      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    • ApiGatewayManaged (boolean) --

      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    • ApiId (string) --

      The API ID.

    • ApiKeySelectionExpression (string) --

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • CorsConfiguration (dict) --

      A CORS configuration. Supported only for HTTP APIs.

      • AllowCredentials (boolean) --

        Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

      • AllowHeaders (list) --

        Represents a collection of allowed headers. Supported only for HTTP APIs.

        • (string) --
      • AllowMethods (list) --

        Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

        • (string) --

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

      • AllowOrigins (list) --

        Represents a collection of allowed origins. Supported only for HTTP APIs.

        • (string) --
      • ExposeHeaders (list) --

        Represents a collection of exposed headers. Supported only for HTTP APIs.

        • (string) --
      • MaxAge (integer) --

        The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

    • CreatedDate (datetime) --

      The timestamp when the API was created.

    • Description (string) --

      The description of the API.

    • DisableSchemaValidation (boolean) --

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • DisableExecuteApiEndpoint (boolean) --

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • ImportInfo (list) --

      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

      The name of the API.

    • ProtocolType (string) --

      The API protocol.

    • RouteSelectionExpression (string) --

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • Tags (dict) --

      A collection of tags associated with the API.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

    • Version (string) --

      A version identifier for the API.

    • Warnings (list) --

      The warning messages reported when failonwarnings is turned on during API import.

      • (string) --

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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) -- The API mapping key.
  • 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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
create_authorizer(**kwargs)

Creates an Authorizer for an API.

See also: AWS API Documentation

Request Syntax

response = client.create_authorizer(
    ApiId='string',
    AuthorizerCredentialsArn='string',
    AuthorizerPayloadFormatVersion='string',
    AuthorizerResultTtlInSeconds=123,
    AuthorizerType='REQUEST'|'JWT',
    AuthorizerUri='string',
    EnableSimpleResponses=True|False,
    IdentitySource=[
        'string',
    ],
    IdentityValidationExpression='string',
    JwtConfiguration={
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    Name='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, don't specify this parameter. Supported only for REQUEST authorizers.
  • AuthorizerPayloadFormatVersion (string) -- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
  • AuthorizerResultTtlInSeconds (integer) -- The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
  • AuthorizerType (string) --

    [REQUIRED]

    The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

  • 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. Supported only for REQUEST authorizers.
  • EnableSimpleResponses (boolean) -- Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
  • IdentitySource (list) --

    [REQUIRED]

    The identity source for which authorization is requested.

    For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

    • (string) --
  • IdentityValidationExpression (string) -- This parameter is not used.
  • JwtConfiguration (dict) --

    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Audience (list) --

      A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

      The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • Name (string) --

    [REQUIRED]

    The name of the authorizer.

Return type

dict

Returns

Response Syntax

{
    'AuthorizerCredentialsArn': 'string',
    'AuthorizerId': 'string',
    'AuthorizerPayloadFormatVersion': 'string',
    'AuthorizerResultTtlInSeconds': 123,
    'AuthorizerType': 'REQUEST'|'JWT',
    'AuthorizerUri': 'string',
    'EnableSimpleResponses': True|False,
    'IdentitySource': [
        'string',
    ],
    'IdentityValidationExpression': 'string',
    'JwtConfiguration': {
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • AuthorizerCredentialsArn (string) --

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

    • AuthorizerId (string) --

      The authorizer identifier.

    • AuthorizerPayloadFormatVersion (string) --

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    • AuthorizerResultTtlInSeconds (integer) --

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • AuthorizerType (string) --

      The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

    • 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. Supported only for REQUEST authorizers.

    • EnableSimpleResponses (boolean) --

      Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

    • IdentitySource (list) --

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

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

      The validation expression does not apply to the REQUEST authorizer.

    • JwtConfiguration (dict) --

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      • Audience (list) --

        A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

        The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Name (string) --

      The name of the authorizer.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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

{
    'AutoDeployed': True|False,
    'CreatedDate': datetime(2015, 1, 1),
    'DeploymentId': 'string',
    'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
    'DeploymentStatusMessage': 'string',
    'Description': 'string'
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • AutoDeployed (boolean) --

      Specifies whether a deployment was automatically released.

    • CreatedDate (datetime) --

      The date and time when the Deployment resource was created.

    • DeploymentId (string) --

      The identifier for the deployment.

    • DeploymentStatus (string) --

      The status of the deployment: PENDING, FAILED, or SUCCEEDED.

    • DeploymentStatusMessage (string) --

      May contain additional feedback on the status of an API deployment.

    • Description (string) --

      The description for the deployment.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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),
            'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage': 'string',
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'OwnershipVerificationCertificateArn': 'string'
        },
    ],
    MutualTlsAuthentication={
        'TruststoreUri': 'string',
        'TruststoreVersion': 'string'
    },
    Tags={
        'string': '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 API.

      • CertificateArn (string) --

        An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

      • CertificateName (string) --

        The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

      • CertificateUploadDate (datetime) --

        The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

      • DomainNameStatus (string) --

        The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

      • DomainNameStatusMessage (string) --

        An optional text message containing detailed information about status of the domain name migration.

      • EndpointType (string) --

        The endpoint type.

      • HostedZoneId (string) --

        The Amazon Route 53 Hosted Zone ID of the endpoint.

      • SecurityPolicy (string) --

        The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

      • OwnershipVerificationCertificateArn (string) --

        The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

  • MutualTlsAuthentication (dict) --

    The mutual TLS authentication configuration for a custom domain name.

    • TruststoreUri (string) --

      An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

    • TruststoreVersion (string) --

      The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

  • Tags (dict) --

    The collection of tags associated with a domain name.

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

        A string with a length between [0-1600].

Return type

dict

Returns

Response Syntax

{
    'ApiMappingSelectionExpression': 'string',
    'DomainName': 'string',
    'DomainNameConfigurations': [
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage': 'string',
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'OwnershipVerificationCertificateArn': 'string'
        },
    ],
    'MutualTlsAuthentication': {
        'TruststoreUri': 'string',
        'TruststoreVersion': 'string',
        'TruststoreWarnings': [
            'string',
        ]
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • ApiMappingSelectionExpression (string) --

      The API mapping selection expression.

    • DomainName (string) --

      The name of the DomainName resource.

    • DomainNameConfigurations (list) --

      The domain name configurations.

      • (dict) --

        The domain name configuration.

        • ApiGatewayDomainName (string) --

          A domain name for the API.

        • CertificateArn (string) --

          An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

        • CertificateName (string) --

          The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

        • CertificateUploadDate (datetime) --

          The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

        • DomainNameStatus (string) --

          The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

        • DomainNameStatusMessage (string) --

          An optional text message containing detailed information about status of the domain name migration.

        • EndpointType (string) --

          The endpoint type.

        • HostedZoneId (string) --

          The Amazon Route 53 Hosted Zone ID of the endpoint.

        • SecurityPolicy (string) --

          The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

        • OwnershipVerificationCertificateArn (string) --

          The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

    • MutualTlsAuthentication (dict) --

      The mutual TLS authentication configuration for a custom domain name.

      • TruststoreUri (string) --

        An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

      • TruststoreVersion (string) --

        The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

      • TruststoreWarnings (list) --

        A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

        • (string) --
    • Tags (dict) --

      The collection of tags associated with a domain name.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
  • ApiGatewayV2.Client.exceptions.AccessDeniedException
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',
    IntegrationSubtype='string',
    IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    IntegrationUri='string',
    PassthroughBehavior='WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    PayloadFormatVersion='string',
    RequestParameters={
        'string': 'string'
    },
    RequestTemplates={
        'string': 'string'
    },
    ResponseParameters={
        'string': {
            'string': 'string'
        }
    },
    TemplateSelectionExpression='string',
    TimeoutInMillis=123,
    TlsConfig={
        'ServerNameToVerify': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ConnectionId (string) -- The ID of the VPC link for a private integration. Supported only for HTTP APIs.
  • ConnectionType (string) -- The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
  • ContentHandlingStrategy (string) --

    Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

  • CredentialsArn (string) -- Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.
  • Description (string) -- The description of the integration.
  • IntegrationMethod (string) -- Specifies the integration's HTTP method type.
  • IntegrationSubtype (string) -- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
  • IntegrationType (string) --

    [REQUIRED]

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

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

    AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

  • IntegrationUri (string) --

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

  • PassthroughBehavior (string) --

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

  • PayloadFormatVersion (string) -- Specifies the format of the payload sent to an integration. Required for HTTP APIs.
  • RequestParameters (dict) --

    For WebSocket APIs, 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.

    For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

    For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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

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

  • RequestTemplates (dict) --

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

        A string with a length between [0-32768].

  • ResponseParameters (dict) --

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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

        For WebSocket APIs, 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.

        For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

        For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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

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

  • TemplateSelectionExpression (string) -- The template selection expression for the integration.
  • TimeoutInMillis (integer) -- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
  • TlsConfig (dict) --

    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

    • ServerNameToVerify (string) --

      If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

Return type

dict

Returns

Response Syntax

{
    'ApiGatewayManaged': True|False,
    'ConnectionId': 'string',
    'ConnectionType': 'INTERNET'|'VPC_LINK',
    'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    'CredentialsArn': 'string',
    'Description': 'string',
    'IntegrationId': 'string',
    'IntegrationMethod': 'string',
    'IntegrationResponseSelectionExpression': 'string',
    'IntegrationSubtype': 'string',
    'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    'IntegrationUri': 'string',
    'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    'PayloadFormatVersion': 'string',
    'RequestParameters': {
        'string': 'string'
    },
    'RequestTemplates': {
        'string': 'string'
    },
    'ResponseParameters': {
        'string': {
            'string': 'string'
        }
    },
    'TemplateSelectionExpression': 'string',
    'TimeoutInMillis': 123,
    'TlsConfig': {
        'ServerNameToVerify': 'string'
    }
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • ApiGatewayManaged (boolean) --

      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

    • ConnectionId (string) --

      The ID of the VPC link for a private integration. Supported only for HTTP APIs.

    • ConnectionType (string) --

      The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

    • ContentHandlingStrategy (string) --

      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • CredentialsArn (string) --

      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.

    • Description (string) --

      Represents the description of an integration.

    • IntegrationId (string) --

      Represents the identifier of an integration.

    • IntegrationMethod (string) --

      Specifies the integration's HTTP method type.

    • IntegrationResponseSelectionExpression (string) --

      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

    • IntegrationSubtype (string) --

      Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

    • IntegrationType (string) --

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

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

      AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

    • IntegrationUri (string) --

      For a Lambda integration, specify the URI of a Lambda function.

      For an HTTP integration, specify a fully-qualified URL.

      For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

    • PassthroughBehavior (string) --

      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

      WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

      NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

      WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    • PayloadFormatVersion (string) --

      Specifies the format of the payload sent to an integration. Required for HTTP APIs.

    • RequestParameters (dict) --

      For WebSocket APIs, 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.

      For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

      For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

      • (string) --

        • (string) --

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

    • RequestTemplates (dict) --

      Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

      • (string) --

        • (string) --

          A string with a length between [0-32768].

    • ResponseParameters (dict) --

      Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

      • (string) --

        • (dict) --

          For WebSocket APIs, 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.

          For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

          For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (string) --

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

    • TemplateSelectionExpression (string) --

      The template selection expression for the integration. Supported only for WebSocket APIs.

    • TimeoutInMillis (integer) --

      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

    • TlsConfig (dict) --

      The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

      • ServerNameToVerify (string) --

        If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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. Supported only for WebSocket APIs.
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) --

      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • IntegrationResponseId (string) --

      The integration response ID.

    • IntegrationResponseKey (string) --

      The integration response key.

    • ResponseParameters (dict) --

      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

      • (string) --

        • (string) --

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

    • ResponseTemplates (dict) --

      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

      • (string) --

        • (string) --

          A string with a length between [0-32768].

    • TemplateSelectionExpression (string) --

      The template selection expressions for the integration response.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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'|'JWT',
    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. Supported only for WebSocket APIs.
  • 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. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.
  • ModelSelectionExpression (string) -- The model selection expression for the route. Supported only for WebSocket APIs.
  • OperationName (string) -- The operation name for the route.
  • RequestModels (dict) --

    The request models for the route. Supported only for WebSocket APIs.

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

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

  • RequestParameters (dict) --

    The request parameters for the route. Supported only for WebSocket APIs.

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

        Validation constraints imposed on parameters of a request (path, query string, headers).

        • Required (boolean) --

          Whether or not the parameter is required.

  • RouteKey (string) --

    [REQUIRED]

    The route key for the route.

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

dict

Returns

Response Syntax

{
    'ApiGatewayManaged': True|False,
    'ApiKeyRequired': True|False,
    'AuthorizationScopes': [
        'string',
    ],
    'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
    'AuthorizerId': 'string',
    'ModelSelectionExpression': 'string',
    'OperationName': 'string',
    'RequestModels': {
        'string': 'string'
    },
    'RequestParameters': {
        'string': {
            'Required': True|False
        }
    },
    'RouteId': 'string',
    'RouteKey': 'string',
    'RouteResponseSelectionExpression': 'string',
    'Target': 'string'
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • ApiGatewayManaged (boolean) --

      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

    • ApiKeyRequired (boolean) --

      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

    • AuthorizationScopes (list) --

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

      • (string) --

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

    • AuthorizationType (string) --

      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.

    • ModelSelectionExpression (string) --

      The model selection expression for the route. Supported only for WebSocket APIs.

    • OperationName (string) --

      The operation name for the route.

    • RequestModels (dict) --

      The request models for the route. Supported only for WebSocket APIs.

      • (string) --

        • (string) --

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

    • RequestParameters (dict) --

      The request parameters for the route. Supported only for WebSocket APIs.

      • (string) --

        • (dict) --

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) --

            Whether or not the parameter is required.

    • RouteId (string) --

      The route ID.

    • RouteKey (string) --

      The route key for the route.

    • RouteResponseSelectionExpression (string) --

      The route response selection expression for the route. Supported only for WebSocket APIs.

    • Target (string) --

      The target for the route.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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. Supported only for WebSocket APIs.
  • 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. Supported only for WebSocket APIs.

    • ResponseModels (dict) --

      Represents the response models of a route response.

      • (string) --

        • (string) --

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

    • ResponseParameters (dict) --

      Represents the response parameters of a route response.

      • (string) --

        • (dict) --

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) --

            Whether or not the parameter is required.

    • RouteResponseId (string) --

      Represents the identifier of a route response.

    • RouteResponseKey (string) --

      Represents the route response key of a route response.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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',
    AutoDeploy=True|False,
    ClientCertificateId='string',
    DefaultRouteSettings={
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'OFF',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    DeploymentId='string',
    Description='string',
    RouteSettings={
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'OFF',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    StageName='string',
    StageVariables={
        'string': 'string'
    },
    Tags={
        'string': 'string'
    }
)
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.

  • AutoDeploy (boolean) -- Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
  • ClientCertificateId (string) -- The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
  • 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. Supported only for WebSocket APIs.

    • DetailedMetricsEnabled (boolean) --

      Specifies whether detailed metrics are enabled.

    • LoggingLevel (string) --

      Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

    • ThrottlingBurstLimit (integer) --

      Specifies the throttling burst limit.

    • ThrottlingRateLimit (float) --

      Specifies the throttling rate limit.

  • DeploymentId (string) -- The deployment identifier of the API stage.
  • Description (string) -- The description for the API stage.
  • RouteSettings (dict) --

    Route settings for the stage, by routeKey.

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

        Represents a collection of route settings.

        • DataTraceEnabled (boolean) --

          Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

        • DetailedMetricsEnabled (boolean) --

          Specifies whether detailed metrics are enabled.

        • LoggingLevel (string) --

          Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

        • ThrottlingBurstLimit (integer) --

          Specifies the throttling burst limit.

        • ThrottlingRateLimit (float) --

          Specifies the throttling rate limit.

  • StageName (string) --

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

  • Tags (dict) --

    The collection of tags. Each tag element is associated with a given resource.

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

        A string with a length between [0-1600].

Return type

dict

Returns

Response Syntax

{
    'AccessLogSettings': {
        'DestinationArn': 'string',
        'Format': 'string'
    },
    'ApiGatewayManaged': True|False,
    'AutoDeploy': True|False,
    'ClientCertificateId': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'DefaultRouteSettings': {
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'OFF',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    'DeploymentId': 'string',
    'Description': 'string',
    'LastDeploymentStatusMessage': 'string',
    'LastUpdatedDate': datetime(2015, 1, 1),
    'RouteSettings': {
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'OFF',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    'StageName': 'string',
    'StageVariables': {
        'string': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • AccessLogSettings (dict) --

      Settings for logging access in this stage.

      • DestinationArn (string) --

        The ARN of the CloudWatch Logs log group to receive access logs.

      • Format (string) --

        A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

    • ApiGatewayManaged (boolean) --

      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

    • AutoDeploy (boolean) --

      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

    • ClientCertificateId (string) --

      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

    • CreatedDate (datetime) --

      The timestamp when the stage was created.

    • DefaultRouteSettings (dict) --

      Default route settings for the stage.

      • DataTraceEnabled (boolean) --

        Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

      • DetailedMetricsEnabled (boolean) --

        Specifies whether detailed metrics are enabled.

      • LoggingLevel (string) --

        Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

      • ThrottlingBurstLimit (integer) --

        Specifies the throttling burst limit.

      • ThrottlingRateLimit (float) --

        Specifies the throttling rate limit.

    • DeploymentId (string) --

      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

    • Description (string) --

      The description of the stage.

    • LastDeploymentStatusMessage (string) --

      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

    • LastUpdatedDate (datetime) --

      The timestamp when the stage was last updated.

    • RouteSettings (dict) --

      Route settings for the stage, by routeKey.

      • (string) --

        • (dict) --

          Represents a collection of route settings.

          • DataTraceEnabled (boolean) --

            Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • DetailedMetricsEnabled (boolean) --

            Specifies whether detailed metrics are enabled.

          • LoggingLevel (string) --

            Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • ThrottlingBurstLimit (integer) --

            Specifies the throttling burst limit.

          • ThrottlingRateLimit (float) --

            Specifies the throttling rate limit.

    • StageName (string) --

      The name of the stage.

    • StageVariables (dict) --

      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      • (string) --

        • (string) --

          A string with a length between [0-2048].

    • Tags (dict) --

      The collection of tags. Each tag element is associated with a given resource.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException

Creates a VPC link.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_link(
    Name='string',
    SecurityGroupIds=[
        'string',
    ],
    SubnetIds=[
        'string',
    ],
    Tags={
        'string': 'string'
    }
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the VPC link.

  • SecurityGroupIds (list) --

    A list of security group IDs for the VPC link.

    • (string) --
  • SubnetIds (list) --

    [REQUIRED]

    A list of subnet IDs to include in the VPC link.

    • (string) --
  • Tags (dict) --

    A list of tags.

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

        A string with a length between [0-1600].

Return type

dict

Returns

Response Syntax

{
    'CreatedDate': datetime(2015, 1, 1),
    'Name': 'string',
    'SecurityGroupIds': [
        'string',
    ],
    'SubnetIds': [
        'string',
    ],
    'Tags': {
        'string': 'string'
    },
    'VpcLinkId': 'string',
    'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
    'VpcLinkStatusMessage': 'string',
    'VpcLinkVersion': 'V2'
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • CreatedDate (datetime) --

      The timestamp when the VPC link was created.

    • Name (string) --

      The name of the VPC link.

    • SecurityGroupIds (list) --

      A list of security group IDs for the VPC link.

      • (string) --
    • SubnetIds (list) --

      A list of subnet IDs to include in the VPC link.

      • (string) --
    • Tags (dict) --

      Tags for the VPC link.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

    • VpcLinkId (string) --

      The ID of the VPC link.

    • VpcLinkStatus (string) --

      The status of the VPC link.

    • VpcLinkStatusMessage (string) --

      A message summarizing the cause of the status of the VPC link.

    • VpcLinkVersion (string) --

      The version of the VPC link.

Exceptions

  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
delete_access_log_settings(**kwargs)

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The API identifier.

  • StageName (string) --

    [REQUIRED]

    The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns

None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
delete_cors_configuration(**kwargs)

Deletes a CORS configuration.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The API identifier.

Returns
None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
delete_route_request_parameter(**kwargs)

Deletes a route request parameter.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The API identifier.

  • RequestParameterKey (string) --

    [REQUIRED]

    The route request parameter key.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

Returns

None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
delete_route_settings(**kwargs)

Deletes the RouteSettings for a stage.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The API identifier.

  • RouteKey (string) --

    [REQUIRED]

    The route key.

  • StageName (string) --

    [REQUIRED]

    The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns

None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns

None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException

Deletes a VPC link.

See also: AWS API Documentation

Request Syntax

response = client.delete_vpc_link(
    VpcLinkId='string'
)
Parameters
VpcLinkId (string) --

[REQUIRED]

The ID of the VPC link.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

    202 response

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
export_api(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.export_api(
    ApiId='string',
    ExportVersion='string',
    IncludeExtensions=True|False,
    OutputType='YAML'|'JSON',
    Specification='OAS30',
    StageName='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ExportVersion (string) -- The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
  • IncludeExtensions (boolean) -- Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
  • OutputType (string) --

    [REQUIRED]

    The output type of the exported definition file. Valid values are JSON and YAML.

  • Specification (string) --

    [REQUIRED]

    The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

  • StageName (string) -- The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
Return type

dict

Returns

Response Syntax

{
    'body': StreamingBody()
}

Response Structure

  • (dict) --

    Success

    • body (StreamingBody) --

      Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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',
    'ApiGatewayManaged': True|False,
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CorsConfiguration': {
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'DisableExecuteApiEndpoint': True|False,
    'ImportInfo': [
        'string',
    ],
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET'|'HTTP',
    'RouteSelectionExpression': 'string',
    'Tags': {
        'string': 'string'
    },
    'Version': 'string',
    'Warnings': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Success

    • ApiEndpoint (string) --

      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    • ApiGatewayManaged (boolean) --

      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    • ApiId (string) --

      The API ID.

    • ApiKeySelectionExpression (string) --

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • CorsConfiguration (dict) --

      A CORS configuration. Supported only for HTTP APIs.

      • AllowCredentials (boolean) --

        Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

      • AllowHeaders (list) --

        Represents a collection of allowed headers. Supported only for HTTP APIs.

        • (string) --
      • AllowMethods (list) --

        Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

        • (string) --

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

      • AllowOrigins (list) --

        Represents a collection of allowed origins. Supported only for HTTP APIs.

        • (string) --
      • ExposeHeaders (list) --

        Represents a collection of exposed headers. Supported only for HTTP APIs.

        • (string) --
      • MaxAge (integer) --

        The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

    • CreatedDate (datetime) --

      The timestamp when the API was created.

    • Description (string) --

      The description of the API.

    • DisableSchemaValidation (boolean) --

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • DisableExecuteApiEndpoint (boolean) --

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • ImportInfo (list) --

      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

      The name of the API.

    • ProtocolType (string) --

      The API protocol.

    • RouteSelectionExpression (string) --

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • Tags (dict) --

      A collection of tags associated with the API.

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

          A string with a length between [0-1600].

    • Version (string) --

      A version identifier for the API.

    • Warnings (list) --

      The warning messages reported when failonwarnings is turned on during API import.

      • (string) --

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
get_api_mapping(**kwargs)

Gets an 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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
get_api_mappings(**kwargs)

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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',
            'ApiGatewayManaged': True|False,
            'ApiId': 'string',
            'ApiKeySelectionExpression': 'string',
            'CorsConfiguration': {
                'AllowCredentials': True|False,
                'AllowHeaders': [
                    'string',
                ],
                'AllowMethods': [
                    'string',
                ],
                'AllowOrigins': [
                    'string',
                ],
                'ExposeHeaders': [
                    'string',
                ],
                'MaxAge': 123
            },
            'CreatedDate': datetime(2015, 1, 1),
            'Description': 'string',
            'DisableSchemaValidation': True|False,
            'DisableExecuteApiEndpoint': True|False,
            'ImportInfo': [
                'string',
            ],
            'Name': 'string',
            'ProtocolType': 'WEBSOCKET'|'HTTP',
            'RouteSelectionExpression': 'string',
            'Tags': {
                'string': 'string'
            },
            'Version': 'string',
            'Warnings': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an API.

        • ApiEndpoint (string) --

          The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

        • ApiGatewayManaged (boolean) --

          Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

        • ApiId (string) --

          The API ID.

        • ApiKeySelectionExpression (string) --

          An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

        • CorsConfiguration (dict) --

          A CORS configuration. Supported only for HTTP APIs.

          • AllowCredentials (boolean) --

            Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

          • AllowHeaders (list) --

            Represents a collection of allowed headers. Supported only for HTTP APIs.

            • (string) --
          • AllowMethods (list) --

            Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

            • (string) --

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

          • AllowOrigins (list) --

            Represents a collection of allowed origins. Supported only for HTTP APIs.

            • (string) --
          • ExposeHeaders (list) --

            Represents a collection of exposed headers. Supported only for HTTP APIs.

            • (string) --
          • MaxAge (integer) --

            The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

        • CreatedDate (datetime) --

          The timestamp when the API was created.

        • Description (string) --

          The description of the API.

        • DisableSchemaValidation (boolean) --

          Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

        • DisableExecuteApiEndpoint (boolean) --

          Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        • ImportInfo (list) --

          The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

          The name of the API.

        • ProtocolType (string) --

          The API protocol.

        • RouteSelectionExpression (string) --

          The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

        • Tags (dict) --

          A collection of tags associated with the API.

          • (string) --

            • (string) --

              A string with a length between [0-1600].

        • Version (string) --

          A version identifier for the API.

        • Warnings (list) --

          The warning messages reported when failonwarnings is turned on during API import.

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

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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',
    'AuthorizerPayloadFormatVersion': 'string',
    'AuthorizerResultTtlInSeconds': 123,
    'AuthorizerType': 'REQUEST'|'JWT',
    'AuthorizerUri': 'string',
    'EnableSimpleResponses': True|False,
    'IdentitySource': [
        'string',
    ],
    'IdentityValidationExpression': 'string',
    'JwtConfiguration': {
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) --

    Success

    • AuthorizerCredentialsArn (string) --

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

    • AuthorizerId (string) --

      The authorizer identifier.

    • AuthorizerPayloadFormatVersion (string) --

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    • AuthorizerResultTtlInSeconds (integer) --

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • AuthorizerType (string) --

      The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

    • 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. Supported only for REQUEST authorizers.

    • EnableSimpleResponses (boolean) --

      Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

    • IdentitySource (list) --

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

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

      The validation expression does not apply to the REQUEST authorizer.

    • JwtConfiguration (dict) --

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      • Audience (list) --

        A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

        The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Name (string) --

      The name of the authorizer.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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',
            'AuthorizerPayloadFormatVersion': 'string',
            'AuthorizerResultTtlInSeconds': 123,
            'AuthorizerType': 'REQUEST'|'JWT',
            'AuthorizerUri': 'string',
            'EnableSimpleResponses': True|False,
            'IdentitySource': [
                'string',
            ],
            'IdentityValidationExpression': 'string',
            'JwtConfiguration': {
                'Audience': [
                    'string',
                ],
                'Issuer': 'string'
            },
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an authorizer.

        • AuthorizerCredentialsArn (string) --

          Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

        • AuthorizerId (string) --

          The authorizer identifier.

        • AuthorizerPayloadFormatVersion (string) --

          Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

        • AuthorizerResultTtlInSeconds (integer) --

          The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

        • AuthorizerType (string) --

          The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

        • 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. Supported only for REQUEST authorizers.

        • EnableSimpleResponses (boolean) --

          Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

        • IdentitySource (list) --

          The identity source for which authorization is requested.

          For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

          For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

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

          The validation expression does not apply to the REQUEST authorizer.

        • JwtConfiguration (dict) --

          Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

          • Audience (list) --

            A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

            The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

        • Name (string) --

          The name of the authorizer.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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

{
    'AutoDeployed': True|False,
    'CreatedDate': datetime(2015, 1, 1),
    'DeploymentId': 'string',
    'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
    'DeploymentStatusMessage': 'string',
    'Description': 'string'
}

Response Structure

  • (dict) --

    Success

    • AutoDeployed (boolean) --

      Specifies whether a deployment was automatically released.

    • CreatedDate (datetime) --

      The date and time when the Deployment resource was created.

    • DeploymentId (string) --

      The identifier for the deployment.

    • DeploymentStatus (string) --

      The status of the deployment: PENDING, FAILED, or SUCCEEDED.

    • DeploymentStatusMessage (string) --

      May contain additional feedback on the status of an API deployment.

    • Description (string) --

      The description for the deployment.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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': [
        {
            'AutoDeployed': True|False,
            'CreatedDate': datetime(2015, 1, 1),
            'DeploymentId': 'string',
            'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
            'DeploymentStatusMessage': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

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

        • AutoDeployed (boolean) --

          Specifies whether a deployment was automatically released.

        • CreatedDate (datetime) --

          The date and time when the Deployment resource was created.

        • DeploymentId (string) --

          The identifier for the deployment.

        • DeploymentStatus (string) --

          The status of the deployment: PENDING, FAILED, or SUCCEEDED.

        • DeploymentStatusMessage (string) --

          May contain additional feedback on the status of an API deployment.

        • Description (string) --

          The description for the deployment.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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),
            'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage': 'string',
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'OwnershipVerificationCertificateArn': 'string'
        },
    ],
    'MutualTlsAuthentication': {
        'TruststoreUri': 'string',
        'TruststoreVersion': 'string',
        'TruststoreWarnings': [
            'string',
        ]
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • ApiMappingSelectionExpression (string) --

      The API mapping selection expression.

    • DomainName (string) --

      The name of the DomainName resource.

    • DomainNameConfigurations (list) --

      The domain name configurations.

      • (dict) --

        The domain name configuration.

        • ApiGatewayDomainName (string) --

          A domain name for the API.

        • CertificateArn (string) --

          An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

        • CertificateName (string) --

          The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

        • CertificateUploadDate (datetime) --

          The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

        • DomainNameStatus (string) --

          The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

        • DomainNameStatusMessage (string) --

          An optional text message containing detailed information about status of the domain name migration.

        • EndpointType (string) --

          The endpoint type.

        • HostedZoneId (string) --

          The Amazon Route 53 Hosted Zone ID of the endpoint.

        • SecurityPolicy (string) --

          The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

        • OwnershipVerificationCertificateArn (string) --

          The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

    • MutualTlsAuthentication (dict) --

      The mutual TLS authentication configuration for a custom domain name.

      • TruststoreUri (string) --

        An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

      • TruststoreVersion (string) --

        The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

      • TruststoreWarnings (list) --

        A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

        • (string) --
    • Tags (dict) --

      The collection of tags associated with a domain name.

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

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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),
                    'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
                    'DomainNameStatusMessage': 'string',
                    'EndpointType': 'REGIONAL'|'EDGE',
                    'HostedZoneId': 'string',
                    'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
                    'OwnershipVerificationCertificateArn': 'string'
                },
            ],
            'MutualTlsAuthentication': {
                'TruststoreUri': 'string',
                'TruststoreVersion': 'string',
                'TruststoreWarnings': [
                    'string',
                ]
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a domain name.

        • ApiMappingSelectionExpression (string) --

          The API mapping selection expression.

        • DomainName (string) --

          The name of the DomainName resource.

        • DomainNameConfigurations (list) --

          The domain name configurations.

          • (dict) --

            The domain name configuration.

            • ApiGatewayDomainName (string) --

              A domain name for the API.

            • CertificateArn (string) --

              An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

            • CertificateName (string) --

              The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

            • CertificateUploadDate (datetime) --

              The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

            • DomainNameStatus (string) --

              The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

            • DomainNameStatusMessage (string) --

              An optional text message containing detailed information about status of the domain name migration.

            • EndpointType (string) --

              The endpoint type.

            • HostedZoneId (string) --

              The Amazon Route 53 Hosted Zone ID of the endpoint.

            • SecurityPolicy (string) --

              The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

            • OwnershipVerificationCertificateArn (string) --

              The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

        • MutualTlsAuthentication (dict) --

          The mutual TLS authentication configuration for a custom domain name.

          • TruststoreUri (string) --

            An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

          • TruststoreVersion (string) --

            The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

          • TruststoreWarnings (list) --

            A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

            • (string) --
        • Tags (dict) --

          The collection of tags associated with a domain name.

          • (string) --

            • (string) --

              A string with a length between [0-1600].

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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

{
    'ApiGatewayManaged': True|False,
    'ConnectionId': 'string',
    'ConnectionType': 'INTERNET'|'VPC_LINK',
    'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    'CredentialsArn': 'string',
    'Description': 'string',
    'IntegrationId': 'string',
    'IntegrationMethod': 'string',
    'IntegrationResponseSelectionExpression': 'string',
    'IntegrationSubtype': 'string',
    'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    'IntegrationUri': 'string',
    'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    'PayloadFormatVersion': 'string',
    'RequestParameters': {
        'string': 'string'
    },
    'RequestTemplates': {
        'string': 'string'
    },
    'ResponseParameters': {
        'string': {
            'string': 'string'
        }
    },
    'TemplateSelectionExpression': 'string',
    'TimeoutInMillis': 123,
    'TlsConfig': {
        'ServerNameToVerify': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • ApiGatewayManaged (boolean) --

      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

    • ConnectionId (string) --

      The ID of the VPC link for a private integration. Supported only for HTTP APIs.

    • ConnectionType (string) --

      The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

    • ContentHandlingStrategy (string) --

      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • CredentialsArn (string) --

      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.

    • Description (string) --

      Represents the description of an integration.

    • IntegrationId (string) --

      Represents the identifier of an integration.

    • IntegrationMethod (string) --

      Specifies the integration's HTTP method type.

    • IntegrationResponseSelectionExpression (string) --

      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

    • IntegrationSubtype (string) --

      Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

    • IntegrationType (string) --

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

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

      AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

    • IntegrationUri (string) --

      For a Lambda integration, specify the URI of a Lambda function.

      For an HTTP integration, specify a fully-qualified URL.

      For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

    • PassthroughBehavior (string) --

      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

      WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

      NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

      WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    • PayloadFormatVersion (string) --

      Specifies the format of the payload sent to an integration. Required for HTTP APIs.

    • RequestParameters (dict) --

      For WebSocket APIs, 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.

      For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

      For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

      • (string) --

        • (string) --

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

    • RequestTemplates (dict) --

      Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

      • (string) --

        • (string) --

          A string with a length between [0-32768].

    • ResponseParameters (dict) --

      Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

      • (string) --

        • (dict) --

          For WebSocket APIs, 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.

          For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

          For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (string) --

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

    • TemplateSelectionExpression (string) --

      The template selection expression for the integration. Supported only for WebSocket APIs.

    • TimeoutInMillis (integer) --

      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

    • TlsConfig (dict) --

      The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

      • ServerNameToVerify (string) --

        If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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) --

      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • IntegrationResponseId (string) --

      The integration response ID.

    • IntegrationResponseKey (string) --

      The integration response key.

    • ResponseParameters (dict) --

      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

      • (string) --

        • (string) --

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

    • ResponseTemplates (dict) --

      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

      • (string) --

        • (string) --

          A string with a length between [0-32768].

    • TemplateSelectionExpression (string) --

      The template selection expressions for the integration response.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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) --

          Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

          CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

          CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

          If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

        • IntegrationResponseId (string) --

          The integration response ID.

        • IntegrationResponseKey (string) --

          The integration response key.

        • ResponseParameters (dict) --

          A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

          • (string) --

            • (string) --

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

        • ResponseTemplates (dict) --

          The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

          • (string) --

            • (string) --

              A string with a length between [0-32768].

        • TemplateSelectionExpression (string) --

          The template selection expressions for the integration response.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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': [
        {
            'ApiGatewayManaged': True|False,
            'ConnectionId': 'string',
            'ConnectionType': 'INTERNET'|'VPC_LINK',
            'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
            'CredentialsArn': 'string',
            'Description': 'string',
            'IntegrationId': 'string',
            'IntegrationMethod': 'string',
            'IntegrationResponseSelectionExpression': 'string',
            'IntegrationSubtype': 'string',
            'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
            'IntegrationUri': 'string',
            'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
            'PayloadFormatVersion': 'string',
            'RequestParameters': {
                'string': 'string'
            },
            'RequestTemplates': {
                'string': 'string'
            },
            'ResponseParameters': {
                'string': {
                    'string': 'string'
                }
            },
            'TemplateSelectionExpression': 'string',
            'TimeoutInMillis': 123,
            'TlsConfig': {
                'ServerNameToVerify': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an integration.

        • ApiGatewayManaged (boolean) --

          Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

        • ConnectionId (string) --

          The ID of the VPC link for a private integration. Supported only for HTTP APIs.

        • ConnectionType (string) --

          The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

        • ContentHandlingStrategy (string) --

          Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

          CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

          CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

          If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

        • CredentialsArn (string) --

          Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.

        • Description (string) --

          Represents the description of an integration.

        • IntegrationId (string) --

          Represents the identifier of an integration.

        • IntegrationMethod (string) --

          Specifies the integration's HTTP method type.

        • IntegrationResponseSelectionExpression (string) --

          The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

        • IntegrationSubtype (string) --

          Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

        • IntegrationType (string) --

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

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

          AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

        • IntegrationUri (string) --

          For a Lambda integration, specify the URI of a Lambda function.

          For an HTTP integration, specify a fully-qualified URL.

          For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

        • PassthroughBehavior (string) --

          Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

          WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

          NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

          WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

        • PayloadFormatVersion (string) --

          Specifies the format of the payload sent to an integration. Required for HTTP APIs.

        • RequestParameters (dict) --

          For WebSocket APIs, 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.

          For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

          For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (string) --

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

        • RequestTemplates (dict) --

          Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

          • (string) --

            • (string) --

              A string with a length between [0-32768].

        • ResponseParameters (dict) --

          Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (dict) --

              For WebSocket APIs, 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.

              For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

              For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

              • (string) --

                • (string) --

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

        • TemplateSelectionExpression (string) --

          The template selection expression for the integration. Supported only for WebSocket APIs.

        • TimeoutInMillis (integer) --

          Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

        • TlsConfig (dict) --

          The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

          • ServerNameToVerify (string) --

            If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

        • ContentType (string) --

          The content-type for the model, for example, "application/json".

        • Description (string) --

          The description of the model.

        • ModelId (string) --

          The model identifier.

        • Name (string) --

          The name of the model. Must be alphanumeric.

        • Schema (string) --

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

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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

{
    'ApiGatewayManaged': True|False,
    'ApiKeyRequired': True|False,
    'AuthorizationScopes': [
        'string',
    ],
    'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
    'AuthorizerId': 'string',
    'ModelSelectionExpression': 'string',
    'OperationName': 'string',
    'RequestModels': {
        'string': 'string'
    },
    'RequestParameters': {
        'string': {
            'Required': True|False
        }
    },
    'RouteId': 'string',
    'RouteKey': 'string',
    'RouteResponseSelectionExpression': 'string',
    'Target': 'string'
}

Response Structure

  • (dict) --

    Success

    • ApiGatewayManaged (boolean) --

      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

    • ApiKeyRequired (boolean) --

      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

    • AuthorizationScopes (list) --

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

      • (string) --

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

    • AuthorizationType (string) --

      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.

    • ModelSelectionExpression (string) --

      The model selection expression for the route. Supported only for WebSocket APIs.

    • OperationName (string) --

      The operation name for the route.

    • RequestModels (dict) --

      The request models for the route. Supported only for WebSocket APIs.

      • (string) --

        • (string) --

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

    • RequestParameters (dict) --

      The request parameters for the route. Supported only for WebSocket APIs.

      • (string) --

        • (dict) --

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) --

            Whether or not the parameter is required.

    • RouteId (string) --

      The route ID.

    • RouteKey (string) --

      The route key for the route.

    • RouteResponseSelectionExpression (string) --

      The route response selection expression for the route. Supported only for WebSocket APIs.

    • Target (string) --

      The target for the route.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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. Supported only for WebSocket APIs.

    • ResponseModels (dict) --

      Represents the response models of a route response.

      • (string) --

        • (string) --

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

    • ResponseParameters (dict) --

      Represents the response parameters of a route response.

      • (string) --

        • (dict) --

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) --

            Whether or not the parameter is required.

    • RouteResponseId (string) --

      Represents the identifier of a route response.

    • RouteResponseKey (string) --

      Represents the route response key of a route response.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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. Supported only for WebSocket APIs.

        • ResponseModels (dict) --

          Represents the response models of a route response.

          • (string) --

            • (string) --

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

        • ResponseParameters (dict) --

          Represents the response parameters of a route response.

          • (string) --

            • (dict) --

              Validation constraints imposed on parameters of a request (path, query string, headers).

              • Required (boolean) --

                Whether or not the parameter is required.

        • RouteResponseId (string) --

          Represents the identifier of a route response.

        • RouteResponseKey (string) --

          Represents the route response key of a route response.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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': [
        {
            'ApiGatewayManaged': True|False,
            'ApiKeyRequired': True|False,
            'AuthorizationScopes': [
                'string',
            ],
            'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
            'AuthorizerId': 'string',
            'ModelSelectionExpression': 'string',
            'OperationName': 'string',
            'RequestModels': {
                'string': 'string'
            },
            'RequestParameters': {
                'string': {
                    'Required': True|False
                }
            },
            'RouteId': 'string',
            'RouteKey': 'string',
            'RouteResponseSelectionExpression': 'string',
            'Target': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a route.

        • ApiGatewayManaged (boolean) --

          Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

        • ApiKeyRequired (boolean) --

          Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

        • AuthorizationScopes (list) --

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

          • (string) --

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

        • AuthorizationType (string) --

          The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.

        • ModelSelectionExpression (string) --

          The model selection expression for the route. Supported only for WebSocket APIs.

        • OperationName (string) --

          The operation name for the route.

        • RequestModels (dict) --

          The request models for the route. Supported only for WebSocket APIs.

          • (string) --

            • (string) --

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

        • RequestParameters (dict) --

          The request parameters for the route. Supported only for WebSocket APIs.

          • (string) --

            • (dict) --

              Validation constraints imposed on parameters of a request (path, query string, headers).

              • Required (boolean) --

                Whether or not the parameter is required.

        • RouteId (string) --

          The route ID.

        • RouteKey (string) --

          The route key for the route.

        • RouteResponseSelectionExpression (string) --

          The route response selection expression for the route. Supported only for WebSocket APIs.

        • Target (string) --

          The target for the route.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
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. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Return type

dict

Returns

Response Syntax

{
    'AccessLogSettings': {
        'DestinationArn': 'string',
        'Format': 'string'
    },
    'ApiGatewayManaged': True|False,
    'AutoDeploy': True|False,
    'ClientCertificateId': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'DefaultRouteSettings': {
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'OFF',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    'DeploymentId': 'string',
    'Description': 'string',
    'LastDeploymentStatusMessage': 'string',
    'LastUpdatedDate': datetime(2015, 1, 1),
    'RouteSettings': {
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'OFF',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    'StageName': 'string',
    'StageVariables': {
        'string': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • AccessLogSettings (dict) --

      Settings for logging access in this stage.

      • DestinationArn (string) --

        The ARN of the CloudWatch Logs log group to receive access logs.

      • Format (string) --

        A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

    • ApiGatewayManaged (boolean) --

      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

    • AutoDeploy (boolean) --

      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

    • ClientCertificateId (string) --

      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

    • CreatedDate (datetime) --

      The timestamp when the stage was created.

    • DefaultRouteSettings (dict) --

      Default route settings for the stage.

      • DataTraceEnabled (boolean) --

        Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

      • DetailedMetricsEnabled (boolean) --

        Specifies whether detailed metrics are enabled.

      • LoggingLevel (string) --

        Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

      • ThrottlingBurstLimit (integer) --

        Specifies the throttling burst limit.

      • ThrottlingRateLimit (float) --

        Specifies the throttling rate limit.

    • DeploymentId (string) --

      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

    • Description (string) --

      The description of the stage.

    • LastDeploymentStatusMessage (string) --

      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

    • LastUpdatedDate (datetime) --

      The timestamp when the stage was last updated.

    • RouteSettings (dict) --

      Route settings for the stage, by routeKey.

      • (string) --

        • (dict) --

          Represents a collection of route settings.

          • DataTraceEnabled (boolean) --

            Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • DetailedMetricsEnabled (boolean) --

            Specifies whether detailed metrics are enabled.

          • LoggingLevel (string) --

            Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • ThrottlingBurstLimit (integer) --

            Specifies the throttling burst limit.

          • ThrottlingRateLimit (float) --

            Specifies the throttling rate limit.

    • StageName (string) --

      The name of the stage.

    • StageVariables (dict) --

      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      • (string) --

        • (string) --

          A string with a length between [0-2048].

    • Tags (dict) --

      The collection of tags. Each tag element is associated with a given resource.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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'
            },
            'ApiGatewayManaged': True|False,
            'AutoDeploy': True|False,
            'ClientCertificateId': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'DefaultRouteSettings': {
                'DataTraceEnabled': True|False,
                'DetailedMetricsEnabled': True|False,
                'LoggingLevel': 'ERROR'|'INFO'|'OFF',
                'ThrottlingBurstLimit': 123,
                'ThrottlingRateLimit': 123.0
            },
            'DeploymentId': 'string',
            'Description': 'string',
            'LastDeploymentStatusMessage': 'string',
            'LastUpdatedDate': datetime(2015, 1, 1),
            'RouteSettings': {
                'string': {
                    'DataTraceEnabled': True|False,
                    'DetailedMetricsEnabled': True|False,
                    'LoggingLevel': 'ERROR'|'INFO'|'OFF',
                    'ThrottlingBurstLimit': 123,
                    'ThrottlingRateLimit': 123.0
                }
            },
            'StageName': 'string',
            'StageVariables': {
                'string': 'string'
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an API stage.

        • AccessLogSettings (dict) --

          Settings for logging access in this stage.

          • DestinationArn (string) --

            The ARN of the CloudWatch Logs log group to receive access logs.

          • Format (string) --

            A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

        • ApiGatewayManaged (boolean) --

          Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

        • AutoDeploy (boolean) --

          Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

        • ClientCertificateId (string) --

          The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

        • CreatedDate (datetime) --

          The timestamp when the stage was created.

        • DefaultRouteSettings (dict) --

          Default route settings for the stage.

          • DataTraceEnabled (boolean) --

            Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • DetailedMetricsEnabled (boolean) --

            Specifies whether detailed metrics are enabled.

          • LoggingLevel (string) --

            Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • ThrottlingBurstLimit (integer) --

            Specifies the throttling burst limit.

          • ThrottlingRateLimit (float) --

            Specifies the throttling rate limit.

        • DeploymentId (string) --

          The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

        • Description (string) --

          The description of the stage.

        • LastDeploymentStatusMessage (string) --

          Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

        • LastUpdatedDate (datetime) --

          The timestamp when the stage was last updated.

        • RouteSettings (dict) --

          Route settings for the stage, by routeKey.

          • (string) --

            • (dict) --

              Represents a collection of route settings.

              • DataTraceEnabled (boolean) --

                Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

              • DetailedMetricsEnabled (boolean) --

                Specifies whether detailed metrics are enabled.

              • LoggingLevel (string) --

                Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

              • ThrottlingBurstLimit (integer) --

                Specifies the throttling burst limit.

              • ThrottlingRateLimit (float) --

                Specifies the throttling rate limit.

        • StageName (string) --

          The name of the stage.

        • StageVariables (dict) --

          A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

          • (string) --

            • (string) --

              A string with a length between [0-2048].

        • Tags (dict) --

          The collection of tags. Each tag element is associated with a given resource.

          • (string) --

            • (string) --

              A string with a length between [0-1600].

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
get_tags(**kwargs)

Gets a collection of Tag resources.

See also: AWS API Documentation

Request Syntax

response = client.get_tags(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The resource ARN for the tag.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • Tags (dict) --

      Represents a collection of tags associated with the resource.

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

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException

Gets a VPC link.

See also: AWS API Documentation

Request Syntax

response = client.get_vpc_link(
    VpcLinkId='string'
)
Parameters
VpcLinkId (string) --

[REQUIRED]

The ID of the VPC link.

Return type
dict
Returns
Response Syntax
{
    'CreatedDate': datetime(2015, 1, 1),
    'Name': 'string',
    'SecurityGroupIds': [
        'string',
    ],
    'SubnetIds': [
        'string',
    ],
    'Tags': {
        'string': 'string'
    },
    'VpcLinkId': 'string',
    'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
    'VpcLinkStatusMessage': 'string',
    'VpcLinkVersion': 'V2'
}

Response Structure

  • (dict) --

    Success

    • CreatedDate (datetime) --

      The timestamp when the VPC link was created.

    • Name (string) --

      The name of the VPC link.

    • SecurityGroupIds (list) --

      A list of security group IDs for the VPC link.

      • (string) --
    • SubnetIds (list) --

      A list of subnet IDs to include in the VPC link.

      • (string) --
    • Tags (dict) --

      Tags for the VPC link.

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

          A string with a length between [0-1600].

    • VpcLinkId (string) --

      The ID of the VPC link.

    • VpcLinkStatus (string) --

      The status of the VPC link.

    • VpcLinkStatusMessage (string) --

      A message summarizing the cause of the status of the VPC link.

    • VpcLinkVersion (string) --

      The version of the VPC link.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException

Gets a collection of VPC links.

See also: AWS API Documentation

Request Syntax

response = client.get_vpc_links(
    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': [
        {
            'CreatedDate': datetime(2015, 1, 1),
            'Name': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ],
            'Tags': {
                'string': 'string'
            },
            'VpcLinkId': 'string',
            'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
            'VpcLinkStatusMessage': 'string',
            'VpcLinkVersion': 'V2'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      A collection of VPC links.

      • (dict) --

        Represents a VPC link.

        • CreatedDate (datetime) --

          The timestamp when the VPC link was created.

        • Name (string) --

          The name of the VPC link.

        • SecurityGroupIds (list) --

          A list of security group IDs for the VPC link.

          • (string) --
        • SubnetIds (list) --

          A list of subnet IDs to include in the VPC link.

          • (string) --
        • Tags (dict) --

          Tags for the VPC link.

          • (string) --

            • (string) --

              A string with a length between [0-1600].

        • VpcLinkId (string) --

          The ID of the VPC link.

        • VpcLinkStatus (string) --

          The status of the VPC link.

        • VpcLinkStatusMessage (string) --

          A message summarizing the cause of the status of the VPC link.

        • VpcLinkVersion (string) --

          The version of the VPC link.

    • NextToken (string) --

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

Exceptions

  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
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
import_api(**kwargs)

Imports an API.

See also: AWS API Documentation

Request Syntax

response = client.import_api(
    Basepath='string',
    Body='string',
    FailOnWarnings=True|False
)
Parameters
  • Basepath (string) -- Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
  • Body (string) --

    [REQUIRED]

    The OpenAPI definition. Supported only for HTTP APIs.

  • FailOnWarnings (boolean) -- Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
Return type

dict

Returns

Response Syntax

{
    'ApiEndpoint': 'string',
    'ApiGatewayManaged': True|False,
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CorsConfiguration': {
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'DisableExecuteApiEndpoint': True|False,
    'ImportInfo': [
        'string',
    ],
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET'|'HTTP',
    'RouteSelectionExpression': 'string',
    'Tags': {
        'string': 'string'
    },
    'Version': 'string',
    'Warnings': [
        'string',
    ]
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • ApiEndpoint (string) --

      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    • ApiGatewayManaged (boolean) --

      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    • ApiId (string) --

      The API ID.

    • ApiKeySelectionExpression (string) --

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • CorsConfiguration (dict) --

      A CORS configuration. Supported only for HTTP APIs.

      • AllowCredentials (boolean) --

        Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

      • AllowHeaders (list) --

        Represents a collection of allowed headers. Supported only for HTTP APIs.

        • (string) --
      • AllowMethods (list) --

        Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

        • (string) --

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

      • AllowOrigins (list) --

        Represents a collection of allowed origins. Supported only for HTTP APIs.

        • (string) --
      • ExposeHeaders (list) --

        Represents a collection of exposed headers. Supported only for HTTP APIs.

        • (string) --
      • MaxAge (integer) --

        The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

    • CreatedDate (datetime) --

      The timestamp when the API was created.

    • Description (string) --

      The description of the API.

    • DisableSchemaValidation (boolean) --

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • DisableExecuteApiEndpoint (boolean) --

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • ImportInfo (list) --

      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

      The name of the API.

    • ProtocolType (string) --

      The API protocol.

    • RouteSelectionExpression (string) --

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • Tags (dict) --

      A collection of tags associated with the API.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

    • Version (string) --

      A version identifier for the API.

    • Warnings (list) --

      The warning messages reported when failonwarnings is turned on during API import.

      • (string) --

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
reimport_api(**kwargs)

Puts an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.reimport_api(
    ApiId='string',
    Basepath='string',
    Body='string',
    FailOnWarnings=True|False
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • Basepath (string) -- Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
  • Body (string) --

    [REQUIRED]

    The OpenAPI definition. Supported only for HTTP APIs.

  • FailOnWarnings (boolean) -- Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
Return type

dict

Returns

Response Syntax

{
    'ApiEndpoint': 'string',
    'ApiGatewayManaged': True|False,
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CorsConfiguration': {
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'DisableExecuteApiEndpoint': True|False,
    'ImportInfo': [
        'string',
    ],
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET'|'HTTP',
    'RouteSelectionExpression': 'string',
    'Tags': {
        'string': 'string'
    },
    'Version': 'string',
    'Warnings': [
        'string',
    ]
}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

    • ApiEndpoint (string) --

      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    • ApiGatewayManaged (boolean) --

      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    • ApiId (string) --

      The API ID.

    • ApiKeySelectionExpression (string) --

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • CorsConfiguration (dict) --

      A CORS configuration. Supported only for HTTP APIs.

      • AllowCredentials (boolean) --

        Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

      • AllowHeaders (list) --

        Represents a collection of allowed headers. Supported only for HTTP APIs.

        • (string) --
      • AllowMethods (list) --

        Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

        • (string) --

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

      • AllowOrigins (list) --

        Represents a collection of allowed origins. Supported only for HTTP APIs.

        • (string) --
      • ExposeHeaders (list) --

        Represents a collection of exposed headers. Supported only for HTTP APIs.

        • (string) --
      • MaxAge (integer) --

        The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

    • CreatedDate (datetime) --

      The timestamp when the API was created.

    • Description (string) --

      The description of the API.

    • DisableSchemaValidation (boolean) --

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • DisableExecuteApiEndpoint (boolean) --

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • ImportInfo (list) --

      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

      The name of the API.

    • ProtocolType (string) --

      The API protocol.

    • RouteSelectionExpression (string) --

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • Tags (dict) --

      A collection of tags associated with the API.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

    • Version (string) --

      A version identifier for the API.

    • Warnings (list) --

      The warning messages reported when failonwarnings is turned on during API import.

      • (string) --

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
reset_authorizers_cache(**kwargs)

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The API identifier.

  • StageName (string) --

    [REQUIRED]

    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Returns

None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
tag_resource(**kwargs)

Creates a new Tag resource to represent a tag.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The resource ARN for the tag.

  • Tags (dict) --

    The collection of tags. Each tag element is associated with a given resource.

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

        A string with a length between [0-1600].

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

    The request has succeeded and has resulted in the creation of a resource.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
untag_resource(**kwargs)

Deletes a Tag.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The resource ARN for the tag.

  • TagKeys (list) --

    [REQUIRED]

    The Tag keys to delete

    • (string) --
Returns

None

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
update_api(**kwargs)

Updates an Api resource.

See also: AWS API Documentation

Request Syntax

response = client.update_api(
    ApiId='string',
    ApiKeySelectionExpression='string',
    CorsConfiguration={
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    CredentialsArn='string',
    Description='string',
    DisableSchemaValidation=True|False,
    DisableExecuteApiEndpoint=True|False,
    Name='string',
    RouteKey='string',
    RouteSelectionExpression='string',
    Target='string',
    Version='string'
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ApiKeySelectionExpression (string) -- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
  • CorsConfiguration (dict) --

    A CORS configuration. Supported only for HTTP APIs.

    • AllowCredentials (boolean) --

      Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

    • AllowHeaders (list) --

      Represents a collection of allowed headers. Supported only for HTTP APIs.

      • (string) --
    • AllowMethods (list) --

      Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

      • (string) --

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

    • AllowOrigins (list) --

      Represents a collection of allowed origins. Supported only for HTTP APIs.

      • (string) --
    • ExposeHeaders (list) --

      Represents a collection of exposed headers. Supported only for HTTP APIs.

      • (string) --
    • MaxAge (integer) --

      The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

  • CredentialsArn (string) -- This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
  • Description (string) -- The description of the API.
  • DisableSchemaValidation (boolean) -- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
  • DisableExecuteApiEndpoint (boolean) -- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
  • Name (string) -- The name of the API.
  • RouteKey (string) -- This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
  • RouteSelectionExpression (string) -- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
  • Target (string) -- This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
  • Version (string) -- A version identifier for the API.
Return type

dict

Returns

Response Syntax

{
    'ApiEndpoint': 'string',
    'ApiGatewayManaged': True|False,
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CorsConfiguration': {
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'DisableExecuteApiEndpoint': True|False,
    'ImportInfo': [
        'string',
    ],
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET'|'HTTP',
    'RouteSelectionExpression': 'string',
    'Tags': {
        'string': 'string'
    },
    'Version': 'string',
    'Warnings': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Success

    • ApiEndpoint (string) --

      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

    • ApiGatewayManaged (boolean) --

      Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

    • ApiId (string) --

      The API ID.

    • ApiKeySelectionExpression (string) --

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • CorsConfiguration (dict) --

      A CORS configuration. Supported only for HTTP APIs.

      • AllowCredentials (boolean) --

        Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

      • AllowHeaders (list) --

        Represents a collection of allowed headers. Supported only for HTTP APIs.

        • (string) --
      • AllowMethods (list) --

        Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

        • (string) --

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

      • AllowOrigins (list) --

        Represents a collection of allowed origins. Supported only for HTTP APIs.

        • (string) --
      • ExposeHeaders (list) --

        Represents a collection of exposed headers. Supported only for HTTP APIs.

        • (string) --
      • MaxAge (integer) --

        The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

    • CreatedDate (datetime) --

      The timestamp when the API was created.

    • Description (string) --

      The description of the API.

    • DisableSchemaValidation (boolean) --

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • DisableExecuteApiEndpoint (boolean) --

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • ImportInfo (list) --

      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

      The name of the API.

    • ProtocolType (string) --

      The API protocol.

    • RouteSelectionExpression (string) --

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • Tags (dict) --

      A collection of tags associated with the API.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

    • Version (string) --

      A version identifier for the API.

    • Warnings (list) --

      The warning messages reported when failonwarnings is turned on during API import.

      • (string) --

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
update_authorizer(**kwargs)

Updates an Authorizer.

See also: AWS API Documentation

Request Syntax

response = client.update_authorizer(
    ApiId='string',
    AuthorizerCredentialsArn='string',
    AuthorizerId='string',
    AuthorizerPayloadFormatVersion='string',
    AuthorizerResultTtlInSeconds=123,
    AuthorizerType='REQUEST'|'JWT',
    AuthorizerUri='string',
    EnableSimpleResponses=True|False,
    IdentitySource=[
        'string',
    ],
    IdentityValidationExpression='string',
    JwtConfiguration={
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    Name='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, don't specify this parameter.
  • AuthorizerId (string) --

    [REQUIRED]

    The authorizer identifier.

  • AuthorizerPayloadFormatVersion (string) -- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
  • AuthorizerResultTtlInSeconds (integer) -- The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
  • AuthorizerType (string) -- The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
  • 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. Supported only for REQUEST authorizers.
  • EnableSimpleResponses (boolean) -- Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
  • IdentitySource (list) --

    The identity source for which authorization is requested.

    For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

    • (string) --
  • IdentityValidationExpression (string) -- This parameter is not used.
  • JwtConfiguration (dict) --

    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Audience (list) --

      A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

      The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • Name (string) -- The name of the authorizer.
Return type

dict

Returns

Response Syntax

{
    'AuthorizerCredentialsArn': 'string',
    'AuthorizerId': 'string',
    'AuthorizerPayloadFormatVersion': 'string',
    'AuthorizerResultTtlInSeconds': 123,
    'AuthorizerType': 'REQUEST'|'JWT',
    'AuthorizerUri': 'string',
    'EnableSimpleResponses': True|False,
    'IdentitySource': [
        'string',
    ],
    'IdentityValidationExpression': 'string',
    'JwtConfiguration': {
        'Audience': [
            'string',
        ],
        'Issuer': 'string'
    },
    'Name': 'string'
}

Response Structure

  • (dict) --

    Success

    • AuthorizerCredentialsArn (string) --

      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

    • AuthorizerId (string) --

      The authorizer identifier.

    • AuthorizerPayloadFormatVersion (string) --

      Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    • AuthorizerResultTtlInSeconds (integer) --

      The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

    • AuthorizerType (string) --

      The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

    • 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. Supported only for REQUEST authorizers.

    • EnableSimpleResponses (boolean) --

      Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

    • IdentitySource (list) --

      The identity source for which authorization is requested.

      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

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

      The validation expression does not apply to the REQUEST authorizer.

    • JwtConfiguration (dict) --

      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

      • Audience (list) --

        A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

        The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

    • Name (string) --

      The name of the authorizer.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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

{
    'AutoDeployed': True|False,
    'CreatedDate': datetime(2015, 1, 1),
    'DeploymentId': 'string',
    'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
    'DeploymentStatusMessage': 'string',
    'Description': 'string'
}

Response Structure

  • (dict) --

    Success

    • AutoDeployed (boolean) --

      Specifies whether a deployment was automatically released.

    • CreatedDate (datetime) --

      The date and time when the Deployment resource was created.

    • DeploymentId (string) --

      The identifier for the deployment.

    • DeploymentStatus (string) --

      The status of the deployment: PENDING, FAILED, or SUCCEEDED.

    • DeploymentStatusMessage (string) --

      May contain additional feedback on the status of an API deployment.

    • Description (string) --

      The description for the deployment.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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),
            'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage': 'string',
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'OwnershipVerificationCertificateArn': 'string'
        },
    ],
    MutualTlsAuthentication={
        'TruststoreUri': 'string',
        'TruststoreVersion': '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 API.

      • CertificateArn (string) --

        An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

      • CertificateName (string) --

        The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

      • CertificateUploadDate (datetime) --

        The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

      • DomainNameStatus (string) --

        The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

      • DomainNameStatusMessage (string) --

        An optional text message containing detailed information about status of the domain name migration.

      • EndpointType (string) --

        The endpoint type.

      • HostedZoneId (string) --

        The Amazon Route 53 Hosted Zone ID of the endpoint.

      • SecurityPolicy (string) --

        The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

      • OwnershipVerificationCertificateArn (string) --

        The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

  • MutualTlsAuthentication (dict) --

    The mutual TLS authentication configuration for a custom domain name.

    • TruststoreUri (string) --

      An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

    • TruststoreVersion (string) --

      The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

Return type

dict

Returns

Response Syntax

{
    'ApiMappingSelectionExpression': 'string',
    'DomainName': 'string',
    'DomainNameConfigurations': [
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
            'DomainNameStatusMessage': 'string',
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'OwnershipVerificationCertificateArn': 'string'
        },
    ],
    'MutualTlsAuthentication': {
        'TruststoreUri': 'string',
        'TruststoreVersion': 'string',
        'TruststoreWarnings': [
            'string',
        ]
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • ApiMappingSelectionExpression (string) --

      The API mapping selection expression.

    • DomainName (string) --

      The name of the DomainName resource.

    • DomainNameConfigurations (list) --

      The domain name configurations.

      • (dict) --

        The domain name configuration.

        • ApiGatewayDomainName (string) --

          A domain name for the API.

        • CertificateArn (string) --

          An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

        • CertificateName (string) --

          The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

        • CertificateUploadDate (datetime) --

          The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

        • DomainNameStatus (string) --

          The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

        • DomainNameStatusMessage (string) --

          An optional text message containing detailed information about status of the domain name migration.

        • EndpointType (string) --

          The endpoint type.

        • HostedZoneId (string) --

          The Amazon Route 53 Hosted Zone ID of the endpoint.

        • SecurityPolicy (string) --

          The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

        • OwnershipVerificationCertificateArn (string) --

          The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

    • MutualTlsAuthentication (dict) --

      The mutual TLS authentication configuration for a custom domain name.

      • TruststoreUri (string) --

        An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

      • TruststoreVersion (string) --

        The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

      • TruststoreWarnings (list) --

        A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

        • (string) --
    • Tags (dict) --

      The collection of tags associated with a domain name.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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',
    IntegrationSubtype='string',
    IntegrationType='AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    IntegrationUri='string',
    PassthroughBehavior='WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    PayloadFormatVersion='string',
    RequestParameters={
        'string': 'string'
    },
    RequestTemplates={
        'string': 'string'
    },
    ResponseParameters={
        'string': {
            'string': 'string'
        }
    },
    TemplateSelectionExpression='string',
    TimeoutInMillis=123,
    TlsConfig={
        'ServerNameToVerify': 'string'
    }
)
Parameters
  • ApiId (string) --

    [REQUIRED]

    The API identifier.

  • ConnectionId (string) -- The ID of the VPC link for a private integration. Supported only for HTTP APIs.
  • ConnectionType (string) -- The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
  • ContentHandlingStrategy (string) --

    Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

  • CredentialsArn (string) -- Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.
  • Description (string) -- The description of the integration
  • IntegrationId (string) --

    [REQUIRED]

    The integration ID.

  • IntegrationMethod (string) -- Specifies the integration's HTTP method type.
  • IntegrationSubtype (string) -- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
  • IntegrationType (string) --

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

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

    AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

  • IntegrationUri (string) --

    For a Lambda integration, specify the URI of a Lambda function.

    For an HTTP integration, specify a fully-qualified URL.

    For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

  • PassthroughBehavior (string) --

    Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

    WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

    NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

    WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

  • PayloadFormatVersion (string) -- Specifies the format of the payload sent to an integration. Required for HTTP APIs.
  • RequestParameters (dict) --

    For WebSocket APIs, 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.

    For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

    For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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

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

  • RequestTemplates (dict) --

    Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

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

        A string with a length between [0-32768].

  • ResponseParameters (dict) --

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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

        For WebSocket APIs, 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.

        For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

        For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

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

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

  • TemplateSelectionExpression (string) -- The template selection expression for the integration.
  • TimeoutInMillis (integer) -- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
  • TlsConfig (dict) --

    The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

    • ServerNameToVerify (string) --

      If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

Return type

dict

Returns

Response Syntax

{
    'ApiGatewayManaged': True|False,
    'ConnectionId': 'string',
    'ConnectionType': 'INTERNET'|'VPC_LINK',
    'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
    'CredentialsArn': 'string',
    'Description': 'string',
    'IntegrationId': 'string',
    'IntegrationMethod': 'string',
    'IntegrationResponseSelectionExpression': 'string',
    'IntegrationSubtype': 'string',
    'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
    'IntegrationUri': 'string',
    'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
    'PayloadFormatVersion': 'string',
    'RequestParameters': {
        'string': 'string'
    },
    'RequestTemplates': {
        'string': 'string'
    },
    'ResponseParameters': {
        'string': {
            'string': 'string'
        }
    },
    'TemplateSelectionExpression': 'string',
    'TimeoutInMillis': 123,
    'TlsConfig': {
        'ServerNameToVerify': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • ApiGatewayManaged (boolean) --

      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

    • ConnectionId (string) --

      The ID of the VPC link for a private integration. Supported only for HTTP APIs.

    • ConnectionType (string) --

      The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

    • ContentHandlingStrategy (string) --

      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • CredentialsArn (string) --

      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.

    • Description (string) --

      Represents the description of an integration.

    • IntegrationId (string) --

      Represents the identifier of an integration.

    • IntegrationMethod (string) --

      Specifies the integration's HTTP method type.

    • IntegrationResponseSelectionExpression (string) --

      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

    • IntegrationSubtype (string) --

      Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

    • IntegrationType (string) --

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

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

      AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

    • IntegrationUri (string) --

      For a Lambda integration, specify the URI of a Lambda function.

      For an HTTP integration, specify a fully-qualified URL.

      For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

    • PassthroughBehavior (string) --

      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

      WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

      NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

      WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    • PayloadFormatVersion (string) --

      Specifies the format of the payload sent to an integration. Required for HTTP APIs.

    • RequestParameters (dict) --

      For WebSocket APIs, 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.

      For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

      For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

      • (string) --

        • (string) --

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

    • RequestTemplates (dict) --

      Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

      • (string) --

        • (string) --

          A string with a length between [0-32768].

    • ResponseParameters (dict) --

      Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

      • (string) --

        • (dict) --

          For WebSocket APIs, 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.

          For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

          For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (string) --

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

    • TemplateSelectionExpression (string) --

      The template selection expression for the integration. Supported only for WebSocket APIs.

    • TimeoutInMillis (integer) --

      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

    • TlsConfig (dict) --

      The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

      • ServerNameToVerify (string) --

        If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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) --

    Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

    CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

    CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

    If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

  • 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. Supported only for WebSocket APIs.
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) --

      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • IntegrationResponseId (string) --

      The integration response ID.

    • IntegrationResponseKey (string) --

      The integration response key.

    • ResponseParameters (dict) --

      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

      • (string) --

        • (string) --

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

    • ResponseTemplates (dict) --

      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

      • (string) --

        • (string) --

          A string with a length between [0-32768].

    • TemplateSelectionExpression (string) --

      The template selection expressions for the integration response.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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'|'JWT',
    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. Supported only for WebSocket APIs.
  • 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. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.
  • ModelSelectionExpression (string) -- The model selection expression for the route. Supported only for WebSocket APIs.
  • OperationName (string) -- The operation name for the route.
  • RequestModels (dict) --

    The request models for the route. Supported only for WebSocket APIs.

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

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

  • RequestParameters (dict) --

    The request parameters for the route. Supported only for WebSocket APIs.

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

        Validation constraints imposed on parameters of a request (path, query string, headers).

        • Required (boolean) --

          Whether or not the parameter is required.

  • RouteId (string) --

    [REQUIRED]

    The route ID.

  • RouteKey (string) -- The route key for the route.
  • RouteResponseSelectionExpression (string) -- The route response selection expression for the route. Supported only for WebSocket APIs.
  • Target (string) -- The target for the route.
Return type

dict

Returns

Response Syntax

{
    'ApiGatewayManaged': True|False,
    'ApiKeyRequired': True|False,
    'AuthorizationScopes': [
        'string',
    ],
    'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
    'AuthorizerId': 'string',
    'ModelSelectionExpression': 'string',
    'OperationName': 'string',
    'RequestModels': {
        'string': 'string'
    },
    'RequestParameters': {
        'string': {
            'Required': True|False
        }
    },
    'RouteId': 'string',
    'RouteKey': 'string',
    'RouteResponseSelectionExpression': 'string',
    'Target': 'string'
}

Response Structure

  • (dict) --

    Success

    • ApiGatewayManaged (boolean) --

      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

    • ApiKeyRequired (boolean) --

      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

    • AuthorizationScopes (list) --

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

      • (string) --

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

    • AuthorizationType (string) --

      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.

    • ModelSelectionExpression (string) --

      The model selection expression for the route. Supported only for WebSocket APIs.

    • OperationName (string) --

      The operation name for the route.

    • RequestModels (dict) --

      The request models for the route. Supported only for WebSocket APIs.

      • (string) --

        • (string) --

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

    • RequestParameters (dict) --

      The request parameters for the route. Supported only for WebSocket APIs.

      • (string) --

        • (dict) --

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) --

            Whether or not the parameter is required.

    • RouteId (string) --

      The route ID.

    • RouteKey (string) --

      The route key for the route.

    • RouteResponseSelectionExpression (string) --

      The route response selection expression for the route. Supported only for WebSocket APIs.

    • Target (string) --

      The target for the route.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
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. Supported only for WebSocket APIs.
  • 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. Supported only for WebSocket APIs.

    • ResponseModels (dict) --

      Represents the response models of a route response.

      • (string) --

        • (string) --

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

    • ResponseParameters (dict) --

      Represents the response parameters of a route response.

      • (string) --

        • (dict) --

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) --

            Whether or not the parameter is required.

    • RouteResponseId (string) --

      Represents the identifier of a route response.

    • RouteResponseKey (string) --

      Represents the route response key of a route response.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException
update_stage(**kwargs)

Updates a Stage.

See also: AWS API Documentation

Request Syntax

response = client.update_stage(
    AccessLogSettings={
        'DestinationArn': 'string',
        'Format': 'string'
    },
    ApiId='string',
    AutoDeploy=True|False,
    ClientCertificateId='string',
    DefaultRouteSettings={
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'OFF',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    DeploymentId='string',
    Description='string',
    RouteSettings={
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'OFF',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    StageName='string',
    StageVariables={
        'string': 'string'
    }
)
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.

  • AutoDeploy (boolean) -- Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
  • ClientCertificateId (string) -- The identifier of a client certificate for a Stage.
  • 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. Supported only for WebSocket APIs.

    • DetailedMetricsEnabled (boolean) --

      Specifies whether detailed metrics are enabled.

    • LoggingLevel (string) --

      Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

    • ThrottlingBurstLimit (integer) --

      Specifies the throttling burst limit.

    • ThrottlingRateLimit (float) --

      Specifies the throttling rate limit.

  • DeploymentId (string) -- The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
  • 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. Supported only for WebSocket APIs.

        • DetailedMetricsEnabled (boolean) --

          Specifies whether detailed metrics are enabled.

        • LoggingLevel (string) --

          Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

        • ThrottlingBurstLimit (integer) --

          Specifies the throttling burst limit.

        • ThrottlingRateLimit (float) --

          Specifies the throttling rate limit.

  • StageName (string) --

    [REQUIRED]

    The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

  • 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'
    },
    'ApiGatewayManaged': True|False,
    'AutoDeploy': True|False,
    'ClientCertificateId': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'DefaultRouteSettings': {
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'OFF',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    'DeploymentId': 'string',
    'Description': 'string',
    'LastDeploymentStatusMessage': 'string',
    'LastUpdatedDate': datetime(2015, 1, 1),
    'RouteSettings': {
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'OFF',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    'StageName': 'string',
    'StageVariables': {
        'string': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • AccessLogSettings (dict) --

      Settings for logging access in this stage.

      • DestinationArn (string) --

        The ARN of the CloudWatch Logs log group to receive access logs.

      • Format (string) --

        A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

    • ApiGatewayManaged (boolean) --

      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

    • AutoDeploy (boolean) --

      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

    • ClientCertificateId (string) --

      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

    • CreatedDate (datetime) --

      The timestamp when the stage was created.

    • DefaultRouteSettings (dict) --

      Default route settings for the stage.

      • DataTraceEnabled (boolean) --

        Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

      • DetailedMetricsEnabled (boolean) --

        Specifies whether detailed metrics are enabled.

      • LoggingLevel (string) --

        Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

      • ThrottlingBurstLimit (integer) --

        Specifies the throttling burst limit.

      • ThrottlingRateLimit (float) --

        Specifies the throttling rate limit.

    • DeploymentId (string) --

      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

    • Description (string) --

      The description of the stage.

    • LastDeploymentStatusMessage (string) --

      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

    • LastUpdatedDate (datetime) --

      The timestamp when the stage was last updated.

    • RouteSettings (dict) --

      Route settings for the stage, by routeKey.

      • (string) --

        • (dict) --

          Represents a collection of route settings.

          • DataTraceEnabled (boolean) --

            Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • DetailedMetricsEnabled (boolean) --

            Specifies whether detailed metrics are enabled.

          • LoggingLevel (string) --

            Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • ThrottlingBurstLimit (integer) --

            Specifies the throttling burst limit.

          • ThrottlingRateLimit (float) --

            Specifies the throttling rate limit.

    • StageName (string) --

      The name of the stage.

    • StageVariables (dict) --

      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      • (string) --

        • (string) --

          A string with a length between [0-2048].

    • Tags (dict) --

      The collection of tags. Each tag element is associated with a given resource.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException
  • ApiGatewayV2.Client.exceptions.ConflictException

Updates a VPC link.

See also: AWS API Documentation

Request Syntax

response = client.update_vpc_link(
    Name='string',
    VpcLinkId='string'
)
Parameters
  • Name (string) -- The name of the VPC link.
  • VpcLinkId (string) --

    [REQUIRED]

    The ID of the VPC link.

Return type

dict

Returns

Response Syntax

{
    'CreatedDate': datetime(2015, 1, 1),
    'Name': 'string',
    'SecurityGroupIds': [
        'string',
    ],
    'SubnetIds': [
        'string',
    ],
    'Tags': {
        'string': 'string'
    },
    'VpcLinkId': 'string',
    'VpcLinkStatus': 'PENDING'|'AVAILABLE'|'DELETING'|'FAILED'|'INACTIVE',
    'VpcLinkStatusMessage': 'string',
    'VpcLinkVersion': 'V2'
}

Response Structure

  • (dict) --

    200 response

    • CreatedDate (datetime) --

      The timestamp when the VPC link was created.

    • Name (string) --

      The name of the VPC link.

    • SecurityGroupIds (list) --

      A list of security group IDs for the VPC link.

      • (string) --
    • SubnetIds (list) --

      A list of subnet IDs to include in the VPC link.

      • (string) --
    • Tags (dict) --

      Tags for the VPC link.

      • (string) --

        • (string) --

          A string with a length between [0-1600].

    • VpcLinkId (string) --

      The ID of the VPC link.

    • VpcLinkStatus (string) --

      The status of the VPC link.

    • VpcLinkStatusMessage (string) --

      A message summarizing the cause of the status of the VPC link.

    • VpcLinkVersion (string) --

      The version of the VPC link.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException
  • ApiGatewayV2.Client.exceptions.TooManyRequestsException
  • ApiGatewayV2.Client.exceptions.BadRequestException

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',
            'ApiGatewayManaged': True|False,
            'ApiId': 'string',
            'ApiKeySelectionExpression': 'string',
            'CorsConfiguration': {
                'AllowCredentials': True|False,
                'AllowHeaders': [
                    'string',
                ],
                'AllowMethods': [
                    'string',
                ],
                'AllowOrigins': [
                    'string',
                ],
                'ExposeHeaders': [
                    'string',
                ],
                'MaxAge': 123
            },
            'CreatedDate': datetime(2015, 1, 1),
            'Description': 'string',
            'DisableSchemaValidation': True|False,
            'DisableExecuteApiEndpoint': True|False,
            'ImportInfo': [
                'string',
            ],
            'Name': 'string',
            'ProtocolType': 'WEBSOCKET'|'HTTP',
            'RouteSelectionExpression': 'string',
            'Tags': {
                'string': '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.

        • ApiGatewayManaged (boolean) --

          Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

        • ApiId (string) --

          The API ID.

        • ApiKeySelectionExpression (string) --

          An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

        • CorsConfiguration (dict) --

          A CORS configuration. Supported only for HTTP APIs.

          • AllowCredentials (boolean) --

            Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

          • AllowHeaders (list) --

            Represents a collection of allowed headers. Supported only for HTTP APIs.

            • (string) --
          • AllowMethods (list) --

            Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

            • (string) --

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

          • AllowOrigins (list) --

            Represents a collection of allowed origins. Supported only for HTTP APIs.

            • (string) --
          • ExposeHeaders (list) --

            Represents a collection of exposed headers. Supported only for HTTP APIs.

            • (string) --
          • MaxAge (integer) --

            The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

        • CreatedDate (datetime) --

          The timestamp when the API was created.

        • Description (string) --

          The description of the API.

        • DisableSchemaValidation (boolean) --

          Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

        • DisableExecuteApiEndpoint (boolean) --

          Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

        • ImportInfo (list) --

          The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

          The name of the API.

        • ProtocolType (string) --

          The API protocol.

        • RouteSelectionExpression (string) --

          The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

        • Tags (dict) --

          A collection of tags associated with the API.

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

              A string with a length between [0-1600].

        • Version (string) --

          A version identifier for the API.

        • Warnings (list) --

          The warning messages reported when failonwarnings is turned on during API import.

          • (string) --
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',
            'AuthorizerPayloadFormatVersion': 'string',
            'AuthorizerResultTtlInSeconds': 123,
            'AuthorizerType': 'REQUEST'|'JWT',
            'AuthorizerUri': 'string',
            'EnableSimpleResponses': True|False,
            'IdentitySource': [
                'string',
            ],
            'IdentityValidationExpression': 'string',
            'JwtConfiguration': {
                'Audience': [
                    'string',
                ],
                'Issuer': 'string'
            },
            'Name': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an authorizer.

        • AuthorizerCredentialsArn (string) --

          Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.

        • AuthorizerId (string) --

          The authorizer identifier.

        • AuthorizerPayloadFormatVersion (string) --

          Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

        • AuthorizerResultTtlInSeconds (integer) --

          The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

        • AuthorizerType (string) --

          The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

        • 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. Supported only for REQUEST authorizers.

        • EnableSimpleResponses (boolean) --

          Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

        • IdentitySource (list) --

          The identity source for which authorization is requested.

          For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

          For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

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

          The validation expression does not apply to the REQUEST authorizer.

        • JwtConfiguration (dict) --

          Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

          • Audience (list) --

            A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

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

            The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}. Required for the JWT authorizer type. Supported only for HTTP APIs.

        • Name (string) --

          The name of the authorizer.

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': [
        {
            'AutoDeployed': True|False,
            'CreatedDate': datetime(2015, 1, 1),
            'DeploymentId': 'string',
            'DeploymentStatus': 'PENDING'|'FAILED'|'DEPLOYED',
            'DeploymentStatusMessage': 'string',
            'Description': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

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

        • AutoDeployed (boolean) --

          Specifies whether a deployment was automatically released.

        • CreatedDate (datetime) --

          The date and time when the Deployment resource was created.

        • DeploymentId (string) --

          The identifier for the deployment.

        • DeploymentStatus (string) --

          The status of the deployment: PENDING, FAILED, or SUCCEEDED.

        • DeploymentStatusMessage (string) --

          May contain additional feedback on the status of an API deployment.

        • Description (string) --

          The description for the deployment.

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),
                    'DomainNameStatus': 'AVAILABLE'|'UPDATING'|'PENDING_CERTIFICATE_REIMPORT'|'PENDING_OWNERSHIP_VERIFICATION',
                    'DomainNameStatusMessage': 'string',
                    'EndpointType': 'REGIONAL'|'EDGE',
                    'HostedZoneId': 'string',
                    'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
                    'OwnershipVerificationCertificateArn': 'string'
                },
            ],
            'MutualTlsAuthentication': {
                'TruststoreUri': 'string',
                'TruststoreVersion': 'string',
                'TruststoreWarnings': [
                    'string',
                ]
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a domain name.

        • ApiMappingSelectionExpression (string) --

          The API mapping selection expression.

        • DomainName (string) --

          The name of the DomainName resource.

        • DomainNameConfigurations (list) --

          The domain name configurations.

          • (dict) --

            The domain name configuration.

            • ApiGatewayDomainName (string) --

              A domain name for the API.

            • CertificateArn (string) --

              An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

            • CertificateName (string) --

              The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

            • CertificateUploadDate (datetime) --

              The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

            • DomainNameStatus (string) --

              The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

            • DomainNameStatusMessage (string) --

              An optional text message containing detailed information about status of the domain name migration.

            • EndpointType (string) --

              The endpoint type.

            • HostedZoneId (string) --

              The Amazon Route 53 Hosted Zone ID of the endpoint.

            • SecurityPolicy (string) --

              The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

            • OwnershipVerificationCertificateArn (string) --

              The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

        • MutualTlsAuthentication (dict) --

          The mutual TLS authentication configuration for a custom domain name.

          • TruststoreUri (string) --

            An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

          • TruststoreVersion (string) --

            The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

          • TruststoreWarnings (list) --

            A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

            • (string) --
        • Tags (dict) --

          The collection of tags associated with a domain name.

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

              A string with a length between [0-1600].

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

          Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

          CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

          CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

          If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

        • IntegrationResponseId (string) --

          The integration response ID.

        • IntegrationResponseKey (string) --

          The integration response key.

        • ResponseParameters (dict) --

          A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

          • (string) --

            • (string) --

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

        • ResponseTemplates (dict) --

          The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

          • (string) --

            • (string) --

              A string with a length between [0-32768].

        • TemplateSelectionExpression (string) --

          The template selection expressions for the integration response.

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': [
        {
            'ApiGatewayManaged': True|False,
            'ConnectionId': 'string',
            'ConnectionType': 'INTERNET'|'VPC_LINK',
            'ContentHandlingStrategy': 'CONVERT_TO_BINARY'|'CONVERT_TO_TEXT',
            'CredentialsArn': 'string',
            'Description': 'string',
            'IntegrationId': 'string',
            'IntegrationMethod': 'string',
            'IntegrationResponseSelectionExpression': 'string',
            'IntegrationSubtype': 'string',
            'IntegrationType': 'AWS'|'HTTP'|'MOCK'|'HTTP_PROXY'|'AWS_PROXY',
            'IntegrationUri': 'string',
            'PassthroughBehavior': 'WHEN_NO_MATCH'|'NEVER'|'WHEN_NO_TEMPLATES',
            'PayloadFormatVersion': 'string',
            'RequestParameters': {
                'string': 'string'
            },
            'RequestTemplates': {
                'string': 'string'
            },
            'ResponseParameters': {
                'string': {
                    'string': 'string'
                }
            },
            'TemplateSelectionExpression': 'string',
            'TimeoutInMillis': 123,
            'TlsConfig': {
                'ServerNameToVerify': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an integration.

        • ApiGatewayManaged (boolean) --

          Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.

        • ConnectionId (string) --

          The ID of the VPC link for a private integration. Supported only for HTTP APIs.

        • ConnectionType (string) --

          The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.

        • ContentHandlingStrategy (string) --

          Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

          CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

          CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

          If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

        • CredentialsArn (string) --

          Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null.

        • Description (string) --

          Represents the description of an integration.

        • IntegrationId (string) --

          Represents the identifier of an integration.

        • IntegrationMethod (string) --

          Specifies the integration's HTTP method type.

        • IntegrationResponseSelectionExpression (string) --

          The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.

        • IntegrationSubtype (string) --

          Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.

        • IntegrationType (string) --

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

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

          AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

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

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

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

        • IntegrationUri (string) --

          For a Lambda integration, specify the URI of a Lambda function.

          For an HTTP integration, specify a fully-qualified URL.

          For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

        • PassthroughBehavior (string) --

          Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.

          WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

          NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

          WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

        • PayloadFormatVersion (string) --

          Specifies the format of the payload sent to an integration. Required for HTTP APIs.

        • RequestParameters (dict) --

          For WebSocket APIs, 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.

          For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

          For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (string) --

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

        • RequestTemplates (dict) --

          Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

          • (string) --

            • (string) --

              A string with a length between [0-32768].

        • ResponseParameters (dict) --

          Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

          • (string) --

            • (dict) --

              For WebSocket APIs, 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.

              For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

              For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

              • (string) --

                • (string) --

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

        • TemplateSelectionExpression (string) --

          The template selection expression for the integration. Supported only for WebSocket APIs.

        • TimeoutInMillis (integer) --

          Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

        • TlsConfig (dict) --

          The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

          • ServerNameToVerify (string) --

            If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.

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. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

        • ContentType (string) --

          The content-type for the model, for example, "application/json".

        • Description (string) --

          The description of the model.

        • ModelId (string) --

          The model identifier.

        • Name (string) --

          The name of the model. Must be alphanumeric.

        • Schema (string) --

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

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. Supported only for WebSocket APIs.

        • ResponseModels (dict) --

          Represents the response models of a route response.

          • (string) --

            • (string) --

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

        • ResponseParameters (dict) --

          Represents the response parameters of a route response.

          • (string) --

            • (dict) --

              Validation constraints imposed on parameters of a request (path, query string, headers).

              • Required (boolean) --

                Whether or not the parameter is required.

        • RouteResponseId (string) --

          Represents the identifier of a route response.

        • RouteResponseKey (string) --

          Represents the route response key of a route response.

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': [
        {
            'ApiGatewayManaged': True|False,
            'ApiKeyRequired': True|False,
            'AuthorizationScopes': [
                'string',
            ],
            'AuthorizationType': 'NONE'|'AWS_IAM'|'CUSTOM'|'JWT',
            'AuthorizerId': 'string',
            'ModelSelectionExpression': 'string',
            'OperationName': 'string',
            'RequestModels': {
                'string': 'string'
            },
            'RequestParameters': {
                'string': {
                    'Required': True|False
                }
            },
            'RouteId': 'string',
            'RouteKey': 'string',
            'RouteResponseSelectionExpression': 'string',
            'Target': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents a route.

        • ApiGatewayManaged (boolean) --

          Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

        • ApiKeyRequired (boolean) --

          Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

        • AuthorizationScopes (list) --

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

          • (string) --

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

        • AuthorizationType (string) --

          The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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. The authorizer identifier is generated by API Gateway when you created the authorizer.

        • ModelSelectionExpression (string) --

          The model selection expression for the route. Supported only for WebSocket APIs.

        • OperationName (string) --

          The operation name for the route.

        • RequestModels (dict) --

          The request models for the route. Supported only for WebSocket APIs.

          • (string) --

            • (string) --

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

        • RequestParameters (dict) --

          The request parameters for the route. Supported only for WebSocket APIs.

          • (string) --

            • (dict) --

              Validation constraints imposed on parameters of a request (path, query string, headers).

              • Required (boolean) --

                Whether or not the parameter is required.

        • RouteId (string) --

          The route ID.

        • RouteKey (string) --

          The route key for the route.

        • RouteResponseSelectionExpression (string) --

          The route response selection expression for the route. Supported only for WebSocket APIs.

        • Target (string) --

          The target for the route.

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'
            },
            'ApiGatewayManaged': True|False,
            'AutoDeploy': True|False,
            'ClientCertificateId': 'string',
            'CreatedDate': datetime(2015, 1, 1),
            'DefaultRouteSettings': {
                'DataTraceEnabled': True|False,
                'DetailedMetricsEnabled': True|False,
                'LoggingLevel': 'ERROR'|'INFO'|'OFF',
                'ThrottlingBurstLimit': 123,
                'ThrottlingRateLimit': 123.0
            },
            'DeploymentId': 'string',
            'Description': 'string',
            'LastDeploymentStatusMessage': 'string',
            'LastUpdatedDate': datetime(2015, 1, 1),
            'RouteSettings': {
                'string': {
                    'DataTraceEnabled': True|False,
                    'DetailedMetricsEnabled': True|False,
                    'LoggingLevel': 'ERROR'|'INFO'|'OFF',
                    'ThrottlingBurstLimit': 123,
                    'ThrottlingRateLimit': 123.0
                }
            },
            'StageName': 'string',
            'StageVariables': {
                'string': 'string'
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) --

    Success

    • Items (list) --

      The elements from this collection.

      • (dict) --

        Represents an API stage.

        • AccessLogSettings (dict) --

          Settings for logging access in this stage.

          • DestinationArn (string) --

            The ARN of the CloudWatch Logs log group to receive access logs.

          • Format (string) --

            A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

        • ApiGatewayManaged (boolean) --

          Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

        • AutoDeploy (boolean) --

          Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

        • ClientCertificateId (string) --

          The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

        • CreatedDate (datetime) --

          The timestamp when the stage was created.

        • DefaultRouteSettings (dict) --

          Default route settings for the stage.

          • DataTraceEnabled (boolean) --

            Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • DetailedMetricsEnabled (boolean) --

            Specifies whether detailed metrics are enabled.

          • LoggingLevel (string) --

            Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

          • ThrottlingBurstLimit (integer) --

            Specifies the throttling burst limit.

          • ThrottlingRateLimit (float) --

            Specifies the throttling rate limit.

        • DeploymentId (string) --

          The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

        • Description (string) --

          The description of the stage.

        • LastDeploymentStatusMessage (string) --

          Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

        • LastUpdatedDate (datetime) --

          The timestamp when the stage was last updated.

        • RouteSettings (dict) --

          Route settings for the stage, by routeKey.

          • (string) --

            • (dict) --

              Represents a collection of route settings.

              • DataTraceEnabled (boolean) --

                Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

              • DetailedMetricsEnabled (boolean) --

                Specifies whether detailed metrics are enabled.

              • LoggingLevel (string) --

                Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

              • ThrottlingBurstLimit (integer) --

                Specifies the throttling burst limit.

              • ThrottlingRateLimit (float) --

                Specifies the throttling rate limit.

        • StageName (string) --

          The name of the stage.

        • StageVariables (dict) --

          A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

          • (string) --

            • (string) --

              A string with a length between [0-2048].

        • Tags (dict) --

          The collection of tags. Each tag element is associated with a given resource.

          • (string) --

            • (string) --

              A string with a length between [0-1600].