Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.GetDistributions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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 Amazon Web Services 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

ToJSON GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods toJSON :: GetDistributions -> Value # toEncoding :: GetDistributions -> Encoding # toJSONList :: [GetDistributions] -> Value # toEncodingList :: [GetDistributions] -> Encoding #
ToHeaders GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods toHeaders :: GetDistributions -> [Header] #
ToPath GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods toPath :: GetDistributions -> ByteString #
ToQuery GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods toQuery :: GetDistributions -> QueryString #
AWSRequest GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Associated Types type AWSResponse GetDistributions # Methods request :: (Service -> Service) -> GetDistributions -> Request GetDistributions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDistributions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDistributions))) #
Generic GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Associated Types type Rep GetDistributions :: Type -> Type # Methods from :: GetDistributions -> Rep GetDistributions x # to :: Rep GetDistributions x -> GetDistributions #
Read GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods readsPrec :: Int -> ReadS GetDistributions # readList :: ReadS [GetDistributions] # readPrec :: ReadPrec GetDistributions # readListPrec :: ReadPrec [GetDistributions] #
Show GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods showsPrec :: Int -> GetDistributions -> ShowS # show :: GetDistributions -> String # showList :: [GetDistributions] -> ShowS #
NFData GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods rnf :: GetDistributions -> () #
Eq GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods (==) :: GetDistributions -> GetDistributions -> Bool # (/=) :: GetDistributions -> GetDistributions -> Bool #
Hashable GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods hashWithSalt :: Int -> GetDistributions -> Int # hash :: GetDistributions -> Int #
type AWSResponse GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions type AWSResponse GetDistributions = GetDistributionsResponse
type Rep GetDistributions Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions type Rep GetDistributions = D1 ('MetaData "GetDistributions" "Amazonka.Lightsail.GetDistributions" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" '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))))

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 Amazon Web Services 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 Amazon Web Services 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

distributions :: Maybe [LightsailDistribution]
An array of objects that describe your distributions.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetDistributionsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Associated Types type Rep GetDistributionsResponse :: Type -> Type # Methods from :: GetDistributionsResponse -> Rep GetDistributionsResponse x # to :: Rep GetDistributionsResponse x -> GetDistributionsResponse #
Read GetDistributionsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods readsPrec :: Int -> ReadS GetDistributionsResponse # readList :: ReadS [GetDistributionsResponse] # readPrec :: ReadPrec GetDistributionsResponse # readListPrec :: ReadPrec [GetDistributionsResponse] #
Show GetDistributionsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods showsPrec :: Int -> GetDistributionsResponse -> ShowS # show :: GetDistributionsResponse -> String # showList :: [GetDistributionsResponse] -> ShowS #
NFData GetDistributionsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods rnf :: GetDistributionsResponse -> () #
Eq GetDistributionsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions Methods (==) :: GetDistributionsResponse -> GetDistributionsResponse -> Bool # (/=) :: GetDistributionsResponse -> GetDistributionsResponse -> Bool #
type Rep GetDistributionsResponse Source #
Instance details Defined in Amazonka.Lightsail.GetDistributions type Rep GetDistributionsResponse = D1 ('MetaData "GetDistributionsResponse" "Amazonka.Lightsail.GetDistributions" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetDistributionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "distributions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LightsailDistribution])) :: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDistributionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDistributionsResponse'`
-> GetDistributionsResponse

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:distributions:GetDistributionsResponse', getDistributionsResponse_distributions - An array of objects that describe your distributions.

$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:httpStatus:GetDistributionsResponse', getDistributionsResponse_httpStatus - The response's http status code.

Response Lenses

getDistributionsResponse_distributions :: Lens' GetDistributionsResponse (Maybe [LightsailDistribution]) Source #

An array of objects that describe your distributions.

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.

getDistributionsResponse_httpStatus :: Lens' GetDistributionsResponse Int Source #

The response's http status code.