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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

Synopsis

data SyncDeploymentJob = SyncDeploymentJob' {
- clientRequestToken :: Text
- fleet :: Text
}
newSyncDeploymentJob :: Text -> Text -> SyncDeploymentJob
syncDeploymentJob_clientRequestToken :: Lens' SyncDeploymentJob Text
syncDeploymentJob_fleet :: Lens' SyncDeploymentJob Text
data SyncDeploymentJobResponse = SyncDeploymentJobResponse' {
- 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
- httpStatus :: Int
}
newSyncDeploymentJobResponse :: Int -> SyncDeploymentJobResponse
syncDeploymentJobResponse_failureReason :: Lens' SyncDeploymentJobResponse (Maybe Text)
syncDeploymentJobResponse_status :: Lens' SyncDeploymentJobResponse (Maybe DeploymentStatus)
syncDeploymentJobResponse_deploymentApplicationConfigs :: Lens' SyncDeploymentJobResponse (Maybe (NonEmpty DeploymentApplicationConfig))
syncDeploymentJobResponse_arn :: Lens' SyncDeploymentJobResponse (Maybe Text)
syncDeploymentJobResponse_createdAt :: Lens' SyncDeploymentJobResponse (Maybe UTCTime)
syncDeploymentJobResponse_failureCode :: Lens' SyncDeploymentJobResponse (Maybe DeploymentJobErrorCode)
syncDeploymentJobResponse_deploymentConfig :: Lens' SyncDeploymentJobResponse (Maybe DeploymentConfig)
syncDeploymentJobResponse_fleet :: Lens' SyncDeploymentJobResponse (Maybe Text)
syncDeploymentJobResponse_httpStatus :: Lens' SyncDeploymentJobResponse Int

Creating a Request

data SyncDeploymentJob Source #

See: newSyncDeploymentJob smart constructor.

Constructors

SyncDeploymentJob'
Fields clientRequestToken :: Text Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. fleet :: Text The target fleet for the synchronization.

Instances

Instances details

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

newSyncDeploymentJob Source #

Arguments

:: Text	`$sel:clientRequestToken:SyncDeploymentJob'`
-> Text	`$sel:fleet:SyncDeploymentJob'`
-> SyncDeploymentJob

Create a value of SyncDeploymentJob 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:clientRequestToken:SyncDeploymentJob', syncDeploymentJob_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:fleet:SyncDeploymentJob', syncDeploymentJob_fleet - The target fleet for the synchronization.

Request Lenses

syncDeploymentJob_clientRequestToken :: Lens' SyncDeploymentJob Text Source #

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

syncDeploymentJob_fleet :: Lens' SyncDeploymentJob Text Source #

The target fleet for the synchronization.

Destructuring the Response

data SyncDeploymentJobResponse Source #

See: newSyncDeploymentJobResponse smart constructor.

Constructors

SyncDeploymentJobResponse'

Fields

