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
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
- data CreateDeploymentJob = CreateDeploymentJob' {}
- newCreateDeploymentJob :: Text -> Text -> NonEmpty DeploymentApplicationConfig -> CreateDeploymentJob
- createDeploymentJob_deploymentConfig :: Lens' CreateDeploymentJob (Maybe DeploymentConfig)
- createDeploymentJob_tags :: Lens' CreateDeploymentJob (Maybe (HashMap Text Text))
- createDeploymentJob_clientRequestToken :: Lens' CreateDeploymentJob Text
- createDeploymentJob_fleet :: Lens' CreateDeploymentJob Text
- createDeploymentJob_deploymentApplicationConfigs :: Lens' CreateDeploymentJob (NonEmpty DeploymentApplicationConfig)
- data CreateDeploymentJobResponse = CreateDeploymentJobResponse' {
- failureReason :: Maybe Text
- status :: Maybe DeploymentStatus
- deploymentApplicationConfigs :: Maybe (NonEmpty DeploymentApplicationConfig)
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- failureCode :: Maybe DeploymentJobErrorCode
- deploymentConfig :: Maybe DeploymentConfig
- fleet :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- newCreateDeploymentJobResponse :: Int -> CreateDeploymentJobResponse
- createDeploymentJobResponse_failureReason :: Lens' CreateDeploymentJobResponse (Maybe Text)
- createDeploymentJobResponse_status :: Lens' CreateDeploymentJobResponse (Maybe DeploymentStatus)
- createDeploymentJobResponse_deploymentApplicationConfigs :: Lens' CreateDeploymentJobResponse (Maybe (NonEmpty DeploymentApplicationConfig))
- createDeploymentJobResponse_arn :: Lens' CreateDeploymentJobResponse (Maybe Text)
- createDeploymentJobResponse_createdAt :: Lens' CreateDeploymentJobResponse (Maybe UTCTime)
- createDeploymentJobResponse_failureCode :: Lens' CreateDeploymentJobResponse (Maybe DeploymentJobErrorCode)
- createDeploymentJobResponse_deploymentConfig :: Lens' CreateDeploymentJobResponse (Maybe DeploymentConfig)
- createDeploymentJobResponse_fleet :: Lens' CreateDeploymentJobResponse (Maybe Text)
- createDeploymentJobResponse_tags :: Lens' CreateDeploymentJobResponse (Maybe (HashMap Text Text))
- createDeploymentJobResponse_httpStatus :: Lens' CreateDeploymentJobResponse Int
Creating a Request
data CreateDeploymentJob Source #
See: newCreateDeploymentJob
smart constructor.
Constructors
CreateDeploymentJob' | |
Fields
|
Instances
newCreateDeploymentJob Source #
Arguments
:: Text | |
-> Text | |
-> NonEmpty DeploymentApplicationConfig | |
-> 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
|
Instances
newCreateDeploymentJobResponse Source #
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.