libZSservicesZSamazonka-robomakerZSamazonka-robomaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RobOMaker.Lens

Contents

Description

 
Synopsis

Operations

DescribeWorldExportJob

describeWorldExportJob_job :: Lens' DescribeWorldExportJob Text Source #

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

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_arn :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

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

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_clientRequestToken :: Lens' DescribeWorldExportJobResponse (Maybe Text) Source #

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

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_worlds :: Lens' DescribeWorldExportJobResponse (Maybe (NonEmpty Text)) Source #

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

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.

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.

GetWorldTemplateBody

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

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

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

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

DeleteFleet

deleteFleet_fleet :: Lens' DeleteFleet Text Source #

The Amazon Resource Name (ARN) of the fleet.

CreateWorldGenerationJob

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_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_template :: Lens' CreateWorldGenerationJob Text Source #

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

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_arn :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

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_template :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

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_clientRequestToken :: Lens' CreateWorldGenerationJobResponse (Maybe Text) Source #

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

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.

ListRobotApplications

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

The version qualifier of the robot application.

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

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

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

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.

UpdateRobotApplication

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

The object that contains the Docker image URI for your 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_lastUpdatedAt :: Lens' UpdateRobotApplicationResponse (Maybe UTCTime) Source #

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

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_robotSoftwareSuite :: Lens' UpdateRobotApplicationResponse (Maybe RobotSoftwareSuite) Source #

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

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.

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_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_imageDigest :: Lens' CreateSimulationApplicationVersion (Maybe Text) Source #

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

createSimulationApplicationVersion_application :: Lens' CreateSimulationApplicationVersion Text Source #

The application information for 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_environment :: Lens' CreateSimulationApplicationVersionResponse (Maybe Environment) Source #

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

ListDeploymentJobs

listDeploymentJobs_filters :: Lens' ListDeploymentJobs (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

The filter names status and fleetName 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 InProgress or the status Pending.

listDeploymentJobs_nextToken :: Lens' ListDeploymentJobs (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 ListDeploymentJobs 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.

listDeploymentJobs_maxResults :: Lens' ListDeploymentJobs (Maybe Int) Source #

When this parameter is used, ListDeploymentJobs 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 ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken value if applicable.

listDeploymentJobsResponse_deploymentJobs :: Lens' ListDeploymentJobsResponse (Maybe [DeploymentJob]) Source #

A list of deployment jobs that meet the criteria of the request.

listDeploymentJobsResponse_nextToken :: Lens' ListDeploymentJobsResponse (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 ListDeploymentJobs 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.

DescribeWorld

describeWorld_world :: Lens' DescribeWorld Text Source #

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

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

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

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_tags :: Lens' DescribeWorldResponse (Maybe (HashMap Text Text)) Source #

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

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

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

CancelSimulationJob

cancelSimulationJob_job :: Lens' CancelSimulationJob Text Source #

The simulation job ARN to cancel.

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_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_robotSoftwareSuite :: Lens' CreateRobotApplication RobotSoftwareSuite Source #

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

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

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

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_robotSoftwareSuite :: Lens' CreateRobotApplicationResponse (Maybe RobotSoftwareSuite) Source #

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

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

The list of all tags added to the robot application.

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.

CreateDeploymentJob

createDeploymentJob_tags :: Lens' CreateDeploymentJob (Maybe (HashMap Text Text)) Source #

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

createDeploymentJob_clientRequestToken :: Lens' CreateDeploymentJob Text Source #

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

createDeploymentJob_fleet :: Lens' CreateDeploymentJob Text Source #

The Amazon Resource Name (ARN) of the fleet to deploy.

createDeploymentJobResponse_failureReason :: Lens' CreateDeploymentJobResponse (Maybe Text) Source #

The failure reason of the deployment job if it failed.

createDeploymentJobResponse_arn :: Lens' CreateDeploymentJobResponse (Maybe Text) Source #

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

createDeploymentJobResponse_createdAt :: Lens' CreateDeploymentJobResponse (Maybe UTCTime) Source #

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