failureReason :: Maybe Text
The failure reason if the job fails.
status :: Maybe DeploymentStatus
The status of the synchronization job.
deploymentApplicationConfigs :: Maybe (NonEmpty DeploymentApplicationConfig)
Information about the deployment application configurations.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the synchronization request.
createdAt :: Maybe POSIX
The time, in milliseconds since the epoch, when the fleet was created.
failureCode :: Maybe DeploymentJobErrorCode
The failure code if the job fails:
InternalServiceError
Internal service error.
RobotApplicationCrash
Robot application exited abnormally.
SimulationApplicationCrash
Simulation application exited abnormally.
BadPermissionsRobotApplication
Robot application bundle could not be downloaded.
BadPermissionsSimulationApplication
Simulation application bundle could not be downloaded.
BadPermissionsS3Output
Unable to publish outputs to customer-provided S3 bucket.
BadPermissionsCloudwatchLogs
Unable to publish logs to customer-provided CloudWatch Logs resource.
SubnetIpLimitExceeded
Subnet IP limit exceeded.
ENILimitExceeded
ENI limit exceeded.
BadPermissionsUserCredentials
Unable to use the Role provided.
InvalidBundleRobotApplication
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
InvalidBundleSimulationApplication
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
RobotApplicationVersionMismatchedEtag
Etag for RobotApplication does not match value during version creation.
SimulationApplicationVersionMismatchedEtag
Etag for SimulationApplication does not match value during version creation.
deploymentConfig :: Maybe DeploymentConfig
Information about the deployment configuration.
fleet :: Maybe Text
The Amazon Resource Name (ARN) of the fleet.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq SyncDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.SyncDeploymentJob Methods (==) :: SyncDeploymentJobResponse -> SyncDeploymentJobResponse -> Bool # (/=) :: SyncDeploymentJobResponse -> SyncDeploymentJobResponse -> Bool #
Read SyncDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.SyncDeploymentJob Methods readsPrec :: Int -> ReadS SyncDeploymentJobResponse # readList :: ReadS [SyncDeploymentJobResponse] # readPrec :: ReadPrec SyncDeploymentJobResponse # readListPrec :: ReadPrec [SyncDeploymentJobResponse] #
Show SyncDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.SyncDeploymentJob Methods showsPrec :: Int -> SyncDeploymentJobResponse -> ShowS # show :: SyncDeploymentJobResponse -> String # showList :: [SyncDeploymentJobResponse] -> ShowS #
Generic SyncDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.SyncDeploymentJob Associated Types type Rep SyncDeploymentJobResponse :: Type -> Type # Methods from :: SyncDeploymentJobResponse -> Rep SyncDeploymentJobResponse x # to :: Rep SyncDeploymentJobResponse x -> SyncDeploymentJobResponse #
NFData SyncDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.SyncDeploymentJob Methods rnf :: SyncDeploymentJobResponse -> () #
type Rep SyncDeploymentJobResponse Source #
Instance details Defined in Amazonka.RobOMaker.SyncDeploymentJob type Rep SyncDeploymentJobResponse = D1 ('MetaData "SyncDeploymentJobResponse" "Amazonka.RobOMaker.SyncDeploymentJob" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "SyncDeploymentJobResponse'" '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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newSyncDeploymentJobResponse Source #

Arguments

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

Create a value of SyncDeploymentJobResponse 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:SyncDeploymentJobResponse', syncDeploymentJobResponse_failureReason - The failure reason if the job fails.

$sel:status:SyncDeploymentJobResponse', syncDeploymentJobResponse_status - The status of the synchronization job.

$sel:deploymentApplicationConfigs:SyncDeploymentJobResponse', syncDeploymentJobResponse_deploymentApplicationConfigs - Information about the deployment application configurations.

$sel:arn:SyncDeploymentJobResponse', syncDeploymentJobResponse_arn - The Amazon Resource Name (ARN) of the synchronization request.

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

$sel:failureCode:SyncDeploymentJobResponse', syncDeploymentJobResponse_failureCode - The failure code if the job fails:

InternalServiceError: Internal service error.
RobotApplicationCrash: Robot application exited abnormally.
SimulationApplicationCrash: Simulation application exited abnormally.
BadPermissionsRobotApplication: Robot application bundle could not be downloaded.
BadPermissionsSimulationApplication: Simulation application bundle could not be downloaded.
BadPermissionsS3Output: Unable to publish outputs to customer-provided S3 bucket.
BadPermissionsCloudwatchLogs: Unable to publish logs to customer-provided CloudWatch Logs resource.
SubnetIpLimitExceeded: Subnet IP limit exceeded.
ENILimitExceeded: ENI limit exceeded.
BadPermissionsUserCredentials: Unable to use the Role provided.
InvalidBundleRobotApplication: Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
InvalidBundleSimulationApplication: Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
RobotApplicationVersionMismatchedEtag: Etag for RobotApplication does not match value during version creation.
SimulationApplicationVersionMismatchedEtag: Etag for SimulationApplication does not match value during version creation.

$sel:deploymentConfig:SyncDeploymentJobResponse', syncDeploymentJobResponse_deploymentConfig - Information about the deployment configuration.

$sel:fleet:SyncDeploymentJob', syncDeploymentJobResponse_fleet - The Amazon Resource Name (ARN) of the fleet.

$sel:httpStatus:SyncDeploymentJobResponse', syncDeploymentJobResponse_httpStatus - The response's http status code.

Response Lenses

syncDeploymentJobResponse_failureReason :: Lens' SyncDeploymentJobResponse (Maybe Text) Source #

The failure reason if the job fails.

syncDeploymentJobResponse_status :: Lens' SyncDeploymentJobResponse (Maybe DeploymentStatus) Source #

The status of the synchronization job.

syncDeploymentJobResponse_deploymentApplicationConfigs :: Lens' SyncDeploymentJobResponse (Maybe (NonEmpty DeploymentApplicationConfig)) Source #

Information about the deployment application configurations.

syncDeploymentJobResponse_arn :: Lens' SyncDeploymentJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the synchronization request.

syncDeploymentJobResponse_createdAt :: Lens' SyncDeploymentJobResponse (Maybe UTCTime) Source #

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

syncDeploymentJobResponse_failureCode :: Lens' SyncDeploymentJobResponse (Maybe DeploymentJobErrorCode) Source #

The failure code if the job fails:

InternalServiceError: Internal service error.
RobotApplicationCrash: Robot application exited abnormally.
SimulationApplicationCrash: Simulation application exited abnormally.
BadPermissionsRobotApplication: Robot application bundle could not be downloaded.
BadPermissionsSimulationApplication: Simulation application bundle could not be downloaded.
BadPermissionsS3Output: Unable to publish outputs to customer-provided S3 bucket.
BadPermissionsCloudwatchLogs: Unable to publish logs to customer-provided CloudWatch Logs resource.
SubnetIpLimitExceeded: Subnet IP limit exceeded.
ENILimitExceeded: ENI limit exceeded.
BadPermissionsUserCredentials: Unable to use the Role provided.
InvalidBundleRobotApplication: Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
InvalidBundleSimulationApplication: Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
RobotApplicationVersionMismatchedEtag: Etag for RobotApplication does not match value during version creation.
SimulationApplicationVersionMismatchedEtag: Etag for SimulationApplication does not match value during version creation.

syncDeploymentJobResponse_deploymentConfig :: Lens' SyncDeploymentJobResponse (Maybe DeploymentConfig) Source #

Information about the deployment configuration.

syncDeploymentJobResponse_fleet :: Lens' SyncDeploymentJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

syncDeploymentJobResponse_httpStatus :: Lens' SyncDeploymentJobResponse Int Source #

The response's http status code.