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.UpdateDeployment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a Deployment.

Synopsis

data UpdateDeployment = UpdateDeployment' {
- description :: Maybe Text
- apiId :: Text
- deploymentId :: Text
}
newUpdateDeployment :: Text -> Text -> UpdateDeployment
updateDeployment_description :: Lens' UpdateDeployment (Maybe Text)
updateDeployment_apiId :: Lens' UpdateDeployment Text
updateDeployment_deploymentId :: Lens' UpdateDeployment Text
data UpdateDeploymentResponse = UpdateDeploymentResponse' {
- autoDeployed :: Maybe Bool
- createdDate :: Maybe ISO8601
- deploymentId :: Maybe Text
- deploymentStatus :: Maybe DeploymentStatus
- deploymentStatusMessage :: Maybe Text
- description :: Maybe Text
- httpStatus :: Int
}
newUpdateDeploymentResponse :: Int -> UpdateDeploymentResponse
updateDeploymentResponse_autoDeployed :: Lens' UpdateDeploymentResponse (Maybe Bool)
updateDeploymentResponse_createdDate :: Lens' UpdateDeploymentResponse (Maybe UTCTime)
updateDeploymentResponse_deploymentId :: Lens' UpdateDeploymentResponse (Maybe Text)
updateDeploymentResponse_deploymentStatus :: Lens' UpdateDeploymentResponse (Maybe DeploymentStatus)
updateDeploymentResponse_deploymentStatusMessage :: Lens' UpdateDeploymentResponse (Maybe Text)
updateDeploymentResponse_description :: Lens' UpdateDeploymentResponse (Maybe Text)
updateDeploymentResponse_httpStatus :: Lens' UpdateDeploymentResponse Int

Creating a Request

data UpdateDeployment Source #

Updates a Deployment.

See: newUpdateDeployment smart constructor.

Constructors

UpdateDeployment'
Fields description :: Maybe Text The description for the deployment resource. apiId :: Text The API identifier. deploymentId :: Text The deployment ID.

Instances

Instances details

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

newUpdateDeployment Source #

Arguments

:: Text	`UpdateDeployment`
-> Text	`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:

UpdateDeployment, updateDeployment_description - The description for the deployment resource.

UpdateDeployment, updateDeployment_apiId - The API identifier.

UpdateDeployment, updateDeployment_deploymentId - The deployment ID.

Request Lenses

updateDeployment_description :: Lens' UpdateDeployment (Maybe Text) Source #

The description for the deployment resource.

updateDeployment_apiId :: Lens' UpdateDeployment Text Source #

The API identifier.

updateDeployment_deploymentId :: Lens' UpdateDeployment Text Source #

The deployment ID.

Destructuring the Response

data UpdateDeploymentResponse Source #

See: newUpdateDeploymentResponse smart constructor.

Constructors

UpdateDeploymentResponse'

Fields

autoDeployed :: Maybe Bool
Specifies whether a deployment was automatically released.
createdDate :: Maybe ISO8601
The date and time when the Deployment resource was created.
deploymentId :: Maybe Text
The identifier for the deployment.
deploymentStatus :: Maybe DeploymentStatus
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
deploymentStatusMessage :: Maybe Text
May contain additional feedback on the status of an API deployment.
description :: Maybe Text
The description for the deployment.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateDeploymentResponse Source #

Arguments

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

Create a value of UpdateDeploymentResponse 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:

UpdateDeploymentResponse, updateDeploymentResponse_autoDeployed - Specifies whether a deployment was automatically released.

UpdateDeploymentResponse, updateDeploymentResponse_createdDate - The date and time when the Deployment resource was created.

UpdateDeployment, updateDeploymentResponse_deploymentId - The identifier for the deployment.

UpdateDeploymentResponse, updateDeploymentResponse_deploymentStatus - The status of the deployment: PENDING, FAILED, or SUCCEEDED.

UpdateDeploymentResponse, updateDeploymentResponse_deploymentStatusMessage - May contain additional feedback on the status of an API deployment.

UpdateDeployment, updateDeploymentResponse_description - The description for the deployment.

$sel:httpStatus:UpdateDeploymentResponse', updateDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

updateDeploymentResponse_autoDeployed :: Lens' UpdateDeploymentResponse (Maybe Bool) Source #

Specifies whether a deployment was automatically released.

updateDeploymentResponse_createdDate :: Lens' UpdateDeploymentResponse (Maybe UTCTime) Source #

The date and time when the Deployment resource was created.

updateDeploymentResponse_deploymentId :: Lens' UpdateDeploymentResponse (Maybe Text) Source #

The identifier for the deployment.

updateDeploymentResponse_deploymentStatus :: Lens' UpdateDeploymentResponse (Maybe DeploymentStatus) Source #

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

updateDeploymentResponse_deploymentStatusMessage :: Lens' UpdateDeploymentResponse (Maybe Text) Source #

May contain additional feedback on the status of an API deployment.

updateDeploymentResponse_description :: Lens' UpdateDeploymentResponse (Maybe Text) Source #

The description for the deployment.

updateDeploymentResponse_httpStatus :: Lens' UpdateDeploymentResponse Int Source #

The response's http status code.