createDeploymentJobResponse_failureCode :: Lens' CreateDeploymentJobResponse (Maybe DeploymentJobErrorCode) Source #

The failure code of the simulation job if it failed:

BadPermissionError
AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.
ExtractingBundleFailure
The robot application could not be extracted from the bundle.
FailureThresholdBreached
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
GreengrassDeploymentFailed
The robot application could not be deployed to the robot.
GreengrassGroupVersionDoesNotExist
The AWS Greengrass group or version associated with a robot is missing.
InternalServerError
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
MissingRobotApplicationArchitecture
The robot application does not have a source that matches the architecture of the robot.
MissingRobotDeploymentResource
One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
PostLaunchFileFailure
The post-launch script failed.
PreLaunchFileFailure
The pre-launch script failed.
ResourceNotFound
One or more deployment resources are missing. For example, do robot application source bundles still exist?
RobotDeploymentNoResponse
There is no response from the robot. It might not be powered on or connected to the internet.

createDeploymentJobResponse_tags :: Lens' CreateDeploymentJobResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the deployment job.

RegisterRobot

registerRobot_fleet :: Lens' RegisterRobot Text Source #

The Amazon Resource Name (ARN) of the fleet.

registerRobot_robot :: Lens' RegisterRobot Text Source #

The Amazon Resource Name (ARN) of the robot.

registerRobotResponse_robot :: Lens' RegisterRobotResponse (Maybe Text) Source #

Information about the robot registration.

registerRobotResponse_fleet :: Lens' RegisterRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet that the robot will join.

ListRobots

listRobots_filters :: Lens' ListRobots (Maybe (NonEmpty Filter)) Source #

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

listRobots_nextToken :: Lens' ListRobots (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 ListRobots 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.

listRobots_maxResults :: Lens' ListRobots (Maybe Int) Source #

When this parameter is used, ListRobots 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 ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

listRobotsResponse_robots :: Lens' ListRobotsResponse (Maybe [Robot]) Source #

A list of robots that meet the criteria of the request.

listRobotsResponse_nextToken :: Lens' ListRobotsResponse (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 ListRobots 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.

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_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_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_arn :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

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

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_clientRequestToken :: Lens' CreateWorldExportJobResponse (Maybe Text) Source #

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

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

BatchDescribeSimulationJob

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

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

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

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

CreateSimulationApplication

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

The object that contains the Docker image URI used to create your 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_robotSoftwareSuite :: Lens' CreateSimulationApplication RobotSoftwareSuite Source #

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

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

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

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_tags :: Lens' CreateSimulationApplicationResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the simulation application.

StartSimulationJobBatch

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.

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_createdAt :: Lens' StartSimulationJobBatchResponse (Maybe UTCTime) Source #

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

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_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_clientRequestToken :: Lens' StartSimulationJobBatchResponse (Maybe Text) Source #

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

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.

CreateRobot

createRobot_tags :: Lens' CreateRobot (Maybe (HashMap Text Text)) Source #

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

createRobot_name :: Lens' CreateRobot Text Source #

The name for the robot.

createRobot_architecture :: Lens' CreateRobot Architecture Source #

The target architecture of the robot.

createRobotResponse_arn :: Lens' CreateRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot.

createRobotResponse_createdAt :: Lens' CreateRobotResponse (Maybe UTCTime) Source #

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

createRobotResponse_greengrassGroupId :: Lens' CreateRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.

createRobotResponse_tags :: Lens' CreateRobotResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the robot.

DescribeFleet

describeFleet_fleet :: Lens' DescribeFleet Text Source #

The Amazon Resource Name (ARN) of the fleet.

describeFleetResponse_lastDeploymentJob :: Lens' DescribeFleetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the last deployment job.

describeFleetResponse_arn :: Lens' DescribeFleetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

describeFleetResponse_createdAt :: Lens' DescribeFleetResponse (Maybe UTCTime) Source #

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

describeFleetResponse_tags :: Lens' DescribeFleetResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the specified fleet.

