AWS API Changes

2019/06/24 - AmazonApiGatewayV2 - 4 updated api methods

Changes Customers can get information about security policies set on custom domain resources in API Gateway

CreateDomainName (updated)

Link ¶
Changes (both)

{'DomainNameConfigurations': {'DomainNameStatus': 'AVAILABLE | UPDATING',
                              'DomainNameStatusMessage': 'string',
                              'SecurityPolicy': 'TLS_1_0 | TLS_1_2'}}

Creates a domain name.

See also: AWS API Documentation

Request Syntax

client.create_domain_name(
    DomainName='string',
    DomainNameConfigurations=[
        {
            'ApiGatewayDomainName': 'string',
            'CertificateArn': 'string',
            'CertificateName': 'string',
            'CertificateUploadDate': datetime(2015, 1, 1),
            'EndpointType': 'REGIONAL'|'EDGE',
            'HostedZoneId': 'string',
            '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'
        },
    ]
}

Response Structure

(dict) --

The request has succeeded and has resulted in the creation of a resource.
- ApiMappingSelectionExpression (string) --
  
  The API mapping selection expression.
- DomainName (string) --
  
  The name of the DomainName resource.
- DomainNameConfigurations (list) --
  
  The domain name configurations.
  - (dict) --
    
    The domain name configuration.
    - ApiGatewayDomainName (string) --
      
      A domain name for the WebSocket API.
    - CertificateArn (string) --
      
      An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - CertificateName (string) --
      
      The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    - CertificateUploadDate (datetime) --
      
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
    - EndpointType (string) --
      
      The endpoint type.
    - HostedZoneId (string) --
      
      The Amazon Route 53 Hosted Zone ID of the endpoint.
    - 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.

GetDomainName (updated)

Link ¶
Changes (response)

{'DomainNameConfigurations': {'DomainNameStatus': 'AVAILABLE | UPDATING',
                              'DomainNameStatusMessage': 'string',
                              'SecurityPolicy': 'TLS_1_0 | TLS_1_2'}}

Gets a domain name.

See also: AWS API Documentation

Request Syntax

client.get_domain_name(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

The domain name.

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

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.

GetDomainNames (updated)

Link ¶
Changes (response)

{'Items': {'DomainNameConfigurations': {'DomainNameStatus': 'AVAILABLE | '
                                                            'UPDATING',
                                        'DomainNameStatusMessage': 'string',
                                        'SecurityPolicy': 'TLS_1_0 | TLS_1_2'}}}

Gets the domain names for an AWS account.

See also: AWS API Documentation

Request Syntax

client.get_domain_names(
    MaxResults='string',
    NextToken='string'
)

type MaxResults

string

param MaxResults

The maximum number of elements to be returned for this resource.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Items': [
        {
            'ApiMappingSelectionExpression': 'string',
            'DomainName': 'string',
            'DomainNameConfigurations': [
                {
                    'ApiGatewayDomainName': 'string',
                    'CertificateArn': 'string',
                    'CertificateName': 'string',
                    'CertificateUploadDate': datetime(2015, 1, 1),
                    'EndpointType': 'REGIONAL'|'EDGE',
                    'HostedZoneId': 'string',
                    'SecurityPolicy': 'TLS_1_0'|'TLS_1_2',
                    'DomainNameStatus': 'AVAILABLE'|'UPDATING',
                    'DomainNameStatusMessage': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Success
- Items (list) --
  
  The elements from this collection.
  - (dict) --
    
    Represents a domain name.
    - ApiMappingSelectionExpression (string) --
      
      The API mapping selection expression.
    - DomainName (string) --
      
      The name of the DomainName resource.
    - DomainNameConfigurations (list) --
      
      The domain name configurations.
      - (dict) --
        
        The domain name configuration.
        
        ApiGatewayDomainName (string) --
        
        A domain name for the WebSocket API.
        
        CertificateArn (string) --
        
        An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
        
        CertificateName (string) --
        
        The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
        
        CertificateUploadDate (datetime) --
        
        The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
        
        EndpointType (string) --
        
        The endpoint type.
        
        HostedZoneId (string) --
        
        The Amazon Route 53 Hosted Zone ID of the endpoint.
        
        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.
- NextToken (string) --
  
  The next page of elements from this collection. Not valid for the last element of the collection.

UpdateDomainName (updated)

Link ¶
Changes (both)

{'DomainNameConfigurations': {'DomainNameStatus': 'AVAILABLE | UPDATING',
                              'DomainNameStatusMessage': 'string',
                              'SecurityPolicy': 'TLS_1_0 | TLS_1_2'}}

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

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.