Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RobOMaker.Lens

Contents

Operations
Types

Description

Synopsis

Operations

BatchDeleteWorlds

batchDeleteWorlds_worlds :: Lens' BatchDeleteWorlds (NonEmpty Text) Source #

A list of Amazon Resource Names (arns) that correspond to worlds to delete.

batchDeleteWorldsResponse_unprocessedWorlds :: Lens' BatchDeleteWorldsResponse (Maybe (NonEmpty Text)) Source #

A list of unprocessed worlds associated with the call. These worlds were not deleted.

batchDeleteWorldsResponse_httpStatus :: Lens' BatchDeleteWorldsResponse Int Source #

The response's http status code.

BatchDescribeSimulationJob

batchDescribeSimulationJob_jobs :: Lens' BatchDescribeSimulationJob (NonEmpty Text) Source #

A list of Amazon Resource Names (ARNs) of simulation jobs to describe.

batchDescribeSimulationJobResponse_jobs :: Lens' BatchDescribeSimulationJobResponse (Maybe [SimulationJob]) Source #

A list of simulation jobs.

batchDescribeSimulationJobResponse_unprocessedJobs :: Lens' BatchDescribeSimulationJobResponse (Maybe (NonEmpty Text)) Source #

A list of unprocessed simulation job Amazon Resource Names (ARNs).

batchDescribeSimulationJobResponse_httpStatus :: Lens' BatchDescribeSimulationJobResponse Int Source #

The response's http status code.

CancelSimulationJob

cancelSimulationJob_job :: Lens' CancelSimulationJob Text Source #

The simulation job ARN to cancel.

cancelSimulationJobResponse_httpStatus :: Lens' CancelSimulationJobResponse Int Source #

The response's http status code.

CancelSimulationJobBatch

cancelSimulationJobBatch_batch :: Lens' CancelSimulationJobBatch Text Source #

The id of the batch to cancel.

cancelSimulationJobBatchResponse_httpStatus :: Lens' CancelSimulationJobBatchResponse Int Source #

The response's http status code.

CancelWorldExportJob

cancelWorldExportJob_job :: Lens' CancelWorldExportJob Text Source #

The Amazon Resource Name (arn) of the world export job to cancel.

cancelWorldExportJobResponse_httpStatus :: Lens' CancelWorldExportJobResponse Int Source #

The response's http status code.

CancelWorldGenerationJob

cancelWorldGenerationJob_job :: Lens' CancelWorldGenerationJob Text Source #

The Amazon Resource Name (arn) of the world generator job to cancel.

cancelWorldGenerationJobResponse_httpStatus :: Lens' CancelWorldGenerationJobResponse Int Source #

The response's http status code.

CreateRobotApplication

createRobotApplication_environment :: Lens' CreateRobotApplication (Maybe Environment) Source #

The object that contains that URI of the Docker image that you use for your robot application.

createRobotApplication_sources :: Lens' CreateRobotApplication (Maybe [SourceConfig]) Source #

The sources of the robot application.

createRobotApplication_tags :: Lens' CreateRobotApplication (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the robot application.

createRobotApplication_name :: Lens' CreateRobotApplication Text Source #

The name of the robot application.

createRobotApplication_robotSoftwareSuite :: Lens' CreateRobotApplication RobotSoftwareSuite Source #

The robot software suite (ROS distribuition) used by the robot application.

createRobotApplicationResponse_arn :: Lens' CreateRobotApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot application.

createRobotApplicationResponse_environment :: Lens' CreateRobotApplicationResponse (Maybe Environment) Source #

An object that contains the Docker image URI used to a create your robot application.

createRobotApplicationResponse_lastUpdatedAt :: Lens' CreateRobotApplicationResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the robot application was last updated.

createRobotApplicationResponse_name :: Lens' CreateRobotApplicationResponse (Maybe Text) Source #

The name of the robot application.

createRobotApplicationResponse_revisionId :: Lens' CreateRobotApplicationResponse (Maybe Text) Source #

The revision id of the robot application.

createRobotApplicationResponse_robotSoftwareSuite :: Lens' CreateRobotApplicationResponse (Maybe RobotSoftwareSuite) Source #

The robot software suite (ROS distribution) used by the robot application.

createRobotApplicationResponse_sources :: Lens' CreateRobotApplicationResponse (Maybe [Source]) Source #

The sources of the robot application.

createRobotApplicationResponse_tags :: Lens' CreateRobotApplicationResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the robot application.

createRobotApplicationResponse_version :: Lens' CreateRobotApplicationResponse (Maybe Text) Source #

The version of the robot application.

createRobotApplicationResponse_httpStatus :: Lens' CreateRobotApplicationResponse Int Source #

The response's http status code.

CreateRobotApplicationVersion

createRobotApplicationVersion_currentRevisionId :: Lens' CreateRobotApplicationVersion (Maybe Text) Source #

The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.

createRobotApplicationVersion_imageDigest :: Lens' CreateRobotApplicationVersion (Maybe Text) Source #

A SHA256 identifier for the Docker image that you use for your robot application.

createRobotApplicationVersion_s3Etags :: Lens' CreateRobotApplicationVersion (Maybe [Text]) Source #

The Amazon S3 identifier for the zip file bundle that you use for your robot application.

createRobotApplicationVersion_application :: Lens' CreateRobotApplicationVersion Text Source #

The application information for the robot application.

createRobotApplicationVersionResponse_arn :: Lens' CreateRobotApplicationVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot application.

createRobotApplicationVersionResponse_environment :: Lens' CreateRobotApplicationVersionResponse (Maybe Environment) Source #

The object that contains the Docker image URI used to create your robot application.

createRobotApplicationVersionResponse_lastUpdatedAt :: Lens' CreateRobotApplicationVersionResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the robot application was last updated.

createRobotApplicationVersionResponse_name :: Lens' CreateRobotApplicationVersionResponse (Maybe Text) Source #

The name of the robot application.

createRobotApplicationVersionResponse_revisionId :: Lens' CreateRobotApplicationVersionResponse (Maybe Text) Source #

The revision id of the robot application.

createRobotApplicationVersionResponse_robotSoftwareSuite :: Lens' CreateRobotApplicationVersionResponse (Maybe RobotSoftwareSuite) Source #

The robot software suite (ROS distribution) used by the robot application.

createRobotApplicationVersionResponse_sources :: Lens' CreateRobotApplicationVersionResponse (Maybe [Source]) Source #

The sources of the robot application.

createRobotApplicationVersionResponse_version :: Lens' CreateRobotApplicationVersionResponse (Maybe Text) Source #

The version of the robot application.

createRobotApplicationVersionResponse_httpStatus :: Lens' CreateRobotApplicationVersionResponse Int Source #

The response's http status code.

CreateSimulationApplication

createSimulationApplication_environment :: Lens' CreateSimulationApplication (Maybe Environment) Source #

The object that contains the Docker image URI used to create your simulation application.

createSimulationApplication_renderingEngine :: Lens' CreateSimulationApplication (Maybe RenderingEngine) Source #

The rendering engine for the simulation application.

createSimulationApplication_sources :: Lens' CreateSimulationApplication (Maybe [SourceConfig]) Source #

The sources of the simulation application.

createSimulationApplication_tags :: Lens' CreateSimulationApplication (Maybe (HashMap Text Text)) Source #

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

createSimulationApplication_name :: Lens' CreateSimulationApplication Text Source #

The name of the simulation application.

createSimulationApplication_simulationSoftwareSuite :: Lens' CreateSimulationApplication SimulationSoftwareSuite Source #

The simulation software suite used by the simulation application.

createSimulationApplication_robotSoftwareSuite :: Lens' CreateSimulationApplication RobotSoftwareSuite Source #

The robot software suite (ROS distribution) used by the simulation application.

createSimulationApplicationResponse_arn :: Lens' CreateSimulationApplicationResponse (Maybe Text) Source #

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

createSimulationApplicationResponse_environment :: Lens' CreateSimulationApplicationResponse (Maybe Environment) Source #

The object that contains the Docker image URI that you used to create your simulation application.

createSimulationApplicationResponse_lastUpdatedAt :: Lens' CreateSimulationApplicationResponse (Maybe UTCTime) Source #

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

createSimulationApplicationResponse_name :: Lens' CreateSimulationApplicationResponse (Maybe Text) Source #

The name of the simulation application.

createSimulationApplicationResponse_renderingEngine :: Lens' CreateSimulationApplicationResponse (Maybe RenderingEngine) Source #

The rendering engine for the simulation application.

createSimulationApplicationResponse_revisionId :: Lens' CreateSimulationApplicationResponse (Maybe Text) Source #

The revision id of the simulation application.

createSimulationApplicationResponse_robotSoftwareSuite :: Lens' CreateSimulationApplicationResponse (Maybe RobotSoftwareSuite) Source #

Information about the robot software suite (ROS distribution).

createSimulationApplicationResponse_simulationSoftwareSuite :: Lens' CreateSimulationApplicationResponse (Maybe SimulationSoftwareSuite) Source #

The simulation software suite used by the simulation application.

createSimulationApplicationResponse_sources :: Lens' CreateSimulationApplicationResponse (Maybe [Source]) Source #