ListWorldTemplates

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.

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.

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.

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_lastUpdatedAt :: Lens' DescribeRobotApplicationResponse (Maybe UTCTime) Source #

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

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_robotSoftwareSuite :: Lens' DescribeRobotApplicationResponse (Maybe RobotSoftwareSuite) Source #

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

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

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

RestartSimulationJob

restartSimulationJob_job :: Lens' RestartSimulationJob Text Source #

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

DescribeSimulationJob

describeSimulationJob_job :: Lens' DescribeSimulationJob Text Source #

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

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

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

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

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

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

The Amazon Resource Name (ARN) of 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_clientRequestToken :: Lens' DescribeSimulationJobResponse (Maybe Text) Source #

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

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

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

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_maxJobDurationInSeconds :: Lens' DescribeSimulationJobResponse (Maybe Integer) Source #

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

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

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

DeregisterRobot

deregisterRobot_fleet :: Lens' DeregisterRobot Text Source #

The Amazon Resource Name (ARN) of the fleet.

deregisterRobot_robot :: Lens' DeregisterRobot Text Source #

The Amazon Resource Name (ARN) of the robot.

deregisterRobotResponse_robot :: Lens' DeregisterRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot.

deregisterRobotResponse_fleet :: Lens' DeregisterRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

DescribeSimulationApplication

describeSimulationApplication_application :: Lens' DescribeSimulationApplication Text Source #

The application information for the simulation application.

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

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

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_tags :: Lens' DescribeSimulationApplicationResponse (Maybe (HashMap Text Text)) Source #

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

ListSimulationJobBatches

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.

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.

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.

ListFleets

listFleets_filters :: Lens' ListFleets (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.

listFleets_nextToken :: Lens' ListFleets (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 ListFleets 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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listFleets_maxResults :: Lens' ListFleets (Maybe Int) Source #

When this parameter is used, ListFleets 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 ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable.

listFleetsResponse_fleetDetails :: Lens' ListFleetsResponse (Maybe [Fleet]) Source #

A list of fleet details meeting the request criteria.

listFleetsResponse_nextToken :: Lens' ListFleetsResponse (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 ListFleets 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.

DescribeWorldTemplate

describeWorldTemplate_template :: Lens' DescribeWorldTemplate Text Source #

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

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

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

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

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

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

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

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

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

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

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

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.

CancelWorldExportJob

cancelWorldExportJob_job :: Lens' CancelWorldExportJob Text Source #

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

ListWorldGenerationJobs

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

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

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.

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.

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.

CreateFleet

createFleet_tags :: Lens' CreateFleet (Maybe (HashMap Text Text)) Source #

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

createFleet_name :: Lens' CreateFleet Text Source #

The name of the fleet.

createFleetResponse_arn :: Lens' CreateFleetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

createFleetResponse_createdAt :: Lens' CreateFleetResponse (Maybe UTCTime) Source #

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

createFleetResponse_tags :: Lens' CreateFleetResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the fleet.

CancelWorldGenerationJob

cancelWorldGenerationJob_job :: Lens' CancelWorldGenerationJob Text Source #

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

DescribeSimulationJobBatch

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_lastUpdatedAt :: Lens' DescribeSimulationJobBatchResponse (Maybe UTCTime) Source #

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

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

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

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_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_clientRequestToken :: Lens' DescribeSimulationJobBatchResponse (Maybe Text) Source #

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

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.

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

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.

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_simulationJobSummaries :: Lens' ListSimulationJobsResponse [SimulationJobSummary] Source #

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

DeleteRobot

deleteRobot_robot :: Lens' DeleteRobot Text Source #

The Amazon Resource Name (ARN) of the robot.

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.

UpdateSimulationApplication

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

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

updateSimulationApplication_application :: Lens' UpdateSimulationApplication Text Source #

The application information for the simulation application.

updateSimulationApplication_robotSoftwareSuite :: Lens' UpdateSimulationApplication RobotSoftwareSuite Source #

Information about the robot software suite (ROS distribution).

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

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

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.

