amazonka-robomaker-2.0: Amazon RoboMaker SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RobOMaker.DescribeSimulationJob

Description

Describes a simulation job.

Synopsis

Creating a Request

data DescribeSimulationJob Source #

See: newDescribeSimulationJob smart constructor.

Constructors

DescribeSimulationJob' 

Fields

  • job :: Text

    The Amazon Resource Name (ARN) of the simulation job to be described.

Instances

Instances details
ToJSON DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toJSON :: DescribeSimulationJob -> Value #

toEncoding :: DescribeSimulationJob -> Encoding #

toJSONList :: [DescribeSimulationJob] -> Value #

toEncodingList :: [DescribeSimulationJob] -> Encoding #

ToHeaders DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toHeaders :: DescribeSimulationJob -> [Header] #

ToPath DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toPath :: DescribeSimulationJob -> ByteString #

ToQuery DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toQuery :: DescribeSimulationJob -> QueryString #

AWSRequest DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Associated Types

type AWSResponse DescribeSimulationJob #

Methods

request :: (Service -> Service) -> DescribeSimulationJob -> Request DescribeSimulationJob #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSimulationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSimulationJob))) #

Generic DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Associated Types

type Rep DescribeSimulationJob :: Type -> Type #

Methods

from :: DescribeSimulationJob -> Rep DescribeSimulationJob x #

to :: Rep DescribeSimulationJob x -> DescribeSimulationJob #

Read DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

readsPrec :: Int -> ReadS DescribeSimulationJob #

readList :: ReadS [DescribeSimulationJob] #

readPrec :: ReadPrec DescribeSimulationJob #

readListPrec :: ReadPrec [DescribeSimulationJob] #

Show DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

showsPrec :: Int -> DescribeSimulationJob -> ShowS #

show :: DescribeSimulationJob -> String #

showList :: [DescribeSimulationJob] -> ShowS #

NFData DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

rnf :: DescribeSimulationJob -> () #

Eq DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

(==) :: DescribeSimulationJob -> DescribeSimulationJob -> Bool #

(/=) :: DescribeSimulationJob -> DescribeSimulationJob -> Bool #

Hashable DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

hashWithSalt :: Int -> DescribeSimulationJob -> Int #

hash :: DescribeSimulationJob -> Int #

type AWSResponse DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

type AWSResponse DescribeSimulationJob = DescribeSimulationJobResponse
type Rep DescribeSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

