Network.AWS.APIGateway.GetDeployment

Gets information about a Deployment resource.

Creating a Request

getDeployment

Arguments

:: Text

gRestAPIId

-> Text

gDeploymentId

-> GetDeployment

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

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

• gEmbed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET restapis{restapi_id}deployments{deployment_id}?embed=var1,var2 . The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET restapis{restapi_id}deployments{deployment_id}?embed=apisummary .
• gRestAPIId - The string identifier of the associated RestApi .
• gDeploymentId - The identifier of the Deployment resource to get information about.

data GetDeployment

Requests Amazon API Gateway to get information about a Deployment resource.

See: getDeployment smart constructor.

Instances

Eq GetDeployment

Methods

(==) :: GetDeployment -> GetDeployment -> Bool

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

Data GetDeployment

Methods

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

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

toConstr :: GetDeployment -> Constr

dataTypeOf :: GetDeployment -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetDeployment

Methods

readsPrec :: Int -> ReadS GetDeployment

readList :: ReadS [GetDeployment]

readPrec :: ReadPrec GetDeployment

readListPrec :: ReadPrec [GetDeployment]

Show GetDeployment

Methods

showsPrec :: Int -> GetDeployment -> ShowS

show :: GetDeployment -> String

showList :: [GetDeployment] -> ShowS

Generic GetDeployment

Associated Types

type Rep GetDeployment :: * -> *

Methods

from :: GetDeployment -> Rep GetDeployment x

to :: Rep GetDeployment x -> GetDeployment

Hashable GetDeployment

Methods

hashWithSalt :: Int -> GetDeployment -> Int

hash :: GetDeployment -> Int

NFData GetDeployment

Methods

rnf :: GetDeployment -> ()

AWSRequest GetDeployment

Associated Types

type Rs GetDeployment :: *

Methods

request :: GetDeployment -> Request GetDeployment

response :: MonadResource m => Logger -> Service -> Proxy * GetDeployment -> ClientResponse -> m (Response GetDeployment)

ToQuery GetDeployment

Methods

toQuery :: GetDeployment -> QueryString

ToPath GetDeployment

Methods

toPath :: GetDeployment -> ByteString

ToHeaders GetDeployment

Methods

toHeaders :: GetDeployment -> [Header]

type Rep GetDeployment

type Rep GetDeployment = D1 (MetaData "GetDeployment" "Network.AWS.APIGateway.GetDeployment" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetDeployment'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gEmbed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_gRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetDeployment

type Rs GetDeployment = Deployment

Request Lenses

gEmbed :: Lens' GetDeployment [Text]

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET restapis{restapi_id}deployments{deployment_id}?embed=var1,var2 . The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET restapis{restapi_id}deployments{deployment_id}?embed=apisummary .

gRestAPIId :: Lens' GetDeployment Text

The string identifier of the associated RestApi .

gDeploymentId :: Lens' GetDeployment Text

The identifier of the Deployment resource to get information about.

Destructuring the Response

deployment :: Deployment

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

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

• dApiSummary - A summary of the RestApi at the date and time that the deployment resource was created.
• dCreatedDate - The date and time that the deployment resource was created.
• dId - The identifier for the deployment resource.
• dDescription - The description for the deployment resource.

data Deployment

An immutable representation of a RestApi resource that can be called by users using Stages . A deployment must be associated with a Stage for it to be callable over the Internet.

To create a deployment, call POST on the Deployments resource of a RestApi . To view, update, or delete a deployment, call GET , PATCH , or DELETE on the specified deployment resource (restapis{restapi_id}deployments{deployment_id} ).RestApi , Deployments , Stage , AWS CLI , AWS SDKs

See: deployment smart constructor.

Instances

Eq Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

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

Data Deployment

Methods

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

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

toConstr :: Deployment -> Constr

dataTypeOf :: Deployment -> DataType

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

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

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

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

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

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

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

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

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

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

Read Deployment

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

Generic Deployment

Associated Types

type Rep Deployment :: * -> *

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

Hashable Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

FromJSON Deployment

Methods

parseJSON :: Value -> Parser Deployment

parseJSONList :: Value -> Parser [Deployment]

NFData Deployment

Methods

rnf :: Deployment -> ()

type Rep Deployment

type Rep Deployment = D1 (MetaData "Deployment" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Deployment'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dApiSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text (Map Text MethodSnapshot))))) (S1 (MetaSel (Just Symbol "_dCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_dId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot))

A summary of the RestApi at the date and time that the deployment resource was created.

dCreatedDate :: Lens' Deployment (Maybe UTCTime)

The date and time that the deployment resource was created.

dId :: Lens' Deployment (Maybe Text)

The identifier for the deployment resource.

dDescription :: Lens' Deployment (Maybe Text)

The description for the deployment resource.