Network.AWS.APIGateway.GetDeployments

Gets information about a Deployments collection.

This operation returns paginated results.

Creating a Request

getDeployments

Arguments

:: Text

gdRestAPIId

-> GetDeployments

Creates a value of GetDeployments with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• gdPosition - The current pagination position in the paged result set.
• gdRestAPIId - [Required] The string identifier of the associated RestApi .

data GetDeployments

Requests API Gateway to get information about a Deployments collection.

See: getDeployments smart constructor.

Instances

Eq GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

(==) :: GetDeployments -> GetDeployments -> Bool

(/=) :: GetDeployments -> GetDeployments -> Bool

Data GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDeployments -> c GetDeployments

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDeployments

toConstr :: GetDeployments -> Constr

dataTypeOf :: GetDeployments -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetDeployments)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDeployments)

gmapT :: (forall b. Data b => b -> b) -> GetDeployments -> GetDeployments

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDeployments -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDeployments -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDeployments -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDeployments -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDeployments -> m GetDeployments

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDeployments -> m GetDeployments

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDeployments -> m GetDeployments

Read GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

readsPrec :: Int -> ReadS GetDeployments

readList :: ReadS [GetDeployments]

readPrec :: ReadPrec GetDeployments

readListPrec :: ReadPrec [GetDeployments]

Show GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

showsPrec :: Int -> GetDeployments -> ShowS

show :: GetDeployments -> String

showList :: [GetDeployments] -> ShowS

Generic GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Associated Types

type Rep GetDeployments :: Type -> Type

Methods

from :: GetDeployments -> Rep GetDeployments x

to :: Rep GetDeployments x -> GetDeployments

Hashable GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

hashWithSalt :: Int -> GetDeployments -> Int

hash :: GetDeployments -> Int

AWSPager GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

page :: GetDeployments -> Rs GetDeployments -> Maybe GetDeployments

AWSRequest GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Associated Types

type Rs GetDeployments :: Type

Methods

request :: GetDeployments -> Request GetDeployments

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetDeployments -> ClientResponse -> m (Response GetDeployments)

ToHeaders GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

toHeaders :: GetDeployments -> [Header]

ToPath GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

toPath :: GetDeployments -> ByteString

ToQuery GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

toQuery :: GetDeployments -> QueryString

NFData GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

Methods

rnf :: GetDeployments -> ()

type Rep GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

type Rep GetDeployments = D1 (MetaData "GetDeployments" "Network.AWS.APIGateway.GetDeployments" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetDeployments'" PrefixI True) (S1 (MetaSel (Just "_gdLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 (MetaSel (Just "_gdPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gdRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetDeployments

Defined in Network.AWS.APIGateway.GetDeployments

type Rs GetDeployments = GetDeploymentsResponse

Request Lenses

gdLimit :: Lens' GetDeployments (Maybe Int)

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

gdPosition :: Lens' GetDeployments (Maybe Text)

The current pagination position in the paged result set.

gdRestAPIId :: Lens' GetDeployments Text

Required

The string identifier of the associated RestApi .

Destructuring the Response

getDeploymentsResponse

Arguments

:: Int

gdrsResponseStatus

-> GetDeploymentsResponse

Creates a value of GetDeploymentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdrsItems - The current page of elements from this collection.
• gdrsPosition - Undocumented member.
• gdrsResponseStatus - -- | The response status code.

data GetDeploymentsResponse

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

To create a new deployment of a RestApi , make a POST request against this resource. To view, update, or delete an existing deployment, make a GET , PATCH , or DELETE request, respectively, on a specified Deployment resource.Deploying an API , AWS CLI , AWS SDKs

See: getDeploymentsResponse smart constructor.

Instances

Eq GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

Methods

(==) :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool

(/=) :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool

Data GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDeploymentsResponse -> c GetDeploymentsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDeploymentsResponse

toConstr :: GetDeploymentsResponse -> Constr

dataTypeOf :: GetDeploymentsResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetDeploymentsResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDeploymentsResponse)

gmapT :: (forall b. Data b => b -> b) -> GetDeploymentsResponse -> GetDeploymentsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDeploymentsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDeploymentsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDeploymentsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDeploymentsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDeploymentsResponse -> m GetDeploymentsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDeploymentsResponse -> m GetDeploymentsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDeploymentsResponse -> m GetDeploymentsResponse

Read GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

Methods

readsPrec :: Int -> ReadS GetDeploymentsResponse

readList :: ReadS [GetDeploymentsResponse]

readPrec :: ReadPrec GetDeploymentsResponse

readListPrec :: ReadPrec [GetDeploymentsResponse]

Show GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

Methods

showsPrec :: Int -> GetDeploymentsResponse -> ShowS

show :: GetDeploymentsResponse -> String

showList :: [GetDeploymentsResponse] -> ShowS

Generic GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

Associated Types

type Rep GetDeploymentsResponse :: Type -> Type

Methods

from :: GetDeploymentsResponse -> Rep GetDeploymentsResponse x

to :: Rep GetDeploymentsResponse x -> GetDeploymentsResponse

NFData GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

Methods

rnf :: GetDeploymentsResponse -> ()

type Rep GetDeploymentsResponse

Defined in Network.AWS.APIGateway.GetDeployments

type Rep GetDeploymentsResponse = D1 (MetaData "GetDeploymentsResponse" "Network.AWS.APIGateway.GetDeployments" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetDeploymentsResponse'" PrefixI True) (S1 (MetaSel (Just "_gdrsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Deployment])) :*: (S1 (MetaSel (Just "_gdrsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gdrsItems :: Lens' GetDeploymentsResponse [Deployment]

The current page of elements from this collection.

gdrsPosition :: Lens' GetDeploymentsResponse (Maybe Text)

Undocumented member.

gdrsResponseStatus :: Lens' GetDeploymentsResponse Int

• - | The response status code.