Lightsail / Client / get_distributions

get_distributions

Lightsail.Client.get_distributions(**kwargs)

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

See also: AWS API Documentation

Request Syntax

response = client.get_distributions(
    distributionName='string',
    pageToken='string'
)

Parameters:

• distributionName (string) –

  The name of the distribution for which to return information.

  When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.

• pageToken (string) –

  The token to advance to the next page of results from your request.

  To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Return type:

dict

Returns:

Response Syntax

{
    'distributions': [
        {
            'name': 'string',
            'arn': 'string',
            'supportCode': 'string',
            'createdAt': datetime(2015, 1, 1),
            'location': {
                'availabilityZone': 'string',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
            },
            'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
            'alternativeDomainNames': [
                'string',
            ],
            'status': 'string',
            'isEnabled': True|False,
            'domainName': 'string',
            'bundleId': 'string',
            'certificateName': 'string',
            'origin': {
                'name': 'string',
                'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
                'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1',
                'protocolPolicy': 'http-only'|'https-only',
                'responseTimeout': 123
            },
            'originPublicDNS': 'string',
            'defaultCacheBehavior': {
                'behavior': 'dont-cache'|'cache'
            },
            'cacheBehaviorSettings': {
                'defaultTTL': 123,
                'minimumTTL': 123,
                'maximumTTL': 123,
                'allowedHTTPMethods': 'string',
                'cachedHTTPMethods': 'string',
                'forwardedCookies': {
                    'option': 'none'|'allow-list'|'all',
                    'cookiesAllowList': [
                        'string',
                    ]
                },
                'forwardedHeaders': {
                    'option': 'none'|'allow-list'|'all',
                    'headersAllowList': [
                        'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
                    ]
                },
                'forwardedQueryStrings': {
                    'option': True|False,
                    'queryStringsAllowList': [
                        'string',
                    ]
                }
            },
            'cacheBehaviors': [
                {
                    'path': 'string',
                    'behavior': 'dont-cache'|'cache'
                },
            ],
            'ableToUpdateBundle': True|False,
            'ipAddressType': 'dualstack'|'ipv4',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'viewerMinimumTlsProtocolVersion': 'string'
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

• (dict) –

  • distributions (list) –

    An array of objects that describe your distributions.

    • (dict) –

      Describes an Amazon Lightsail content delivery network (CDN) distribution.

      • name (string) –

        The name of the distribution.

      • arn (string) –

        The Amazon Resource Name (ARN) of the distribution.

      • supportCode (string) –

        The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.

      • createdAt (datetime) –

        The timestamp when the distribution was created.

      • location (dict) –

        An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.

        Note

        Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

        • availabilityZone (string) –

          The Availability Zone. Follows the format us-east-2a (case-sensitive).

        • regionName (string) –

          The Amazon Web Services Region name.

      • resourceType (string) –

        The Lightsail resource type ( Distribution).

      • alternativeDomainNames (list) –

        The alternate domain names of the distribution.

        • (string) –

      • status (string) –

        The status of the distribution.

      • isEnabled (boolean) –

        Indicates whether the distribution is enabled.

      • domainName (string) –

        The domain name of the distribution.

      • bundleId (string) –

        The ID of the bundle currently applied to the distribution.

      • certificateName (string) –

        The name of the SSL/TLS certificate attached to the distribution, if any.

      • origin (dict) –

        An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.

        The distribution pulls, caches, and serves content from the origin.

        • name (string) –

          The name of the origin resource.

        • resourceType (string) –

          The resource type of the origin resource (Instance).

        • regionName (string) –

          The AWS Region name of the origin resource.

        • protocolPolicy (string) –

          The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.

        • responseTimeout (integer) –

          The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don’t specify otherwise) is 30 seconds.

      • originPublicDNS (string) –

        The public DNS of the origin.

      • defaultCacheBehavior (dict) –

        An object that describes the default cache behavior of the distribution.

        • behavior (string) –

          The cache behavior of the distribution.

          The following cache behaviors can be specified:

          • cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn’t change depending on who views it, or for websites that don’t use cookies, headers, or query strings to personalize content.

          • dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution’s CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.

      • cacheBehaviorSettings (dict) –

        An object that describes the cache behavior settings of the distribution.

        • defaultTTL (integer) –

          The default amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the content has been updated.

          Note

          The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

        • minimumTTL (integer) –

          The minimum amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the object has been updated.

          A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

        • maximumTTL (integer) –

          The maximum amount of time that objects stay in the distribution’s cache before the distribution forwards another request to the origin to determine whether the object has been updated.

          The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

        • allowedHTTPMethods (string) –

          The HTTP methods that are processed and forwarded to the distribution’s origin.

          You can specify the following options:

          • GET,HEAD - The distribution forwards the GET and HEAD methods.

          • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

          • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

          If you specify the third option, you might need to restrict access to your distribution’s origin so users can’t perform operations that you don’t want them to. For example, you might not want users to have permission to delete objects from your origin.

        • cachedHTTPMethods (string) –

          The HTTP method responses that are cached by your distribution.

          You can specify the following options:

          • GET,HEAD - The distribution caches responses to the GET and HEAD methods.

          • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

        • forwardedCookies (dict) –

          An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

          • option (string) –

            Specifies which cookies to forward to the distribution’s origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

          • cookiesAllowList (list) –

            The specific cookies to forward to your distribution’s origin.

            • (string) –

        • forwardedHeaders (dict) –

          An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

          • option (string) –

            The headers that you want your distribution to forward to your origin and base caching on.

            You can configure your distribution to do one of the following:

            • all - Forward all headers to your origin.

            • none - Forward only the default headers.

            • allow-list - Forward only the headers you specify using the headersAllowList parameter.

          • headersAllowList (list) –

            The specific headers to forward to your distribution’s origin.

            • (string) –

        • forwardedQueryStrings (dict) –

          An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

          • option (boolean) –

            Indicates whether the distribution forwards and caches based on query strings.

          • queryStringsAllowList (list) –

            The specific query strings that the distribution forwards to the origin.

            Your distribution will cache content based on the specified query strings.

            If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.

            • (string) –

      • cacheBehaviors (list) –

        An array of objects that describe the per-path cache behavior of the distribution.

        • (dict) –

          Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

          A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution’s cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

          • path (string) –

            The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types ( *.html, *jpg, *js). Directories and file paths are case-sensitive.

            Examples:

            • Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/

            • Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html

            • Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html

            • Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/

          • behavior (string) –

            The cache behavior for the specified path.

            You can specify one of the following per-path cache behaviors:

            • cache - This behavior caches the specified path.

            • dont-cache - This behavior doesn’t cache the specified path.

      • ableToUpdateBundle (boolean) –

        Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.

        Use the UpdateDistributionBundle action to change your distribution’s bundle.

      • ipAddressType (string) –

        The IP address type of the distribution.

        The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.

      • tags (list) –

        The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

        • (dict) –

          Describes a tag key and optional value assigned to an Amazon Lightsail resource.

          For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

          • key (string) –

            The key of the tag.

            Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

          • value (string) –

            The value of the tag.

            Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

      • viewerMinimumTlsProtocolVersion (string) –

        The minimum TLS protocol version that the distribution can use to communicate with viewers.

  • nextPageToken (string) –

    The token to advance to the next page of results from your request.

    A next page token is not returned if there are no more results to display.

    To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.

Exceptions

• Lightsail.Client.exceptions.ServiceException

• Lightsail.Client.exceptions.InvalidInputException

• Lightsail.Client.exceptions.NotFoundException

• Lightsail.Client.exceptions.OperationFailureException

• Lightsail.Client.exceptions.AccessDeniedException

• Lightsail.Client.exceptions.UnauthenticatedException