CreateSimulationJob

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_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_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_outputLocation :: Lens' CreateSimulationJob (Maybe OutputLocation) Source #

Location for output files generated by the simulation job.

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

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

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_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_lastUpdatedAt :: Lens' CreateSimulationJobResponse (Maybe UTCTime) Source #

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

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

The Amazon Resource Name (ARN) of 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_clientRequestToken :: Lens' CreateSimulationJobResponse (Maybe Text) Source #

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

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

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

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_tags :: Lens' CreateSimulationJobResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the simulation job.

ListWorldExportJobs

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

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

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.

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.

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.

ListSimulationApplications

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

The version qualifier of the simulation application.

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

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.

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_s3Etags :: Lens' CreateRobotApplicationVersion (Maybe [Text]) Source #

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

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

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

createRobotApplicationVersion_application :: Lens' CreateRobotApplicationVersion Text Source #

The application information for the robot application.

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

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

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.

CancelDeploymentJob

cancelDeploymentJob_job :: Lens' CancelDeploymentJob Text Source #

The deployment job ARN to cancel.

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.

ListWorlds

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

Optional filters to limit results. You can use status.

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.

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.

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.

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.

DescribeDeploymentJob

describeDeploymentJob_job :: Lens' DescribeDeploymentJob Text Source #

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

describeDeploymentJobResponse_failureReason :: Lens' DescribeDeploymentJobResponse (Maybe Text) Source #

A short description of the reason why the deployment job failed.

describeDeploymentJobResponse_arn :: Lens' DescribeDeploymentJobResponse (Maybe Text) Source #

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

describeDeploymentJobResponse_createdAt :: Lens' DescribeDeploymentJobResponse (Maybe UTCTime) Source #

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

describeDeploymentJobResponse_tags :: Lens' DescribeDeploymentJobResponse (Maybe (HashMap Text Text)) Source #

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

DeleteWorldTemplate

deleteWorldTemplate_template :: Lens' DeleteWorldTemplate Text Source #

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

UpdateWorldTemplate

updateWorldTemplate_template :: Lens' UpdateWorldTemplate Text Source #

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

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

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

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.

DescribeWorldGenerationJob

describeWorldGenerationJob_job :: Lens' DescribeWorldGenerationJob Text Source #

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

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_arn :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

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

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_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_clientRequestToken :: Lens' DescribeWorldGenerationJobResponse (Maybe Text) Source #

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

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.

CreateWorldTemplate

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

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

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.

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

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

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

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

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

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

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.

CancelSimulationJobBatch

DescribeRobot

describeRobot_robot :: Lens' DescribeRobot Text Source #

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

describeRobotResponse_lastDeploymentJob :: Lens' DescribeRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the last deployment job.

describeRobotResponse_arn :: Lens' DescribeRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot.

describeRobotResponse_createdAt :: Lens' DescribeRobotResponse (Maybe UTCTime) Source #

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

describeRobotResponse_fleetArn :: Lens' DescribeRobotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

describeRobotResponse_architecture :: Lens' DescribeRobotResponse (Maybe Architecture) Source #

The target architecture of the robot application.

describeRobotResponse_tags :: Lens' DescribeRobotResponse (Maybe (HashMap Text Text)) Source #

The list of all tags added to the specified robot.

SyncDeploymentJob

syncDeploymentJob_clientRequestToken :: Lens' SyncDeploymentJob Text Source #

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

syncDeploymentJob_fleet :: Lens' SyncDeploymentJob Text Source #

The target fleet for the synchronization.

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

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

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

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

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

The failure code if the job fails:

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

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

The Amazon Resource Name (ARN) of the fleet.

Types

BatchPolicy

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.

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.

Compute

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.

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_computeType :: Lens' Compute (Maybe ComputeType) Source #

Compute type information for the simulation job.

ComputeResponse

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.

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

Compute type response information for the simulation job.

DataSource

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

The list of S3 keys identifying the data source files.

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

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

The S3 bucket where the data files are located.

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.

DeploymentApplicationConfig

