AmazonApiGatewayV2

2019/07/12 - AmazonApiGatewayV2 - 3 updated api methods

Changes  Bug fix (Add tags field to Update Stage , Api and DomainName Responses )

UpdateApi (updated) Link ¶
Changes (response) 
{'Tags': {'string': 'string'}}

Updates an Api resource.

See also: AWS API Documentation

Request Syntax

client.update_api(
    ApiId='string',
    ApiKeySelectionExpression='string',
    Description='string',
    DisableSchemaValidation=True|False,
    Name='string',
    RouteSelectionExpression='string',
    Version='string'
)
type ApiId

string

param ApiId

[REQUIRED]

The API identifier.

type ApiKeySelectionExpression

string

param ApiKeySelectionExpression

An API key selection expression. See API Key Selection Expressions .

type Description

string

param Description

The description of the API.

type DisableSchemaValidation

boolean

param DisableSchemaValidation

Avoid validating models when creating a deployment.

type Name

string

param Name

The name of the API.

type RouteSelectionExpression

string

param RouteSelectionExpression

The route selection expression for the API.

type Version

string

param Version

A version identifier for the API.

rtype

dict

returns

Response Syntax

{
    'ApiEndpoint': 'string',
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET',
    'RouteSelectionExpression': 'string',
    'Version': 'string',
    'Warnings': [
        'string',
    ],
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • ApiEndpoint (string) --

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

    • ApiId (string) --

      The API ID.

    • ApiKeySelectionExpression (string) --

      An API key selection expression. See API Key Selection Expressions .

    • CreatedDate (datetime) --

      The timestamp when the API was created.

    • Description (string) --

      The description of the API.

    • DisableSchemaValidation (boolean) --

      Avoid validating models when creating a deployment.

    • Name (string) --

      The name of the API.

    • ProtocolType (string) --

      The API protocol: Currently only WEBSOCKET is supported.

    • RouteSelectionExpression (string) --

      The route selection expression for the API.

    • Version (string) --

      A version identifier for the API.

    • Warnings (list) --

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

      • (string) --

    • Tags (dict) --

      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

      • (string) --

        • (string) --

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

UpdateDomainName (updated) Link ¶
Changes (response) 
{'Tags': {'string': 'string'}}

Updates a domain name.

See also: AWS API Documentation

Request Syntax

client.update_domain_name(
    DomainName='string',
    DomainNameConfigurations=[
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'DomainNameStatus': 'AVAILABLE'|'UPDATING',
            'DomainNameStatusMessage': 'string'
        },
    ]
)
type DomainName

string

param DomainName

[REQUIRED]

The domain name.

type DomainNameConfigurations

list

param DomainNameConfigurations

The domain name configurations.

  • (dict) --

    The domain name configuration.

    • ApiGatewayDomainName (string) --

      A domain name for the WebSocket API.

    • CertificateArn (string) --

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

    • CertificateName (string) --

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

    • CertificateUploadDate (datetime) --

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

    • EndpointType (string) --

      The endpoint type.

    • HostedZoneId (string) --

      The Amazon Route 53 Hosted Zone ID of the endpoint.

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

    • DomainNameStatus (string) --

      The status of the domain name migration. The valid values are AVAILABLE and UPDATING. 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.

rtype

dict

returns

Response Syntax

