AWS API Changes

2025/03/18 - AWS AppSync - 4 updated api methods

Changes Providing Tagging support for DomainName in AppSync

CreateDomainName (updated)

Link ¶
Changes (request, response)
Request

{'tags': {'string': 'string'}}

Response

{'domainNameConfig': {'domainNameArn': 'string', 'tags': {'string': 'string'}}}

Creates a custom DomainName object.

See also: AWS API Documentation

Request Syntax

client.create_domain_name(
    domainName='string',
    certificateArn='string',
    description='string',
    tags={
        'string': '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.

type tags:

dict

param tags:

A map with keys of TagKey objects and values of TagValue objects.

(string) --

The key for the tag.
- (string) --
  
  The value for the tag.

rtype:

dict

returns:

Response Syntax

{
    'domainNameConfig': {
        'domainName': 'string',
        'description': 'string',
        'certificateArn': 'string',
        'appsyncDomainName': 'string',
        'hostedZoneId': 'string',
        'tags': {
            'string': 'string'
        },
        'domainNameArn': '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.
  - tags (dict) --
    
    A map with keys of TagKey objects and values of TagValue objects.
    - (string) --
      
      The key for the tag.
      - (string) --
        
        The value for the tag.
  - domainNameArn (string) --
    
    The Amazon Resource Name (ARN) of the domain name.

GetDomainName (updated)

Link ¶
Changes (response)

{'domainNameConfig': {'domainNameArn': 'string', 'tags': {'string': 'string'}}}

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',
        'tags': {
            'string': 'string'
        },
        'domainNameArn': '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.
  - tags (dict) --
    
    A map with keys of TagKey objects and values of TagValue objects.
    - (string) --
      
      The key for the tag.
      - (string) --
        
        The value for the tag.
  - domainNameArn (string) --
    
    The Amazon Resource Name (ARN) of the domain name.

ListDomainNames (updated)

Link ¶
Changes (response)

{'domainNameConfigs': {'domainNameArn': 'string', 'tags': {'string': 'string'}}}

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:

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

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',
            'tags': {
                'string': 'string'
            },
            'domainNameArn': '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.
    - tags (dict) --
      
      A map with keys of TagKey objects and values of TagValue objects.
      - (string) --
        
        The key for the tag.
        
        (string) --
        
        The value for the tag.
    - domainNameArn (string) --
      
      The Amazon Resource Name (ARN) of the domain name.
- nextToken (string) --
  
  An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

UpdateDomainName (updated)

Link ¶
Changes (response)

{'domainNameConfig': {'domainNameArn': 'string', 'tags': {'string': 'string'}}}

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',
        'tags': {
            'string': 'string'
        },
        'domainNameArn': '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.
  - tags (dict) --
    
    A map with keys of TagKey objects and values of TagValue objects.
    - (string) --
      
      The key for the tag.
      - (string) --
        
        The value for the tag.
  - domainNameArn (string) --
    
    The Amazon Resource Name (ARN) of the domain name.