RoboMaker

Table of Contents

Client

class RoboMaker.Client

A low-level client representing AWS RoboMaker:

import boto3

client = boto3.client('robomaker')

These are the available methods:

batch_describe_simulation_job(**kwargs)

Describes one or more simulation jobs.

See also: AWS API Documentation

Request Syntax

response = client.batch_describe_simulation_job(
    jobs=[
        'string',
    ]
)
Parameters
jobs (list) --

[REQUIRED]

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

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'jobs': [
        {
            'arn': 'string',
            'name': 'string',
            'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
            'lastStartedAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'failureBehavior': 'Fail'|'Continue',
            'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'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.

        • lastStartedAt (datetime) --

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

        • lastUpdatedAt (datetime) --

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

        • failureBehavior (string) --

          The failure behavior the simulation job.

          Continue

          Restart the simulation job in the same host instance.

          Fail

          Stop the simulation job and terminate the instance.

        • failureCode (string) --

          The failure code of the simulation job if it failed.

        • failureReason (string) --

          The reason why the simulation job failed.

        • clientRequestToken (string) --

          A unique identifier for this SimulationJob request.

        • outputLocation (dict) --

          Location for output files generated by the simulation job.

          • s3Bucket (string) --

            The S3 bucket for output.

          • s3Prefix (string) --

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

        • maxJobDurationInSeconds (integer) --

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

        • simulationTimeMillis (integer) --

          The simulation job execution duration in milliseconds.

        • iamRole (string) --

          The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

        • robotApplications (list) --

          A list of robot applications.

          • (dict) --

            Application configuration information for a robot.

            • application (string) --

              The application information for the robot application.

            • applicationVersion (string) --

              The version of the robot application.

            • launchConfig (dict) --

              The launch configuration for the robot application.

              • packageName (string) --

                The package name.

              • launchFile (string) --

                The launch file name.

              • environmentVariables (dict) --

                The environment variables for the application launch.

                • (string) --
                  • (string) --
        • simulationApplications (list) --

          A list of simulation applications.

          • (dict) --

            Information about a simulation application configuration.

            • application (string) --

              The application information for the simulation application.

            • applicationVersion (string) --

              The version of the simulation application.

            • launchConfig (dict) --

              The launch configuration for the simulation application.

              • packageName (string) --

                The package name.

              • launchFile (string) --

                The launch file name.

              • environmentVariables (dict) --

                The environment variables for the application launch.

                • (string) --
                  • (string) --
        • 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) --
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_deployment_job(**kwargs)

Cancels the specified deployment job.

See also: AWS API Documentation

Request Syntax

response = client.cancel_deployment_job(
    job='string'
)
Parameters
job (string) --

[REQUIRED]

The deployment job ARN to cancel.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
cancel_simulation_job(**kwargs)

Cancels the specified simulation job.

See also: AWS API Documentation

Request Syntax

response = client.cancel_simulation_job(
    job='string'
)
Parameters
job (string) --

[REQUIRED]

The simulation job ARN to cancel.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
create_deployment_job(**kwargs)

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 .

Note

After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters
  • deploymentConfig (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.

  • clientRequestToken (string) --

    [REQUIRED]

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

    This field is autopopulated if not provided.

  • fleet (string) --

    [REQUIRED]

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

  • deploymentApplicationConfigs (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) --
  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'fleet': 'string',
    'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
    'deploymentApplicationConfigs': [
        {
            'application': 'string',
            'applicationVersion': 'string',
            'launchConfig': {
                'packageName': 'string',
                'preLaunchFile': 'string',
                'launchFile': 'string',
                'postLaunchFile': 'string',
                'environmentVariables': {
                    'string': 'string'
                }
            }
        },
    ],
    'failureReason': 'string',
    'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
    'createdAt': datetime(2015, 1, 1),
    'deploymentConfig': {
        'concurrentDeploymentPercentage': 123,
        'failureThresholdPercentage': 123
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

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

    • fleet (string) --

      The target fleet for the deployment job.

    • status (string) --

      The status of the deployment job.

    • deploymentApplicationConfigs (list) --

      The deployment application configuration.

      • (dict) --

        Information about a deployment application configuration.

        • application (string) --

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

        • applicationVersion (string) --

          The version of the application.

        • launchConfig (dict) --

          The launch configuration.

          • packageName (string) --

            The package name.

          • preLaunchFile (string) --

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

          • launchFile (string) --

            The launch file name.

          • postLaunchFile (string) --

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

          • environmentVariables (dict) --

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

            • (string) --
              • (string) --
    • failureReason (string) --

      The failure reason of the deployment job if it failed.

    • failureCode (string) --

      The failure code of the simulation job if it failed:

      BadPermissionError

      AWS Greengrass requires a service-level role permission to access other services. The role must include the ` AWSGreengrassResourceAccessRolePolicy managed policy <https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor>`__ .

      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) --

create_fleet(**kwargs)

Creates a fleet, a logical group of robots running the same robot application.

See also: AWS API Documentation

Request Syntax

response = client.create_fleet(
    name='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the fleet.

  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

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) --

create_robot(**kwargs)

Creates a robot.

See also: AWS API Documentation

Request Syntax

response = client.create_robot(
    name='string',
    architecture='X86_64'|'ARM64'|'ARMHF',
    greengrassGroupId='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name for the robot.

  • architecture (string) --

    [REQUIRED]

    The target architecture of the robot.

  • greengrassGroupId (string) --

    [REQUIRED]

    The Greengrass group id.

  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

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) --

create_robot_application(**kwargs)

Creates a robot application.

See also: AWS API Documentation

Request Syntax

response = client.create_robot_application(
    name='string',
    sources=[
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    robotSoftwareSuite={
        'name': 'ROS',
        'version': 'Kinetic'|'Melodic'
    },
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the robot application.

  • sources (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.

  • robotSoftwareSuite (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.

  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

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'|'Melodic'
    },
    '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) --

create_robot_application_version(**kwargs)

Creates a version of a robot application.

See also: AWS API Documentation

Request Syntax

response = client.create_robot_application_version(
    application='string',
    currentRevisionId='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The application information for the robot application.

  • currentRevisionId (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.
Return type

dict

Returns

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'|'Melodic'
    },
    '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.

create_simulation_application(**kwargs)

Creates a simulation application.

See also: AWS API Documentation

Request Syntax

response = 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'|'Melodic'
    },
    renderingEngine={
        'name': 'OGRE',
        'version': 'string'
    },
    tags={
        'string': 'string'
    }
)
Parameters
  • name (string) --

    [REQUIRED]

    The name of the simulation application.

  • sources (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.

  • simulationSoftwareSuite (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.

  • robotSoftwareSuite (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.

  • renderingEngine (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.

  • tags (dict) --

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

    • (string) --
      • (string) --
Return type

dict

Returns

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'|'Melodic'
    },
    'renderingEngine': {
        'name': 'OGRE',
        'version': 'string'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'revisionId': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

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

    • name (string) --

      The name of the simulation application.

    • version (string) --

      The version of the simulation application.

    • sources (list) --

      The sources of the simulation application.

      • (dict) --

        Information about a source.

        • s3Bucket (string) --

          The s3 bucket name.

        • s3Key (string) --

          The s3 object key.

        • etag (string) --

          A hash of the object specified by s3Bucket and s3Key .

        • architecture (string) --

          The taget processor architecture for the application.

    • simulationSoftwareSuite (dict) --

      The simulation software suite used by the simulation application.

      • name (string) --

        The name of the simulation software suite.

      • version (string) --

        The version of the simulation software suite.

    • robotSoftwareSuite (dict) --

      Information about the robot software suite.

      • name (string) --

        The name of the robot software suite.

      • version (string) --

        The version of the robot software suite.

    • renderingEngine (dict) --

      The rendering engine for the simulation application.

      • name (string) --

        The name of the rendering engine.

      • version (string) --

        The version of the rendering engine.

    • lastUpdatedAt (datetime) --

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

    • revisionId (string) --

      The revision id of the simulation application.

    • tags (dict) --

      The list of all tags added to the simulation application.

      • (string) --
        • (string) --

create_simulation_application_version(**kwargs)

Creates a simulation application with a specific revision id.

See also: AWS API Documentation

Request Syntax

response = client.create_simulation_application_version(
    application='string',
    currentRevisionId='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The application information for the simulation application.

  • currentRevisionId (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.
Return type

dict

Returns

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'|'Melodic'
    },
    'renderingEngine': {
        'name': 'OGRE',
        'version': 'string'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'revisionId': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

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

    • name (string) --

      The name of the simulation application.

    • version (string) --

      The version of the simulation application.

    • sources (list) --

      The sources of the simulation application.

      • (dict) --

        Information about a source.

        • s3Bucket (string) --

          The s3 bucket name.

        • s3Key (string) --

          The s3 object key.

        • etag (string) --

          A hash of the object specified by s3Bucket and s3Key .

        • architecture (string) --

          The taget processor architecture for the application.

    • simulationSoftwareSuite (dict) --

      The simulation software suite used by the simulation application.

      • name (string) --

        The name of the simulation software suite.

      • version (string) --

        The version of the simulation software suite.

    • robotSoftwareSuite (dict) --

      Information about the robot software suite.

      • name (string) --

        The name of the robot software suite.

      • version (string) --

        The version of the robot software suite.

    • renderingEngine (dict) --

      The rendering engine for the simulation application.

      • name (string) --

        The name of the rendering engine.

      • version (string) --

        The version of the rendering engine.

    • lastUpdatedAt (datetime) --

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

    • revisionId (string) --

      The revision ID of the simulation application.

create_simulation_job(**kwargs)

Creates a simulation job.

Note

After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

See also: AWS API Documentation

Request Syntax

response = 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
    }
)
Parameters
  • clientRequestToken (string) --

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

    This field is autopopulated if not provided.

  • 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) --

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

  • iamRole (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.

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

  • robotApplications (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) --
  • simulationApplications (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) --
  • tags (dict) --

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

    • (string) --
      • (string) --
  • vpcConfig (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.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
    'lastStartedAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'failureBehavior': 'Fail'|'Continue',
    'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'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.

    • lastStartedAt (datetime) --

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

    • lastUpdatedAt (datetime) --

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

    • failureBehavior (string) --

      the failure behavior for the simulation job.

    • failureCode (string) --

      The failure code of the simulation job if it failed:

      InternalServiceError

      Internal service error.

      RobotApplicationCrash

      Robot application exited abnormally.

      SimulationApplicationCrash

      Simulation application exited abnormally.

      BadPermissionsRobotApplication

      Robot application bundle could not be downloaded.

      BadPermissionsSimulationApplication

      Simulation application bundle could not be downloaded.

      BadPermissionsS3Output

      Unable to publish outputs to customer-provided S3 bucket.

      BadPermissionsCloudwatchLogs

      Unable to publish logs to customer-provided CloudWatch Logs resource.

      SubnetIpLimitExceeded

      Subnet IP limit exceeded.

      ENILimitExceeded

      ENI limit exceeded.

      BadPermissionsUserCredentials

      Unable to use the Role provided.

      InvalidBundleRobotApplication

      Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

      InvalidBundleSimulationApplication

      Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

      RobotApplicationVersionMismatchedEtag

      Etag for RobotApplication does not match value during version creation.

      SimulationApplicationVersionMismatchedEtag

      Etag for SimulationApplication does not match value during version creation.

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

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

delete_fleet(**kwargs)

Deletes a fleet.

See also: AWS API Documentation

Request Syntax

response = client.delete_fleet(
    fleet='string'
)
Parameters
fleet (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_robot(**kwargs)

Deletes a robot.

See also: AWS API Documentation

Request Syntax

response = client.delete_robot(
    robot='string'
)
Parameters
robot (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the robot.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_robot_application(**kwargs)

Deletes a robot application.

See also: AWS API Documentation

Request Syntax

response = client.delete_robot_application(
    application='string',
    applicationVersion='string'
)
Parameters
  • application (string) --

    [REQUIRED]

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

  • applicationVersion (string) -- The version of the robot application to delete.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_simulation_application(**kwargs)

Deletes a simulation application.

See also: AWS API Documentation

Request Syntax

response = client.delete_simulation_application(
    application='string',
    applicationVersion='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The application information for the simulation application to delete.

  • applicationVersion (string) -- The version of the simulation application to delete.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

deregister_robot(**kwargs)

Deregisters a robot.

See also: AWS API Documentation

Request Syntax

response = client.deregister_robot(
    fleet='string',
    robot='string'
)
Parameters
  • fleet (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the fleet.

  • robot (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the robot.

Return type

dict

Returns

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.

describe_deployment_job(**kwargs)

Describes a deployment job.

See also: AWS API Documentation

Request Syntax

response = client.describe_deployment_job(
    job='string'
)
Parameters
job (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'fleet': 'string',
    'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
    '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'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
    'createdAt': datetime(2015, 1, 1),
    'robotDeploymentSummary': [
        {
            'arn': 'string',
            'deploymentStartTime': datetime(2015, 1, 1),
            'deploymentFinishTime': datetime(2015, 1, 1),
            'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
            'progressDetail': {
                'currentProgress': 'Validating'|'DownloadingExtracting'|'ExecutingPreLaunch'|'Launching'|'ExecutingPostLaunch'|'Finished',
                'percentDone': ...,
                'estimatedTimeRemainingSeconds': 123,
                'targetResource': 'string'
            },
            'failureReason': 'string',
            'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError'
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • arn (string) --

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

    • fleet (string) --

      The Amazon Resource Name (ARN) of the fleet.

    • status (string) --

      The status of the deployment job.

    • deploymentConfig (dict) --

      The deployment configuration.

      • concurrentDeploymentPercentage (integer) --

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

      • failureThresholdPercentage (integer) --

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

    • deploymentApplicationConfigs (list) --

      The deployment application configuration.

      • (dict) --

        Information about a deployment application configuration.

        • application (string) --

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

        • applicationVersion (string) --

          The version of the application.

        • launchConfig (dict) --

          The launch configuration.

          • packageName (string) --

            The package name.

          • preLaunchFile (string) --

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

          • launchFile (string) --

            The launch file name.

          • postLaunchFile (string) --

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

          • environmentVariables (dict) --

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

            • (string) --
              • (string) --
    • failureReason (string) --

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

    • failureCode (string) --

      The deployment job failure code.

    • createdAt (datetime) --

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

    • robotDeploymentSummary (list) --

      A list of robot deployment summaries.

      • (dict) --

        Information about a robot deployment.

        • arn (string) --

          The robot deployment Amazon Resource Name (ARN).

        • deploymentStartTime (datetime) --

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

        • deploymentFinishTime (datetime) --

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

        • status (string) --

          The status of the robot deployment.

        • progressDetail (dict) --

          Information about how the deployment is progressing.

          • currentProgress (string) --

            The current progress status.

            Validating

            Validating the deployment.

            DownloadingExtracting

            Downloading and extracting the bundle on the robot.

            ExecutingPreLaunch

            Executing pre-launch script(s) if provided.

            Launching

            Launching the robot application.

            ExecutingPostLaunch

            Executing post-launch script(s) if provided.

            Finished

            Deployment is complete.

          • percentDone (float) --

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

          • estimatedTimeRemainingSeconds (integer) --

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

          • targetResource (string) --

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

        • failureReason (string) --

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

        • failureCode (string) --

          The robot deployment failure code.

    • tags (dict) --

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

      • (string) --
        • (string) --
describe_fleet(**kwargs)

Describes a fleet.

See also: AWS API Documentation

Request Syntax

response = client.describe_fleet(
    fleet='string'
)
Parameters
fleet (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

Return type
dict
Returns
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'|'Canceled',
    '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) --
describe_robot(**kwargs)

Describes a robot.

See also: AWS API Documentation

Request Syntax

response = client.describe_robot(
    robot='string'
)
Parameters
robot (string) --

[REQUIRED]

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

Return type
dict
Returns
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) --
describe_robot_application(**kwargs)

Describes a robot application.

See also: AWS API Documentation

Request Syntax

response = client.describe_robot_application(
    application='string',
    applicationVersion='string'
)
Parameters
  • application (string) --

    [REQUIRED]

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

  • applicationVersion (string) -- The version of the robot application to describe.
Return type

dict

Returns

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'|'Melodic'
    },
    '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) --

describe_simulation_application(**kwargs)

Describes a simulation application.

See also: AWS API Documentation

Request Syntax

response = client.describe_simulation_application(
    application='string',
    applicationVersion='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The application information for the simulation application.

  • applicationVersion (string) -- The version of the simulation application to describe.
Return type

dict

Returns

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'|'Melodic'
    },
    'renderingEngine': {
        'name': 'OGRE',
        'version': 'string'
    },
    'revisionId': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

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

    • name (string) --

      The name of the simulation application.

    • version (string) --

      The version of the simulation application.

    • sources (list) --

      The sources of the simulation application.

      • (dict) --

        Information about a source.

        • s3Bucket (string) --

          The s3 bucket name.

        • s3Key (string) --

          The s3 object key.

        • etag (string) --

          A hash of the object specified by s3Bucket and s3Key .

        • architecture (string) --

          The taget processor architecture for the application.

    • simulationSoftwareSuite (dict) --

      The simulation software suite used by the simulation application.

      • name (string) --

        The name of the simulation software suite.

      • version (string) --

        The version of the simulation software suite.

    • robotSoftwareSuite (dict) --

      Information about the robot software suite.

      • name (string) --

        The name of the robot software suite.

      • version (string) --

        The version of the robot software suite.

    • renderingEngine (dict) --

      The rendering engine for the simulation application.

      • name (string) --

        The name of the rendering engine.

      • version (string) --

        The version of the rendering engine.

    • revisionId (string) --

      The revision id of the simulation application.

    • lastUpdatedAt (datetime) --

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

    • tags (dict) --

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

      • (string) --
        • (string) --

describe_simulation_job(**kwargs)

Describes a simulation job.

See also: AWS API Documentation

Request Syntax

response = client.describe_simulation_job(
    job='string'
)
Parameters
job (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{
    'arn': 'string',
    'name': 'string',
    'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
    'lastStartedAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'failureBehavior': 'Fail'|'Continue',
    'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'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.

    • lastStartedAt (datetime) --

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

    • lastUpdatedAt (datetime) --

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

    • failureBehavior (string) --

      The failure behavior for the simulation job.

    • failureCode (string) --

      The failure code of the simulation job if it failed:

      InternalServiceError

      Internal service error.

      RobotApplicationCrash

      Robot application exited abnormally.

      SimulationApplicationCrash

      Simulation application exited abnormally.

      BadPermissionsRobotApplication

      Robot application bundle could not be downloaded.

      BadPermissionsSimulationApplication

      Simulation application bundle could not be downloaded.

      BadPermissionsS3Output

      Unable to publish outputs to customer-provided S3 bucket.

      BadPermissionsCloudwatchLogs

      Unable to publish logs to customer-provided CloudWatch Logs resource.

      SubnetIpLimitExceeded

      Subnet IP limit exceeded.

      ENILimitExceeded

      ENI limit exceeded.

      BadPermissionsUserCredentials

      Unable to use the Role provided.

      InvalidBundleRobotApplication

      Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

      InvalidBundleSimulationApplication

      Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

      RobotApplicationVersionMismatchedEtag

      Etag for RobotApplication does not match value during version creation.

      SimulationApplicationVersionMismatchedEtag

      Etag for SimulationApplication does not match value during version creation.

    • failureReason (string) --

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

    • clientRequestToken (string) --

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

    • outputLocation (dict) --

      Location for output files generated by the simulation job.

      • s3Bucket (string) --

        The S3 bucket for output.

      • s3Prefix (string) --

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

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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_deployment_jobs(**kwargs)

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

response = client.list_deployment_jobs(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • filters (list) --

    Optional filters to limit results.

    The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending .

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • nextToken (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.

  • maxResults (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.
Return type

dict

Returns

Response Syntax

{
    'deploymentJobs': [
        {
            'arn': 'string',
            'fleet': 'string',
            'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
            'deploymentApplicationConfigs': [
                {
                    'application': 'string',
                    'applicationVersion': 'string',
                    'launchConfig': {
                        'packageName': 'string',
                        'preLaunchFile': 'string',
                        'launchFile': 'string',
                        'postLaunchFile': 'string',
                        'environmentVariables': {
                            'string': 'string'
                        }
                    }
                },
            ],
            'deploymentConfig': {
                'concurrentDeploymentPercentage': 123,
                'failureThresholdPercentage': 123
            },
            'failureReason': 'string',
            'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • deploymentJobs (list) --

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

      • (dict) --

        Information about a deployment job.

        • arn (string) --

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

        • fleet (string) --

          The Amazon Resource Name (ARN) of the fleet.

        • status (string) --

          The status of the deployment job.

        • deploymentApplicationConfigs (list) --

          The deployment application configuration.

          • (dict) --

            Information about a deployment application configuration.

            • application (string) --

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

            • applicationVersion (string) --

              The version of the application.

            • launchConfig (dict) --

              The launch configuration.

              • packageName (string) --

                The package name.

              • preLaunchFile (string) --

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

              • launchFile (string) --

                The launch file name.

              • postLaunchFile (string) --

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

              • environmentVariables (dict) --

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

                • (string) --
                  • (string) --
        • deploymentConfig (dict) --

          The deployment configuration.

          • concurrentDeploymentPercentage (integer) --

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

          • failureThresholdPercentage (integer) --

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

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

list_fleets(**kwargs)

Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

See also: AWS API Documentation

Request Syntax

response = client.list_fleets(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters
  • nextToken (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.

  • maxResults (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.
  • filters (list) --

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'fleetDetails': [
        {
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
            '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.

list_robot_applications(**kwargs)

Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

See also: AWS API Documentation

Request Syntax

response = client.list_robot_applications(
    versionQualifier='string',
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters
  • versionQualifier (string) -- The version qualifier of the robot application.
  • nextToken (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.

  • maxResults (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 ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.
  • filters (list) --

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'robotApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS',
                'version': 'Kinetic'|'Melodic'
            }
        },
    ],
    '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.

        • robotSoftwareSuite (dict) --

          Information about a robot software suite.

          • name (string) --

            The name of the robot software suite.

          • version (string) --

            The version of the robot software suite.

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

list_robots(**kwargs)

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

See also: AWS API Documentation

Request Syntax

response = client.list_robots(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters
  • nextToken (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.

  • maxResults (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 ListRobots 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.
  • filters (list) --

    Optional filters to limit results.

    The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available .

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
Return type

dict

Returns

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.

list_simulation_applications(**kwargs)

Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.

See also: AWS API Documentation

Request Syntax

response = client.list_simulation_applications(
    versionQualifier='string',
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters
  • versionQualifier (string) -- The version qualifier of the simulation application.
  • nextToken (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.

  • maxResults (integer) -- The maximum number of deployment job results returned by ListSimulationApplications in paginated output. When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.
  • filters (list) --

    Optional list of filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'simulationApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS',
                'version': 'Kinetic'|'Melodic'
            },
            'simulationSoftwareSuite': {
                'name': 'Gazebo',
                'version': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • simulationApplicationSummaries (list) --

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

      • (dict) --

        Summary information for a simulation application.

        • name (string) --

          The name of the simulation application.

        • arn (string) --

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

        • version (string) --

          The version of the simulation application.

        • lastUpdatedAt (datetime) --

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

        • robotSoftwareSuite (dict) --

          Information about a robot software suite.

          • name (string) --

            The name of the robot software suite.

          • version (string) --

            The version of the robot software suite.

        • simulationSoftwareSuite (dict) --

          Information about a simulation software suite.

          • name (string) --

            The name of the simulation software suite.

          • version (string) --

            The version of the simulation software suite.

    • nextToken (string) --

      The nextToken value to include in a future ListSimulationApplications request. When the results of a ListRobot request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_simulation_jobs(**kwargs)

Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_simulation_jobs(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ]
)
Parameters
  • nextToken (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.

  • maxResults (integer) -- The maximum number of deployment job results returned by ListSimulationJobs in paginated output. When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationJobs returns up to 100 results and a nextToken value if applicable.
  • filters (list) --

    Optional filters to limit results.

    The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running .

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
Return type

dict

Returns

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.

list_tags_for_resource(**kwargs)

Lists all tags on a AWS RoboMaker resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The list of all tags added to the specified resource.

      • (string) --
        • (string) --
register_robot(**kwargs)

Registers a robot with a fleet.

See also: AWS API Documentation

Request Syntax

response = client.register_robot(
    fleet='string',
    robot='string'
)
Parameters
  • fleet (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the fleet.

  • robot (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the robot.

Return type

dict

Returns

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.

restart_simulation_job(**kwargs)

Restarts a running simulation job.

See also: AWS API Documentation

Request Syntax

response = client.restart_simulation_job(
    job='string'
)
Parameters
job (string) --

[REQUIRED]

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

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
sync_deployment_job(**kwargs)

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

response = client.sync_deployment_job(
    clientRequestToken='string',
    fleet='string'
)
Parameters
  • clientRequestToken (string) --

    [REQUIRED]

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

    This field is autopopulated if not provided.

  • fleet (string) --

    [REQUIRED]

    The target fleet for the synchronization.

Return type

dict

Returns

Response Syntax

{
    'arn': 'string',
    'fleet': 'string',
    'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
    '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'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • arn (string) --

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

    • fleet (string) --

      The Amazon Resource Name (ARN) of the fleet.

    • status (string) --

      The status of the synchronization job.

    • deploymentConfig (dict) --

      Information about the deployment configuration.

      • concurrentDeploymentPercentage (integer) --

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

      • failureThresholdPercentage (integer) --

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

    • deploymentApplicationConfigs (list) --

      Information about the deployment application configurations.

      • (dict) --

        Information about a deployment application configuration.

        • application (string) --

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

        • applicationVersion (string) --

          The version of the application.

        • launchConfig (dict) --

          The launch configuration.

          • packageName (string) --

            The package name.

          • preLaunchFile (string) --

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

          • launchFile (string) --

            The launch file name.

          • postLaunchFile (string) --

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

          • environmentVariables (dict) --

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

            • (string) --
              • (string) --
    • failureReason (string) --

      The failure reason if the job fails.

    • failureCode (string) --

      The failure code if the job fails:

      InternalServiceError

      Internal service error.

      RobotApplicationCrash

      Robot application exited abnormally.

      SimulationApplicationCrash

      Simulation application exited abnormally.

      BadPermissionsRobotApplication

      Robot application bundle could not be downloaded.

      BadPermissionsSimulationApplication

      Simulation application bundle could not be downloaded.

      BadPermissionsS3Output

      Unable to publish outputs to customer-provided S3 bucket.

      BadPermissionsCloudwatchLogs

      Unable to publish logs to customer-provided CloudWatch Logs resource.

      SubnetIpLimitExceeded

      Subnet IP limit exceeded.

      ENILimitExceeded

      ENI limit exceeded.

      BadPermissionsUserCredentials

      Unable to use the Role provided.

      InvalidBundleRobotApplication

      Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

      InvalidBundleSimulationApplication

      Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

      RobotApplicationVersionMismatchedEtag

      Etag for RobotApplication does not match value during version creation.

      SimulationApplicationVersionMismatchedEtag

      Etag for SimulationApplication does not match value during version creation.

    • createdAt (datetime) --

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

tag_resource(**kwargs)

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

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

  • tags (dict) --

    [REQUIRED]

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

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

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 https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html`__ .

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

  • tagKeys (list) --

    [REQUIRED]

    A map that contains tag keys and tag values that will be unattached from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_robot_application(**kwargs)

Updates a robot application.

See also: AWS API Documentation

Request Syntax

response = client.update_robot_application(
    application='string',
    sources=[
        {
            's3Bucket': 'string',
            's3Key': 'string',
            'architecture': 'X86_64'|'ARM64'|'ARMHF'
        },
    ],
    robotSoftwareSuite={
        'name': 'ROS',
        'version': 'Kinetic'|'Melodic'
    },
    currentRevisionId='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The application information for the robot application.

  • sources (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.

  • robotSoftwareSuite (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.

  • currentRevisionId (string) -- The revision id for the robot application.
Return type

dict

Returns

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'|'Melodic'
    },
    '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.

update_simulation_application(**kwargs)

Updates a simulation application.

See also: AWS API Documentation

Request Syntax

response = 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'|'Melodic'
    },
    renderingEngine={
        'name': 'OGRE',
        'version': 'string'
    },
    currentRevisionId='string'
)
Parameters
  • application (string) --

    [REQUIRED]

    The application information for the simulation application.

  • sources (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.

  • simulationSoftwareSuite (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.

  • robotSoftwareSuite (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.

  • renderingEngine (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.

  • currentRevisionId (string) -- The revision id for the robot application.
Return type

dict

Returns

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'|'Melodic'
    },
    'renderingEngine': {
        'name': 'OGRE',
        'version': 'string'
    },
    'lastUpdatedAt': datetime(2015, 1, 1),
    'revisionId': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

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

    • name (string) --

      The name of the simulation application.

    • version (string) --

      The version of the robot application.

    • sources (list) --

      The sources of the simulation application.

      • (dict) --

        Information about a source.

        • s3Bucket (string) --

          The s3 bucket name.

        • s3Key (string) --

          The s3 object key.

        • etag (string) --

          A hash of the object specified by s3Bucket and s3Key .

        • architecture (string) --

          The taget processor architecture for the application.

    • simulationSoftwareSuite (dict) --

      The simulation software suite used by the simulation application.

      • name (string) --

        The name of the simulation software suite.

      • version (string) --

        The version of the simulation software suite.

    • robotSoftwareSuite (dict) --

      Information about the robot software suite.

      • name (string) --

        The name of the robot software suite.

      • version (string) --

        The version of the robot software suite.

    • renderingEngine (dict) --

      The rendering engine for the simulation application.

      • name (string) --

        The name of the rendering engine.

      • version (string) --

        The version of the rendering engine.

    • lastUpdatedAt (datetime) --

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

    • revisionId (string) --

      The revision id of the simulation application.

Paginators

The available paginators are:

class RoboMaker.Paginator.ListDeploymentJobs
paginator = client.get_paginator('list_deployment_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_deployment_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    Optional filters to limit results.

    The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending .

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'deploymentJobs': [
        {
            'arn': 'string',
            'fleet': 'string',
            'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
            'deploymentApplicationConfigs': [
                {
                    'application': 'string',
                    'applicationVersion': 'string',
                    'launchConfig': {
                        'packageName': 'string',
                        'preLaunchFile': 'string',
                        'launchFile': 'string',
                        'postLaunchFile': 'string',
                        'environmentVariables': {
                            'string': 'string'
                        }
                    }
                },
            ],
            'deploymentConfig': {
                'concurrentDeploymentPercentage': 123,
                'failureThresholdPercentage': 123
            },
            'failureReason': 'string',
            'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'InternalServerError',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • deploymentJobs (list) --

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

      • (dict) --

        Information about a deployment job.

        • arn (string) --

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

        • fleet (string) --

          The Amazon Resource Name (ARN) of the fleet.

        • status (string) --

          The status of the deployment job.

        • deploymentApplicationConfigs (list) --

          The deployment application configuration.

          • (dict) --

            Information about a deployment application configuration.

            • application (string) --

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

            • applicationVersion (string) --

              The version of the application.

            • launchConfig (dict) --

              The launch configuration.

              • packageName (string) --

                The package name.

              • preLaunchFile (string) --

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

              • launchFile (string) --

                The launch file name.

              • postLaunchFile (string) --

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

              • environmentVariables (dict) --

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

                • (string) --
                  • (string) --
        • deploymentConfig (dict) --

          The deployment configuration.

          • concurrentDeploymentPercentage (integer) --

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

          • failureThresholdPercentage (integer) --

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

        • 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) --

      A token to resume pagination.

class RoboMaker.Paginator.ListFleets
paginator = client.get_paginator('list_fleets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_fleets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'fleetDetails': [
        {
            'name': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
            '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) --

      A token to resume pagination.

class RoboMaker.Paginator.ListRobotApplications
paginator = client.get_paginator('list_robot_applications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_robot_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    versionQualifier='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • versionQualifier (string) -- The version qualifier of the robot application.
  • filters (list) --

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'robotApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS',
                'version': 'Kinetic'|'Melodic'
            }
        },
    ],
    '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.

        • robotSoftwareSuite (dict) --

          Information about a robot software suite.

          • name (string) --

            The name of the robot software suite.

          • version (string) --

            The version of the robot software suite.

    • NextToken (string) --

      A token to resume pagination.

class RoboMaker.Paginator.ListRobots
paginator = client.get_paginator('list_robots')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_robots().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    Optional filters to limit results.

    The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available .

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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) --

      A token to resume pagination.

class RoboMaker.Paginator.ListSimulationApplications
paginator = client.get_paginator('list_simulation_applications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_simulation_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    versionQualifier='string',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • versionQualifier (string) -- The version qualifier of the simulation application.
  • filters (list) --

    Optional list of filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'simulationApplicationSummaries': [
        {
            'name': 'string',
            'arn': 'string',
            'version': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'robotSoftwareSuite': {
                'name': 'ROS',
                'version': 'Kinetic'|'Melodic'
            },
            'simulationSoftwareSuite': {
                'name': 'Gazebo',
                'version': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • simulationApplicationSummaries (list) --

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

      • (dict) --

        Summary information for a simulation application.

        • name (string) --

          The name of the simulation application.

        • arn (string) --

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

        • version (string) --

          The version of the simulation application.

        • lastUpdatedAt (datetime) --

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

        • robotSoftwareSuite (dict) --

          Information about a robot software suite.

          • name (string) --

            The name of the robot software suite.

          • version (string) --

            The version of the robot software suite.

        • simulationSoftwareSuite (dict) --

          Information about a simulation software suite.

          • name (string) --

            The name of the simulation software suite.

          • version (string) --

            The version of the simulation software suite.

    • NextToken (string) --

      A token to resume pagination.

class RoboMaker.Paginator.ListSimulationJobs
paginator = client.get_paginator('list_simulation_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RoboMaker.Client.list_simulation_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    Optional filters to limit results.

    The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running .

    • (dict) --

      Information about a filter.

      • name (string) --

        The name of the filter.

      • values (list) --

        A list of values.

        • (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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) --

      A token to resume pagination.