AWS API Changes

2021/12/06 - AWS AppSync - 8 new api methods

Changes AWS AppSync now supports custom domain names, allowing you to associate a domain name that you own with an AppSync API in your account.

CreateDomainName (new)

Link ¶

Creates a custom DomainName object.

See also: AWS API Documentation

Request Syntax

client.create_domain_name(
    domainName='string',
    certificateArn='string',
    description='string'
)

type domainName

string

param domainName

[REQUIRED]

The domain name.

type certificateArn

string

param certificateArn

[REQUIRED]

The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

type description

string

param description

A description of the DomainName .

rtype

dict

returns

Response Syntax

{
    'domainNameConfig': {
        'domainName': 'string',
        'description': 'string',
        'certificateArn': 'string',
        'appsyncDomainName': 'string',
        'hostedZoneId': 'string'
    }
}

Response Structure

(dict) --
- domainNameConfig (dict) --
  
  The configuration for the DomainName .
  - domainName (string) --
    
    The domain name.
  - description (string) --
    
    A description of the DomainName configuration.
  - certificateArn (string) --
    
    The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
  - appsyncDomainName (string) --
    
    The domain name that AppSync provides.
  - hostedZoneId (string) --
    
    The ID of your Amazon Route 53 hosted zone.

AssociateApi (new)

Link ¶

Maps an endpoint to your custom domain.

See also: AWS API Documentation

Request Syntax

client.associate_api(
    domainName='string',
    apiId='string'
)

type domainName

string

param domainName

[REQUIRED]

The domain name.

type apiId

string

param apiId

[REQUIRED]

The API ID.

rtype

dict

returns

Response Syntax

{
    'apiAssociation': {
        'domainName': 'string',
        'apiId': 'string',
        'associationStatus': 'PROCESSING'|'FAILED'|'SUCCESS',
        'deploymentDetail': 'string'
    }
}

Response Structure

(dict) --
- apiAssociation (dict) --
  
  The ApiAssociation object.
  - domainName (string) --
    
    The domain name.
  - apiId (string) --
    
    The API ID.
  - associationStatus (string) --
    
    Identifies the status of an association.
    - PROCESSING : The API association is being created. You cannot modify association requests during processing.
    - SUCCESS : The API association was successful. You can modify associations after success.
    - FAILED : The API association has failed. You can modify associations after failure.
  - deploymentDetail (string) --
    
    Details about the last deployment status.

DisassociateApi (new)

Link ¶

Removes an ApiAssociation object from a custom domain.

See also: AWS API Documentation

Request Syntax

client.disassociate_api(
    domainName='string'
)

type domainName

string

param domainName

[REQUIRED]

The domain name.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetDomainName (new)

Link ¶

Retrieves a custom DomainName object.

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

{
    'domainNameConfig': {
        'domainName': 'string',
        'description': 'string',
        'certificateArn': 'string',
        'appsyncDomainName': 'string',
        'hostedZoneId': 'string'
    }
}

Response Structure

(dict) --
- domainNameConfig (dict) --
  
  The configuration for the DomainName .
  - domainName (string) --
    
    The domain name.
  - description (string) --
    
    A description of the DomainName configuration.
  - certificateArn (string) --
    
    The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
  - appsyncDomainName (string) --
    
    The domain name that AppSync provides.
  - hostedZoneId (string) --
    
    The ID of your Amazon Route 53 hosted zone.

ListDomainNames (new)

Link ¶

Lists multiple custom domain names.

See also: AWS API Documentation

Request Syntax

client.list_domain_names(
    nextToken='string',
    maxResults=123
)

type nextToken

string

param nextToken

The API token.

type maxResults

integer

param maxResults

The maximum number of results that you want the request to return.

rtype

dict

returns

Response Syntax

{
    'domainNameConfigs': [
        {
            'domainName': 'string',
            'description': 'string',
            'certificateArn': 'string',
            'appsyncDomainName': 'string',
            'hostedZoneId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- domainNameConfigs (list) --
  
  Lists configurations for multiple domain names.
  - (dict) --
    
    Describes a configuration for a custom domain.
    - domainName (string) --
      
      The domain name.
    - description (string) --
      
      A description of the DomainName configuration.
    - certificateArn (string) --
      
      The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
    - appsyncDomainName (string) --
      
      The domain name that AppSync provides.
    - hostedZoneId (string) --
      
      The ID of your Amazon Route 53 hosted zone.
- nextToken (string) --
  
  The API token.

GetApiAssociation (new)

Link ¶

Retrieves an ApiAssociation object.

See also: AWS API Documentation

Request Syntax

client.get_api_association(
    domainName='string'
)

type domainName

string

param domainName

[REQUIRED]

The domain name.

rtype

dict

returns

Response Syntax

{
    'apiAssociation': {
        'domainName': 'string',
        'apiId': 'string',
        'associationStatus': 'PROCESSING'|'FAILED'|'SUCCESS',
        'deploymentDetail': 'string'
    }
}

Response Structure

(dict) --
- apiAssociation (dict) --
  
  The ApiAssociation object.
  - domainName (string) --
    
    The domain name.
  - apiId (string) --
    
    The API ID.
  - associationStatus (string) --
    
    Identifies the status of an association.
    - PROCESSING : The API association is being created. You cannot modify association requests during processing.
    - SUCCESS : The API association was successful. You can modify associations after success.
    - FAILED : The API association has failed. You can modify associations after failure.
  - deploymentDetail (string) --
    
    Details about the last deployment status.

DeleteDomainName (new)

Link ¶

Deletes a custom DomainName object.

See also: AWS API Documentation

Request Syntax

client.delete_domain_name(
    domainName='string'
)

type domainName

string

param domainName

[REQUIRED]

The domain name.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateDomainName (new)

Link ¶

Updates a custom DomainName object.

See also: AWS API Documentation

Request Syntax

client.update_domain_name(
    domainName='string',
    description='string'
)

type domainName

string

param domainName

[REQUIRED]

The domain name.

type description

string

param description

A description of the DomainName .

rtype

dict

returns

Response Syntax

{
    'domainNameConfig': {
        'domainName': 'string',
        'description': 'string',
        'certificateArn': 'string',
        'appsyncDomainName': 'string',
        'hostedZoneId': 'string'
    }
}

Response Structure

(dict) --
- domainNameConfig (dict) --
  
  The configuration for the DomainName .
  - domainName (string) --
    
    The domain name.
  - description (string) --
    
    A description of the DomainName configuration.
  - certificateArn (string) --
    
    The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.
  - appsyncDomainName (string) --
    
    The domain name that AppSync provides.
  - hostedZoneId (string) --
    
    The ID of your Amazon Route 53 hosted zone.