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.RobOMaker.CreateDeploymentJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deploys a specific version of a robot application to robots in a fleet.

The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.

After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

Synopsis

Creating a Request

data CreateDeploymentJob Source #

See: newCreateDeploymentJob smart constructor.

Constructors

CreateDeploymentJob'

Fields

deploymentConfig :: Maybe DeploymentConfig
The requested deployment configuration.
tags :: Maybe (HashMap Text Text)
A map that contains tag keys and tag values that are attached to the deployment job.
clientRequestToken :: Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
fleet :: Text
The Amazon Resource Name (ARN) of the fleet to deploy.
deploymentApplicationConfigs :: NonEmpty DeploymentApplicationConfig
The deployment application configuration.

Instances

Instances details

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

newCreateDeploymentJob Source #

Arguments

:: Text	`$sel:clientRequestToken:CreateDeploymentJob'`
-> Text	`$sel:fleet:CreateDeploymentJob'`
-> NonEmpty DeploymentApplicationConfig	`$sel:deploymentApplicationConfigs:CreateDeploymentJob'`
-> CreateDeploymentJob

Create a value of CreateDeploymentJob 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:deploymentConfig:CreateDeploymentJob', createDeploymentJob_deploymentConfig - The requested deployment configuration.

$sel:tags:CreateDeploymentJob', createDeploymentJob_tags - A map that contains tag keys and tag values that are attached to the deployment job.

$sel:clientRequestToken:CreateDeploymentJob', createDeploymentJob_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:fleet:CreateDeploymentJob', createDeploymentJob_fleet - The Amazon Resource Name (ARN) of the fleet to deploy.

$sel:deploymentApplicationConfigs:CreateDeploymentJob', createDeploymentJob_deploymentApplicationConfigs - The deployment application configuration.

Request Lenses

createDeploymentJob_deploymentConfig :: Lens' CreateDeploymentJob (Maybe DeploymentConfig) Source #

The requested deployment configuration.

createDeploymentJob_tags :: Lens' CreateDeploymentJob (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the deployment job.

createDeploymentJob_clientRequestToken :: Lens' CreateDeploymentJob Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createDeploymentJob_fleet :: Lens' CreateDeploymentJob Text Source #

The Amazon Resource Name (ARN) of the fleet to deploy.

createDeploymentJob_deploymentApplicationConfigs :: Lens' CreateDeploymentJob (NonEmpty DeploymentApplicationConfig) Source #

The deployment application configuration.

Destructuring the Response

data CreateDeploymentJobResponse Source #

See: newCreateDeploymentJobResponse smart constructor.

Constructors

CreateDeploymentJobResponse'

Fields

