Amazonka.RobOMaker.DescribeSimulationJob

Describes a simulation job.

Creating a Request

data DescribeSimulationJob

See: newDescribeSimulationJob smart constructor.

Constructors

DescribeSimulationJob'

Fields

• job :: Text

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

Instances

ToJSON DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toJSON :: DescribeSimulationJob -> Value

toEncoding :: DescribeSimulationJob -> Encoding

toJSONList :: [DescribeSimulationJob] -> Value

toEncodingList :: [DescribeSimulationJob] -> Encoding

ToHeaders DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toHeaders :: DescribeSimulationJob -> [Header]

ToPath DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toPath :: DescribeSimulationJob -> ByteString

ToQuery DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

toQuery :: DescribeSimulationJob -> QueryString

AWSRequest DescribeSimulationJob

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

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

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

readsPrec :: Int -> ReadS DescribeSimulationJob

readList :: ReadS [DescribeSimulationJob]

readPrec :: ReadPrec DescribeSimulationJob

readListPrec :: ReadPrec [DescribeSimulationJob]

Show DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

showsPrec :: Int -> DescribeSimulationJob -> ShowS

show :: DescribeSimulationJob -> String

showList :: [DescribeSimulationJob] -> ShowS

NFData DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

rnf :: DescribeSimulationJob -> ()

Eq DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

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

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

Hashable DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

hashWithSalt :: Int -> DescribeSimulationJob -> Int

hash :: DescribeSimulationJob -> Int

type AWSResponse DescribeSimulationJob

Defined in Amazonka.RobOMaker.DescribeSimulationJob

type AWSResponse DescribeSimulationJob = DescribeSimulationJobResponse

type Rep DescribeSimulationJob

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

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

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

Destructuring the Response

data DescribeSimulationJobResponse

See: newDescribeSimulationJobResponse smart constructor.

Constructors

DescribeSimulationJobResponse'

Fields

• arn :: Maybe Text

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

• clientRequestToken :: Maybe Text

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

• compute :: Maybe ComputeResponse

  Compute information for the simulation job.

• dataSources :: Maybe [DataSource]

  The data sources for the simulation job.

• failureBehavior :: Maybe FailureBehavior

  The failure behavior for the simulation job.

• failureCode :: Maybe SimulationJobErrorCode

  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.

• failureReason :: Maybe Text

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

• iamRole :: Maybe Text

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

• lastStartedAt :: Maybe POSIX

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

• lastUpdatedAt :: Maybe POSIX

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

• loggingConfig :: Maybe LoggingConfig

  The logging configuration.

• maxJobDurationInSeconds :: Maybe Integer

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

• name :: Maybe Text

  The name of the simulation job.

• networkInterface :: Maybe NetworkInterface

  The network interface information for the simulation job.

• outputLocation :: Maybe OutputLocation

  Location for output files generated by the simulation job.

• robotApplications :: Maybe (NonEmpty RobotApplicationConfig)

  A list of robot applications.

• simulationApplications :: Maybe (NonEmpty SimulationApplicationConfig)

  A list of simulation applications.

• simulationTimeMillis :: Maybe Integer

  The simulation job execution duration in milliseconds.

• status :: Maybe SimulationJobStatus

  The status of the simulation job.

• tags :: Maybe (HashMap Text Text)

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

• vpcConfig :: Maybe VPCConfigResponse

  The VPC configuration.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeSimulationJobResponse

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

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

readsPrec :: Int -> ReadS DescribeSimulationJobResponse

readList :: ReadS [DescribeSimulationJobResponse]

readPrec :: ReadPrec DescribeSimulationJobResponse

readListPrec :: ReadPrec [DescribeSimulationJobResponse]

Show DescribeSimulationJobResponse

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

showsPrec :: Int -> DescribeSimulationJobResponse -> ShowS

show :: DescribeSimulationJobResponse -> String

showList :: [DescribeSimulationJobResponse] -> ShowS

NFData DescribeSimulationJobResponse

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

rnf :: DescribeSimulationJobResponse -> ()

Eq DescribeSimulationJobResponse

Defined in Amazonka.RobOMaker.DescribeSimulationJob

Methods

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

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

type Rep DescribeSimulationJobResponse

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

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)

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

describeSimulationJobResponse_clientRequestToken :: Lens' DescribeSimulationJobResponse (Maybe Text)

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

describeSimulationJobResponse_compute :: Lens' DescribeSimulationJobResponse (Maybe ComputeResponse)

Compute information for the simulation job.

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

The data sources for the simulation job.

describeSimulationJobResponse_failureBehavior :: Lens' DescribeSimulationJobResponse (Maybe FailureBehavior)

The failure behavior for the simulation job.

describeSimulationJobResponse_failureCode :: Lens' DescribeSimulationJobResponse (Maybe SimulationJobErrorCode)

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)

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

describeSimulationJobResponse_iamRole :: Lens' DescribeSimulationJobResponse (Maybe Text)

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)

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

describeSimulationJobResponse_lastUpdatedAt :: Lens' DescribeSimulationJobResponse (Maybe UTCTime)

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

describeSimulationJobResponse_loggingConfig :: Lens' DescribeSimulationJobResponse (Maybe LoggingConfig)

The logging configuration.

describeSimulationJobResponse_maxJobDurationInSeconds :: Lens' DescribeSimulationJobResponse (Maybe Integer)

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

describeSimulationJobResponse_name :: Lens' DescribeSimulationJobResponse (Maybe Text)

The name of the simulation job.

describeSimulationJobResponse_networkInterface :: Lens' DescribeSimulationJobResponse (Maybe NetworkInterface)

The network interface information for the simulation job.

describeSimulationJobResponse_outputLocation :: Lens' DescribeSimulationJobResponse (Maybe OutputLocation)

Location for output files generated by the simulation job.

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

A list of robot applications.

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

A list of simulation applications.

describeSimulationJobResponse_simulationTimeMillis :: Lens' DescribeSimulationJobResponse (Maybe Integer)

The simulation job execution duration in milliseconds.

describeSimulationJobResponse_status :: Lens' DescribeSimulationJobResponse (Maybe SimulationJobStatus)

The status of the simulation job.

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

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

describeSimulationJobResponse_vpcConfig :: Lens' DescribeSimulationJobResponse (Maybe VPCConfigResponse)

The VPC configuration.

describeSimulationJobResponse_httpStatus :: Lens' DescribeSimulationJobResponse Int

The response's http status code.