APIGateway / Client / get_domain_name_access_associations

get_domain_name_access_associations#

APIGateway.Client.get_domain_name_access_associations(**kwargs)#

Represents a collection on DomainNameAccessAssociations resources.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_name_access_associations(
    position='string',
    limit=123,
    resourceOwner='SELF'|'OTHER_ACCOUNTS'
)
Parameters:

  • position (string) – The current pagination position in the paged result set.

  • limit (integer) – The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

  • resourceOwner (string) – The owner of the domain name access association. Use SELF to only list the domain name access associations owned by your own account. Use OTHER_ACCOUNTS to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.

Return type:

dict

Returns:

Response Syntax

{
    'position': 'string',
    'items': [
        {
            'domainNameAccessAssociationArn': 'string',
            'domainNameArn': 'string',
            'accessAssociationSourceType': 'VPCE',
            'accessAssociationSource': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • position (string) –

    • items (list) –

      The current page of elements from this collection.

      • (dict) –

        Represents a domain name access association between an access association source and a private custom domain name. With a domain name access association, an access association source can invoke a private custom domain name while isolated from the public internet.

        • domainNameAccessAssociationArn (string) –

          The ARN of the domain name access association resource.

        • domainNameArn (string) –

          The ARN of the domain name.

        • accessAssociationSourceType (string) –

          The type of the domain name access association source.

        • accessAssociationSource (string) –

          The ARN of the domain name access association source. For a VPCE, the ARN must be a VPC endpoint.

        • tags (dict) –

          The collection of tags. Each tag element is associated with a given resource.

          • (string) –

            • (string) –

Exceptions

  • APIGateway.Client.exceptions.BadRequestException

  • APIGateway.Client.exceptions.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException