AppSync / Client / list_domain_names

list_domain_names#

AppSync.Client.list_domain_names(**kwargs)#

Lists multiple custom domain names.

Request Syntax

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

Parameters:

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.
maxResults (integer) – The maximum number of results that you want the request to return.

Return type:

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) –
  
  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.

Exceptions

AppSync.Client.exceptions.AccessDeniedException
AppSync.Client.exceptions.BadRequestException
AppSync.Client.exceptions.InternalFailureException