type Rep DescribeSimulationJob = D1 ('MetaData "DescribeSimulationJob" "Amazonka.RobOMaker.DescribeSimulationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "DescribeSimulationJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeSimulationJob Source #

Arguments

:: Text

$sel:job:DescribeSimulationJob'

-> DescribeSimulationJob 

Create a value of DescribeSimulationJob 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:job:DescribeSimulationJob', describeSimulationJob_job - The Amazon Resource Name (ARN) of the simulation job to be described.

Request Lenses

describeSimulationJob_job :: Lens' DescribeSimulationJob Text Source #

The Amazon Resource Name (ARN) of the simulation job to be described.

Destructuring the Response

data DescribeSimulationJobResponse Source #

See: newDescribeSimulationJobResponse smart constructor.

Constructors

DescribeSimulationJobResponse' 

Fields

Instances

Instances details
Generic DescribeSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Associated Types

type Rep DescribeSimulationJobResponse :: Type -> Type #

Methods

from :: DescribeSimulationJobResponse -> Rep DescribeSimulationJobResponse x #

to :: Rep DescribeSimulationJobResponse x -> DescribeSimulationJobResponse #

Read DescribeSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

readsPrec :: Int -> ReadS DescribeSimulationJobResponse #

readList :: ReadS [DescribeSimulationJobResponse] #

readPrec :: ReadPrec DescribeSimulationJobResponse #

readListPrec :: ReadPrec [DescribeSimulationJobResponse] #

Show DescribeSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

showsPrec :: Int -> DescribeSimulationJobResponse -> ShowS #

show :: DescribeSimulationJobResponse -> String #

showList :: [DescribeSimulationJobResponse] -> ShowS #

NFData DescribeSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

rnf :: DescribeSimulationJobResponse -> () #

Eq DescribeSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

(==) :: DescribeSimulationJobResponse -> DescribeSimulationJobResponse -> Bool #

(/=) :: DescribeSimulationJobResponse -> DescribeSimulationJobResponse -> Bool #

type Rep DescribeSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.DescribeSimulationJob

type Rep DescribeSimulationJobResponse = D1 ('MetaData "DescribeSimulationJobResponse" "Amazonka.RobOMaker.DescribeSimulationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "DescribeSimulationJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComputeResponse)) :*: (S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataSource])) :*: S1 ('MetaSel ('Just "failureBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureBehavior))))) :*: ((S1 ('MetaSel ('Just "failureCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobErrorCode)) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lastStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)))))) :*: (((S1 ('MetaSel ('Just "maxJobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "networkInterface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkInterface)) :*: (S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation)) :*: S1 ('MetaSel ('Just "robotApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty RobotApplicationConfig)))))) :*: ((S1 ('MetaSel ('Just "simulationApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SimulationApplicationConfig))) :*: (S1 ('MetaSel ('Just "simulationTimeMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulationJobStatus)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCConfigResponse)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeSimulationJobResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeSimulationJobResponse'

-> DescribeSimulationJobResponse 

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

DescribeSimulationJobResponse, describeSimulationJobResponse_arn - The Amazon Resource Name (ARN) of the simulation job.

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

DescribeSimulationJobResponse, describeSimulationJobResponse_compute - Compute information for the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_dataSources - The data sources for the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_failureBehavior - The failure behavior for the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_failureCode - The failure code of the simulation job if it failed:

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.

DescribeSimulationJobResponse, describeSimulationJobResponse_failureReason - Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

DescribeSimulationJobResponse, describeSimulationJobResponse_iamRole - The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

DescribeSimulationJobResponse, describeSimulationJobResponse_lastStartedAt - The time, in milliseconds since the epoch, when the simulation job was last started.

DescribeSimulationJobResponse, describeSimulationJobResponse_lastUpdatedAt - The time, in milliseconds since the epoch, when the simulation job was last updated.

DescribeSimulationJobResponse, describeSimulationJobResponse_loggingConfig - The logging configuration.

DescribeSimulationJobResponse, describeSimulationJobResponse_maxJobDurationInSeconds - The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

DescribeSimulationJobResponse, describeSimulationJobResponse_name - The name of the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_networkInterface - The network interface information for the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_outputLocation - Location for output files generated by the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_robotApplications - A list of robot applications.

DescribeSimulationJobResponse, describeSimulationJobResponse_simulationApplications - A list of simulation applications.

DescribeSimulationJobResponse, describeSimulationJobResponse_simulationTimeMillis - The simulation job execution duration in milliseconds.

DescribeSimulationJobResponse, describeSimulationJobResponse_status - The status of the simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_tags - The list of all tags added to the specified simulation job.

DescribeSimulationJobResponse, describeSimulationJobResponse_vpcConfig - The VPC configuration.

$sel:httpStatus:DescribeSimulationJobResponse', describeSimulationJobResponse_httpStatus - The response's http status code.

Response Lenses

describeSimulationJobResponse_arn :: Lens' DescribeSimulationJobResponse (Maybe Text) Source #

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

describeSimulationJobResponse_clientRequestToken :: Lens' DescribeSimulationJobResponse (Maybe Text) Source #

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

describeSimulationJobResponse_compute :: Lens' DescribeSimulationJobResponse (Maybe ComputeResponse) Source #

Compute information for the simulation job.

describeSimulationJobResponse_dataSources :: Lens' DescribeSimulationJobResponse (Maybe [DataSource]) Source #

The data sources for the simulation job.

describeSimulationJobResponse_failureBehavior :: Lens' DescribeSimulationJobResponse (Maybe FailureBehavior) Source #

The failure behavior for the simulation job.

describeSimulationJobResponse_failureCode :: Lens' DescribeSimulationJobResponse (Maybe SimulationJobErrorCode) Source #

The failure code of the simulation job if it failed:

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.

describeSimulationJobResponse_failureReason :: Lens' DescribeSimulationJobResponse (Maybe Text) Source #

Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

describeSimulationJobResponse_iamRole :: Lens' DescribeSimulationJobResponse (Maybe Text) Source #

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

describeSimulationJobResponse_lastStartedAt :: Lens' DescribeSimulationJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the simulation job was last started.

describeSimulationJobResponse_lastUpdatedAt :: Lens' DescribeSimulationJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the simulation job was last updated.

describeSimulationJobResponse_loggingConfig :: Lens' DescribeSimulationJobResponse (Maybe LoggingConfig) Source #

The logging configuration.

describeSimulationJobResponse_maxJobDurationInSeconds :: Lens' DescribeSimulationJobResponse (Maybe Integer) Source #

The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

describeSimulationJobResponse_name :: Lens' DescribeSimulationJobResponse (Maybe Text) Source #

The name of the simulation job.

describeSimulationJobResponse_networkInterface :: Lens' DescribeSimulationJobResponse (Maybe NetworkInterface) Source #

The network interface information for the simulation job.

describeSimulationJobResponse_outputLocation :: Lens' DescribeSimulationJobResponse (Maybe OutputLocation) Source #

Location for output files generated by the simulation job.

describeSimulationJobResponse_robotApplications :: Lens' DescribeSimulationJobResponse (Maybe (NonEmpty RobotApplicationConfig)) Source #

A list of robot applications.

describeSimulationJobResponse_simulationApplications :: Lens' DescribeSimulationJobResponse (Maybe (NonEmpty SimulationApplicationConfig)) Source #

A list of simulation applications.

describeSimulationJobResponse_simulationTimeMillis :: Lens' DescribeSimulationJobResponse (Maybe Integer) Source #

The simulation job execution duration in milliseconds.

describeSimulationJobResponse_status :: Lens' DescribeSimulationJobResponse (Maybe SimulationJobStatus) Source #

The status of the simulation job.

describeSimulationJobResponse_tags :: Lens' DescribeSimulationJobResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the specified simulation job.

describeSimulationJobResponse_vpcConfig :: Lens' DescribeSimulationJobResponse (Maybe VPCConfigResponse) Source #

The VPC configuration.

describeSimulationJobResponse_httpStatus :: Lens' DescribeSimulationJobResponse Int Source #

The response's http status code.