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.APIGateway.GetDomainNames

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Represents a collection of DomainName resources.

This operation returns paginated results.

Creating a Request

data GetDomainNames Source #

Request to describe a collection of DomainName resources.

See: newGetDomainNames smart constructor.

Constructors

GetDomainNames'
Fields limit :: Maybe Int The maximum number of returned results per page. The default value is 25 and the maximum value is 500. position :: Maybe Text The current pagination position in the paged result set.

Instances

Instances details

ToHeaders GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods toHeaders :: GetDomainNames -> [Header] #
ToPath GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods toPath :: GetDomainNames -> ByteString #
ToQuery GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods toQuery :: GetDomainNames -> QueryString #
AWSPager GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods page :: GetDomainNames -> AWSResponse GetDomainNames -> Maybe GetDomainNames #
AWSRequest GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Associated Types type AWSResponse GetDomainNames # Methods request :: (Service -> Service) -> GetDomainNames -> Request GetDomainNames # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDomainNames -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDomainNames))) #
Generic GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Associated Types type Rep GetDomainNames :: Type -> Type # Methods from :: GetDomainNames -> Rep GetDomainNames x # to :: Rep GetDomainNames x -> GetDomainNames #
Read GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods readsPrec :: Int -> ReadS GetDomainNames # readList :: ReadS [GetDomainNames] # readPrec :: ReadPrec GetDomainNames # readListPrec :: ReadPrec [GetDomainNames] #
Show GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods showsPrec :: Int -> GetDomainNames -> ShowS # show :: GetDomainNames -> String # showList :: [GetDomainNames] -> ShowS #
NFData GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods rnf :: GetDomainNames -> () #
Eq GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods (==) :: GetDomainNames -> GetDomainNames -> Bool # (/=) :: GetDomainNames -> GetDomainNames -> Bool #
Hashable GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods hashWithSalt :: Int -> GetDomainNames -> Int # hash :: GetDomainNames -> Int #
type AWSResponse GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames type AWSResponse GetDomainNames = GetDomainNamesResponse
type Rep GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames type Rep GetDomainNames = D1 ('MetaData "GetDomainNames" "Amazonka.APIGateway.GetDomainNames" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDomainNames'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetDomainNames :: GetDomainNames Source #

Create a value of GetDomainNames 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:

GetDomainNames, getDomainNames_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetDomainNames, getDomainNames_position - The current pagination position in the paged result set.

Request Lenses

getDomainNames_limit :: Lens' GetDomainNames (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getDomainNames_position :: Lens' GetDomainNames (Maybe Text) Source #

The current pagination position in the paged result set.

Destructuring the Response

data GetDomainNamesResponse Source #

Represents a collection of DomainName resources.

See: newGetDomainNamesResponse smart constructor.

Constructors

GetDomainNamesResponse'
Fields items :: Maybe [DomainName] The current page of elements from this collection. position :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Associated Types type Rep GetDomainNamesResponse :: Type -> Type # Methods from :: GetDomainNamesResponse -> Rep GetDomainNamesResponse x # to :: Rep GetDomainNamesResponse x -> GetDomainNamesResponse #
Read GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods readsPrec :: Int -> ReadS GetDomainNamesResponse # readList :: ReadS [GetDomainNamesResponse] # readPrec :: ReadPrec GetDomainNamesResponse # readListPrec :: ReadPrec [GetDomainNamesResponse] #
Show GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods showsPrec :: Int -> GetDomainNamesResponse -> ShowS # show :: GetDomainNamesResponse -> String # showList :: [GetDomainNamesResponse] -> ShowS #
NFData GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods rnf :: GetDomainNamesResponse -> () #
Eq GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods (==) :: GetDomainNamesResponse -> GetDomainNamesResponse -> Bool # (/=) :: GetDomainNamesResponse -> GetDomainNamesResponse -> Bool #
type Rep GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames type Rep GetDomainNamesResponse = D1 ('MetaData "GetDomainNamesResponse" "Amazonka.APIGateway.GetDomainNames" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDomainNamesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainName])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDomainNamesResponse Source #

Arguments

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

Create a value of GetDomainNamesResponse 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:

GetDomainNamesResponse, getDomainNamesResponse_items - The current page of elements from this collection.

GetDomainNames, getDomainNamesResponse_position - Undocumented member.

$sel:httpStatus:GetDomainNamesResponse', getDomainNamesResponse_httpStatus - The response's http status code.

Response Lenses

getDomainNamesResponse_items :: Lens' GetDomainNamesResponse (Maybe [DomainName]) Source #

The current page of elements from this collection.

getDomainNamesResponse_position :: Lens' GetDomainNamesResponse (Maybe Text) Source #

Undocumented member.

getDomainNamesResponse_httpStatus :: Lens' GetDomainNamesResponse Int Source #

The response's http status code.