2019/08/16 - AWS RoboMaker - 13 updated api methods
Changes Update robomaker client to latest version
{'jobs': {'dataSources': [{'name': 'string',
's3Bucket': 'string',
's3Keys': [{'etag': 'string', 's3Key': 'string'}]}],
'failureCode': {'BadPermissionsS3Object',
'InvalidInput',
'InvalidS3Resource',
'MismatchedEtag',
'ResourceNotFound',
'WrongRegionS3Bucket'},
'loggingConfig': {'recordAllRosTopics': 'boolean'}}}
Describes one or more simulation jobs.
See also: AWS API Documentation
Request Syntax
client.batch_describe_simulation_job(
jobs=[
'string',
]
)
list
[REQUIRED]
A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
(string) --
dict
Response Syntax
{
'jobs': [
{
'arn': 'string',
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'lastStartedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failureReason': 'string',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'simulationTimeMillis': 123,
'iamRole': 'string',
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
{
's3Key': 'string',
'etag': 'string'
},
]
},
],
'tags': {
'string': 'string'
},
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'vpcId': 'string',
'assignPublicIp': True|False
}
},
],
'unprocessedJobs': [
'string',
]
}
Response Structure
(dict) --
jobs (list) --
A list of simulation jobs.
(dict) --
Information about a simulation job.
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
name (string) --
The name of the simulation job.
status (string) --
Status of the simulation job.
lastStartedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last updated.
failureBehavior (string) --
The failure behavior the simulation job.
Continue
Restart the simulation job in the same host instance.
Fail
Stop the simulation job and terminate the instance.
failureCode (string) --
The failure code of the simulation job if it failed.
failureReason (string) --
The reason why the simulation job failed.
clientRequestToken (string) --
A unique identifier for this SimulationJob request.
outputLocation (dict) --
Location for output files generated by the simulation job.
s3Bucket (string) --
The S3 bucket for output.
s3Prefix (string) --
The S3 folder in the s3Bucket where output files will be placed.
loggingConfig (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulationTimeMillis (integer) --
The simulation job execution duration in milliseconds.
iamRole (string) --
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.
robotApplications (list) --
A list of robot applications.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
simulationApplications (list) --
A list of simulation applications.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
dataSources (list) --
The data sources for the simulation job.
(dict) --
Information about a data source.
name (string) --
The name of the data source.
s3Bucket (string) --
The S3 bucket where the data files are located.
s3Keys (list) --
The list of S3 keys identifying the data source files.
(dict) --
Information about S3 keys.
s3Key (string) --
The S3 key.
etag (string) --
The etag for the object.
tags (dict) --
A map that contains tag keys and tag values that are attached to the simulation job.
(string) --
(string) --
vpcConfig (dict) --
VPC configuration information.
subnets (list) --
A list of subnet IDs associated with the simulation job.
(string) --
securityGroups (list) --
A list of security group IDs associated with the simulation job.
(string) --
vpcId (string) --
The VPC ID associated with your simulation job.
assignPublicIp (boolean) --
A boolean indicating if a public IP was assigned.
unprocessedJobs (list) --
A list of unprocessed simulation job Amazon Resource Names (ARNs).
(string) --
{'deploymentConfig': {'robotDeploymentTimeoutInSeconds': 'long'}}
Deploys a specific version of a robot application to robots in a fleet.
The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.
See also: AWS API Documentation
Request Syntax
client.create_deployment_job(
deploymentConfig={
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123
},
clientRequestToken='string',
fleet='string',
deploymentApplicationConfigs=[
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
tags={
'string': 'string'
}
)
dict
The requested deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
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.
string
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet to deploy.
list
[REQUIRED]
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) -- [REQUIRED]
The version of the application.
launchConfig (dict) -- [REQUIRED]
The launch configuration.
packageName (string) -- [REQUIRED]
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) -- [REQUIRED]
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
(string) --
(string) --
dict
A map that contains tag keys and tag values that are attached to the deployment job.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
'createdAt': datetime(2015, 1, 1),
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the deployment job.
fleet (string) --
The target fleet for the deployment job.
status (string) --
The status of the deployment job.
deploymentApplicationConfigs (list) --
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
(string) --
(string) --
failureReason (string) --
The failure reason of the deployment job if it failed.
failureCode (string) --
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.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
deploymentConfig (dict) --
The deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
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.
tags (dict) --
The list of all tags added to the deployment job.
(string) --
(string) --
{'simulationSoftwareSuite': {'name': {'RosbagPlay'}}}
Creates a simulation application.
See also: AWS API Documentation
Request Syntax
client.create_simulation_application(
name='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
simulationSoftwareSuite={
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
robotSoftwareSuite={
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
renderingEngine={
'name': 'OGRE',
'version': 'string'
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the simulation application.
list
[REQUIRED]
The sources of the simulation application.
(dict) --
Information about a source configuration.
s3Bucket (string) --
The Amazon S3 bucket name.
s3Key (string) --
The s3 object key.
architecture (string) --
The target processor architecture for the application.
dict
[REQUIRED]
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
dict
[REQUIRED]
The robot software suite of the simulation application.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
dict
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
dict
A map that contains tag keys and tag values that are attached to the simulation application.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the simulation application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key.
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
revisionId (string) --
The revision id of the simulation application.
tags (dict) --
The list of all tags added to the simulation application.
(string) --
(string) --
{'simulationSoftwareSuite': {'name': {'RosbagPlay'}}}
Creates a simulation application with a specific revision id.
See also: AWS API Documentation
Request Syntax
client.create_simulation_application_version(
application='string',
currentRevisionId='string'
)
string
[REQUIRED]
The application information for the simulation application.
string
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.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the simulation application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key.
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
revisionId (string) --
The revision ID of the simulation application.
{'dataSources': [{'name': 'string',
's3Bucket': 'string',
's3Keys': ['string']}],
'loggingConfig': {'recordAllRosTopics': 'boolean'}}
Response {'dataSources': [{'name': 'string',
's3Bucket': 'string',
's3Keys': [{'etag': 'string', 's3Key': 'string'}]}],
'failureCode': {'BadPermissionsS3Object',
'InvalidInput',
'InvalidS3Resource',
'MismatchedEtag',
'ResourceNotFound',
'WrongRegionS3Bucket'},
'loggingConfig': {'recordAllRosTopics': 'boolean'}}
Creates a simulation job.
See also: AWS API Documentation
Request Syntax
client.create_simulation_job(
clientRequestToken='string',
outputLocation={
's3Bucket': 'string',
's3Prefix': 'string'
},
loggingConfig={
'recordAllRosTopics': True|False
},
maxJobDurationInSeconds=123,
iamRole='string',
failureBehavior='Fail'|'Continue',
robotApplications=[
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
simulationApplications=[
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
dataSources=[
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
tags={
'string': 'string'
},
vpcConfig={
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Location for output files generated by the simulation job.
s3Bucket (string) --
The S3 bucket for output.
s3Prefix (string) --
The S3 folder in the s3Bucket where output files will be placed.
dict
The logging configuration.
recordAllRosTopics (boolean) -- [REQUIRED]
A boolean indicating whether to record all ROS topics.
integer
[REQUIRED]
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
[REQUIRED]
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
The failure behavior the simulation job.
Continue
Restart the simulation job in the same host instance.
Fail
Stop the simulation job and terminate the instance.
list
The robot application to use in the simulation job.
(dict) --
Application configuration information for a robot.
application (string) -- [REQUIRED]
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) -- [REQUIRED]
The launch configuration for the robot application.
packageName (string) -- [REQUIRED]
The package name.
launchFile (string) -- [REQUIRED]
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
list
The simulation application to use in the simulation job.
(dict) --
Information about a simulation application configuration.
application (string) -- [REQUIRED]
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) -- [REQUIRED]
The launch configuration for the simulation application.
packageName (string) -- [REQUIRED]
The package name.
launchFile (string) -- [REQUIRED]
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
list
The data sources for the simulation job.
(dict) --
Information about a data source.
name (string) -- [REQUIRED]
The name of the data source.
s3Bucket (string) -- [REQUIRED]
The S3 bucket where the data files are located.
s3Keys (list) -- [REQUIRED]
The list of S3 keys identifying the data source files.
(string) --
dict
A map that contains tag keys and tag values that are attached to the simulation job.
(string) --
(string) --
dict
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.
subnets (list) -- [REQUIRED]
A list of one or more subnet IDs in your VPC.
(string) --
securityGroups (list) --
A list of one or more security groups IDs in your VPC.
(string) --
assignPublicIp (boolean) --
A boolean indicating whether to assign a public IP address.
dict
Response Syntax
{
'arn': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'lastStartedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'simulationTimeMillis': 123,
'iamRole': 'string',
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
{
's3Key': 'string',
'etag': 'string'
},
]
},
],
'tags': {
'string': 'string'
},
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'vpcId': 'string',
'assignPublicIp': True|False
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
status (string) --
The status of the simulation job.
lastStartedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last updated.
failureBehavior (string) --
the failure behavior for the simulation job.
failureCode (string) --
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.
WrongRegionS3Output
S3 output bucket is in a different region than AWS RoboMaker.
WrongRegionRobotApplication
RobotApplication bucket is in a different region than AWS RoboMaker.
WrongRegionSimulationApplication
SimulationApplication bucket is in a different region than AWS RoboMaker.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
outputLocation (dict) --
Simulation job output files location.
s3Bucket (string) --
The S3 bucket for output.
s3Prefix (string) --
The S3 folder in the s3Bucket where output files will be placed.
loggingConfig (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
The maximum simulation job duration in seconds.
simulationTimeMillis (integer) --
The simulation job execution duration in milliseconds.
iamRole (string) --
The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
robotApplications (list) --
The robot application used by the simulation job.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
simulationApplications (list) --
The simulation application used by the simulation job.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
dataSources (list) --
The data sources for the simulation job.
(dict) --
Information about a data source.
name (string) --
The name of the data source.
s3Bucket (string) --
The S3 bucket where the data files are located.
s3Keys (list) --
The list of S3 keys identifying the data source files.
(dict) --
Information about S3 keys.
s3Key (string) --
The S3 key.
etag (string) --
The etag for the object.
tags (dict) --
The list of all tags added to the simulation job.
(string) --
(string) --
vpcConfig (dict) --
Information about the vpc configuration.
subnets (list) --
A list of subnet IDs associated with the simulation job.
(string) --
securityGroups (list) --
A list of security group IDs associated with the simulation job.
(string) --
vpcId (string) --
The VPC ID associated with your simulation job.
assignPublicIp (boolean) --
A boolean indicating if a public IP was assigned.
{'deploymentConfig': {'robotDeploymentTimeoutInSeconds': 'long'}}
Describes a deployment job.
See also: AWS API Documentation
Request Syntax
client.describe_deployment_job(
job='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the deployment job.
dict
Response Syntax
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123
},
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
'createdAt': datetime(2015, 1, 1),
'robotDeploymentSummary': [
{
'arn': 'string',
'deploymentStartTime': datetime(2015, 1, 1),
'deploymentFinishTime': datetime(2015, 1, 1),
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'progressDetail': {
'currentProgress': 'Validating'|'DownloadingExtracting'|'ExecutingPreLaunch'|'Launching'|'ExecutingPostLaunch'|'Finished',
'percentDone': ...,
'estimatedTimeRemainingSeconds': 123,
'targetResource': 'string'
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError'
},
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the deployment job.
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the deployment job.
deploymentConfig (dict) --
The deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
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.
deploymentApplicationConfigs (list) --
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
(string) --
(string) --
failureReason (string) --
A short description of the reason why the deployment job failed.
failureCode (string) --
The deployment job failure code.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the deployment job was created.
robotDeploymentSummary (list) --
A list of robot deployment summaries.
(dict) --
Information about a robot deployment.
arn (string) --
The robot deployment Amazon Resource Name (ARN).
deploymentStartTime (datetime) --
The time, in milliseconds since the epoch, when the deployment was started.
deploymentFinishTime (datetime) --
The time, in milliseconds since the epoch, when the deployment finished.
status (string) --
The status of the robot deployment.
progressDetail (dict) --
Information about how the deployment is progressing.
currentProgress (string) --
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.
percentDone (float) --
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.
estimatedTimeRemainingSeconds (integer) --
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.
targetResource (string) --
The Amazon Resource Name (ARN) of the deployment job.
failureReason (string) --
A short description of the reason why the robot deployment failed.
failureCode (string) --
The robot deployment failure code.
tags (dict) --
The list of all tags added to the specified deployment job.
(string) --
(string) --
{'simulationSoftwareSuite': {'name': {'RosbagPlay'}}}
Describes a simulation application.
See also: AWS API Documentation
Request Syntax
client.describe_simulation_application(
application='string',
applicationVersion='string'
)
string
[REQUIRED]
The application information for the simulation application.
string
The version of the simulation application to describe.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'revisionId': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the simulation application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key.
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
revisionId (string) --
The revision id of the simulation application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
tags (dict) --
The list of all tags added to the specified simulation application.
(string) --
(string) --
{'dataSources': [{'name': 'string',
's3Bucket': 'string',
's3Keys': [{'etag': 'string', 's3Key': 'string'}]}],
'failureCode': {'BadPermissionsS3Object',
'InvalidInput',
'InvalidS3Resource',
'MismatchedEtag',
'ResourceNotFound',
'WrongRegionS3Bucket'},
'loggingConfig': {'recordAllRosTopics': 'boolean'}}
Describes a simulation job.
See also: AWS API Documentation
Request Syntax
client.describe_simulation_job(
job='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the simulation job to be described.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'lastStartedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failureReason': 'string',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'simulationTimeMillis': 123,
'iamRole': 'string',
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
{
's3Key': 'string',
'etag': 'string'
},
]
},
],
'tags': {
'string': 'string'
},
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'vpcId': 'string',
'assignPublicIp': True|False
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
name (string) --
The name of the simulation job.
status (string) --
The status of the simulation job.
lastStartedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last updated.
failureBehavior (string) --
The failure behavior for the simulation job.
failureCode (string) --
The failure code of the simulation job if it failed:
InternalServiceError
Internal service error.
RobotApplicationCrash
Robot application exited abnormally.
SimulationApplicationCrash
Simulation application exited abnormally.
BadPermissionsRobotApplication
Robot application bundle could not be downloaded.
BadPermissionsSimulationApplication
Simulation application bundle could not be downloaded.
BadPermissionsS3Output
Unable to publish outputs to customer-provided S3 bucket.
BadPermissionsCloudwatchLogs
Unable to publish logs to customer-provided CloudWatch Logs resource.
SubnetIpLimitExceeded
Subnet IP limit exceeded.
ENILimitExceeded
ENI limit exceeded.
BadPermissionsUserCredentials
Unable to use the Role provided.
InvalidBundleRobotApplication
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
InvalidBundleSimulationApplication
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
RobotApplicationVersionMismatchedEtag
Etag for RobotApplication does not match value during version creation.
SimulationApplicationVersionMismatchedEtag
Etag for SimulationApplication does not match value during version creation.
failureReason (string) --
Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
outputLocation (dict) --
Location for output files generated by the simulation job.
s3Bucket (string) --
The S3 bucket for output.
s3Prefix (string) --
The S3 folder in the s3Bucket where output files will be placed.
loggingConfig (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulationTimeMillis (integer) --
The simulation job execution duration in milliseconds.
iamRole (string) --
The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
robotApplications (list) --
A list of robot applications.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
simulationApplications (list) --
A list of simulation applications.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
dataSources (list) --
The data sources for the simulation job.
(dict) --
Information about a data source.
name (string) --
The name of the data source.
s3Bucket (string) --
The S3 bucket where the data files are located.
s3Keys (list) --
The list of S3 keys identifying the data source files.
(dict) --
Information about S3 keys.
s3Key (string) --
The S3 key.
etag (string) --
The etag for the object.
tags (dict) --
The list of all tags added to the specified simulation job.
(string) --
(string) --
vpcConfig (dict) --
The VPC configuration.
subnets (list) --
A list of subnet IDs associated with the simulation job.
(string) --
securityGroups (list) --
A list of security group IDs associated with the simulation job.
(string) --
vpcId (string) --
The VPC ID associated with your simulation job.
assignPublicIp (boolean) --
A boolean indicating if a public IP was assigned.
{'deploymentJobs': {'deploymentConfig': {'robotDeploymentTimeoutInSeconds': 'long'}}}
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
See also: AWS API Documentation
Request Syntax
client.list_deployment_jobs(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
list
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.
(dict) --
Information about a filter.
name (string) --
The name of the filter.
values (list) --
A list of values.
(string) --
string
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
The maximum number of deployment job results returned by ListDeploymentJobs in paginated output. 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 100. If this parameter is not used, then ListDeploymentJobs returns up to 100 results and a nextToken value if applicable.
dict
Response Syntax
{
'deploymentJobs': [
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deploymentJobs (list) --
A list of deployment jobs that meet the criteria of the request.
(dict) --
Information about a deployment job.
arn (string) --
The Amazon Resource Name (ARN) of the deployment job.
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the deployment job.
deploymentApplicationConfigs (list) --
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
(string) --
(string) --
deploymentConfig (dict) --
The deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
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.
failureReason (string) --
A short description of the reason why the deployment job failed.
failureCode (string) --
The deployment job failure code.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the deployment job was created.
nextToken (string) --
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.
{'simulationApplicationSummaries': {'simulationSoftwareSuite': {'name': {'RosbagPlay'}}}}
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
See also: AWS API Documentation
Request Syntax
client.list_simulation_applications(
versionQualifier='string',
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
The version qualifier of the simulation application.
string
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
The maximum number of deployment job results returned by ListSimulationApplications in paginated output. 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
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.
(dict) --
Information about a filter.
name (string) --
The name of the filter.
values (list) --
A list of values.
(string) --
dict
Response Syntax
{
'simulationApplicationSummaries': [
{
'name': 'string',
'arn': 'string',
'version': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
simulationApplicationSummaries (list) --
A list of simulation application summaries that meet the criteria of the request.
(dict) --
Summary information for a simulation application.
name (string) --
The name of the simulation application.
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
version (string) --
The version of the simulation application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
robotSoftwareSuite (dict) --
Information about a robot software suite.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
simulationSoftwareSuite (dict) --
Information about a simulation software suite.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
nextToken (string) --
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.
{'simulationJobSummaries': {'dataSourceNames': ['string']}}
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
See also: AWS API Documentation
Request Syntax
client.list_simulation_jobs(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
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.
integer
The maximum number of deployment job results returned by ListSimulationJobs in paginated output. 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 100. If this parameter is not used, then ListSimulationJobs returns up to 100 results and a nextToken value if applicable.
list
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.
(dict) --
Information about a filter.
name (string) --
The name of the filter.
values (list) --
A list of values.
(string) --
dict
Response Syntax
{
'simulationJobSummaries': [
{
'arn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'simulationApplicationNames': [
'string',
],
'robotApplicationNames': [
'string',
],
'dataSourceNames': [
'string',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
simulationJobSummaries (list) --
A list of simulation job summaries that meet the criteria of the request.
(dict) --
Summary information for a simulation job.
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last updated.
name (string) --
The name of the simulation job.
status (string) --
The status of the simulation job.
simulationApplicationNames (list) --
A list of simulation job simulation application names.
(string) --
robotApplicationNames (list) --
A list of simulation job robot application names.
(string) --
dataSourceNames (list) --
The names of the data sources.
(string) --
nextToken (string) --
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.
{'deploymentConfig': {'robotDeploymentTimeoutInSeconds': 'long'}}
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
See also: AWS API Documentation
Request Syntax
client.sync_deployment_job(
clientRequestToken='string',
fleet='string'
)
string
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The target fleet for the synchronization.
dict
Response Syntax
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123
},
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the synchronization request.
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the synchronization job.
deploymentConfig (dict) --
Information about the deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
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.
deploymentApplicationConfigs (list) --
Information about the deployment application configurations.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
(string) --
(string) --
failureReason (string) --
The failure reason if the job fails.
failureCode (string) --
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.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
{'simulationSoftwareSuite': {'name': {'RosbagPlay'}}}
Updates a simulation application.
See also: AWS API Documentation
Request Syntax
client.update_simulation_application(
application='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
simulationSoftwareSuite={
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
robotSoftwareSuite={
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
renderingEngine={
'name': 'OGRE',
'version': 'string'
},
currentRevisionId='string'
)
string
[REQUIRED]
The application information for the simulation application.
list
[REQUIRED]
The sources of the simulation application.
(dict) --
Information about a source configuration.
s3Bucket (string) --
The Amazon S3 bucket name.
s3Key (string) --
The s3 object key.
architecture (string) --
The target processor architecture for the application.
dict
[REQUIRED]
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
dict
[REQUIRED]
Information about the robot software suite.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
dict
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
string
The revision id for the robot application.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'|'Melodic'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the updated simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key.
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
revisionId (string) --
The revision id of the simulation application.