failureReason :: Maybe Text
The failure reason of the deployment job if it failed.
status :: Maybe DeploymentStatus
The status of the deployment job.
deploymentApplicationConfigs :: Maybe (NonEmpty DeploymentApplicationConfig)
The deployment application configuration.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the deployment job.
createdAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the fleet was created.
failureCode :: Maybe DeploymentJobErrorCode
The failure code of the simulation job if it failed:
BadPermissionError
AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.
ExtractingBundleFailure
The robot application could not be extracted from the bundle.
FailureThresholdBreached
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
GreengrassDeploymentFailed
The robot application could not be deployed to the robot.
GreengrassGroupVersionDoesNotExist
The AWS Greengrass group or version associated with a robot is missing.
InternalServerError
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
MissingRobotApplicationArchitecture
The robot application does not have a source that matches the architecture of the robot.
MissingRobotDeploymentResource
One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
PostLaunchFileFailure
The post-launch script failed.
PreLaunchFileFailure
The pre-launch script failed.
ResourceNotFound
One or more deployment resources are missing. For example, do robot application source bundles still exist?
RobotDeploymentNoResponse
There is no response from the robot. It might not be powered on or connected to the internet.
deploymentConfig :: Maybe DeploymentConfig
The deployment configuration.
fleet :: Maybe Text
The target fleet for the deployment job.
tags :: Maybe (HashMap Text Text)
The list of all tags added to the deployment job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateDeploymentJob Methods (==) :: CreateDeploymentJobResponse -> CreateDeploymentJobResponse -> Bool # (/=) :: CreateDeploymentJobResponse -> CreateDeploymentJobResponse -> Bool #
Read CreateDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateDeploymentJob Methods readsPrec :: Int -> ReadS CreateDeploymentJobResponse # readList :: ReadS [CreateDeploymentJobResponse] # readPrec :: ReadPrec CreateDeploymentJobResponse # readListPrec :: ReadPrec [CreateDeploymentJobResponse] #
Show CreateDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateDeploymentJob Methods showsPrec :: Int -> CreateDeploymentJobResponse -> ShowS # show :: CreateDeploymentJobResponse -> String # showList :: [CreateDeploymentJobResponse] -> ShowS #
Generic CreateDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateDeploymentJob Associated Types type Rep CreateDeploymentJobResponse :: Type -> Type # Methods from :: CreateDeploymentJobResponse -> Rep CreateDeploymentJobResponse x # to :: Rep CreateDeploymentJobResponse x -> CreateDeploymentJobResponse #
NFData CreateDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateDeploymentJob Methods rnf :: CreateDeploymentJobResponse -> () #
type Rep CreateDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.CreateDeploymentJob type Rep CreateDeploymentJobResponse = D1 ('MetaData "CreateDeploymentJobResponse" "Amazonka.RobOMaker.CreateDeploymentJob" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "CreateDeploymentJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentStatus))) :: (S1 ('MetaSel ('Just "deploymentApplicationConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DeploymentApplicationConfig))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentJobErrorCode)) :: S1 ('MetaSel ('Just "deploymentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentConfig))) :: (S1 ('MetaSel ('Just "fleet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateDeploymentJobResponse Source #

Arguments

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

Create a value of CreateDeploymentJobResponse 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:failureReason:CreateDeploymentJobResponse', createDeploymentJobResponse_failureReason - The failure reason of the deployment job if it failed.

$sel:status:CreateDeploymentJobResponse', createDeploymentJobResponse_status - The status of the deployment job.

$sel:deploymentApplicationConfigs:CreateDeploymentJob', createDeploymentJobResponse_deploymentApplicationConfigs - The deployment application configuration.

$sel:arn:CreateDeploymentJobResponse', createDeploymentJobResponse_arn - The Amazon Resource Name (ARN) of the deployment job.

$sel:createdAt:CreateDeploymentJobResponse', createDeploymentJobResponse_createdAt - The time, in milliseconds since the epoch, when the fleet was created.

$sel:failureCode:CreateDeploymentJobResponse', createDeploymentJobResponse_failureCode - The failure code of the simulation job if it failed:

BadPermissionError: AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.
ExtractingBundleFailure: The robot application could not be extracted from the bundle.
FailureThresholdBreached: The percentage of robots that could not be updated exceeded the percentage set for the deployment.
GreengrassDeploymentFailed: The robot application could not be deployed to the robot.
GreengrassGroupVersionDoesNotExist: The AWS Greengrass group or version associated with a robot is missing.
InternalServerError: An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
MissingRobotApplicationArchitecture: The robot application does not have a source that matches the architecture of the robot.
MissingRobotDeploymentResource: One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
PostLaunchFileFailure: The post-launch script failed.
PreLaunchFileFailure: The pre-launch script failed.
ResourceNotFound: One or more deployment resources are missing. For example, do robot application source bundles still exist?
RobotDeploymentNoResponse: There is no response from the robot. It might not be powered on or connected to the internet.

$sel:deploymentConfig:CreateDeploymentJob', createDeploymentJobResponse_deploymentConfig - The deployment configuration.

$sel:fleet:CreateDeploymentJob', createDeploymentJobResponse_fleet - The target fleet for the deployment job.

$sel:tags:CreateDeploymentJob', createDeploymentJobResponse_tags - The list of all tags added to the deployment job.

$sel:httpStatus:CreateDeploymentJobResponse', createDeploymentJobResponse_httpStatus - The response's http status code.

Response Lenses

createDeploymentJobResponse_failureReason :: Lens' CreateDeploymentJobResponse (Maybe Text) Source #

The failure reason of the deployment job if it failed.

createDeploymentJobResponse_status :: Lens' CreateDeploymentJobResponse (Maybe DeploymentStatus) Source #

The status of the deployment job.

createDeploymentJobResponse_deploymentApplicationConfigs :: Lens' CreateDeploymentJobResponse (Maybe (NonEmpty DeploymentApplicationConfig)) Source #

The deployment application configuration.

createDeploymentJobResponse_arn :: Lens' CreateDeploymentJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the deployment job.

createDeploymentJobResponse_createdAt :: Lens' CreateDeploymentJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the fleet was created.

createDeploymentJobResponse_failureCode :: Lens' CreateDeploymentJobResponse (Maybe DeploymentJobErrorCode) Source #

The failure code of the simulation job if it failed:

BadPermissionError: AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.
ExtractingBundleFailure: The robot application could not be extracted from the bundle.
FailureThresholdBreached: The percentage of robots that could not be updated exceeded the percentage set for the deployment.
GreengrassDeploymentFailed: The robot application could not be deployed to the robot.
GreengrassGroupVersionDoesNotExist: The AWS Greengrass group or version associated with a robot is missing.
InternalServerError: An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
MissingRobotApplicationArchitecture: The robot application does not have a source that matches the architecture of the robot.
MissingRobotDeploymentResource: One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
PostLaunchFileFailure: The post-launch script failed.
PreLaunchFileFailure: The pre-launch script failed.
ResourceNotFound: One or more deployment resources are missing. For example, do robot application source bundles still exist?
RobotDeploymentNoResponse: There is no response from the robot. It might not be powered on or connected to the internet.

createDeploymentJobResponse_deploymentConfig :: Lens' CreateDeploymentJobResponse (Maybe DeploymentConfig) Source #

The deployment configuration.

createDeploymentJobResponse_fleet :: Lens' CreateDeploymentJobResponse (Maybe Text) Source #

The target fleet for the deployment job.

createDeploymentJobResponse_tags :: Lens' CreateDeploymentJobResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the deployment job.

createDeploymentJobResponse_httpStatus :: Lens' CreateDeploymentJobResponse Int Source #

The response's http status code.