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.ApiGatewayV2.GetDeployments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the Deployments for an API.

This operation returns paginated results.

Creating a Request

data GetDeployments Source #

See: newGetDeployments smart constructor.

Constructors

GetDeployments'
Fields maxResults :: Maybe Text The maximum number of elements to be returned for this resource. nextToken :: Maybe Text The next page of elements from this collection. Not valid for the last element of the collection. apiId :: Text The API identifier.

Instances

Instances details

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

newGetDeployments Source #

Arguments

:: Text	`GetDeployments`
-> GetDeployments

Create a value of GetDeployments 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:maxResults:GetDeployments', getDeployments_maxResults - The maximum number of elements to be returned for this resource.

GetDeployments, getDeployments_nextToken - The next page of elements from this collection. Not valid for the last element of the collection.

GetDeployments, getDeployments_apiId - The API identifier.

Request Lenses

getDeployments_maxResults :: Lens' GetDeployments (Maybe Text) Source #

The maximum number of elements to be returned for this resource.

getDeployments_nextToken :: Lens' GetDeployments (Maybe Text) Source #

The next page of elements from this collection. Not valid for the last element of the collection.

getDeployments_apiId :: Lens' GetDeployments Text Source #

The API identifier.

Destructuring the Response

data GetDeploymentsResponse Source #

See: newGetDeploymentsResponse smart constructor.

Constructors

GetDeploymentsResponse'
Fields items :: Maybe [Deployment] The elements from this collection. nextToken :: Maybe Text The next page of elements from this collection. Not valid for the last element of the collection. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetDeploymentsResponse Source #

Arguments

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

Create a value of GetDeploymentsResponse 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:items:GetDeploymentsResponse', getDeploymentsResponse_items - The elements from this collection.

GetDeployments, getDeploymentsResponse_nextToken - The next page of elements from this collection. Not valid for the last element of the collection.

$sel:httpStatus:GetDeploymentsResponse', getDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment]) Source #

The elements from this collection.

getDeploymentsResponse_nextToken :: Lens' GetDeploymentsResponse (Maybe Text) Source #

The next page of elements from this collection. Not valid for the last element of the collection.

getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int Source #

The response's http status code.