Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.UpdateDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about a Deployment resource.

Synopsis

Creating a Request

data UpdateDeployment Source #

Requests API Gateway to change information about a Deployment resource.

See: newUpdateDeployment smart constructor.

Constructors

UpdateDeployment'
Fields patchOperations :: Maybe [PatchOperation] A list of update operations to be applied to the specified resource and in the order specified in this list. restApiId :: Text Required The string identifier of the associated RestApi. deploymentId :: Text The replacement identifier for the Deployment resource to change information about.

Instances

Instances details

Eq UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods (==) :: UpdateDeployment -> UpdateDeployment -> Bool # (/=) :: UpdateDeployment -> UpdateDeployment -> Bool #
Read UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods readsPrec :: Int -> ReadS UpdateDeployment # readList :: ReadS [UpdateDeployment] # readPrec :: ReadPrec UpdateDeployment # readListPrec :: ReadPrec [UpdateDeployment] #
Show UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods showsPrec :: Int -> UpdateDeployment -> ShowS # show :: UpdateDeployment -> String # showList :: [UpdateDeployment] -> ShowS #
Generic UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Associated Types type Rep UpdateDeployment :: Type -> Type # Methods from :: UpdateDeployment -> Rep UpdateDeployment x # to :: Rep UpdateDeployment x -> UpdateDeployment #
NFData UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods rnf :: UpdateDeployment -> () #
Hashable UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods hashWithSalt :: Int -> UpdateDeployment -> Int # hash :: UpdateDeployment -> Int #
ToJSON UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toJSON :: UpdateDeployment -> Value # toEncoding :: UpdateDeployment -> Encoding # toJSONList :: [UpdateDeployment] -> Value # toEncodingList :: [UpdateDeployment] -> Encoding #
AWSRequest UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Associated Types type AWSResponse UpdateDeployment # Methods request :: UpdateDeployment -> Request UpdateDeployment # response :: MonadResource m => Logger -> Service -> Proxy UpdateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDeployment))) #
ToHeaders UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toHeaders :: UpdateDeployment -> [Header] #
ToPath UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toPath :: UpdateDeployment -> ByteString #
ToQuery UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toQuery :: UpdateDeployment -> QueryString #
type Rep UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment type Rep UpdateDeployment = D1 ('MetaData "UpdateDeployment" "Amazonka.APIGateway.UpdateDeployment" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment type AWSResponse UpdateDeployment = Deployment

newUpdateDeployment Source #

Arguments

:: Text	`$sel:restApiId:UpdateDeployment'`
-> Text	`$sel:deploymentId:UpdateDeployment'`
-> UpdateDeployment

Create a value of UpdateDeployment 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:patchOperations:UpdateDeployment', updateDeployment_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:restApiId:UpdateDeployment', updateDeployment_restApiId - [Required] The string identifier of the associated RestApi.

$sel:deploymentId:UpdateDeployment', updateDeployment_deploymentId - The replacement identifier for the Deployment resource to change information about.

Request Lenses

updateDeployment_patchOperations :: Lens' UpdateDeployment (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateDeployment_restApiId :: Lens' UpdateDeployment Text Source #

Required: The string identifier of the associated RestApi.

updateDeployment_deploymentId :: Lens' UpdateDeployment Text Source #

The replacement identifier for the Deployment resource to change information about.

Destructuring the Response

data Deployment Source #

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: newDeployment smart constructor.

Constructors

Deployment'
Fields apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot)) A summary of the RestApi at the date and time that the deployment resource was created. createdDate :: Maybe POSIX The date and time that the deployment resource was created. id :: Maybe Text The identifier for the deployment resource. description :: Maybe Text The description for the deployment resource.

Instances

Instances details

Eq Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Read Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
Generic Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
NFData Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods rnf :: Deployment -> () #
Hashable Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
FromJSON Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
type Rep Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment Source #

Create a value of Deployment 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:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

Response Lenses

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #

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

deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.