{
    'ApiMappingSelectionExpression': 'string',
    'DomainName': 'string',
    'DomainNameConfigurations': [
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
            'DomainNameStatus': 'AVAILABLE'|'UPDATING',
            'DomainNameStatusMessage': '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 WebSocket API.

        • CertificateArn (string) --

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

        • CertificateName (string) --

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

        • CertificateUploadDate (datetime) --

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

        • EndpointType (string) --

          The endpoint type.

        • HostedZoneId (string) --

          The Amazon Route 53 Hosted Zone ID of the endpoint.

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

        • DomainNameStatus (string) --

          The status of the domain name migration. The valid values are AVAILABLE and UPDATING. 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.

    • Tags (dict) --

      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

      • (string) --

        • (string) --

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

UpdateStage (updated) Link ¶
Changes (response) 
{'Tags': {'string': 'string'}}

Updates a Stage.

See also: AWS API Documentation

Request Syntax

client.update_stage(
    AccessLogSettings={
        'DestinationArn': 'string',
        'Format': 'string'
    },
    ApiId='string',
    ClientCertificateId='string',
    DefaultRouteSettings={
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'false',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    DeploymentId='string',
    Description='string',
    RouteSettings={
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'false',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    StageName='string',
    StageVariables={
        'string': 'string'
    }
)
type AccessLogSettings

dict

param AccessLogSettings

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.

type ApiId

string

param ApiId

[REQUIRED]

The API identifier.

type ClientCertificateId

string

param ClientCertificateId

The identifier of a client certificate for a Stage.

type DefaultRouteSettings

dict

param DefaultRouteSettings

The default route settings for the stage.

  • DataTraceEnabled (boolean) --

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

  • DetailedMetricsEnabled (boolean) --

    Specifies whether detailed metrics are enabled.

  • LoggingLevel (string) --

    Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

  • ThrottlingBurstLimit (integer) --

    Specifies the throttling burst limit.

  • ThrottlingRateLimit (float) --

    Specifies the throttling rate limit.

type DeploymentId

string

param DeploymentId

The deployment identifier for the API stage.

type Description

string

param Description

The description for the API stage.

type RouteSettings

dict

param RouteSettings

Route settings for the stage.

  • (string) --

    • (dict) --

      Represents a collection of route settings.

      • DataTraceEnabled (boolean) --

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

      • DetailedMetricsEnabled (boolean) --

        Specifies whether detailed metrics are enabled.

      • LoggingLevel (string) --

        Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

      • ThrottlingBurstLimit (integer) --

        Specifies the throttling burst limit.

      • ThrottlingRateLimit (float) --

        Specifies the throttling rate limit.

type StageName

string

param StageName

[REQUIRED]

The stage name.

type StageVariables

dict

param StageVariables

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

rtype

dict

returns

Response Syntax

{
    'AccessLogSettings': {
        'DestinationArn': 'string',
        'Format': 'string'
    },
    'ClientCertificateId': 'string',
    'CreatedDate': datetime(2015, 1, 1),
    'DefaultRouteSettings': {
        'DataTraceEnabled': True|False,
        'DetailedMetricsEnabled': True|False,
        'LoggingLevel': 'ERROR'|'INFO'|'false',
        'ThrottlingBurstLimit': 123,
        'ThrottlingRateLimit': 123.0
    },
    'DeploymentId': 'string',
    'Description': 'string',
    'LastUpdatedDate': datetime(2015, 1, 1),
    'RouteSettings': {
        'string': {
            'DataTraceEnabled': True|False,
            'DetailedMetricsEnabled': True|False,
            'LoggingLevel': 'ERROR'|'INFO'|'false',
            'ThrottlingBurstLimit': 123,
            'ThrottlingRateLimit': 123.0
        }
    },
    'StageName': 'string',
    'StageVariables': {
        'string': 'string'
    },
    '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.

    • ClientCertificateId (string) --

      The identifier of a client certificate for a Stage.

    • CreatedDate (datetime) --

      The timestamp when the stage was created.

    • DefaultRouteSettings (dict) --

      Default route settings for the stage.

      • DataTraceEnabled (boolean) --

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

      • DetailedMetricsEnabled (boolean) --

        Specifies whether detailed metrics are enabled.

      • LoggingLevel (string) --

        Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

      • ThrottlingBurstLimit (integer) --

        Specifies the throttling burst limit.

      • ThrottlingRateLimit (float) --

        Specifies the throttling rate limit.

    • DeploymentId (string) --

      The identifier of the Deployment that the Stage is associated with.

    • Description (string) --

      The description of the stage.

    • LastUpdatedDate (datetime) --

      The timestamp when the stage was last updated.

    • RouteSettings (dict) --

      Route settings for the stage.

      • (string) --

        • (dict) --

          Represents a collection of route settings.

          • DataTraceEnabled (boolean) --

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

          • DetailedMetricsEnabled (boolean) --

            Specifies whether detailed metrics are enabled.

          • LoggingLevel (string) --

            Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

          • ThrottlingBurstLimit (integer) --

            Specifies the throttling burst limit.

          • ThrottlingRateLimit (float) --

            Specifies the throttling rate limit.

    • StageName (string) --

      The name of the stage.

    • StageVariables (dict) --

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

      • (string) --

        • (string) --

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

    • Tags (dict) --

      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

      • (string) --

        • (string) --

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