2018/11/26 - AWS RoboMaker - 32 new api methods
Changes (New Service) AWS RoboMaker is a service that makes it easy to develop, simulate, and deploy intelligent robotics applications at scale.
Registers a robot with a fleet.
See also: AWS API Documentation
Request Syntax
client.register_robot(
fleet='string',
robot='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the robot.
dict
Response Syntax
{
'fleet': 'string',
'robot': 'string'
}
Response Structure
(dict) --
fleet (string) --
The Amazon Resource Name (ARN) of the fleet that the robot will join.
robot (string) --
Information about the robot registration.
Deletes a simulation application.
See also: AWS API Documentation
Request Syntax
client.delete_simulation_application(
application='string',
applicationVersion='string'
)
string
[REQUIRED]
The application information for the simulation application to delete.
string
The version of the simulation application to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Cancels the specified simulation job.
See also: AWS API Documentation
Request Syntax
client.cancel_simulation_job(
job='string'
)
string
[REQUIRED]
The simulation job ARN to cancel.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
(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.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
integer
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',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'FailureThresholdBreached'|'RobotDeploymentNoResponse'|'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 application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration, usually roslaunch .
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the deployment launch file.
launchFile (string) --
The deployment launch file.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the deployment launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the deployment 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.
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.
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.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
integer
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 ListFleets 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 only valid filter name is name .
(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)
},
],
'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.
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.
Creates a version of a robot application.
See also: AWS API Documentation
Request Syntax
client.create_robot_application_version(
application='string',
currentRevisionId='string'
)
string
[REQUIRED]
The application information for the robot application.
string
The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.
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'
}
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.
Deregisters a robot.
See also: AWS API Documentation
Request Syntax
client.deregister_robot(
fleet='string',
robot='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the robot.
dict
Response Syntax
{
'fleet': 'string',
'robot': 'string'
}
Response Structure
(dict) --
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
robot (string) --
The Amazon Resource Name (ARN) of the robot.
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',
'version': 'string'
},
robotSoftwareSuite={
'name': 'ROS',
'version': 'Kinetic'
},
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
[REQUIRED]
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',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'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.
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)
}
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.
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',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'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.
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'
},
]
}
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 application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration, usually roslaunch .
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the deployment launch file.
launchFile (string) --
The deployment launch file.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the deployment launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the deployment 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.
Updates a robot application.
See also: AWS API Documentation
Request Syntax
client.update_robot_application(
application='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
robotSoftwareSuite={
'name': 'ROS',
'version': 'Kinetic'
},
currentRevisionId='string'
)
string
[REQUIRED]
The application information for 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.
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'
},
],
'robotSoftwareSuite': {
'name': 'ROS',
'version': 'Kinetic'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the updated 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.
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
See also: AWS API Documentation
Request Syntax
client.list_fleets(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
The nextToken value returned from a previous paginated ListFleets request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
integer
The maximum number of deployment job results returned by ListFleets in paginated output. When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListFleets returns up to 100 results and a nextToken value if applicable.
list
Optional filters to limit results.
(dict) --
Information about a filter.
name (string) --
The name of the filter.
values (list) --
A list of values.
(string) --
dict
Response Syntax
{
'fleetDetails': [
{
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fleetDetails (list) --
A list of fleet details meeting the request criteria.
(dict) --
Information about a fleet.
name (string) --
The name of the fleet.
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
lastDeploymentStatus (string) --
The status of the last fleet deployment.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
nextToken (string) --
The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListFleets request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
See also: AWS API Documentation
Request Syntax
client.list_robot_applications(
versionQualifier='string',
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
The version qualifier of the robot application.
string
The nextToken value returned from a previous paginated ListRobotApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
integer
The maximum number of deployment job results returned by ListRobotApplications in paginated output. When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.
list
Optional filters to limit results.
(dict) --
Information about a filter.
name (string) --
The name of the filter.
values (list) --
A list of values.
(string) --
dict
Response Syntax
{
'robotApplicationSummaries': [
{
'name': 'string',
'arn': 'string',
'version': 'string',
'lastUpdatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
robotApplicationSummaries (list) --
A list of robot application summaries that meet the criteria of the request.
(dict) --
Summary information for a robot application.
name (string) --
The name of the robot application.
arn (string) --
The Amazon Resource Name (ARN) of the robot.
version (string) --
The version of the robot application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
nextToken (string) --
The nextToken value to include in a future ListRobotApplications request. When the results of a ListRobotApplications request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
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'
}
)
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
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'
}
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.
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)
}
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.
Deletes a fleet.
See also: AWS API Documentation
Request Syntax
client.delete_fleet(
fleet='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
integer
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 ListFleets 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.
(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',
]
},
],
'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) --
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.
Creates a deployment job.
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'
}
}
},
]
)
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 application.
applicationVersion (string) -- [REQUIRED]
The version of the application.
launchConfig (dict) -- [REQUIRED]
The launch configuration, usually roslaunch .
packageName (string) -- [REQUIRED]
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the deployment launch file.
launchFile (string) -- [REQUIRED]
The deployment launch file.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the deployment launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the deployment application.
(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
}
}
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 application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration, usually roslaunch .
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the deployment launch file.
launchFile (string) --
The deployment launch file.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the deployment launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the deployment application.
(string) --
(string) --
failureReason (string) --
The failure reason of the deployment job if it failed.
failureCode (string) --
The failure code of the deployment job if it failed.
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.
Restarts a running simulation job.
See also: AWS API Documentation
Request Syntax
client.restart_simulation_job(
job='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the simulation job.
dict
Response Syntax
{}
Response Structure
(dict) --
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',
'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'
}
}
},
],
'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.
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.
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.
environmentVariables (dict) --
The environment variables for the application launch.
(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) --
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'
}
}
},
],
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 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.
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.
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.
environmentVariables (dict) --
The environment variables for the application launch.
(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',
'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'
}
}
},
],
'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.
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.
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.
environmentVariables (dict) --
The environment variables for the application launch.
(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.
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'
)
string
[REQUIRED]
The name of the fleet.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1)
}
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.
Creates a robot.
See also: AWS API Documentation
Request Syntax
client.create_robot(
name='string',
architecture='X86_64'|'ARM64'|'ARMHF',
greengrassGroupId='string'
)
string
[REQUIRED]
The name for the robot.
string
[REQUIRED]
The target architecture of the robot.
string
[REQUIRED]
The Greengrass group id.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
}
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.
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)
}
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.
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',
'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)
}
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.
deploymentApplicationConfigs (list) --
Information about the deployment application configurations.
(dict) --
Information about a deployment application configuration.
application (string) --
The application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration, usually roslaunch .
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the deployment launch file.
launchFile (string) --
The deployment launch file.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the deployment launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the deployment application.
(string) --
(string) --
failureReason (string) --
The failure reason if the job fails.
failureCode (string) --
The failure code if the job fails.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
See also: AWS API Documentation
Request Syntax
client.list_robots(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
string
The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
integer
The maximum number of deployment job results returned by ListRobots in paginated output. When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable.
list
Optional filters to limit results.
(dict) --
Information about a filter.
name (string) --
The name of the filter.
values (list) --
A list of values.
(string) --
dict
Response Syntax
{
'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)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
robots (list) --
A list of robots that meet the criteria of the request.
(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.
nextToken (string) --
The nextToken value to include in a future ListRobots request. When the results of a ListRobot request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
Deletes a robot.
See also: AWS API Documentation
Request Syntax
client.delete_robot(
robot='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the robot.
dict
Response Syntax
{}
Response Structure
(dict) --
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',
'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'
}
}
},
],
'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 (segfault, etc.)
SimulationApplicationCrash
Simulation application exited abnormally (segfault, etc.)
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, etc.)
InvalidBundleSimulationApplication
Simulation bundle cannot be extracted (invalid format, bundling error, etc.)
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) --
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.
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.
environmentVariables (dict) --
The environment variables for the application launch.
(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.
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'
}
)
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
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'
}
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.
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)
}
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.
Deletes a robot application.
See also: AWS API Documentation
Request Syntax
client.delete_robot_application(
application='string',
applicationVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the the robot application.
string
The version of the robot application to delete.
dict
Response Syntax
{}
Response Structure
(dict) --