Long timeoutInSeconds
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.
Integer maxConcurrency
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.
String job
The deployment job ARN to cancel.
String batch
The id of the batch to cancel.
String job
The simulation job ARN to cancel.
Integer simulationUnitLimit
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 maximim value provided.
Integer simulationUnitLimit
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 maximim value provided.
DeploymentConfig deploymentConfig
The requested deployment configuration.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String fleet
The Amazon Resource Name (ARN) of the fleet to deploy.
List<E> deploymentApplicationConfigs
The deployment application configuration.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the deployment job.
String arn
The Amazon Resource Name (ARN) of the deployment job.
String fleet
The target fleet for the deployment job.
String status
The status of the deployment job.
List<E> deploymentApplicationConfigs
The deployment application configuration.
String failureReason
The failure reason of the deployment job if it failed.
String failureCode
The failure code of the simulation job if it failed:
AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.
The robot application could not be extracted from the bundle.
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
The robot application could not be deployed to the robot.
The AWS Greengrass group or version associated with a robot is missing.
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
The robot application does not have a source that matches the architecture of the robot.
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?
The post-launch script failed.
The pre-launch script failed.
One or more deployment resources are missing. For example, do robot application source bundles still exist?
There is no response from the robot. It might not be powered on or connected to the internet.
Date createdAt
The time, in milliseconds since the epoch, when the fleet was created.
DeploymentConfig deploymentConfig
The deployment configuration.
Map<K,V> tags
The list of all tags added to the deployment job.
String name
The name of the robot application.
List<E> sources
The sources of the robot application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribuition) used by the robot application.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the robot application.
String arn
The Amazon Resource Name (ARN) of the robot application.
String name
The name of the robot application.
String version
The version of the robot application.
List<E> sources
The sources of the robot application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribution) used by the robot application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the robot application was last updated.
String revisionId
The revision id of the robot application.
Map<K,V> tags
The list of all tags added to the robot application.
String arn
The Amazon Resource Name (ARN) of the robot application.
String name
The name of the robot application.
String version
The version of the robot application.
List<E> sources
The sources of the robot application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribution) used by the robot application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the robot application was last updated.
String revisionId
The revision id of the robot application.
String arn
The Amazon Resource Name (ARN) of the robot.
String name
The name of the robot.
Date createdAt
The time, in milliseconds since the epoch, when the robot was created.
String greengrassGroupId
The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
String architecture
The target architecture of the robot.
Map<K,V> tags
The list of all tags added to the robot.
String name
The name of the simulation application.
List<E> sources
The sources of the simulation application.
SimulationSoftwareSuite simulationSoftwareSuite
The simulation software suite used by the simulation application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribution) used by the simulation application.
RenderingEngine renderingEngine
The rendering engine for the simulation application.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the simulation application.
String arn
The Amazon Resource Name (ARN) of the simulation application.
String name
The name of the simulation application.
String version
The version of the simulation application.
List<E> sources
The sources of the simulation application.
SimulationSoftwareSuite simulationSoftwareSuite
The simulation software suite used by the simulation application.
RobotSoftwareSuite robotSoftwareSuite
Information about the robot software suite (ROS distribution).
RenderingEngine renderingEngine
The rendering engine for the simulation application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation application was last updated.
String revisionId
The revision id of the simulation application.
Map<K,V> tags
The list of all tags added to the simulation application.
String arn
The Amazon Resource Name (ARN) of the simulation application.
String name
The name of the simulation application.
String version
The version of the simulation application.
List<E> sources
The sources of the simulation application.
SimulationSoftwareSuite simulationSoftwareSuite
The simulation software suite used by the simulation application.
RobotSoftwareSuite robotSoftwareSuite
Information about the robot software suite (ROS distribution).
RenderingEngine renderingEngine
The rendering engine for the simulation application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation application was last updated.
String revisionId
The revision ID of the simulation application.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
OutputLocation outputLocation
Location for output files generated by the simulation job.
LoggingConfig loggingConfig
The logging configuration.
Long maxJobDurationInSeconds
The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When
maxJobDurationInSeconds is reached, the simulation job will status will transition to
Completed.
String iamRole
The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
String failureBehavior
The failure behavior the simulation job.
Restart the simulation job in the same host instance.
Stop the simulation job and terminate the instance.
List<E> robotApplications
The robot application to use in the simulation job.
List<E> simulationApplications
The simulation application to use in the simulation job.
List<E> dataSources
Specify data sources to mount read-only files from S3 into your simulation. These files are available under
/opt/robomaker/datasources/data_source_name.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the simulation job.
VPCConfig vpcConfig
If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
Compute compute
Compute information for the simulation job.
String arn
The Amazon Resource Name (ARN) of the simulation job.
String status
The status of the simulation job.
Date lastStartedAt
The time, in milliseconds since the epoch, when the simulation job was last started.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation job was last updated.
String failureBehavior
the failure behavior for the simulation job.
String failureCode
The failure code of the simulation job if it failed:
Internal service error.
Robot application exited abnormally.
Simulation application exited abnormally.
Robot application bundle could not be downloaded.
Simulation application bundle could not be downloaded.
Unable to publish outputs to customer-provided S3 bucket.
Unable to publish logs to customer-provided CloudWatch Logs resource.
Subnet IP limit exceeded.
ENI limit exceeded.
Unable to use the Role provided.
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
Etag for RobotApplication does not match value during version creation.
Etag for SimulationApplication does not match value during version creation.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
OutputLocation outputLocation
Simulation job output files location.
LoggingConfig loggingConfig
The logging configuration.
Long maxJobDurationInSeconds
The maximum simulation job duration in seconds.
Long simulationTimeMillis
The simulation job execution duration in milliseconds.
String iamRole
The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
List<E> robotApplications
The robot application used by the simulation job.
List<E> simulationApplications
The simulation application used by the simulation job.
List<E> dataSources
The data sources for the simulation job.
Map<K,V> tags
The list of all tags added to the simulation job.
VPCConfigResponse vpcConfig
Information about the vpc configuration.
ComputeResponse compute
Compute information for the simulation job.
String fleet
The Amazon Resource Name (ARN) of the fleet.
String robot
The Amazon Resource Name (ARN) of the robot.
String application
The Amazon Resource Name (ARN) of the robot application.
String applicationVersion
The version of the application.
DeploymentLaunchConfig launchConfig
The launch configuration.
Integer concurrentDeploymentPercentage
The percentage of robots receiving the deployment at the same time.
Integer failureThresholdPercentage
The percentage of deployments that need to fail before stopping deployment.
Long robotDeploymentTimeoutInSeconds
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.
S3Object downloadConditionFile
The download condition file.
String arn
The Amazon Resource Name (ARN) of the deployment job.
String fleet
The Amazon Resource Name (ARN) of the fleet.
String status
The status of the deployment job.
List<E> deploymentApplicationConfigs
The deployment application configuration.
DeploymentConfig deploymentConfig
The deployment configuration.
String failureReason
A short description of the reason why the deployment job failed.
String failureCode
The deployment job failure code.
Date createdAt
The time, in milliseconds since the epoch, when the deployment job was created.
String packageName
The package name.
String preLaunchFile
The deployment pre-launch file. This file will be executed prior to the launch file.
String launchFile
The launch file name.
String postLaunchFile
The deployment post-launch file. This file will be executed after the launch file.
Map<K,V> environmentVariables
An array of key/value pairs specifying environment variables for the robot application
String job
The Amazon Resource Name (ARN) of the deployment job.
String arn
The Amazon Resource Name (ARN) of the deployment job.
String fleet
The Amazon Resource Name (ARN) of the fleet.
String status
The status of the deployment job.
DeploymentConfig deploymentConfig
The deployment configuration.
List<E> deploymentApplicationConfigs
The deployment application configuration.
String failureReason
A short description of the reason why the deployment job failed.
String failureCode
The deployment job failure code.
Date createdAt
The time, in milliseconds since the epoch, when the deployment job was created.
List<E> robotDeploymentSummary
A list of robot deployment summaries.
Map<K,V> tags
The list of all tags added to the specified deployment job.
String fleet
The Amazon Resource Name (ARN) of the fleet.
String name
The name of the fleet.
String arn
The Amazon Resource Name (ARN) of the fleet.
List<E> robots
A list of robots.
Date createdAt
The time, in milliseconds since the epoch, when the fleet was created.
String lastDeploymentStatus
The status of the last deployment.
String lastDeploymentJob
The Amazon Resource Name (ARN) of the last deployment job.
Date lastDeploymentTime
The time of the last deployment.
Map<K,V> tags
The list of all tags added to the specified fleet.
String arn
The Amazon Resource Name (ARN) of the robot application.
String name
The name of the robot application.
String version
The version of the robot application.
List<E> sources
The sources of the robot application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribution) used by the robot application.
String revisionId
The revision id of the robot application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the robot application was last updated.
Map<K,V> tags
The list of all tags added to the specified robot application.
String robot
The Amazon Resource Name (ARN) of the robot to be described.
String arn
The Amazon Resource Name (ARN) of the robot.
String name
The name of the robot.
String fleetArn
The Amazon Resource Name (ARN) of the fleet.
String status
The status of the fleet.
String greengrassGroupId
The Greengrass group id.
Date createdAt
The time, in milliseconds since the epoch, when the robot was created.
String architecture
The target architecture of the robot application.
String lastDeploymentJob
The Amazon Resource Name (ARN) of the last deployment job.
Date lastDeploymentTime
The time of the last deployment job.
Map<K,V> tags
The list of all tags added to the specified robot.
String arn
The Amazon Resource Name (ARN) of the robot simulation application.
String name
The name of the simulation application.
String version
The version of the simulation application.
List<E> sources
The sources of the simulation application.
SimulationSoftwareSuite simulationSoftwareSuite
The simulation software suite used by the simulation application.
RobotSoftwareSuite robotSoftwareSuite
Information about the robot software suite (ROS distribution).
RenderingEngine renderingEngine
The rendering engine for the simulation application.
String revisionId
The revision id of the simulation application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation application was last updated.
Map<K,V> tags
The list of all tags added to the specified simulation application.
String batch
The id of the batch to describe.
String arn
The Amazon Resource Name (ARN) of the batch.
String status
The status of the batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
The simulation batch job timed out.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
Date createdAt
The time, in milliseconds since the epoch, when the simulation job batch was created.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
BatchPolicy batchPolicy
The batch policy.
String failureCode
The failure code of the simulation job batch.
String failureReason
The reason the simulation job batch failed.
List<E> failedRequests
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.
List<E> pendingRequests
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
List<E> createdRequests
A list of created simulation job summaries.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the simulation job batch.
String job
The Amazon Resource Name (ARN) of the simulation job to be described.
String arn
The Amazon Resource Name (ARN) of the simulation job.
String name
The name of the simulation job.
String status
The status of the simulation job.
Date lastStartedAt
The time, in milliseconds since the epoch, when the simulation job was last started.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation job was last updated.
String failureBehavior
The failure behavior for the simulation job.
String failureCode
The failure code of the simulation job if it failed:
Internal service error.
Robot application exited abnormally.
Simulation application exited abnormally.
Robot application bundle could not be downloaded.
Simulation application bundle could not be downloaded.
Unable to publish outputs to customer-provided S3 bucket.
Unable to publish logs to customer-provided CloudWatch Logs resource.
Subnet IP limit exceeded.
ENI limit exceeded.
Unable to use the Role provided.
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
Etag for RobotApplication does not match value during version creation.
Etag for SimulationApplication does not match value during version creation.
String failureReason
Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
OutputLocation outputLocation
Location for output files generated by the simulation job.
LoggingConfig loggingConfig
The logging configuration.
Long maxJobDurationInSeconds
The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
Long simulationTimeMillis
The simulation job execution duration in milliseconds.
String iamRole
The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
List<E> robotApplications
A list of robot applications.
List<E> simulationApplications
A list of simulation applications.
List<E> dataSources
The data sources for the simulation job.
Map<K,V> tags
The list of all tags added to the specified simulation job.
VPCConfigResponse vpcConfig
The VPC configuration.
NetworkInterface networkInterface
The network interface information for the simulation job.
ComputeResponse compute
Compute information for the simulation job.
SimulationJobRequest request
The simulation job request.
String failureReason
The failure reason of the simulation job request.
String failureCode
The failure code.
Date failedAt
The time, in milliseconds since the epoch, when the simulation job batch failed.
String name
The name of the fleet.
String arn
The Amazon Resource Name (ARN) of the fleet.
Date createdAt
The time, in milliseconds since the epoch, when the fleet was created.
String lastDeploymentStatus
The status of the last fleet deployment.
String lastDeploymentJob
The Amazon Resource Name (ARN) of the last deployment job.
Date lastDeploymentTime
The time of the last deployment.
String packageName
The package name.
String launchFile
The launch file name.
Map<K,V> environmentVariables
The environment variables for the application launch.
PortForwardingConfig portForwardingConfig
The port forwarding configuration.
Boolean streamUI
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 luanch the component. It must have a graphical user interface.
List<E> filters
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.
String nextToken
The nextToken value returned from a previous paginated ListDeploymentJobs request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
Integer maxResults
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.
List<E> deploymentJobs
A list of deployment jobs that meet the criteria of the request.
String nextToken
The nextToken value to include in a future ListDeploymentJobs request. When the results
of a ListDeploymentJobs request exceed maxResults, this value can be used to retrieve
the next page of results. This value is null when there are no more results to return.
String nextToken
The nextToken value returned from a previous paginated ListFleets request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
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.
Integer maxResults
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.
List<E> filters
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.
List<E> fleetDetails
A list of fleet details meeting the request criteria.
String nextToken
The nextToken value to include in a future ListDeploymentJobs request. When the results
of a ListFleets request exceed maxResults, this value can be used to retrieve the next
page of results. This value is null when there are no more results to return.
String versionQualifier
The version qualifier of the robot application.
String nextToken
The nextToken value returned from a previous paginated ListRobotApplications request
where maxResults was used and the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the nextToken value.
Integer maxResults
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.
List<E> filters
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.
List<E> robotApplicationSummaries
A list of robot application summaries that meet the criteria of the request.
String nextToken
The nextToken value to include in a future ListRobotApplications request. When the
results of a ListRobotApplications request exceed maxResults, this value can be used to
retrieve the next page of results. This value is null when there are no more results to return.
String nextToken
The nextToken value returned from a previous paginated ListRobots request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
Integer maxResults
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.
List<E> filters
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.
List<E> robots
A list of robots that meet the criteria of the request.
String nextToken
The nextToken value to include in a future ListRobots request. When the results of a
ListRobot request exceed maxResults, this value can be used to retrieve the next page
of results. This value is null when there are no more results to return.
String versionQualifier
The version qualifier of the simulation application.
String nextToken
The nextToken value returned from a previous paginated ListSimulationApplications
request where maxResults was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the nextToken value.
Integer maxResults
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.
List<E> filters
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.
List<E> simulationApplicationSummaries
A list of simulation application summaries that meet the criteria of the request.
String nextToken
The nextToken value to include in a future ListSimulationApplications request. When the
results of a ListRobot request exceed maxResults, this value can be used to retrieve
the next page of results. This value is null when there are no more results to return.
String nextToken
The nextToken value returned from a previous paginated ListSimulationJobBatches request
where maxResults was used and the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the nextToken value.
Integer maxResults
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.
List<E> filters
Optional filters to limit results.
List<E> simulationJobBatchSummaries
A list of simulation job batch summaries.
String nextToken
The nextToken value to include in a future ListSimulationJobBatches request. When the
results of a ListSimulationJobBatches request exceed maxResults, this value can be used
to retrieve the next page of results. This value is null when there are no more results to return.
String nextToken
The nextToken value returned from a previous paginated ListSimulationJobs request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
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.
Integer maxResults
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.
List<E> filters
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.
List<E> simulationJobSummaries
A list of simulation job summaries that meet the criteria of the request.
String nextToken
The nextToken value to include in a future ListSimulationJobs request. When the results
of a ListRobot request exceed maxResults, this value can be used to retrieve the next
page of results. This value is null when there are no more results to return.
String resourceArn
The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
Boolean recordAllRosTopics
A boolean indicating whether to record all ROS topics.
String currentProgress
The current progress status.
Validating the deployment.
Downloading and extracting the bundle on the robot.
Executing pre-launch script(s) if provided.
Launching the robot application.
Executing post-launch script(s) if provided.
Deployment is complete.
Float percentDone
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.
Integer estimatedTimeRemainingSeconds
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.
String targetResource
The Amazon Resource Name (ARN) of the deployment job.
String job
The Amazon Resource Name (ARN) of the simulation job.
String arn
The Amazon Resource Name (ARN) of the robot.
String name
The name of the robot.
String fleetArn
The Amazon Resource Name (ARN) of the fleet.
String status
The status of the robot.
String greenGrassGroupId
The Greengrass group associated with the robot.
Date createdAt
The time, in milliseconds since the epoch, when the robot was created.
String architecture
The architecture of the robot.
String lastDeploymentJob
The Amazon Resource Name (ARN) of the last deployment job.
Date lastDeploymentTime
The time of the last deployment.
String application
The application information for the robot application.
String applicationVersion
The version of the robot application.
LaunchConfig launchConfig
The launch configuration for the robot application.
String name
The name of the robot application.
String arn
The Amazon Resource Name (ARN) of the robot.
String version
The version of the robot application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the robot application was last updated.
RobotSoftwareSuite robotSoftwareSuite
Information about a robot software suite (ROS distribution).
String arn
The robot deployment Amazon Resource Name (ARN).
Date deploymentStartTime
The time, in milliseconds since the epoch, when the deployment was started.
Date deploymentFinishTime
The time, in milliseconds since the epoch, when the deployment finished.
String status
The status of the robot deployment.
ProgressDetail progressDetail
Information about how the deployment is progressing.
String failureReason
A short description of the reason why the robot deployment failed.
String failureCode
The robot deployment failure code.
String application
The application information for the simulation application.
String applicationVersion
The version of the simulation application.
LaunchConfig launchConfig
The launch configuration for the simulation application.
String name
The name of the simulation application.
String arn
The Amazon Resource Name (ARN) of the simulation application.
String version
The version of the simulation application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation application was last updated.
RobotSoftwareSuite robotSoftwareSuite
Information about a robot software suite (ROS distribution).
SimulationSoftwareSuite simulationSoftwareSuite
Information about a simulation software suite.
String arn
The Amazon Resource Name (ARN) of the simulation job.
String name
The name of the simulation job.
String status
Status of the simulation job.
Date lastStartedAt
The time, in milliseconds since the epoch, when the simulation job was last started.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation job was last updated.
String failureBehavior
The failure behavior the simulation job.
Restart the simulation job in the same host instance.
Stop the simulation job and terminate the instance.
String failureCode
The failure code of the simulation job if it failed.
String failureReason
The reason why the simulation job failed.
String clientRequestToken
A unique identifier for this SimulationJob request.
OutputLocation outputLocation
Location for output files generated by the simulation job.
LoggingConfig loggingConfig
The logging configuration.
Long maxJobDurationInSeconds
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
Long simulationTimeMillis
The simulation job execution duration in milliseconds.
String iamRole
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.
List<E> robotApplications
A list of robot applications.
List<E> simulationApplications
A list of simulation applications.
List<E> dataSources
The data sources for the simulation job.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the simulation job.
VPCConfigResponse vpcConfig
VPC configuration information.
NetworkInterface networkInterface
Information about a network interface.
ComputeResponse compute
Compute information for the simulation job
String arn
The Amazon Resource Name (ARN) of the batch.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
Date createdAt
The time, in milliseconds since the epoch, when the simulation job batch was created.
String status
The status of the simulation job batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
The simulation batch job timed out.
Integer failedRequestCount
The number of failed simulation job requests.
Integer pendingRequestCount
The number of pending simulation job requests.
Integer createdRequestCount
The number of created simulation job requests.
OutputLocation outputLocation
LoggingConfig loggingConfig
Long maxJobDurationInSeconds
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
String iamRole
The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
String failureBehavior
The failure behavior the simulation job.
Restart the simulation job in the same host instance.
Stop the simulation job and terminate the instance.
Boolean useDefaultApplications
Boolean indicating whether to use default simulation tool applications.
List<E> robotApplications
The robot applications to use in the simulation job.
List<E> simulationApplications
The simulation applications to use in the simulation job.
List<E> dataSources
Specify data sources to mount read-only files from S3 into your simulation. These files are available under
/opt/robomaker/datasources/data_source_name.
There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
VPCConfig vpcConfig
Compute compute
Compute information for the simulation job
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the simulation job request.
String arn
The Amazon Resource Name (ARN) of the simulation job.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation job was last updated.
String name
The name of the simulation job.
String status
The status of the simulation job.
List<E> simulationApplicationNames
A list of simulation job simulation application names.
List<E> robotApplicationNames
A list of simulation job robot application names.
List<E> dataSourceNames
The names of the data sources.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
BatchPolicy batchPolicy
The batch policy.
List<E> createSimulationJobRequests
A list of simulation job requests to create in the batch.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the deployment job batch.
String arn
The Amazon Resource Name (arn) of the batch.
String status
The status of the simulation job batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
The simulation batch job timed out.
Date createdAt
The time, in milliseconds since the epoch, when the simulation job batch was created.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
BatchPolicy batchPolicy
The batch policy.
String failureCode
The failure code if the simulation job batch failed.
String failureReason
The reason the simulation job batch failed.
List<E> failedRequests
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.
List<E> pendingRequests
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
List<E> createdRequests
A list of created simulation job request summaries.
Map<K,V> tags
A map that contains tag keys and tag values that are attached to the deployment job batch.
String arn
The Amazon Resource Name (ARN) of the synchronization request.
String fleet
The Amazon Resource Name (ARN) of the fleet.
String status
The status of the synchronization job.
DeploymentConfig deploymentConfig
Information about the deployment configuration.
List<E> deploymentApplicationConfigs
Information about the deployment application configurations.
String failureReason
The failure reason if the job fails.
String failureCode
The failure code if the job fails:
Internal service error.
Robot application exited abnormally.
Simulation application exited abnormally.
Robot application bundle could not be downloaded.
Simulation application bundle could not be downloaded.
Unable to publish outputs to customer-provided S3 bucket.
Unable to publish logs to customer-provided CloudWatch Logs resource.
Subnet IP limit exceeded.
ENI limit exceeded.
Unable to use the Role provided.
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
Etag for RobotApplication does not match value during version creation.
Etag for SimulationApplication does not match value during version creation.
Date createdAt
The time, in milliseconds since the epoch, when the fleet was created.
String application
The application information for the robot application.
List<E> sources
The sources of the robot application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribution) used by the robot application.
String currentRevisionId
The revision id for the robot application.
String arn
The Amazon Resource Name (ARN) of the updated robot application.
String name
The name of the robot application.
String version
The version of the robot application.
List<E> sources
The sources of the robot application.
RobotSoftwareSuite robotSoftwareSuite
The robot software suite (ROS distribution) used by the robot application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the robot application was last updated.
String revisionId
The revision id of the robot application.
String application
The application information for the simulation application.
List<E> sources
The sources of the simulation application.
SimulationSoftwareSuite simulationSoftwareSuite
The simulation software suite used by the simulation application.
RobotSoftwareSuite robotSoftwareSuite
Information about the robot software suite (ROS distribution).
RenderingEngine renderingEngine
The rendering engine for the simulation application.
String currentRevisionId
The revision id for the robot application.
String arn
The Amazon Resource Name (ARN) of the updated simulation application.
String name
The name of the simulation application.
String version
The version of the robot application.
List<E> sources
The sources of the simulation application.
SimulationSoftwareSuite simulationSoftwareSuite
The simulation software suite used by the simulation application.
RobotSoftwareSuite robotSoftwareSuite
Information about the robot software suite (ROS distribution).
RenderingEngine renderingEngine
The rendering engine for the simulation application.
Date lastUpdatedAt
The time, in milliseconds since the epoch, when the simulation application was last updated.
String revisionId
The revision id of the simulation application.
List<E> subnets
A list of subnet IDs associated with the simulation job.
List<E> securityGroups
A list of security group IDs associated with the simulation job.
String vpcId
The VPC ID associated with your simulation job.
Boolean assignPublicIp
A boolean indicating if a public IP was assigned.
Copyright © 2020. All rights reserved.