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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a Deployment.

Synopsis

data GetDeployment = GetDeployment' {
- apiId :: Text
- deploymentId :: Text
}
newGetDeployment :: Text -> Text -> GetDeployment
getDeployment_apiId :: Lens' GetDeployment Text
getDeployment_deploymentId :: Lens' GetDeployment Text
data GetDeploymentResponse = GetDeploymentResponse' {
- autoDeployed :: Maybe Bool
- createdDate :: Maybe ISO8601
- deploymentId :: Maybe Text
- deploymentStatus :: Maybe DeploymentStatus
- deploymentStatusMessage :: Maybe Text
- description :: Maybe Text
- httpStatus :: Int
}
newGetDeploymentResponse :: Int -> GetDeploymentResponse
getDeploymentResponse_autoDeployed :: Lens' GetDeploymentResponse (Maybe Bool)
getDeploymentResponse_createdDate :: Lens' GetDeploymentResponse (Maybe UTCTime)
getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus)
getDeploymentResponse_deploymentStatusMessage :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_description :: Lens' GetDeploymentResponse (Maybe Text)
getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int

Creating a Request

data GetDeployment Source #

See: newGetDeployment smart constructor.

Constructors

GetDeployment'
Fields apiId :: Text The API identifier. deploymentId :: Text The deployment ID.

Instances

Instances details

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

newGetDeployment Source #

Arguments

:: Text	`GetDeployment`
-> Text	`GetDeployment`
-> GetDeployment

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

GetDeployment, getDeployment_apiId - The API identifier.

GetDeployment, getDeployment_deploymentId - The deployment ID.

Request Lenses

getDeployment_apiId :: Lens' GetDeployment Text Source #

The API identifier.

getDeployment_deploymentId :: Lens' GetDeployment Text Source #

The deployment ID.

Destructuring the Response

data GetDeploymentResponse Source #

See: newGetDeploymentResponse smart constructor.

Constructors

GetDeploymentResponse'

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 GetDeploymentResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetDeployment Associated Types type Rep GetDeploymentResponse :: Type -> Type # Methods from :: GetDeploymentResponse -> Rep GetDeploymentResponse x # to :: Rep GetDeploymentResponse x -> GetDeploymentResponse #
Read GetDeploymentResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetDeployment Methods readsPrec :: Int -> ReadS GetDeploymentResponse # readList :: ReadS [GetDeploymentResponse] # readPrec :: ReadPrec GetDeploymentResponse # readListPrec :: ReadPrec [GetDeploymentResponse] #
Show GetDeploymentResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetDeployment Methods showsPrec :: Int -> GetDeploymentResponse -> ShowS # show :: GetDeploymentResponse -> String # showList :: [GetDeploymentResponse] -> ShowS #
NFData GetDeploymentResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetDeployment Methods rnf :: GetDeploymentResponse -> () #
Eq GetDeploymentResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetDeployment Methods (==) :: GetDeploymentResponse -> GetDeploymentResponse -> Bool # (/=) :: GetDeploymentResponse -> GetDeploymentResponse -> Bool #
type Rep GetDeploymentResponse Source #
Instance details Defined in Amazonka.ApiGatewayV2.GetDeployment type Rep GetDeploymentResponse = D1 ('MetaData "GetDeploymentResponse" "Amazonka.ApiGatewayV2.GetDeployment" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "GetDeploymentResponse'" '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)))))

newGetDeploymentResponse Source #

Arguments

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

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

GetDeploymentResponse, getDeploymentResponse_autoDeployed - Specifies whether a deployment was automatically released.

GetDeploymentResponse, getDeploymentResponse_createdDate - The date and time when the Deployment resource was created.

GetDeployment, getDeploymentResponse_deploymentId - The identifier for the deployment.

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

GetDeploymentResponse, getDeploymentResponse_deploymentStatusMessage - May contain additional feedback on the status of an API deployment.

GetDeploymentResponse, getDeploymentResponse_description - The description for the deployment.

$sel:httpStatus:GetDeploymentResponse', getDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

getDeploymentResponse_autoDeployed :: Lens' GetDeploymentResponse (Maybe Bool) Source #

Specifies whether a deployment was automatically released.

getDeploymentResponse_createdDate :: Lens' GetDeploymentResponse (Maybe UTCTime) Source #

The date and time when the Deployment resource was created.

getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text) Source #

The identifier for the deployment.

getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus) Source #

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

getDeploymentResponse_deploymentStatusMessage :: Lens' GetDeploymentResponse (Maybe Text) Source #

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

getDeploymentResponse_description :: Lens' GetDeploymentResponse (Maybe Text) Source #

The description for the deployment.

getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int Source #

The response's http status code.