amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

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

Network.AWS.APIGateway.GetDeployments

Contents

Description

Gets information about a Deployments collection.

This operation returns paginated results.

Synopsis

Creating a Request

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 Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
  • gdPosition - The position of the current Deployment resource in the collection to get information about.
  • gdRestAPIId - The identifier of the RestApi resource for the collection of Deployment resources to get information about.

data GetDeployments #

Requests Amazon API Gateway to get information about a Deployments collection.

See: getDeployments smart constructor.

Instances

Eq GetDeployments # 
Data 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 # 
Show GetDeployments # 
Generic GetDeployments # 

Associated Types

type Rep GetDeployments :: * -> * #

Hashable GetDeployments # 
NFData GetDeployments # 

Methods

rnf :: GetDeployments -> () #

AWSPager GetDeployments # 
AWSRequest GetDeployments # 
ToQuery GetDeployments # 
ToPath GetDeployments # 
ToHeaders GetDeployments # 
type Rep GetDeployments # 
type Rep GetDeployments = D1 (MetaData "GetDeployments" "Network.AWS.APIGateway.GetDeployments" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "GetDeployments'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gdLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_gdPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gdRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs GetDeployments # 

Request Lenses

gdLimit :: Lens' GetDeployments (Maybe Int) #

The maximum number of Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

gdPosition :: Lens' GetDeployments (Maybe Text) #

The position of the current Deployment resource in the collection to get information about.

gdRestAPIId :: Lens' GetDeployments Text #

The identifier of the RestApi resource for the collection of Deployment resources to get information about.

Destructuring the Response

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:

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 # 
Data GetDeploymentsResponse # 

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 # 
Show GetDeploymentsResponse # 
Generic GetDeploymentsResponse # 
NFData GetDeploymentsResponse # 

Methods

rnf :: GetDeploymentsResponse -> () #

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

Response Lenses

gdrsItems :: Lens' GetDeploymentsResponse [Deployment] #

The current page of any Deployment resources in the collection of deployment resources.

gdrsResponseStatus :: Lens' GetDeploymentsResponse Int #

  • - | The response status code.