deploymentApplicationConfig_application :: Lens' DeploymentApplicationConfig Text Source #

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

DeploymentConfig

deploymentConfig_concurrentDeploymentPercentage :: Lens' DeploymentConfig (Maybe Natural) Source #

The percentage of robots receiving the deployment at the same time.

deploymentConfig_failureThresholdPercentage :: Lens' DeploymentConfig (Maybe Natural) Source #

The percentage of deployments that need to fail before stopping deployment.

deploymentConfig_robotDeploymentTimeoutInSeconds :: Lens' DeploymentConfig (Maybe Integer) Source #

The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.

DeploymentJob

deploymentJob_failureReason :: Lens' DeploymentJob (Maybe Text) Source #

A short description of the reason why the deployment job failed.

deploymentJob_status :: Lens' DeploymentJob (Maybe DeploymentStatus) Source #

The status of the deployment job.

deploymentJob_arn :: Lens' DeploymentJob (Maybe Text) Source #

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

deploymentJob_createdAt :: Lens' DeploymentJob (Maybe UTCTime) Source #

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

deploymentJob_fleet :: Lens' DeploymentJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

DeploymentLaunchConfig

deploymentLaunchConfig_preLaunchFile :: Lens' DeploymentLaunchConfig (Maybe Text) Source #

The deployment pre-launch file. This file will be executed prior to the launch file.

deploymentLaunchConfig_postLaunchFile :: Lens' DeploymentLaunchConfig (Maybe Text) Source #

The deployment post-launch file. This file will be executed after the launch file.

deploymentLaunchConfig_environmentVariables :: Lens' DeploymentLaunchConfig (Maybe (HashMap Text Text)) Source #

An array of key/value pairs specifying environment variables for the robot application

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.

FailureSummary

Filter

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

The name of the filter.

FinishedWorldsSummary

Fleet

fleet_lastDeploymentJob :: Lens' Fleet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the last deployment job.

fleet_lastDeploymentStatus :: Lens' Fleet (Maybe DeploymentStatus) Source #

The status of the last fleet deployment.

fleet_arn :: Lens' Fleet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

fleet_createdAt :: Lens' Fleet (Maybe UTCTime) Source #

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

fleet_name :: Lens' Fleet (Maybe Text) Source #

The name of the fleet.

fleet_lastDeploymentTime :: Lens' Fleet (Maybe UTCTime) Source #

The time of the last deployment.

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_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 Bool Source #

A boolean indicating whether to record all ROS topics.

NetworkInterface

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_s3Prefix :: Lens' OutputLocation (Maybe Text) Source #

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

PortForwardingConfig

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.

ProgressDetail

progressDetail_currentProgress :: Lens' ProgressDetail (Maybe RobotDeploymentStep) Source #

The current progress status.

Validating
Validating the deployment.
DownloadingExtracting
Downloading and extracting the bundle on the robot.
ExecutingPreLaunch
Executing pre-launch script(s) if provided.
Launching
Launching the robot application.
ExecutingPostLaunch
Executing post-launch script(s) if provided.
Finished
Deployment is complete.

progressDetail_estimatedTimeRemainingSeconds :: Lens' ProgressDetail (Maybe Int) Source #

Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

progressDetail_targetResource :: Lens' ProgressDetail (Maybe Text) Source #

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

progressDetail_percentDone :: Lens' ProgressDetail (Maybe Double) Source #

Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

RenderingEngine

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

The version of the rendering engine.

Robot

robot_lastDeploymentJob :: Lens' Robot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the last deployment job.

robot_status :: Lens' Robot (Maybe RobotStatus) Source #

The status of the robot.

robot_arn :: Lens' Robot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the robot.

robot_createdAt :: Lens' Robot (Maybe UTCTime) Source #

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

robot_greenGrassGroupId :: Lens' Robot (Maybe Text) Source #

The Greengrass group associated with the robot.

robot_fleetArn :: Lens' Robot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the fleet.

robot_name :: Lens' Robot (Maybe Text) Source #

