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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

Synopsis

data CreateDeployment = CreateDeployment' {
- amznClientToken :: Maybe Text
- deploymentId :: Maybe Text
- groupVersionId :: Maybe Text
- groupId :: Text
- deploymentType :: DeploymentType
}
newCreateDeployment :: Text -> DeploymentType -> CreateDeployment
createDeployment_amznClientToken :: Lens' CreateDeployment (Maybe Text)
createDeployment_deploymentId :: Lens' CreateDeployment (Maybe Text)
createDeployment_groupVersionId :: Lens' CreateDeployment (Maybe Text)
createDeployment_groupId :: Lens' CreateDeployment Text
createDeployment_deploymentType :: Lens' CreateDeployment DeploymentType
data CreateDeploymentResponse = CreateDeploymentResponse' {
- deploymentArn :: Maybe Text
- deploymentId :: Maybe Text
- httpStatus :: Int
}
newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
createDeploymentResponse_deploymentArn :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int

Creating a Request

data CreateDeployment Source #

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment'

Fields

amznClientToken :: Maybe Text
A client token used to correlate requests and responses.
deploymentId :: Maybe Text
The ID of the deployment if you wish to redeploy a previous deployment.
groupVersionId :: Maybe Text
The ID of the group version to be deployed.
groupId :: Text
The ID of the Greengrass group.
deploymentType :: DeploymentType
The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

Instances

Instances details

ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
ToHeaders CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods toHeaders :: CreateDeployment -> [Header] #
ToPath CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods toPath :: CreateDeployment -> ByteString #
ToQuery CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods toQuery :: CreateDeployment -> QueryString #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.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.Greengrass.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.Greengrass.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeployment # readList :: ReadS [CreateDeployment] # readPrec :: ReadPrec CreateDeployment # readListPrec :: ReadPrec [CreateDeployment] #
Show CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods showsPrec :: Int -> CreateDeployment -> ShowS # show :: CreateDeployment -> String # showList :: [CreateDeployment] -> ShowS #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods rnf :: CreateDeployment -> () #
Eq CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment type AWSResponse CreateDeployment = CreateDeploymentResponse
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.Greengrass.CreateDeployment" "amazonka-greengrass-2.0-KjUXjyW3l8XyfFjm5ZueR" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "amznClientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "groupVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentType)))))

newCreateDeployment Source #

Arguments

:: Text	`$sel:groupId:CreateDeployment'`
-> DeploymentType	`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:

$sel:amznClientToken:CreateDeployment', createDeployment_amznClientToken - A client token used to correlate requests and responses.

CreateDeployment, createDeployment_deploymentId - The ID of the deployment if you wish to redeploy a previous deployment.

$sel:groupVersionId:CreateDeployment', createDeployment_groupVersionId - The ID of the group version to be deployed.

$sel:groupId:CreateDeployment', createDeployment_groupId - The ID of the Greengrass group.

CreateDeployment, createDeployment_deploymentType - The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

Request Lenses

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

A client token used to correlate requests and responses.

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

The ID of the deployment if you wish to redeploy a previous deployment.

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

The ID of the group version to be deployed.

createDeployment_groupId :: Lens' CreateDeployment Text Source #

The ID of the Greengrass group.

createDeployment_deploymentType :: Lens' CreateDeployment DeploymentType Source #

The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

Destructuring the Response

data CreateDeploymentResponse Source #

See: newCreateDeploymentResponse smart constructor.

Constructors

CreateDeploymentResponse'
Fields deploymentArn :: Maybe Text The ARN of the deployment. deploymentId :: Maybe Text The ID of the deployment. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Greengrass.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.Greengrass.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeploymentResponse # readList :: ReadS [CreateDeploymentResponse] # readPrec :: ReadPrec CreateDeploymentResponse # readListPrec :: ReadPrec [CreateDeploymentResponse] #
Show CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods showsPrec :: Int -> CreateDeploymentResponse -> ShowS # show :: CreateDeploymentResponse -> String # showList :: [CreateDeploymentResponse] -> ShowS #
NFData CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods rnf :: CreateDeploymentResponse -> () #
Eq CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment Methods (==) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool # (/=) :: CreateDeploymentResponse -> CreateDeploymentResponse -> Bool #
type Rep CreateDeploymentResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateDeployment type Rep CreateDeploymentResponse = D1 ('MetaData "CreateDeploymentResponse" "Amazonka.Greengrass.CreateDeployment" "amazonka-greengrass-2.0-KjUXjyW3l8XyfFjm5ZueR" 'False) (C1 ('MetaCons "CreateDeploymentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deploymentId") '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_deploymentArn - The ARN of the deployment.

CreateDeployment, createDeploymentResponse_deploymentId - The ID of the deployment.

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

Response Lenses

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

The ARN of the deployment.

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

The ID of the deployment.

createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #

The response's http status code.