CloudFront / Client / list_distribution_tenants_by_customization

list_distribution_tenants_by_customization

CloudFront.Client.list_distribution_tenants_by_customization(**kwargs)

Lists distribution tenants by the customization that you specify.

You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.

See also: AWS API Documentation

Request Syntax

response = client.list_distribution_tenants_by_customization(
    WebACLArn='string',
    CertificateArn='string',
    Marker='string',
    MaxItems=123
)

Parameters:

• WebACLArn (string) – Filter by the ARN of the associated WAF web ACL.

• CertificateArn (string) – Filter by the ARN of the associated ACM certificate.

• Marker (string) – The marker for the next set of results.

• MaxItems (integer) – The maximum number of distribution tenants to return by the specified customization.

Return type:

dict

Returns:

Response Syntax

{
    'NextMarker': 'string',
    'DistributionTenantList': [
        {
            'Id': 'string',
            'DistributionId': 'string',
            'Name': 'string',
            'Arn': 'string',
            'Domains': [
                {
                    'Domain': 'string',
                    'Status': 'active'|'inactive'
                },
            ],
            'ConnectionGroupId': 'string',
            'Customizations': {
                'WebAcl': {
                    'Action': 'override'|'disable',
                    'Arn': 'string'
                },
                'Certificate': {
                    'Arn': 'string'
                },
                'GeoRestrictions': {
                    'RestrictionType': 'blacklist'|'whitelist'|'none',
                    'Locations': [
                        'string',
                    ]
                }
            },
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'ETag': 'string',
            'Enabled': True|False,
            'Status': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • NextMarker (string) –

    A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.

  • DistributionTenantList (list) –

    A list of distribution tenants with the specified customization.

    • (dict) –

      A summary of the information about a distribution tenant.

      • Id (string) –

        The ID of the distribution tenant.

      • DistributionId (string) –

        The identifier for the multi-tenant distribution. For example: EDFDVBD632BHDS5.

      • Name (string) –

        The name of the distribution tenant.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the distribution tenant.

      • Domains (list) –

        The domains associated with the distribution tenant.

        • (dict) –

          The details about the domain result.

          • Domain (string) –

            The specified domain.

          • Status (string) –

            Whether the domain is active or inactive.

      • ConnectionGroupId (string) –

        The ID of the connection group ID for the distribution tenant. If you don’t specify a connection group, CloudFront uses the default connection group.

      • Customizations (dict) –

        Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

        • WebAcl (dict) –

          The WAF web ACL.

          • Action (string) –

            The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won’t have WAF web ACL protections and won’t inherit from the multi-tenant distribution.

          • Arn (string) –

            The Amazon Resource Name (ARN) of the WAF web ACL.

        • Certificate (dict) –

          The Certificate Manager (ACM) certificate.

          • Arn (string) –

            The Amazon Resource Name (ARN) of the ACM certificate.

        • GeoRestrictions (dict) –

          The geographic restrictions.

          • RestrictionType (string) –

            The method that you want to use to restrict distribution of your content by country:

            • none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.

            • blacklist: The Location elements specify the countries in which you don’t want CloudFront to distribute your content.

            • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

          • Locations (list) –

            The locations for geographic restrictions.

            • (string) –

      • CreatedTime (datetime) –

        The date and time when the distribution tenant was created.

      • LastModifiedTime (datetime) –

        The date and time when the distribution tenant was updated.

      • ETag (string) –

        The current version of the distribution tenant.

      • Enabled (boolean) –

        Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won’t service traffic.

      • Status (string) –

        The status of the distribution tenant.

Exceptions

• CloudFront.Client.exceptions.AccessDenied

• CloudFront.Client.exceptions.EntityNotFound

• CloudFront.Client.exceptions.InvalidArgument