2019/02/07 - AWS RoboMaker - 3 new 13 updated api methods
Changes Added support for tagging and tag-based access control for AWS RoboMaker resources. Also, DescribeSimulationJob now includes a new failureReason field to help debug simulation job failures
Lists all tags on a AWS RoboMaker resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The list of all tags added to the specified resource.
(string) --
(string) --
Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
dict
[REQUIRED]
A map that contains tag keys and tag values that are attached to the resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
list
[REQUIRED]
A map that contains tag keys and tag values that will be unattached from the resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'jobs': {'failureCode': {'WrongRegionRobotApplication',
'WrongRegionS3Output',
'WrongRegionSimulationApplication'},
'failureReason': 'string',
'tags': {'string': 'string'}}}
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',
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failureReason': 'string',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'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'
}
}
},
],
'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.
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.
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. See how to specify AWS security credentials for your application.
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) --
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) --
{'tags': {'string': 'string'}}
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
},
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.
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',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'FailureThresholdBreached'|'RobotDeploymentNoResponse'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
'createdAt': datetime(2015, 1, 1),
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 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 AWSGreengrassResourceAccessRolePolicymanaged 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.
tags (dict) --
The list of all tags added to the deployment job.
(string) --
(string) --
{'tags': {'string': 'string'}}
Creates a fleet, a logical group of robots running the same robot application.
See also: AWS API Documentation
Request Syntax
client.create_fleet(
name='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the fleet.
dict
A map that contains tag keys and tag values that are attached to the fleet.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
name (string) --
The name of the fleet.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
tags (dict) --
The list of all tags added to the fleet.
(string) --
(string) --
{'tags': {'string': 'string'}}
Creates a robot.
See also: AWS API Documentation
Request Syntax
client.create_robot(
name='string',
architecture='X86_64'|'ARM64'|'ARMHF',
greengrassGroupId='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name for the robot.
string
[REQUIRED]
The target architecture of the robot.
string
[REQUIRED]
The Greengrass group id.
dict
A map that contains tag keys and tag values that are attached to the robot.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot.
name (string) --
The name of the robot.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the robot was created.
greengrassGroupId (string) --
The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
architecture (string) --
The target architecture of the robot.
tags (dict) --
The list of all tags added to the robot.
(string) --
(string) --
{'tags': {'string': 'string'}}
Creates a robot application.
See also: AWS API Documentation
Request Syntax
client.create_robot_application(
name='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
robotSoftwareSuite={
'name': 'ROS',
'version': 'Kinetic'
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the robot application.
list
[REQUIRED]
The sources of the robot 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 robot software suite used by the robot application.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
dict
A map that contains tag keys and tag values that are attached to the robot application.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot application.
name (string) --
The name of the robot application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the robot 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.
robotSoftwareSuite (dict) --
The robot software suite used by the robot application.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
revisionId (string) --
The revision id of the robot application.
tags (dict) --
The list of all tags added to the robot application.
(string) --
(string) --
{'tags': {'string': 'string'}}
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',
'version': 'string'
},
robotSoftwareSuite={
'name': 'ROS',
'version': 'Kinetic'
},
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
[REQUIRED]
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',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'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) --
{'tags': {'string': 'string'}}
Response {'failureCode': {'WrongRegionRobotApplication',
'WrongRegionS3Output',
'WrongRegionSimulationApplication'},
'tags': {'string': 'string'}}
Creates a simulation job.
See also: AWS API Documentation
Request Syntax
client.create_simulation_job(
clientRequestToken='string',
outputLocation={
's3Bucket': 'string',
's3Prefix': 'string'
},
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'
}
}
},
],
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.
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) --
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',
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'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'
}
}
},
],
'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.
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.
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.
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 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) --
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.
{'tags': {'string': 'string'}}
Describes a deployment job. [Does it work regardless of deployment status, e.g. Failed?]
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',
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123
},
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'FailureThresholdBreached'|'RobotDeploymentNoResponse'|'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': 'string',
'targetResource': 'string'
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'FailureThresholdBreached'|'RobotDeploymentNoResponse'|'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.
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.
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) --
{'tags': {'string': 'string'}}
Describes a fleet.
See also: AWS API Documentation
Request Syntax
client.describe_fleet(
fleet='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
dict
Response Syntax
{
'name': 'string',
'arn': 'string',
'robots': [
{
'arn': 'string',
'name': 'string',
'fleetArn': 'string',
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'greenGrassGroupId': 'string',
'createdAt': datetime(2015, 1, 1),
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'createdAt': datetime(2015, 1, 1),
'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
name (string) --
The name of the fleet.
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
robots (list) --
A list of robots.
(dict) --
Information about a robot.
arn (string) --
The Amazon Resource Name (ARN) of the robot.
name (string) --
The name of the robot.
fleetArn (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the robot.
greenGrassGroupId (string) --
The Greengrass group associated with the robot.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the robot was created.
architecture (string) --
The architecture of the robot.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
lastDeploymentStatus (string) --
The status of the last deployment.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
tags (dict) --
The list of all tags added to the specified fleet.
(string) --
(string) --
{'tags': {'string': 'string'}}
Describes a robot.
See also: AWS API Documentation
Request Syntax
client.describe_robot(
robot='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the robot to be described.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'fleetArn': 'string',
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'greengrassGroupId': 'string',
'createdAt': datetime(2015, 1, 1),
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot.
name (string) --
The name of the robot.
fleetArn (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the fleet.
greengrassGroupId (string) --
The Greengrass group id.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the robot was created.
architecture (string) --
The target architecture of the robot application.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment job.
tags (dict) --
The list of all tags added to the specified robot.
(string) --
(string) --
{'tags': {'string': 'string'}}
Describes a robot application.
See also: AWS API Documentation
Request Syntax
client.describe_robot_application(
application='string',
applicationVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the robot application.
string
The version of the robot application to describe.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'revisionId': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot application.
name (string) --
The name of the robot application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the robot 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.
robotSoftwareSuite (dict) --
The robot software suite used by the robot application.
name (string) --
The name of the robot software suite.
version (string) --
The version of the robot software suite.
revisionId (string) --
The revision id of the robot application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
tags (dict) --
The list of all tags added to the specified robot application.
(string) --
(string) --
{'tags': {'string': 'string'}}
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',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'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) --
{'failureCode': {'WrongRegionRobotApplication',
'WrongRegionS3Output',
'WrongRegionSimulationApplication'},
'failureReason': 'string',
'tags': {'string': 'string'}}
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',
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failureReason': 'string',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'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'
}
}
},
],
'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.
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.
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) --
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.