libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetDistributions

Description

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

Synopsis

Creating a Request

data GetDistributions Source #

See: newGetDistributions smart constructor.

Constructors

GetDistributions' 

Fields

  • distributionName :: Maybe Text

    The name of the distribution for which to return information.

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

  • pageToken :: Maybe Text

    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.

Instances

Instances details
Eq GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Read GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Show GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Generic GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Associated Types

type Rep GetDistributions :: Type -> Type #

NFData GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Methods

rnf :: GetDistributions -> () #

Hashable GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

ToJSON GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

AWSRequest GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Associated Types

type AWSResponse GetDistributions #

ToHeaders GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

ToPath GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

ToQuery GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

type Rep GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

type Rep GetDistributions = D1 ('MetaData "GetDistributions" "Amazonka.Lightsail.GetDistributions" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetDistributions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "distributionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse GetDistributions Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

newGetDistributions :: GetDistributions Source #

Create a value of GetDistributions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:distributionName:GetDistributions', getDistributions_distributionName - The name of the distribution for which to return information.

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

$sel:pageToken:GetDistributions', getDistributions_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.

Request Lenses

getDistributions_distributionName :: Lens' GetDistributions (Maybe Text) Source #

The name of the distribution for which to return information.

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

getDistributions_pageToken :: Lens' GetDistributions (Maybe Text) Source #

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.

Destructuring the Response

data GetDistributionsResponse Source #

See: newGetDistributionsResponse smart constructor.

Constructors

GetDistributionsResponse' 

Fields

  • nextPageToken :: Maybe Text

    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.

  • distributions :: Maybe [LightsailDistribution]

    An array of objects that describe your distributions.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetDistributionsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Read GetDistributionsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Show GetDistributionsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Generic GetDistributionsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

Associated Types

type Rep GetDistributionsResponse :: Type -> Type #

NFData GetDistributionsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

type Rep GetDistributionsResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributions

type Rep GetDistributionsResponse = D1 ('MetaData "GetDistributionsResponse" "Amazonka.Lightsail.GetDistributions" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetDistributionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "distributions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LightsailDistribution])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDistributionsResponse Source #

Create a value of GetDistributionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextPageToken:GetDistributionsResponse', getDistributionsResponse_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.

$sel:distributions:GetDistributionsResponse', getDistributionsResponse_distributions - An array of objects that describe your distributions.

$sel:httpStatus:GetDistributionsResponse', getDistributionsResponse_httpStatus - The response's http status code.

Response Lenses

getDistributionsResponse_nextPageToken :: Lens' GetDistributionsResponse (Maybe Text) Source #

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.