get_domain_name

get_domain_name(**kwargs)

Retrieves a custom DomainName object.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_name(
    domainName='string'
)

Parameters

domainName (string) --

[REQUIRED]

The domain name.

Return type

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.

Exceptions

• AppSync.Client.exceptions.AccessDeniedException
• AppSync.Client.exceptions.BadRequestException
• AppSync.Client.exceptions.InternalFailureException
• AppSync.Client.exceptions.NotFoundException