The sources of the simulation application.

createSimulationApplicationResponse_tags :: Lens' CreateSimulationApplicationResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the simulation application.

createSimulationApplicationResponse_version :: Lens' CreateSimulationApplicationResponse (Maybe Text) Source #

The version of the simulation application.

createSimulationApplicationResponse_httpStatus :: Lens' CreateSimulationApplicationResponse Int Source #

The response's http status code.

CreateSimulationApplicationVersion

createSimulationApplicationVersion_currentRevisionId :: Lens' CreateSimulationApplicationVersion (Maybe Text) Source #

The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.

createSimulationApplicationVersion_imageDigest :: Lens' CreateSimulationApplicationVersion (Maybe Text) Source #

The SHA256 digest used to identify the Docker image URI used to created the simulation application.

createSimulationApplicationVersion_s3Etags :: Lens' CreateSimulationApplicationVersion (Maybe [Text]) Source #

The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.

createSimulationApplicationVersion_application :: Lens' CreateSimulationApplicationVersion Text Source #

The application information for the simulation application.

createSimulationApplicationVersionResponse_arn :: Lens' CreateSimulationApplicationVersionResponse (Maybe Text) Source #

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

createSimulationApplicationVersionResponse_environment :: Lens' CreateSimulationApplicationVersionResponse (Maybe Environment) Source #

The object that contains the Docker image URI used to create the simulation application.

createSimulationApplicationVersionResponse_lastUpdatedAt :: Lens' CreateSimulationApplicationVersionResponse (Maybe UTCTime) Source #

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

createSimulationApplicationVersionResponse_name :: Lens' CreateSimulationApplicationVersionResponse (Maybe Text) Source #

The name of the simulation application.

createSimulationApplicationVersionResponse_renderingEngine :: Lens' CreateSimulationApplicationVersionResponse (Maybe RenderingEngine) Source #

The rendering engine for the simulation application.

createSimulationApplicationVersionResponse_revisionId :: Lens' CreateSimulationApplicationVersionResponse (Maybe Text) Source #

The revision ID of the simulation application.

createSimulationApplicationVersionResponse_robotSoftwareSuite :: Lens' CreateSimulationApplicationVersionResponse (Maybe RobotSoftwareSuite) Source #

Information about the robot software suite (ROS distribution).

createSimulationApplicationVersionResponse_simulationSoftwareSuite :: Lens' CreateSimulationApplicationVersionResponse (Maybe SimulationSoftwareSuite) Source #

The simulation software suite used by the simulation application.

createSimulationApplicationVersionResponse_sources :: Lens' CreateSimulationApplicationVersionResponse (Maybe [Source]) Source #

The sources of the simulation application.

createSimulationApplicationVersionResponse_version :: Lens' CreateSimulationApplicationVersionResponse (Maybe Text) Source #

The version of the simulation application.

createSimulationApplicationVersionResponse_httpStatus :: Lens' CreateSimulationApplicationVersionResponse Int Source #

The response's http status code.

CreateSimulationJob

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_loggingConfig :: Lens' CreateSimulationJob (Maybe LoggingConfig) Source #

The logging configuration.

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

Location for output files generated by the simulation job.

createSimulationJob_robotApplications :: Lens' CreateSimulationJob (Maybe (NonEmpty RobotApplicationConfig)) Source #

The robot application to use in the simulation job.

createSimulationJob_simulationApplications :: Lens' CreateSimulationJob (Maybe (NonEmpty SimulationApplicationConfig)) Source #

The simulation application to use in 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.

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_compute :: Lens' CreateSimulationJobResponse (Maybe ComputeResponse) Source #

Compute information for the simulation job.

createSimulationJobResponse_dataSources :: Lens' CreateSimulationJobResponse (Maybe [DataSource]) Source #

The data sources for the simulation job.

createSimulationJobResponse_failureBehavior :: Lens' CreateSimulationJobResponse (Maybe FailureBehavior) Source #

the failure behavior for the simulation job.

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_loggingConfig :: Lens' CreateSimulationJobResponse (Maybe LoggingConfig) Source #

The logging configuration.

createSimulationJobResponse_maxJobDurationInSeconds :: Lens' CreateSimulationJobResponse (Maybe Integer) Source #

The maximum simulation job duration in seconds.

createSimulationJobResponse_outputLocation :: Lens' CreateSimulationJobResponse (Maybe OutputLocation) Source #

Simulation job output files location.

createSimulationJobResponse_robotApplications :: Lens' CreateSimulationJobResponse (Maybe (NonEmpty RobotApplicationConfig)) Source #

The robot application used by the simulation job.

createSimulationJobResponse_simulationApplications :: Lens' CreateSimulationJobResponse (Maybe (NonEmpty SimulationApplicationConfig)) Source #

The simulation application used by the simulation job.

createSimulationJobResponse_simulationTimeMillis :: Lens' CreateSimulationJobResponse (Maybe Integer) Source #

The simulation job execution duration in milliseconds.

createSimulationJobResponse_status :: Lens' CreateSimulationJobResponse (Maybe SimulationJobStatus) Source #

The status of the simulation job.

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

The list of all tags added to the simulation job.

createSimulationJobResponse_vpcConfig :: Lens' CreateSimulationJobResponse (Maybe VPCConfigResponse) Source #

Information about the vpc configuration.

createSimulationJobResponse_httpStatus :: Lens' CreateSimulationJobResponse Int Source #

The response's http status code.

CreateWorldExportJob

createWorldExportJob_clientRequestToken :: Lens' CreateWorldExportJob (Maybe Text) Source #

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

createWorldExportJob_tags :: Lens' CreateWorldExportJob (Maybe (HashMap Text Text)) Source #

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

createWorldExportJob_worlds :: Lens' CreateWorldExportJob (NonEmpty Text) Source #

A list of Amazon Resource Names (arns) that correspond to worlds to export.

createWorldExportJob_outputLocation :: Lens' CreateWorldExportJob OutputLocation Source #

Undocumented member.

createWorldExportJob_iamRole :: Lens' CreateWorldExportJob Text Source #

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

createWorldExportJobResponse_arn :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world export job.

createWorldExportJobResponse_clientRequestToken :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

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

createWorldExportJobResponse_createdAt :: Lens' CreateWorldExportJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world export job was created.

createWorldExportJobResponse_failureCode :: Lens' CreateWorldExportJobResponse (Maybe WorldExportJobErrorCode) Source #

The failure code of the world export job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.
AllWorldGenerationFailed: All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.

For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.

createWorldExportJobResponse_iamRole :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

createWorldExportJobResponse_outputLocation :: Lens' CreateWorldExportJobResponse (Maybe OutputLocation) Source #

Undocumented member.

createWorldExportJobResponse_status :: Lens' CreateWorldExportJobResponse (Maybe WorldExportJobStatus) Source #

The status of the world export job.

Pending: The world export job request is pending.
Running: The world export job is running.
Completed: The world export job completed.
Failed: The world export job failed. See failureCode for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

createWorldExportJobResponse_tags :: Lens' CreateWorldExportJobResponse (Maybe (HashMap Text Text)) Source #

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

createWorldExportJobResponse_httpStatus :: Lens' CreateWorldExportJobResponse Int Source #

The response's http status code.

CreateWorldGenerationJob

createWorldGenerationJob_clientRequestToken :: Lens' CreateWorldGenerationJob (Maybe Text) Source #

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

createWorldGenerationJob_tags :: Lens' CreateWorldGenerationJob (Maybe (HashMap Text Text)) Source #

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

createWorldGenerationJob_worldTags :: Lens' CreateWorldGenerationJob (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the generated worlds.

createWorldGenerationJob_template :: Lens' CreateWorldGenerationJob Text Source #

The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

createWorldGenerationJob_worldCount :: Lens' CreateWorldGenerationJob WorldCount Source #

Information about the world count.

createWorldGenerationJobResponse_arn :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world generator job.

createWorldGenerationJobResponse_clientRequestToken :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

createWorldGenerationJobResponse_createdAt :: Lens' CreateWorldGenerationJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world generator job was created.

createWorldGenerationJobResponse_failureCode :: Lens' CreateWorldGenerationJobResponse (Maybe WorldGenerationJobErrorCode) Source #

The failure code of the world generator job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

createWorldGenerationJobResponse_status :: Lens' CreateWorldGenerationJobResponse (Maybe WorldGenerationJobStatus) Source #

The status of the world generator job.

Pending: The world generator job request is pending.
Running: The world generator job is running.
Completed: The world generator job completed.
Failed: The world generator job failed. See failureCode for more information.
PartialFailed: Some worlds did not generate.
Canceled: The world generator job was cancelled.
Canceling: The world generator job is being cancelled.

createWorldGenerationJobResponse_tags :: Lens' CreateWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

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

createWorldGenerationJobResponse_template :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.

createWorldGenerationJobResponse_worldCount :: Lens' CreateWorldGenerationJobResponse (Maybe WorldCount) Source #

Information about the world count.

createWorldGenerationJobResponse_worldTags :: Lens' CreateWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the generated worlds.

createWorldGenerationJobResponse_httpStatus :: Lens' CreateWorldGenerationJobResponse Int Source #

The response's http status code.

CreateWorldTemplate

createWorldTemplate_clientRequestToken :: Lens' CreateWorldTemplate (Maybe Text) Source #

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

createWorldTemplate_name :: Lens' CreateWorldTemplate (Maybe Text) Source #

The name of the world template.

createWorldTemplate_tags :: Lens' CreateWorldTemplate (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the world template.

createWorldTemplate_templateBody :: Lens' CreateWorldTemplate (Maybe Text) Source #

The world template body.

createWorldTemplate_templateLocation :: Lens' CreateWorldTemplate (Maybe TemplateLocation) Source #

The location of the world template.

createWorldTemplateResponse_arn :: Lens' CreateWorldTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world template.

createWorldTemplateResponse_clientRequestToken :: Lens' CreateWorldTemplateResponse (Maybe Text) Source #

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

createWorldTemplateResponse_createdAt :: Lens' CreateWorldTemplateResponse (Maybe UTCTime) Source #

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

createWorldTemplateResponse_name :: Lens' CreateWorldTemplateResponse (Maybe Text) Source #

The name of the world template.

createWorldTemplateResponse_tags :: Lens' CreateWorldTemplateResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the world template.

createWorldTemplateResponse_httpStatus :: Lens' CreateWorldTemplateResponse Int Source #

The response's http status code.

DeleteRobotApplication

deleteRobotApplication_applicationVersion :: Lens' DeleteRobotApplication (Maybe Text) Source #

The version of the robot application to delete.

deleteRobotApplication_application :: Lens' DeleteRobotApplication Text Source #

The Amazon Resource Name (ARN) of the the robot application.

deleteRobotApplicationResponse_httpStatus :: Lens' DeleteRobotApplicationResponse Int Source #

The response's http status code.

DeleteSimulationApplication

deleteSimulationApplication_applicationVersion :: Lens' DeleteSimulationApplication (Maybe Text) Source #

The version of the simulation application to delete.

deleteSimulationApplication_application :: Lens' DeleteSimulationApplication Text Source #

The application information for the simulation application to delete.

deleteSimulationApplicationResponse_httpStatus :: Lens' DeleteSimulationApplicationResponse Int Source #

The response's http status code.

DeleteWorldTemplate

deleteWorldTemplate_template :: Lens' DeleteWorldTemplate Text Source #

The Amazon Resource Name (arn) of the world template you want to delete.

deleteWorldTemplateResponse_httpStatus :: Lens' DeleteWorldTemplateResponse Int Source #

The response's http status code.

DescribeRobotApplication

describeRobotApplication_applicationVersion :: Lens' DescribeRobotApplication (Maybe Text) Source #

The version of the robot application to describe.

describeRobotApplication_application :: Lens' DescribeRobotApplication Text Source #

The Amazon Resource Name (ARN) of the robot application.

describeRobotApplicationResponse_arn :: Lens' DescribeRobotApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot application.

describeRobotApplicationResponse_environment :: Lens' DescribeRobotApplicationResponse (Maybe Environment) Source #

The object that contains the Docker image URI used to create the robot application.

describeRobotApplicationResponse_imageDigest :: Lens' DescribeRobotApplicationResponse (Maybe Text) Source #

A SHA256 identifier for the Docker image that you use for your robot application.

describeRobotApplicationResponse_lastUpdatedAt :: Lens' DescribeRobotApplicationResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the robot application was last updated.

describeRobotApplicationResponse_name :: Lens' DescribeRobotApplicationResponse (Maybe Text) Source #

The name of the robot application.

describeRobotApplicationResponse_revisionId :: Lens' DescribeRobotApplicationResponse (Maybe Text) Source #

The revision id of the robot application.

describeRobotApplicationResponse_robotSoftwareSuite :: Lens' DescribeRobotApplicationResponse (Maybe RobotSoftwareSuite) Source #

The robot software suite (ROS distribution) used by the robot application.

describeRobotApplicationResponse_sources :: Lens' DescribeRobotApplicationResponse (Maybe [Source]) Source #

The sources of the robot application.

describeRobotApplicationResponse_tags :: Lens' DescribeRobotApplicationResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the specified robot application.

describeRobotApplicationResponse_version :: Lens' DescribeRobotApplicationResponse (Maybe Text) Source #

The version of the robot application.

describeRobotApplicationResponse_httpStatus :: Lens' DescribeRobotApplicationResponse Int Source #

The response's http status code.

DescribeSimulationApplication

describeSimulationApplication_applicationVersion :: Lens' DescribeSimulationApplication (Maybe Text) Source #

The version of the simulation application to describe.

describeSimulationApplication_application :: Lens' DescribeSimulationApplication Text Source #

The application information for the simulation application.

describeSimulationApplicationResponse_arn :: Lens' DescribeSimulationApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot simulation application.

describeSimulationApplicationResponse_environment :: Lens' DescribeSimulationApplicationResponse (Maybe Environment) Source #

The object that contains the Docker image URI used to create the simulation application.

describeSimulationApplicationResponse_imageDigest :: Lens' DescribeSimulationApplicationResponse (Maybe Text) Source #

A SHA256 identifier for the Docker image that you use for your simulation application.

describeSimulationApplicationResponse_lastUpdatedAt :: Lens' DescribeSimulationApplicationResponse (Maybe UTCTime) Source #

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

describeSimulationApplicationResponse_name :: Lens' DescribeSimulationApplicationResponse (Maybe Text) Source #

The name of the simulation application.

describeSimulationApplicationResponse_renderingEngine :: Lens' DescribeSimulationApplicationResponse (Maybe RenderingEngine) Source #

The rendering engine for the simulation application.

describeSimulationApplicationResponse_revisionId :: Lens' DescribeSimulationApplicationResponse (Maybe Text) Source #

The revision id of the simulation application.

describeSimulationApplicationResponse_robotSoftwareSuite :: Lens' DescribeSimulationApplicationResponse (Maybe RobotSoftwareSuite) Source #

Information about the robot software suite (ROS distribution).

describeSimulationApplicationResponse_simulationSoftwareSuite :: Lens' DescribeSimulationApplicationResponse (Maybe SimulationSoftwareSuite) Source #

The simulation software suite used by the simulation application.

describeSimulationApplicationResponse_sources :: Lens' DescribeSimulationApplicationResponse (Maybe [Source]) Source #

The sources of the simulation application.

describeSimulationApplicationResponse_tags :: Lens' DescribeSimulationApplicationResponse (Maybe (HashMap Text Text)) Source #

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

describeSimulationApplicationResponse_version :: Lens' DescribeSimulationApplicationResponse (Maybe Text) Source #

The version of the simulation application.

describeSimulationApplicationResponse_httpStatus :: Lens' DescribeSimulationApplicationResponse Int Source #

The response's http status code.

DescribeSimulationJob

describeSimulationJob_job :: Lens' DescribeSimulationJob Text Source #

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

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.

DescribeSimulationJobBatch

describeSimulationJobBatch_batch :: Lens' DescribeSimulationJobBatch Text Source #

The id of the batch to describe.

describeSimulationJobBatchResponse_arn :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the batch.

describeSimulationJobBatchResponse_batchPolicy :: Lens' DescribeSimulationJobBatchResponse (Maybe BatchPolicy) Source #

The batch policy.

describeSimulationJobBatchResponse_clientRequestToken :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

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

describeSimulationJobBatchResponse_createdAt :: Lens' DescribeSimulationJobBatchResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the simulation job batch was created.

describeSimulationJobBatchResponse_createdRequests :: Lens' DescribeSimulationJobBatchResponse (Maybe [SimulationJobSummary]) Source #

A list of created simulation job summaries.

describeSimulationJobBatchResponse_failedRequests :: Lens' DescribeSimulationJobBatchResponse (Maybe [FailedCreateSimulationJobRequest]) Source #

A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

describeSimulationJobBatchResponse_failureCode :: Lens' DescribeSimulationJobBatchResponse (Maybe SimulationJobBatchErrorCode) Source #

The failure code of the simulation job batch.

describeSimulationJobBatchResponse_failureReason :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

The reason the simulation job batch failed.

describeSimulationJobBatchResponse_lastUpdatedAt :: Lens' DescribeSimulationJobBatchResponse (Maybe UTCTime) Source #

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

describeSimulationJobBatchResponse_pendingRequests :: Lens' DescribeSimulationJobBatchResponse (Maybe (NonEmpty SimulationJobRequest)) Source #

A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

describeSimulationJobBatchResponse_status :: Lens' DescribeSimulationJobBatchResponse (Maybe SimulationJobBatchStatus) Source #

The status of the batch.

Pending: The simulation job batch request is pending.
InProgress: The simulation job batch is in progress.
Failed: The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.
Completed: The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).
Canceled: The simulation batch job was cancelled.
Canceling: The simulation batch job is being cancelled.
Completing: The simulation batch job is completing.
TimingOut: The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.
TimedOut: The simulation batch job timed out.

describeSimulationJobBatchResponse_tags :: Lens' DescribeSimulationJobBatchResponse (Maybe (HashMap Text Text)) Source #

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

describeSimulationJobBatchResponse_httpStatus :: Lens' DescribeSimulationJobBatchResponse Int Source #

The response's http status code.

DescribeWorld

describeWorld_world :: Lens' DescribeWorld Text Source #

The Amazon Resource Name (arn) of the world you want to describe.

describeWorldResponse_arn :: Lens' DescribeWorldResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world.

describeWorldResponse_createdAt :: Lens' DescribeWorldResponse (Maybe UTCTime) Source #

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

describeWorldResponse_generationJob :: Lens' DescribeWorldResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world generation job that generated the world.

describeWorldResponse_tags :: Lens' DescribeWorldResponse (Maybe (HashMap Text Text)) Source #

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

describeWorldResponse_template :: Lens' DescribeWorldResponse (Maybe Text) Source #

The world template.

describeWorldResponse_worldDescriptionBody :: Lens' DescribeWorldResponse (Maybe Text) Source #

Returns the JSON formatted string that describes the contents of your world.

describeWorldResponse_httpStatus :: Lens' DescribeWorldResponse Int Source #

The response's http status code.

DescribeWorldExportJob

describeWorldExportJob_job :: Lens' DescribeWorldExportJob Text Source #

The Amazon Resource Name (arn) of the world export job to describe.

describeWorldExportJobResponse_arn :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world export job.

describeWorldExportJobResponse_clientRequestToken :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

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

describeWorldExportJobResponse_createdAt :: Lens' DescribeWorldExportJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world export job was created.

describeWorldExportJobResponse_failureCode :: Lens' DescribeWorldExportJobResponse (Maybe WorldExportJobErrorCode) Source #

The failure code of the world export job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

describeWorldExportJobResponse_failureReason :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

The reason why the world export job failed.

describeWorldExportJobResponse_iamRole :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

describeWorldExportJobResponse_outputLocation :: Lens' DescribeWorldExportJobResponse (Maybe OutputLocation) Source #

Undocumented member.

describeWorldExportJobResponse_status :: Lens' DescribeWorldExportJobResponse (Maybe WorldExportJobStatus) Source #

The status of the world export job.

Pending: The world export job request is pending.
Running: The world export job is running.
Completed: The world export job completed.
Failed: The world export job failed. See failureCode and failureReason for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

describeWorldExportJobResponse_tags :: Lens' DescribeWorldExportJobResponse (Maybe (HashMap Text Text)) Source #

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

describeWorldExportJobResponse_worlds :: Lens' DescribeWorldExportJobResponse (Maybe (NonEmpty Text)) Source #

A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

describeWorldExportJobResponse_httpStatus :: Lens' DescribeWorldExportJobResponse Int Source #

The response's http status code.

DescribeWorldGenerationJob

describeWorldGenerationJob_job :: Lens' DescribeWorldGenerationJob Text Source #

The Amazon Resource Name (arn) of the world generation job to describe.

describeWorldGenerationJobResponse_arn :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world generation job.

describeWorldGenerationJobResponse_clientRequestToken :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

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

describeWorldGenerationJobResponse_createdAt :: Lens' DescribeWorldGenerationJobResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world generation job was created.

describeWorldGenerationJobResponse_failureCode :: Lens' DescribeWorldGenerationJobResponse (Maybe WorldGenerationJobErrorCode) Source #

The failure code of the world generation job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

describeWorldGenerationJobResponse_failureReason :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

The reason why the world generation job failed.

describeWorldGenerationJobResponse_finishedWorldsSummary :: Lens' DescribeWorldGenerationJobResponse (Maybe FinishedWorldsSummary) Source #

Summary information about finished worlds.

describeWorldGenerationJobResponse_status :: Lens' DescribeWorldGenerationJobResponse (Maybe WorldGenerationJobStatus) Source #

The status of the world generation job:

Pending: The world generation job request is pending.
Running: The world generation job is running.
Completed: The world generation job completed.
Failed: The world generation job failed. See failureCode for more information.
PartialFailed: Some worlds did not generate.
Canceled: The world generation job was cancelled.
Canceling: The world generation job is being cancelled.

describeWorldGenerationJobResponse_tags :: Lens' DescribeWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

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

describeWorldGenerationJobResponse_template :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.

describeWorldGenerationJobResponse_worldCount :: Lens' DescribeWorldGenerationJobResponse (Maybe WorldCount) Source #

Information about the world count.

describeWorldGenerationJobResponse_worldTags :: Lens' DescribeWorldGenerationJobResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the generated worlds.

describeWorldGenerationJobResponse_httpStatus :: Lens' DescribeWorldGenerationJobResponse Int Source #

The response's http status code.

DescribeWorldTemplate

describeWorldTemplate_template :: Lens' DescribeWorldTemplate Text Source #

The Amazon Resource Name (arn) of the world template you want to describe.

describeWorldTemplateResponse_arn :: Lens' DescribeWorldTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world template.

describeWorldTemplateResponse_clientRequestToken :: Lens' DescribeWorldTemplateResponse (Maybe Text) Source #

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

describeWorldTemplateResponse_createdAt :: Lens' DescribeWorldTemplateResponse (Maybe UTCTime) Source #

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

describeWorldTemplateResponse_lastUpdatedAt :: Lens' DescribeWorldTemplateResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world template was last updated.

describeWorldTemplateResponse_name :: Lens' DescribeWorldTemplateResponse (Maybe Text) Source #

The name of the world template.

describeWorldTemplateResponse_tags :: Lens' DescribeWorldTemplateResponse (Maybe (HashMap Text Text)) Source #

A map that contains tag keys and tag values that are attached to the world template.

describeWorldTemplateResponse_version :: Lens' DescribeWorldTemplateResponse (Maybe Text) Source #

The version of the world template that you're using.

describeWorldTemplateResponse_httpStatus :: Lens' DescribeWorldTemplateResponse Int Source #

The response's http status code.

GetWorldTemplateBody

getWorldTemplateBody_generationJob :: Lens' GetWorldTemplateBody (Maybe Text) Source #

The Amazon Resource Name (arn) of the world generator job.

getWorldTemplateBody_template :: Lens' GetWorldTemplateBody (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.

getWorldTemplateBodyResponse_templateBody :: Lens' GetWorldTemplateBodyResponse (Maybe Text) Source #

The world template body.

getWorldTemplateBodyResponse_httpStatus :: Lens' GetWorldTemplateBodyResponse Int Source #

The response's http status code.

ListRobotApplications

listRobotApplications_filters :: Lens' ListRobotApplications (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

listRobotApplications_maxResults :: Lens' ListRobotApplications (Maybe Int) Source #

When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

listRobotApplications_nextToken :: Lens' ListRobotApplications (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listRobotApplications_versionQualifier :: Lens' ListRobotApplications (Maybe Text) Source #

The version qualifier of the robot application.

listRobotApplicationsResponse_nextToken :: Lens' ListRobotApplicationsResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listRobotApplicationsResponse_robotApplicationSummaries :: Lens' ListRobotApplicationsResponse (Maybe [RobotApplicationSummary]) Source #

A list of robot application summaries that meet the criteria of the request.

listRobotApplicationsResponse_httpStatus :: Lens' ListRobotApplicationsResponse Int Source #

The response's http status code.

ListSimulationApplications

listSimulationApplications_filters :: Lens' ListSimulationApplications (Maybe (NonEmpty Filter)) Source #

Optional list of filters to limit results.

The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

listSimulationApplications_maxResults :: Lens' ListSimulationApplications (Maybe Int) Source #

When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.

listSimulationApplications_nextToken :: Lens' ListSimulationApplications (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listSimulationApplications_versionQualifier :: Lens' ListSimulationApplications (Maybe Text) Source #

The version qualifier of the simulation application.

listSimulationApplicationsResponse_nextToken :: Lens' ListSimulationApplicationsResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listSimulationApplicationsResponse_simulationApplicationSummaries :: Lens' ListSimulationApplicationsResponse (Maybe [SimulationApplicationSummary]) Source #

A list of simulation application summaries that meet the criteria of the request.

listSimulationApplicationsResponse_httpStatus :: Lens' ListSimulationApplicationsResponse Int Source #

The response's http status code.

ListSimulationJobBatches

listSimulationJobBatches_filters :: Lens' ListSimulationJobBatches (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

listSimulationJobBatches_maxResults :: Lens' ListSimulationJobBatches (Maybe Int) Source #

When this parameter is used, ListSimulationJobBatches only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobBatches request with the returned nextToken value.

listSimulationJobBatches_nextToken :: Lens' ListSimulationJobBatches (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listSimulationJobBatchesResponse_nextToken :: Lens' ListSimulationJobBatchesResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listSimulationJobBatchesResponse_simulationJobBatchSummaries :: Lens' ListSimulationJobBatchesResponse (Maybe [SimulationJobBatchSummary]) Source #

A list of simulation job batch summaries.

listSimulationJobBatchesResponse_httpStatus :: Lens' ListSimulationJobBatchesResponse Int Source #

The response's http status code.

ListSimulationJobs

listSimulationJobs_filters :: Lens' ListSimulationJobs (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

listSimulationJobs_maxResults :: Lens' ListSimulationJobs (Maybe Int) Source #

When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

listSimulationJobs_nextToken :: Lens' ListSimulationJobs (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listSimulationJobsResponse_nextToken :: Lens' ListSimulationJobsResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listSimulationJobsResponse_httpStatus :: Lens' ListSimulationJobsResponse Int Source #

The response's http status code.

listSimulationJobsResponse_simulationJobSummaries :: Lens' ListSimulationJobsResponse [SimulationJobSummary] Source #

A list of simulation job summaries that meet the criteria of the request.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the specified resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListWorldExportJobs

listWorldExportJobs_filters :: Lens' ListWorldExportJobs (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results. You can use generationJobId and templateId.

listWorldExportJobs_maxResults :: Lens' ListWorldExportJobs (Maybe Int) Source #

When this parameter is used, ListWorldExportJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable.

listWorldExportJobs_nextToken :: Lens' ListWorldExportJobs (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldExportJobsResponse_nextToken :: Lens' ListWorldExportJobsResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldExportJobsResponse_httpStatus :: Lens' ListWorldExportJobsResponse Int Source #

The response's http status code.

listWorldExportJobsResponse_worldExportJobSummaries :: Lens' ListWorldExportJobsResponse [WorldExportJobSummary] Source #

Summary information for world export jobs.

ListWorldGenerationJobs

listWorldGenerationJobs_filters :: Lens' ListWorldGenerationJobs (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results. You can use status and templateId.

listWorldGenerationJobs_maxResults :: Lens' ListWorldGenerationJobs (Maybe Int) Source #

When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable.

listWorldGenerationJobs_nextToken :: Lens' ListWorldGenerationJobs (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldGenerationJobsResponse_nextToken :: Lens' ListWorldGenerationJobsResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldGenerationJobsResponse_httpStatus :: Lens' ListWorldGenerationJobsResponse Int Source #

The response's http status code.

listWorldGenerationJobsResponse_worldGenerationJobSummaries :: Lens' ListWorldGenerationJobsResponse [WorldGenerationJobSummary] Source #

Summary information for world generator jobs.

ListWorldTemplates

listWorldTemplates_maxResults :: Lens' ListWorldTemplates (Maybe Int) Source #

When this parameter is used, ListWorldTemplates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable.

listWorldTemplates_nextToken :: Lens' ListWorldTemplates (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldTemplatesResponse_nextToken :: Lens' ListWorldTemplatesResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldTemplatesResponse_templateSummaries :: Lens' ListWorldTemplatesResponse (Maybe [TemplateSummary]) Source #

Summary information for templates.

listWorldTemplatesResponse_httpStatus :: Lens' ListWorldTemplatesResponse Int Source #

The response's http status code.

ListWorlds

listWorlds_filters :: Lens' ListWorlds (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results. You can use status.

listWorlds_maxResults :: Lens' ListWorlds (Maybe Int) Source #

When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

listWorlds_nextToken :: Lens' ListWorlds (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldsResponse_nextToken :: Lens' ListWorldsResponse (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

listWorldsResponse_worldSummaries :: Lens' ListWorldsResponse (Maybe [WorldSummary]) Source #

Summary information for worlds.

listWorldsResponse_httpStatus :: Lens' ListWorldsResponse Int Source #

The response's http status code.

RestartSimulationJob

restartSimulationJob_job :: Lens' RestartSimulationJob Text Source #

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

restartSimulationJobResponse_httpStatus :: Lens' RestartSimulationJobResponse Int Source #

The response's http status code.

StartSimulationJobBatch

startSimulationJobBatch_batchPolicy :: Lens' StartSimulationJobBatch (Maybe BatchPolicy) Source #

The batch policy.

startSimulationJobBatch_clientRequestToken :: Lens' StartSimulationJobBatch (Maybe Text) Source #

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

startSimulationJobBatch_tags :: Lens' StartSimulationJobBatch (Maybe (HashMap Text Text)) Source #

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

startSimulationJobBatch_createSimulationJobRequests :: Lens' StartSimulationJobBatch (NonEmpty SimulationJobRequest) Source #

A list of simulation job requests to create in the batch.

startSimulationJobBatchResponse_arn :: Lens' StartSimulationJobBatchResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the batch.

startSimulationJobBatchResponse_batchPolicy :: Lens' StartSimulationJobBatchResponse (Maybe BatchPolicy) Source #

The batch policy.

startSimulationJobBatchResponse_clientRequestToken :: Lens' StartSimulationJobBatchResponse (Maybe Text) Source #

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

startSimulationJobBatchResponse_createdAt :: Lens' StartSimulationJobBatchResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the simulation job batch was created.

startSimulationJobBatchResponse_createdRequests :: Lens' StartSimulationJobBatchResponse (Maybe [SimulationJobSummary]) Source #

A list of created simulation job request summaries.

startSimulationJobBatchResponse_failedRequests :: Lens' StartSimulationJobBatchResponse (Maybe [FailedCreateSimulationJobRequest]) Source #

A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

startSimulationJobBatchResponse_failureCode :: Lens' StartSimulationJobBatchResponse (Maybe SimulationJobBatchErrorCode) Source #

The failure code if the simulation job batch failed.

startSimulationJobBatchResponse_failureReason :: Lens' StartSimulationJobBatchResponse (Maybe Text) Source #

The reason the simulation job batch failed.

startSimulationJobBatchResponse_pendingRequests :: Lens' StartSimulationJobBatchResponse (Maybe (NonEmpty SimulationJobRequest)) Source #

A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

startSimulationJobBatchResponse_status :: Lens' StartSimulationJobBatchResponse (Maybe SimulationJobBatchStatus) Source #

The status of the simulation job batch.

Pending: The simulation job batch request is pending.
InProgress: The simulation job batch is in progress.
Failed: The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.
Completed: The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).
Canceled: The simulation batch job was cancelled.
Canceling: The simulation batch job is being cancelled.
Completing: The simulation batch job is completing.
TimingOut: The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.
TimedOut: The simulation batch job timed out.

startSimulationJobBatchResponse_tags :: Lens' StartSimulationJobBatchResponse (Maybe (HashMap Text Text)) Source #

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

startSimulationJobBatchResponse_httpStatus :: Lens' StartSimulationJobBatchResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

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

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A map that contains tag keys and tag values that will be unattached from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateRobotApplication

updateRobotApplication_currentRevisionId :: Lens' UpdateRobotApplication (Maybe Text) Source #

The revision id for the robot application.

updateRobotApplication_environment :: Lens' UpdateRobotApplication (Maybe Environment) Source #

The object that contains the Docker image URI for your robot application.

updateRobotApplication_sources :: Lens' UpdateRobotApplication (Maybe [SourceConfig]) Source #

The sources of the robot application.

updateRobotApplication_application :: Lens' UpdateRobotApplication Text Source #

The application information for the robot application.

updateRobotApplication_robotSoftwareSuite :: Lens' UpdateRobotApplication RobotSoftwareSuite Source #

The robot software suite (ROS distribution) used by the robot application.

updateRobotApplicationResponse_arn :: Lens' UpdateRobotApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated robot application.

updateRobotApplicationResponse_environment :: Lens' UpdateRobotApplicationResponse (Maybe Environment) Source #

The object that contains the Docker image URI for your robot application.

updateRobotApplicationResponse_lastUpdatedAt :: Lens' UpdateRobotApplicationResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the robot application was last updated.

updateRobotApplicationResponse_name :: Lens' UpdateRobotApplicationResponse (Maybe Text) Source #

The name of the robot application.

updateRobotApplicationResponse_revisionId :: Lens' UpdateRobotApplicationResponse (Maybe Text) Source #

The revision id of the robot application.

updateRobotApplicationResponse_robotSoftwareSuite :: Lens' UpdateRobotApplicationResponse (Maybe RobotSoftwareSuite) Source #

The robot software suite (ROS distribution) used by the robot application.

updateRobotApplicationResponse_sources :: Lens' UpdateRobotApplicationResponse (Maybe [Source]) Source #

The sources of the robot application.

updateRobotApplicationResponse_version :: Lens' UpdateRobotApplicationResponse (Maybe Text) Source #

The version of the robot application.

updateRobotApplicationResponse_httpStatus :: Lens' UpdateRobotApplicationResponse Int Source #

The response's http status code.

UpdateSimulationApplication

updateSimulationApplication_currentRevisionId :: Lens' UpdateSimulationApplication (Maybe Text) Source #

The revision id for the robot application.

updateSimulationApplication_environment :: Lens' UpdateSimulationApplication (Maybe Environment) Source #

The object that contains the Docker image URI for your simulation application.

updateSimulationApplication_renderingEngine :: Lens' UpdateSimulationApplication (Maybe RenderingEngine) Source #

The rendering engine for the simulation application.

updateSimulationApplication_sources :: Lens' UpdateSimulationApplication (Maybe [SourceConfig]) Source #

The sources of the simulation application.

updateSimulationApplication_application :: Lens' UpdateSimulationApplication Text Source #

The application information for the simulation application.

updateSimulationApplication_simulationSoftwareSuite :: Lens' UpdateSimulationApplication SimulationSoftwareSuite Source #

The simulation software suite used by the simulation application.

updateSimulationApplication_robotSoftwareSuite :: Lens' UpdateSimulationApplication RobotSoftwareSuite Source #

Information about the robot software suite (ROS distribution).

updateSimulationApplicationResponse_arn :: Lens' UpdateSimulationApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated simulation application.

updateSimulationApplicationResponse_environment :: Lens' UpdateSimulationApplicationResponse (Maybe Environment) Source #

The object that contains the Docker image URI used for your simulation application.

updateSimulationApplicationResponse_lastUpdatedAt :: Lens' UpdateSimulationApplicationResponse (Maybe UTCTime) Source #

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

updateSimulationApplicationResponse_name :: Lens' UpdateSimulationApplicationResponse (Maybe Text) Source #

The name of the simulation application.

updateSimulationApplicationResponse_renderingEngine :: Lens' UpdateSimulationApplicationResponse (Maybe RenderingEngine) Source #

The rendering engine for the simulation application.

updateSimulationApplicationResponse_revisionId :: Lens' UpdateSimulationApplicationResponse (Maybe Text) Source #

The revision id of the simulation application.

updateSimulationApplicationResponse_robotSoftwareSuite :: Lens' UpdateSimulationApplicationResponse (Maybe RobotSoftwareSuite) Source #

Information about the robot software suite (ROS distribution).

updateSimulationApplicationResponse_simulationSoftwareSuite :: Lens' UpdateSimulationApplicationResponse (Maybe SimulationSoftwareSuite) Source #

The simulation software suite used by the simulation application.

updateSimulationApplicationResponse_sources :: Lens' UpdateSimulationApplicationResponse (Maybe [Source]) Source #

The sources of the simulation application.

updateSimulationApplicationResponse_version :: Lens' UpdateSimulationApplicationResponse (Maybe Text) Source #

The version of the robot application.

updateSimulationApplicationResponse_httpStatus :: Lens' UpdateSimulationApplicationResponse Int Source #

The response's http status code.

UpdateWorldTemplate

updateWorldTemplate_name :: Lens' UpdateWorldTemplate (Maybe Text) Source #

The name of the template.

updateWorldTemplate_templateBody :: Lens' UpdateWorldTemplate (Maybe Text) Source #

The world template body.

updateWorldTemplate_templateLocation :: Lens' UpdateWorldTemplate (Maybe TemplateLocation) Source #

The location of the world template.

updateWorldTemplate_template :: Lens' UpdateWorldTemplate Text Source #

The Amazon Resource Name (arn) of the world template to update.

updateWorldTemplateResponse_arn :: Lens' UpdateWorldTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.

updateWorldTemplateResponse_createdAt :: Lens' UpdateWorldTemplateResponse (Maybe UTCTime) Source #

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

updateWorldTemplateResponse_lastUpdatedAt :: Lens' UpdateWorldTemplateResponse (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world template was last updated.

updateWorldTemplateResponse_name :: Lens' UpdateWorldTemplateResponse (Maybe Text) Source #

The name of the world template.

updateWorldTemplateResponse_httpStatus :: Lens' UpdateWorldTemplateResponse Int Source #

The response's http status code.

Types

BatchPolicy

batchPolicy_maxConcurrency :: Lens' BatchPolicy (Maybe Int) Source #

The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

batchPolicy_timeoutInSeconds :: Lens' BatchPolicy (Maybe Integer) Source #

The amount of time, in seconds, to wait for the batch to complete.

If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

Compute

compute_computeType :: Lens' Compute (Maybe ComputeType) Source #

Compute type information for the simulation job.

compute_gpuUnitLimit :: Lens' Compute (Maybe Natural) Source #

Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

compute_simulationUnitLimit :: Lens' Compute (Maybe Natural) Source #

The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

ComputeResponse

computeResponse_computeType :: Lens' ComputeResponse (Maybe ComputeType) Source #

Compute type response information for the simulation job.

computeResponse_gpuUnitLimit :: Lens' ComputeResponse (Maybe Natural) Source #

Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

computeResponse_simulationUnitLimit :: Lens' ComputeResponse (Maybe Natural) Source #

The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

DataSource

dataSource_destination :: Lens' DataSource (Maybe Text) Source #

The location where your files are mounted in the container image.

If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

dataSource_name :: Lens' DataSource (Maybe Text) Source #

The name of the data source.

dataSource_s3Bucket :: Lens' DataSource (Maybe Text) Source #

The S3 bucket where the data files are located.

dataSource_s3Keys :: Lens' DataSource (Maybe [S3KeyOutput]) Source #

The list of S3 keys identifying the data source files.

dataSource_type :: Lens' DataSource (Maybe DataSourceType) Source #

The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

If you don't specify a field, the default value is File.

DataSourceConfig

dataSourceConfig_destination :: Lens' DataSourceConfig (Maybe Text) Source #

The location where your files are mounted in the container image.

If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

dataSourceConfig_type :: Lens' DataSourceConfig (Maybe DataSourceType) Source #

The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

If you don't specify a field, the default value is File.

dataSourceConfig_name :: Lens' DataSourceConfig Text Source #

The name of the data source.

dataSourceConfig_s3Bucket :: Lens' DataSourceConfig Text Source #

The S3 bucket where the data files are located.

dataSourceConfig_s3Keys :: Lens' DataSourceConfig (NonEmpty Text) Source #

The list of S3 keys identifying the data source files.

Environment

environment_uri :: Lens' Environment (Maybe Text) Source #

The Docker image URI for either your robot or simulation applications.

FailedCreateSimulationJobRequest

failedCreateSimulationJobRequest_failedAt :: Lens' FailedCreateSimulationJobRequest (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the simulation job batch failed.

failedCreateSimulationJobRequest_failureCode :: Lens' FailedCreateSimulationJobRequest (Maybe SimulationJobErrorCode) Source #

The failure code.

failedCreateSimulationJobRequest_failureReason :: Lens' FailedCreateSimulationJobRequest (Maybe Text) Source #

The failure reason of the simulation job request.

failedCreateSimulationJobRequest_request :: Lens' FailedCreateSimulationJobRequest (Maybe SimulationJobRequest) Source #

The simulation job request.

FailureSummary

failureSummary_failures :: Lens' FailureSummary (Maybe [WorldFailure]) Source #

The worlds that failed.

failureSummary_totalFailureCount :: Lens' FailureSummary (Maybe Int) Source #

The total number of failures.

Filter

filter_name :: Lens' Filter (Maybe Text) Source #

The name of the filter.

filter_values :: Lens' Filter (Maybe (NonEmpty Text)) Source #

A list of values.

FinishedWorldsSummary

finishedWorldsSummary_failureSummary :: Lens' FinishedWorldsSummary (Maybe FailureSummary) Source #

Information about worlds that failed.

finishedWorldsSummary_finishedCount :: Lens' FinishedWorldsSummary (Maybe Int) Source #

The total number of finished worlds.

finishedWorldsSummary_succeededWorlds :: Lens' FinishedWorldsSummary (Maybe (NonEmpty Text)) Source #

A list of worlds that succeeded.

LaunchConfig

launchConfig_command :: Lens' LaunchConfig (Maybe [Text]) Source #

If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

launchConfig_environmentVariables :: Lens' LaunchConfig (Maybe (HashMap Text Text)) Source #

The environment variables for the application launch.

launchConfig_launchFile :: Lens' LaunchConfig (Maybe Text) Source #

The launch file name.

launchConfig_packageName :: Lens' LaunchConfig (Maybe Text) Source #

The package name.

launchConfig_portForwardingConfig :: Lens' LaunchConfig (Maybe PortForwardingConfig) Source #

The port forwarding configuration.

launchConfig_streamUI :: Lens' LaunchConfig (Maybe Bool) Source #

Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

LoggingConfig

loggingConfig_recordAllRosTopics :: Lens' LoggingConfig (Maybe Bool) Source #

A boolean indicating whether to record all ROS topics.

This API is no longer supported and will throw an error if used.

NetworkInterface

networkInterface_networkInterfaceId :: Lens' NetworkInterface (Maybe Text) Source #

The ID of the network interface.

networkInterface_privateIpAddress :: Lens' NetworkInterface (Maybe Text) Source #

The IPv4 address of the network interface within the subnet.

networkInterface_publicIpAddress :: Lens' NetworkInterface (Maybe Text) Source #

The IPv4 public address of the network interface.

OutputLocation

outputLocation_s3Bucket :: Lens' OutputLocation (Maybe Text) Source #

The S3 bucket for output.

outputLocation_s3Prefix :: Lens' OutputLocation (Maybe Text) Source #

The S3 folder in the s3Bucket where output files will be placed.

PortForwardingConfig

portForwardingConfig_portMappings :: Lens' PortForwardingConfig (Maybe [PortMapping]) Source #

The port mappings for the configuration.

PortMapping

portMapping_enableOnPublicIp :: Lens' PortMapping (Maybe Bool) Source #

A Boolean indicating whether to enable this port mapping on public IP.

portMapping_jobPort :: Lens' PortMapping Natural Source #

The port number on the simulation job instance to use as a remote connection point.

portMapping_applicationPort :: Lens' PortMapping Natural Source #

The port number on the application.

RenderingEngine

renderingEngine_name :: Lens' RenderingEngine (Maybe RenderingEngineType) Source #

The name of the rendering engine.

renderingEngine_version :: Lens' RenderingEngine (Maybe Text) Source #

The version of the rendering engine.

RobotApplicationConfig

robotApplicationConfig_applicationVersion :: Lens' RobotApplicationConfig (Maybe Text) Source #

The version of the robot application.

robotApplicationConfig_tools :: Lens' RobotApplicationConfig (Maybe [Tool]) Source #

Information about tools configured for the robot application.

robotApplicationConfig_uploadConfigurations :: Lens' RobotApplicationConfig (Maybe [UploadConfiguration]) Source #

The upload configurations for the robot application.

robotApplicationConfig_useDefaultTools :: Lens' RobotApplicationConfig (Maybe Bool) Source #

A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

robotApplicationConfig_useDefaultUploadConfigurations :: Lens' RobotApplicationConfig (Maybe Bool) Source #

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

robotApplicationConfig_application :: Lens' RobotApplicationConfig Text Source #

The application information for the robot application.

robotApplicationConfig_launchConfig :: Lens' RobotApplicationConfig LaunchConfig Source #

The launch configuration for the robot application.

RobotApplicationSummary

robotApplicationSummary_arn :: Lens' RobotApplicationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot.

robotApplicationSummary_lastUpdatedAt :: Lens' RobotApplicationSummary (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the robot application was last updated.

robotApplicationSummary_name :: Lens' RobotApplicationSummary (Maybe Text) Source #

The name of the robot application.

robotApplicationSummary_robotSoftwareSuite :: Lens' RobotApplicationSummary (Maybe RobotSoftwareSuite) Source #

Information about a robot software suite (ROS distribution).

robotApplicationSummary_version :: Lens' RobotApplicationSummary (Maybe Text) Source #

The version of the robot application.

RobotSoftwareSuite

robotSoftwareSuite_name :: Lens' RobotSoftwareSuite (Maybe RobotSoftwareSuiteType) Source #

The name of the robot software suite (ROS distribution).

robotSoftwareSuite_version :: Lens' RobotSoftwareSuite (Maybe RobotSoftwareSuiteVersionType) Source #

The version of the robot software suite (ROS distribution).

S3KeyOutput

s3KeyOutput_etag :: Lens' S3KeyOutput (Maybe Text) Source #

The etag for the object.

s3KeyOutput_s3Key :: Lens' S3KeyOutput (Maybe Text) Source #

The S3 key.

SimulationApplicationConfig

simulationApplicationConfig_applicationVersion :: Lens' SimulationApplicationConfig (Maybe Text) Source #

The version of the simulation application.

simulationApplicationConfig_tools :: Lens' SimulationApplicationConfig (Maybe [Tool]) Source #

Information about tools configured for the simulation application.

simulationApplicationConfig_uploadConfigurations :: Lens' SimulationApplicationConfig (Maybe [UploadConfiguration]) Source #

Information about upload configurations for the simulation application.

simulationApplicationConfig_useDefaultTools :: Lens' SimulationApplicationConfig (Maybe Bool) Source #

A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

simulationApplicationConfig_useDefaultUploadConfigurations :: Lens' SimulationApplicationConfig (Maybe Bool) Source #

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

simulationApplicationConfig_worldConfigs :: Lens' SimulationApplicationConfig (Maybe [WorldConfig]) Source #

A list of world configurations.

simulationApplicationConfig_application :: Lens' SimulationApplicationConfig Text Source #

The application information for the simulation application.

simulationApplicationConfig_launchConfig :: Lens' SimulationApplicationConfig LaunchConfig Source #

The launch configuration for the simulation application.

SimulationApplicationSummary

simulationApplicationSummary_arn :: Lens' SimulationApplicationSummary (Maybe Text) Source #

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

simulationApplicationSummary_lastUpdatedAt :: Lens' SimulationApplicationSummary (Maybe UTCTime) Source #

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

simulationApplicationSummary_name :: Lens' SimulationApplicationSummary (Maybe Text) Source #

The name of the simulation application.

simulationApplicationSummary_robotSoftwareSuite :: Lens' SimulationApplicationSummary (Maybe RobotSoftwareSuite) Source #

Information about a robot software suite (ROS distribution).

simulationApplicationSummary_simulationSoftwareSuite :: Lens' SimulationApplicationSummary (Maybe SimulationSoftwareSuite) Source #

Information about a simulation software suite.

simulationApplicationSummary_version :: Lens' SimulationApplicationSummary (Maybe Text) Source #

The version of the simulation application.

SimulationJob

simulationJob_arn :: Lens' SimulationJob (Maybe Text) Source #

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

simulationJob_clientRequestToken :: Lens' SimulationJob (Maybe Text) Source #

A unique identifier for this SimulationJob request.

simulationJob_compute :: Lens' SimulationJob (Maybe ComputeResponse) Source #

Compute information for the simulation job

simulationJob_dataSources :: Lens' SimulationJob (Maybe [DataSource]) Source #

The data sources for the simulation job.

simulationJob_failureBehavior :: Lens' SimulationJob (Maybe FailureBehavior) Source #

The failure behavior the simulation job.

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

simulationJob_failureCode :: Lens' SimulationJob (Maybe SimulationJobErrorCode) Source #

The failure code of the simulation job if it failed.

simulationJob_failureReason :: Lens' SimulationJob (Maybe Text) Source #

The reason why the simulation job failed.

simulationJob_iamRole :: Lens' SimulationJob (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. This is how credentials are passed in to your simulation job.

simulationJob_lastStartedAt :: Lens' SimulationJob (Maybe UTCTime) Source #

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

simulationJob_lastUpdatedAt :: Lens' SimulationJob (Maybe UTCTime) Source #

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

simulationJob_loggingConfig :: Lens' SimulationJob (Maybe LoggingConfig) Source #

The logging configuration.

simulationJob_maxJobDurationInSeconds :: Lens' SimulationJob (Maybe Integer) Source #

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

simulationJob_name :: Lens' SimulationJob (Maybe Text) Source #

The name of the simulation job.

simulationJob_networkInterface :: Lens' SimulationJob (Maybe NetworkInterface) Source #

Information about a network interface.

simulationJob_outputLocation :: Lens' SimulationJob (Maybe OutputLocation) Source #

Location for output files generated by the simulation job.

simulationJob_robotApplications :: Lens' SimulationJob (Maybe (NonEmpty RobotApplicationConfig)) Source #

A list of robot applications.

simulationJob_simulationApplications :: Lens' SimulationJob (Maybe (NonEmpty SimulationApplicationConfig)) Source #

A list of simulation applications.

simulationJob_simulationTimeMillis :: Lens' SimulationJob (Maybe Integer) Source #

The simulation job execution duration in milliseconds.

simulationJob_status :: Lens' SimulationJob (Maybe SimulationJobStatus) Source #

Status of the simulation job.

simulationJob_tags :: Lens' SimulationJob (Maybe (HashMap Text Text)) Source #

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

simulationJob_vpcConfig :: Lens' SimulationJob (Maybe VPCConfigResponse) Source #

VPC configuration information.

SimulationJobBatchSummary

simulationJobBatchSummary_arn :: Lens' SimulationJobBatchSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the batch.

simulationJobBatchSummary_createdAt :: Lens' SimulationJobBatchSummary (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the simulation job batch was created.

simulationJobBatchSummary_createdRequestCount :: Lens' SimulationJobBatchSummary (Maybe Int) Source #

The number of created simulation job requests.

simulationJobBatchSummary_failedRequestCount :: Lens' SimulationJobBatchSummary (Maybe Int) Source #

The number of failed simulation job requests.

simulationJobBatchSummary_lastUpdatedAt :: Lens' SimulationJobBatchSummary (Maybe UTCTime) Source #

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

simulationJobBatchSummary_pendingRequestCount :: Lens' SimulationJobBatchSummary (Maybe Int) Source #

The number of pending simulation job requests.

simulationJobBatchSummary_status :: Lens' SimulationJobBatchSummary (Maybe SimulationJobBatchStatus) Source #

The status of the simulation job batch.

Pending: The simulation job batch request is pending.
InProgress: The simulation job batch is in progress.
Failed: The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.
Completed: The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).
Canceled: The simulation batch job was cancelled.
Canceling: The simulation batch job is being cancelled.
Completing: The simulation batch job is completing.
TimingOut: The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.
TimedOut: The simulation batch job timed out.

SimulationJobRequest

simulationJobRequest_compute :: Lens' SimulationJobRequest (Maybe Compute) Source #

Compute information for the simulation job

simulationJobRequest_dataSources :: Lens' SimulationJobRequest (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.

simulationJobRequest_failureBehavior :: Lens' SimulationJobRequest (Maybe FailureBehavior) Source #

The failure behavior the simulation job.

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

simulationJobRequest_iamRole :: Lens' SimulationJobRequest (Maybe 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.

simulationJobRequest_loggingConfig :: Lens' SimulationJobRequest (Maybe LoggingConfig) Source #

Undocumented member.

simulationJobRequest_outputLocation :: Lens' SimulationJobRequest (Maybe OutputLocation) Source #

Undocumented member.

simulationJobRequest_robotApplications :: Lens' SimulationJobRequest (Maybe (NonEmpty RobotApplicationConfig)) Source #

The robot applications to use in the simulation job.

simulationJobRequest_simulationApplications :: Lens' SimulationJobRequest (Maybe (NonEmpty SimulationApplicationConfig)) Source #

The simulation applications to use in the simulation job.

simulationJobRequest_tags :: Lens' SimulationJobRequest (Maybe (HashMap Text Text)) Source #

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

simulationJobRequest_useDefaultApplications :: Lens' SimulationJobRequest (Maybe Bool) Source #

A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

simulationJobRequest_vpcConfig :: Lens' SimulationJobRequest (Maybe VPCConfig) Source #

Undocumented member.

simulationJobRequest_maxJobDurationInSeconds :: Lens' SimulationJobRequest Integer Source #

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

SimulationJobSummary

simulationJobSummary_arn :: Lens' SimulationJobSummary (Maybe Text) Source #

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

simulationJobSummary_computeType :: Lens' SimulationJobSummary (Maybe ComputeType) Source #

The compute type for the simulation job summary.

simulationJobSummary_dataSourceNames :: Lens' SimulationJobSummary (Maybe [Text]) Source #

The names of the data sources.

simulationJobSummary_lastUpdatedAt :: Lens' SimulationJobSummary (Maybe UTCTime) Source #

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

simulationJobSummary_name :: Lens' SimulationJobSummary (Maybe Text) Source #

The name of the simulation job.

simulationJobSummary_robotApplicationNames :: Lens' SimulationJobSummary (Maybe [Text]) Source #

A list of simulation job robot application names.

simulationJobSummary_simulationApplicationNames :: Lens' SimulationJobSummary (Maybe [Text]) Source #

A list of simulation job simulation application names.

simulationJobSummary_status :: Lens' SimulationJobSummary (Maybe SimulationJobStatus) Source #

The status of the simulation job.

SimulationSoftwareSuite

simulationSoftwareSuite_name :: Lens' SimulationSoftwareSuite (Maybe SimulationSoftwareSuiteType) Source #

The name of the simulation software suite.

simulationSoftwareSuite_version :: Lens' SimulationSoftwareSuite (Maybe Text) Source #

The version of the simulation software suite.

Source

source_architecture :: Lens' Source (Maybe Architecture) Source #

The taget processor architecture for the application.

source_etag :: Lens' Source (Maybe Text) Source #

A hash of the object specified by s3Bucket and s3Key.

source_s3Bucket :: Lens' Source (Maybe Text) Source #

The s3 bucket name.

source_s3Key :: Lens' Source (Maybe Text) Source #

The s3 object key.

SourceConfig

sourceConfig_architecture :: Lens' SourceConfig (Maybe Architecture) Source #

The target processor architecture for the application.

sourceConfig_s3Bucket :: Lens' SourceConfig (Maybe Text) Source #

The Amazon S3 bucket name.

sourceConfig_s3Key :: Lens' SourceConfig (Maybe Text) Source #

The s3 object key.

TemplateLocation

templateLocation_s3Bucket :: Lens' TemplateLocation Text Source #

The Amazon S3 bucket name.

templateLocation_s3Key :: Lens' TemplateLocation Text Source #

The list of S3 keys identifying the data source files.

TemplateSummary

templateSummary_arn :: Lens' TemplateSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

templateSummary_createdAt :: Lens' TemplateSummary (Maybe UTCTime) Source #

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

templateSummary_lastUpdatedAt :: Lens' TemplateSummary (Maybe UTCTime) Source #

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

templateSummary_name :: Lens' TemplateSummary (Maybe Text) Source #

The name of the template.

templateSummary_version :: Lens' TemplateSummary (Maybe Text) Source #

The version of the template that you're using.

Tool

tool_exitBehavior :: Lens' Tool (Maybe ExitBehavior) Source #

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

tool_streamOutputToCloudWatch :: Lens' Tool (Maybe Bool) Source #

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

tool_streamUI :: Lens' Tool (Maybe Bool) Source #

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

tool_name :: Lens' Tool Text Source #

The name of the tool.

tool_command :: Lens' Tool Text Source #

Command-line arguments for the tool. It must include the tool executable name.

UploadConfiguration

uploadConfiguration_name :: Lens' UploadConfiguration Text Source #

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

uploadConfiguration_path :: Lens' UploadConfiguration Text Source #

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

uploadConfiguration_uploadBehavior :: Lens' UploadConfiguration UploadBehavior Source #

Specifies when to upload the files:

UPLOAD_ON_TERMINATE: Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE: Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

VPCConfig

vPCConfig_assignPublicIp :: Lens' VPCConfig (Maybe Bool) Source #

A boolean indicating whether to assign a public IP address.

vPCConfig_securityGroups :: Lens' VPCConfig (Maybe (NonEmpty Text)) Source #

A list of one or more security groups IDs in your VPC.

vPCConfig_subnets :: Lens' VPCConfig (NonEmpty Text) Source #

A list of one or more subnet IDs in your VPC.

VPCConfigResponse

vPCConfigResponse_assignPublicIp :: Lens' VPCConfigResponse (Maybe Bool) Source #

A boolean indicating if a public IP was assigned.

vPCConfigResponse_securityGroups :: Lens' VPCConfigResponse (Maybe (NonEmpty Text)) Source #

A list of security group IDs associated with the simulation job.

vPCConfigResponse_subnets :: Lens' VPCConfigResponse (Maybe (NonEmpty Text)) Source #

A list of subnet IDs associated with the simulation job.

vPCConfigResponse_vpcId :: Lens' VPCConfigResponse (Maybe Text) Source #

The VPC ID associated with your simulation job.

WorldConfig

worldConfig_world :: Lens' WorldConfig (Maybe Text) Source #

The world generated by Simulation WorldForge.

WorldCount

worldCount_floorplanCount :: Lens' WorldCount (Maybe Int) Source #

The number of unique floorplans.

worldCount_interiorCountPerFloorplan :: Lens' WorldCount (Maybe Int) Source #

The number of unique interiors per floorplan.

WorldExportJobSummary

worldExportJobSummary_arn :: Lens' WorldExportJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world export job.

worldExportJobSummary_createdAt :: Lens' WorldExportJobSummary (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world export job was created.

worldExportJobSummary_outputLocation :: Lens' WorldExportJobSummary (Maybe OutputLocation) Source #

Undocumented member.

worldExportJobSummary_status :: Lens' WorldExportJobSummary (Maybe WorldExportJobStatus) Source #

The status of the world export job.

Pending: The world export job request is pending.
Running: The world export job is running.
Completed: The world export job completed.
Failed: The world export job failed. See failureCode for more information.
Canceled: The world export job was cancelled.
Canceling: The world export job is being cancelled.

worldExportJobSummary_worlds :: Lens' WorldExportJobSummary (Maybe (NonEmpty Text)) Source #

A list of worlds.

WorldFailure

worldFailure_failureCode :: Lens' WorldFailure (Maybe WorldGenerationJobErrorCode) Source #

The failure code of the world export job if it failed:

InternalServiceError: Internal service error.
LimitExceeded: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound: The specified resource could not be found.
RequestThrottled: The request was throttled.
InvalidInput: An input parameter in the request is not valid.

worldFailure_failureCount :: Lens' WorldFailure (Maybe Int) Source #

The number of failed worlds.

worldFailure_sampleFailureReason :: Lens' WorldFailure (Maybe Text) Source #

The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.

WorldGenerationJobSummary

worldGenerationJobSummary_arn :: Lens' WorldGenerationJobSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world generator job.

worldGenerationJobSummary_createdAt :: Lens' WorldGenerationJobSummary (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the world generator job was created.

worldGenerationJobSummary_failedWorldCount :: Lens' WorldGenerationJobSummary (Maybe Int) Source #

The number of worlds that failed.

worldGenerationJobSummary_status :: Lens' WorldGenerationJobSummary (Maybe WorldGenerationJobStatus) Source #

The status of the world generator job:

Pending: The world generator job request is pending.
Running: The world generator job is running.
Completed: The world generator job completed.
Failed: The world generator job failed. See failureCode for more information.
PartialFailed: Some worlds did not generate.
Canceled: The world generator job was cancelled.
Canceling: The world generator job is being cancelled.

worldGenerationJobSummary_succeededWorldCount :: Lens' WorldGenerationJobSummary (Maybe Int) Source #

The number of worlds that were generated.

worldGenerationJobSummary_template :: Lens' WorldGenerationJobSummary (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.

worldGenerationJobSummary_worldCount :: Lens' WorldGenerationJobSummary (Maybe WorldCount) Source #

Information about the world count.

WorldSummary

worldSummary_arn :: Lens' WorldSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the world.

worldSummary_createdAt :: Lens' WorldSummary (Maybe UTCTime) Source #

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

worldSummary_generationJob :: Lens' WorldSummary (Maybe Text) Source #

The Amazon Resource Name (arn) of the world generation job.

worldSummary_template :: Lens' WorldSummary (Maybe Text) Source #

The Amazon Resource Name (arn) of the world template.