The name of the robot.

robot_architecture :: Lens' Robot (Maybe Architecture) Source #

The architecture of the robot.

robot_lastDeploymentTime :: Lens' Robot (Maybe UTCTime) Source #

The time of the last deployment.

RobotApplicationConfig

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.

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.

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

Information about tools configured for the robot application.

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_lastUpdatedAt :: Lens' RobotApplicationSummary (Maybe UTCTime) Source #

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

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

The Amazon Resource Name (ARN) of the robot.

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

Information about a robot software suite (ROS distribution).

RobotDeployment

robotDeployment_deploymentStartTime :: Lens' RobotDeployment (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the deployment was started.

robotDeployment_failureReason :: Lens' RobotDeployment (Maybe Text) Source #

A short description of the reason why the robot deployment failed.

robotDeployment_status :: Lens' RobotDeployment (Maybe RobotStatus) Source #

The status of the robot deployment.

robotDeployment_arn :: Lens' RobotDeployment (Maybe Text) Source #

The robot deployment Amazon Resource Name (ARN).

robotDeployment_progressDetail :: Lens' RobotDeployment (Maybe ProgressDetail) Source #

Information about how the deployment is progressing.

robotDeployment_deploymentFinishTime :: Lens' RobotDeployment (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the deployment finished.

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.

S3Object

s3Object_etag :: Lens' S3Object (Maybe Text) Source #

The etag of the object.

s3Object_bucket :: Lens' S3Object Text Source #

The bucket containing the object.

s3Object_key :: Lens' S3Object Text Source #

The key of the object.

SimulationApplicationConfig

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.

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.

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

Information about upload configurations for the simulation application.

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

Information about tools configured for the simulation application.

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_lastUpdatedAt :: Lens' SimulationApplicationSummary (Maybe UTCTime) Source #

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

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

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

SimulationJob

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

The reason why the simulation job failed.

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_lastUpdatedAt :: Lens' SimulationJob (Maybe UTCTime) Source #

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

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

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

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

The failure code of the simulation job if it failed.

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_name :: Lens' SimulationJob (Maybe Text) Source #

The name of the simulation job.

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

Location for output files generated by the simulation job.

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

The simulation job execution duration in milliseconds.

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

A unique identifier for this SimulationJob request.

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

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

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_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_tags :: Lens' SimulationJob (Maybe (HashMap Text Text)) Source #

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

SimulationJobBatchSummary

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.

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

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

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.

SimulationJobRequest

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_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_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_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_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_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_robotApplicationNames :: Lens' SimulationJobSummary (Maybe [Text]) Source #

A list of simulation job robot application names.

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

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

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

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

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

A list of simulation job simulation application names.

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

The compute type for the simulation job summary.

SimulationSoftwareSuite

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

The version of the simulation software suite.

Source

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

A hash of the object specified by s3Bucket and s3Key.

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

The s3 object key.

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

The taget processor architecture for the application.

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

The s3 bucket name.

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.

TemplateLocation

templateLocation_s3Key :: Lens' TemplateLocation Text Source #

The list of S3 keys identifying the data source files.

TemplateSummary

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

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

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_version :: Lens' TemplateSummary (Maybe Text) Source #

The version of the template that you're using.

Tool

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

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

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_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_securityGroups :: Lens' VPCConfig (Maybe (NonEmpty Text)) Source #

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

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

A boolean indicating whether to assign a public IP address.

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

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

VPCConfigResponse

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

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

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

The VPC ID associated with your simulation job.

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

A list of subnet IDs associated with the simulation job.

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

A boolean indicating if a public IP was assigned.

WorldConfig

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

The world generated by Simulation WorldForge.

WorldCount

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

The number of unique interiors per floorplan.

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

The number of unique floorplans.

WorldExportJobSummary

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

WorldFailure

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.

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.

WorldGenerationJobSummary

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_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_template :: Lens' WorldGenerationJobSummary (Maybe Text) Source #

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

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_template :: Lens' WorldSummary (Maybe Text) Source #

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

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

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