AppSync / Client / create_domain_name

create_domain_name

AppSync.Client.create_domain_name(**kwargs)

Creates a custom DomainName object.

See also: AWS API Documentation

Request Syntax

response = client.create_domain_name(
    domainName='string',
    certificateArn='string',
    description='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • domainName (string) –

    [REQUIRED]

    The domain name.

  • certificateArn (string) –

    [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.

  • description (string) – A description of the DomainName.

  • 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.

Return type:

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.

Exceptions