GetDistributions - Amazon Lightsail

GetDistributions

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

Request Syntax

{ "distributionName": "string", "pageToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

distributionName

The name of the distribution for which to return information.

Use the GetDistributions action to get a list of distribution names that you can specify.

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

Type: String

Pattern: \w[\w\-]*\w

Required: No

pageToken

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.

Type: String

Required: No

Response Syntax

{ "distributions": [ { "ableToUpdateBundle": boolean, "alternativeDomainNames": [ "string" ], "arn": "string", "bundleId": "string", "cacheBehaviors": [ { "behavior": "string", "path": "string" } ], "cacheBehaviorSettings": { "allowedHTTPMethods": "string", "cachedHTTPMethods": "string", "defaultTTL": number, "forwardedCookies": { "cookiesAllowList": [ "string" ], "option": "string" }, "forwardedHeaders": { "headersAllowList": [ "string" ], "option": "string" }, "forwardedQueryStrings": { "option": boolean, "queryStringsAllowList": [ "string" ] }, "maximumTTL": number, "minimumTTL": number }, "certificateName": "string", "createdAt": number, "defaultCacheBehavior": { "behavior": "string" }, "domainName": "string", "ipAddressType": "string", "isEnabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "origin": { "name": "string", "protocolPolicy": "string", "regionName": "string", "resourceType": "string" }, "originPublicDNS": "string", "resourceType": "string", "status": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

distributions

An array of objects that describe your distributions.

Type: Array of LightsailDistribution objects

nextPageToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

OperationFailureException

Lightsail throws this exception when an operation fails to execute.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: