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

Description

Creates a simulation job.

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

Synopsis

Creating a Request

data CreateSimulationJob Source #

See: newCreateSimulationJob smart constructor.

Constructors

CreateSimulationJob' 

Fields

Instances

Instances details
ToJSON CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

ToHeaders CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

ToPath CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

ToQuery CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

AWSRequest CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Associated Types

type AWSResponse CreateSimulationJob #

Generic CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Associated Types

type Rep CreateSimulationJob :: Type -> Type #

Read CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Show CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

NFData CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Methods

rnf :: CreateSimulationJob -> () #

Eq CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Hashable CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

type AWSResponse CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

type Rep CreateSimulationJob Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

type Rep CreateSimulationJob = D1 ('MetaData "CreateSimulationJob" "Amazonka.RobOMaker.CreateSimulationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "CreateSimulationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "compute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Compute)) :*: S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceConfig))))) :*: (S1 ('MetaSel ('Just "failureBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureBehavior)) :*: (S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :*: 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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCConfig)) :*: (S1 ('MetaSel ('Just "maxJobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateSimulationJob Source #

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

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

CreateSimulationJob, createSimulationJob_compute - Compute information for the simulation job.

CreateSimulationJob, createSimulationJob_dataSources - Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

CreateSimulationJob, createSimulationJob_failureBehavior - The failure behavior the simulation job.

Continue
Leaves the instance running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.

CreateSimulationJob, createSimulationJob_loggingConfig - The logging configuration.

CreateSimulationJob, createSimulationJob_outputLocation - Location for output files generated by the simulation job.

CreateSimulationJob, createSimulationJob_robotApplications - The robot application to use in the simulation job.

CreateSimulationJob, createSimulationJob_simulationApplications - The simulation application to use in the simulation job.

CreateSimulationJob, createSimulationJob_tags - A map that contains tag keys and tag values that are attached to the simulation job.

CreateSimulationJob, createSimulationJob_vpcConfig - If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

CreateSimulationJob, createSimulationJob_maxJobDurationInSeconds - The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

CreateSimulationJob, createSimulationJob_iamRole - The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

Request Lenses

createSimulationJob_clientRequestToken :: Lens' CreateSimulationJob (Maybe Text) Source #

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

createSimulationJob_compute :: Lens' CreateSimulationJob (Maybe Compute) Source #

Compute information for the simulation job.

createSimulationJob_dataSources :: Lens' CreateSimulationJob (Maybe (NonEmpty DataSourceConfig)) Source #

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

createSimulationJob_failureBehavior :: Lens' CreateSimulationJob (Maybe FailureBehavior) Source #

The failure behavior the simulation job.

Continue
Leaves the instance running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.

createSimulationJob_outputLocation :: Lens' CreateSimulationJob (Maybe OutputLocation) Source #

Location for output files generated by the simulation job.

createSimulationJob_tags :: Lens' CreateSimulationJob (Maybe (HashMap Text Text)) Source #

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

createSimulationJob_vpcConfig :: Lens' CreateSimulationJob (Maybe VPCConfig) Source #

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

createSimulationJob_maxJobDurationInSeconds :: Lens' CreateSimulationJob Integer Source #

The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

createSimulationJob_iamRole :: Lens' CreateSimulationJob Text Source #

The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

Destructuring the Response

data CreateSimulationJobResponse Source #

See: newCreateSimulationJobResponse smart constructor.

Constructors

CreateSimulationJobResponse' 

Fields

Instances

Instances details
Generic CreateSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Associated Types

type Rep CreateSimulationJobResponse :: Type -> Type #

Read CreateSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Show CreateSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

NFData CreateSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

Eq CreateSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

type Rep CreateSimulationJobResponse Source # 
Instance details

Defined in Amazonka.RobOMaker.CreateSimulationJob

type Rep CreateSimulationJobResponse = D1 ('MetaData "CreateSimulationJobResponse" "Amazonka.RobOMaker.CreateSimulationJob" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "CreateSimulationJobResponse'" '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 "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 "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)))))))

newCreateSimulationJobResponse Source #

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

CreateSimulationJobResponse, createSimulationJobResponse_arn - The Amazon Resource Name (ARN) of the simulation job.

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

CreateSimulationJob, createSimulationJobResponse_compute - Compute information for the simulation job.

CreateSimulationJob, createSimulationJobResponse_dataSources - The data sources for the simulation job.

CreateSimulationJob, createSimulationJobResponse_failureBehavior - the failure behavior for the simulation job.

CreateSimulationJobResponse, createSimulationJobResponse_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.

CreateSimulationJob, createSimulationJobResponse_iamRole - The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.

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

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

CreateSimulationJob, createSimulationJobResponse_loggingConfig - The logging configuration.

CreateSimulationJob, createSimulationJobResponse_maxJobDurationInSeconds - The maximum simulation job duration in seconds.

CreateSimulationJob, createSimulationJobResponse_outputLocation - Simulation job output files location.

CreateSimulationJob, createSimulationJobResponse_robotApplications - The robot application used by the simulation job.

CreateSimulationJob, createSimulationJobResponse_simulationApplications - The simulation application used by the simulation job.

CreateSimulationJobResponse, createSimulationJobResponse_simulationTimeMillis - The simulation job execution duration in milliseconds.

CreateSimulationJobResponse, createSimulationJobResponse_status - The status of the simulation job.

CreateSimulationJob, createSimulationJobResponse_tags - The list of all tags added to the simulation job.

CreateSimulationJob, createSimulationJobResponse_vpcConfig - Information about the vpc configuration.

$sel:httpStatus:CreateSimulationJobResponse', createSimulationJobResponse_httpStatus - The response's http status code.

Response Lenses

createSimulationJobResponse_arn :: Lens' CreateSimulationJobResponse (Maybe Text) Source #

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

createSimulationJobResponse_clientRequestToken :: Lens' CreateSimulationJobResponse (Maybe Text) Source #

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

createSimulationJobResponse_failureCode :: Lens' CreateSimulationJobResponse (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.

createSimulationJobResponse_iamRole :: Lens' CreateSimulationJobResponse (Maybe Text) Source #

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

createSimulationJobResponse_lastStartedAt :: Lens' CreateSimulationJobResponse (Maybe UTCTime) Source #

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

createSimulationJobResponse_lastUpdatedAt :: Lens' CreateSimulationJobResponse (Maybe UTCTime) Source #

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

createSimulationJobResponse_tags :: Lens' CreateSimulationJobResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the simulation job.