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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Deployment for an API.

Synopsis

data CreateDeployment = CreateDeployment' {
- description :: Maybe Text
- stageName :: Maybe Text
- apiId :: Text
}
newCreateDeployment :: Text -> CreateDeployment
createDeployment_description :: Lens' CreateDeployment (Maybe Text)
createDeployment_stageName :: Lens' CreateDeployment (Maybe Text)
createDeployment_apiId :: Lens' CreateDeployment Text
data CreateDeploymentResponse = CreateDeploymentResponse' {
- autoDeployed :: Maybe Bool
- createdDate :: Maybe ISO8601
- deploymentId :: Maybe Text
- deploymentStatus :: Maybe DeploymentStatus
- deploymentStatusMessage :: Maybe Text
- description :: Maybe Text
- httpStatus :: Int
}
newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
createDeploymentResponse_autoDeployed :: Lens' CreateDeploymentResponse (Maybe Bool)
createDeploymentResponse_createdDate :: Lens' CreateDeploymentResponse (Maybe UTCTime)
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_deploymentStatus :: Lens' CreateDeploymentResponse (Maybe DeploymentStatus)
createDeploymentResponse_deploymentStatusMessage :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_description :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int

Creating a Request

data CreateDeployment Source #

Creates a new Deployment resource to represent a deployment.

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment'
Fields description :: Maybe Text The description for the deployment resource. stageName :: Maybe Text The name of the Stage resource for the Deployment resource to create. apiId :: Text The API identifier.

Instances

Instances details

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

newCreateDeployment Source #

Arguments

:: Text	`CreateDeployment`
-> CreateDeployment

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

CreateDeployment, createDeployment_description - The description for the deployment resource.

CreateDeployment, createDeployment_stageName - The name of the Stage resource for the Deployment resource to create.

CreateDeployment, createDeployment_apiId - The API identifier.

Request Lenses

createDeployment_description :: Lens' CreateDeployment (Maybe Text) Source #

The description for the deployment resource.

createDeployment_stageName :: Lens' CreateDeployment (Maybe Text) Source #

The name of the Stage resource for the Deployment resource to create.

createDeployment_apiId :: Lens' CreateDeployment Text Source #

The API identifier.

Destructuring the Response

data CreateDeploymentResponse Source #

See: newCreateDeploymentResponse smart constructor.

Constructors

CreateDeploymentResponse'

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

newCreateDeploymentResponse Source #

Arguments

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

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

CreateDeploymentResponse, createDeploymentResponse_autoDeployed - Specifies whether a deployment was automatically released.

CreateDeploymentResponse, createDeploymentResponse_createdDate - The date and time when the Deployment resource was created.

CreateDeploymentResponse, createDeploymentResponse_deploymentId - The identifier for the deployment.

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

CreateDeploymentResponse, createDeploymentResponse_deploymentStatusMessage - May contain additional feedback on the status of an API deployment.

CreateDeployment, createDeploymentResponse_description - The description for the deployment.

$sel:httpStatus:CreateDeploymentResponse', createDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

createDeploymentResponse_autoDeployed :: Lens' CreateDeploymentResponse (Maybe Bool) Source #

Specifies whether a deployment was automatically released.

createDeploymentResponse_createdDate :: Lens' CreateDeploymentResponse (Maybe UTCTime) Source #

The date and time when the Deployment resource was created.

createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #

The identifier for the deployment.

createDeploymentResponse_deploymentStatus :: Lens' CreateDeploymentResponse (Maybe DeploymentStatus) Source #

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

createDeploymentResponse_deploymentStatusMessage :: Lens' CreateDeploymentResponse (Maybe Text) Source #

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

createDeploymentResponse_description :: Lens' CreateDeploymentResponse (Maybe Text) Source #

The description for the deployment.

createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #

The response's http status code.