RoboMaker / Client / batch_describe_simulation_job

batch_describe_simulation_job#

RoboMaker.Client.batch_describe_simulation_job(**kwargs)#

Warning

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.

Describes one or more simulation jobs.

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'|'RobotApplicationHealthCheckFailure'|'SimulationApplicationHealthCheckFailure'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'ThrottlingError'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication'|'UploadContentMismatchError',
            'failureReason': 'string',
            'clientRequestToken': 'string',
            'outputLocation': {
                's3Bucket': 'string',
                's3Prefix': 'string'
            },
            'loggingConfig': {
                'recordAllRosTopics': True|False
            },
            'maxJobDurationInSeconds': 123,
            'simulationTimeMillis': 123,
            'iamRole': 'string',
            'robotApplications': [
                {
                    'application': 'string',
                    'applicationVersion': 'string',
                    'launchConfig': {
                        'packageName': 'string',
                        'launchFile': 'string',
                        'environmentVariables': {
                            'string': 'string'
                        },
                        'portForwardingConfig': {
                            'portMappings': [
                                {
                                    'jobPort': 123,
                                    'applicationPort': 123,
                                    'enableOnPublicIp': True|False
                                },
                            ]
                        },
                        'streamUI': True|False,
                        'command': [
                            'string',
                        ]
                    },
                    'uploadConfigurations': [
                        {
                            'name': 'string',
                            'path': 'string',
                            'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
                        },
                    ],
                    'useDefaultUploadConfigurations': True|False,
                    'tools': [
                        {
                            'streamUI': True|False,
                            'name': 'string',
                            'command': 'string',
                            'streamOutputToCloudWatch': True|False,
                            'exitBehavior': 'FAIL'|'RESTART'
                        },
                    ],
                    'useDefaultTools': True|False
                },
            ],
            'simulationApplications': [
                {
                    'application': 'string',
                    'applicationVersion': 'string',
                    'launchConfig': {
                        'packageName': 'string',
                        'launchFile': 'string',
                        'environmentVariables': {
                            'string': 'string'
                        },
                        'portForwardingConfig': {
                            'portMappings': [
                                {
                                    'jobPort': 123,
                                    'applicationPort': 123,
                                    'enableOnPublicIp': True|False
                                },
                            ]
                        },
                        'streamUI': True|False,
                        'command': [
                            'string',
                        ]
                    },
                    'uploadConfigurations': [
                        {
                            'name': 'string',
                            'path': 'string',
                            'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
                        },
                    ],
                    'worldConfigs': [
                        {
                            'world': 'string'
                        },
                    ],
                    'useDefaultUploadConfigurations': True|False,
                    'tools': [
                        {
                            'streamUI': True|False,
                            'name': 'string',
                            'command': 'string',
                            'streamOutputToCloudWatch': True|False,
                            'exitBehavior': 'FAIL'|'RESTART'
                        },
                    ],
                    'useDefaultTools': True|False
                },
            ],
            'dataSources': [
                {
                    'name': 'string',
                    's3Bucket': 'string',
                    's3Keys': [
                        {
                            's3Key': 'string',
                            'etag': 'string'
                        },
                    ],
                    'type': 'Prefix'|'Archive'|'File',
                    'destination': 'string'
                },
            ],
            'tags': {
                'string': 'string'
            },
            'vpcConfig': {
                'subnets': [
                    'string',
                ],
                'securityGroups': [
                    'string',
                ],
                'vpcId': 'string',
                'assignPublicIp': True|False
            },
            'networkInterface': {
                'networkInterfaceId': 'string',
                'privateIpAddress': 'string',
                'publicIpAddress': 'string'
            },
            'compute': {
                'simulationUnitLimit': 123,
                'computeType': 'CPU'|'GPU_AND_CPU',
                'gpuUnitLimit': 123
            }
        },
    ],
    '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
      
      Leaves the host running for its maximum timeout duration after a 4XX error code.
      
      Fail
      
      Stop the simulation job and terminate the instance.
    - failureCode (string) –
      
      The failure code of the simulation job if it failed.
    - failureReason (string) –
      
      The reason why the simulation job failed.
    - clientRequestToken (string) –
      
      A unique identifier for this SimulationJob request.
    - outputLocation (dict) –
      
      Location for output files generated by the simulation job.
      - s3Bucket (string) –
        
        The S3 bucket for output.
      - s3Prefix (string) –
        
        The S3 folder in the s3Bucket where output files will be placed.
    - loggingConfig (dict) –
      
      The logging configuration.
      - recordAllRosTopics (boolean) –
        
        A boolean indicating whether to record all ROS topics.
        
        Warning
        This API is no longer supported and will throw an error if used.
    - 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) –
        
        portForwardingConfig (dict) –
        
        The port forwarding configuration.
        
        portMappings (list) –
        
        The port mappings for the configuration.
        
        (dict) –
        
        An object representing a port mapping.
        
        jobPort (integer) –
        
        The port number on the simulation job instance to use as a remote connection point.
        
        applicationPort (integer) –
        
        The port number on the application.
        
        enableOnPublicIp (boolean) –
        
        A Boolean indicating whether to enable this port mapping on public IP.
        
        streamUI (boolean) –
        
        Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
        
        command (list) –
        
        If you’ve specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.
        
        If you’ve specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.
        
        (string) –
        
        uploadConfigurations (list) –
        
        The upload configurations for the robot application.
        
        (dict) –
        
        Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
        
        name (string) –
        
        A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
        
        For example, if your simulation output location is s3://amzn-s3-demo-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.
        
        path (string) –
        
        Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.
        
        uploadBehavior (string) –
        
        Specifies when to upload the files:
        
        UPLOAD_ON_TERMINATE
        
        Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
        
        If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
        
        UPLOAD_ROLLING_AUTO_REMOVE
        
        Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
        
        useDefaultUploadConfigurations (boolean) –
        
        A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
        
        If you set this value, you must specify an outputLocation.
        
        Warning
        This API is no longer supported and will throw an error if used.
        
        tools (list) –
        
        Information about tools configured for the robot application.
        
        (dict) –
        
        Information about a tool. Tools are used in a simulation job.
        
        streamUI (boolean) –
        
        Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
        
        name (string) –
        
        The name of the tool.
        
        command (string) –
        
        Command-line arguments for the tool. It must include the tool executable name.
        
        streamOutputToCloudWatch (boolean) –
        
        Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
        
        exitBehavior (string) –
        
        Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
        
        useDefaultTools (boolean) –
        
        A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.
        
        Warning
        This API is no longer supported and will throw an error if used.
    - 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) –
        
        portForwardingConfig (dict) –
        
        The port forwarding configuration.
        
        portMappings (list) –
        
        The port mappings for the configuration.
        
        (dict) –
        
        An object representing a port mapping.
        
        jobPort (integer) –
        
        The port number on the simulation job instance to use as a remote connection point.
        
        applicationPort (integer) –
        
        The port number on the application.
        
        enableOnPublicIp (boolean) –
        
        A Boolean indicating whether to enable this port mapping on public IP.
        
        streamUI (boolean) –
        
        Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
        
        command (list) –
        
        If you’ve specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.
        
        If you’ve specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.
        
        (string) –
        
        uploadConfigurations (list) –
        
        Information about upload configurations for the simulation application.
        
        (dict) –
        
        Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
        
        name (string) –
        
        A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
        
        For example, if your simulation output location is s3://amzn-s3-demo-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.
        
        path (string) –
        
        Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.
        
        uploadBehavior (string) –
        
        Specifies when to upload the files:
        
        UPLOAD_ON_TERMINATE
        
        Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
        
        If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
        
        UPLOAD_ROLLING_AUTO_REMOVE
        
        Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
        
        worldConfigs (list) –
        
        A list of world configurations.
        
        Warning
        This API is no longer supported and will throw an error if used.
        
        (dict) –
        
        Configuration information for a world.
        
        world (string) –
        
        The world generated by Simulation WorldForge.
        
        useDefaultUploadConfigurations (boolean) –
        
        A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
        
        If you set this value, you must specify an outputLocation.
        
        Warning
        This API is no longer supported and will throw an error if used.
        
        tools (list) –
        
        Information about tools configured for the simulation application.
        
        (dict) –
        
        Information about a tool. Tools are used in a simulation job.
        
        streamUI (boolean) –
        
        Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
        
        name (string) –
        
        The name of the tool.
        
        command (string) –
        
        Command-line arguments for the tool. It must include the tool executable name.
        
        streamOutputToCloudWatch (boolean) –
        
        Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
        
        exitBehavior (string) –
        
        Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
        
        useDefaultTools (boolean) –
        
        A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.
        
        Warning
        This API is no longer supported and will throw an error if used.
    - dataSources (list) –
      
      The data sources for the simulation job.
      - (dict) –
        
        Information about a data source.
        
        name (string) –
        
        The name of the data source.
        
        s3Bucket (string) –
        
        The S3 bucket where the data files are located.
        
        s3Keys (list) –
        
        The list of S3 keys identifying the data source files.
        
        (dict) –
        
        Information about S3 keys.
        
        s3Key (string) –
        
        The S3 key.
        
        etag (string) –
        
        The etag for the object.
        
        type (string) –
        
        The data type for the data source that you’re using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.
        
        If you don’t specify a field, the default value is File.
        
        destination (string) –
        
        The location where your files are mounted in the container image.
        
        If you’ve specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.
        
        If you’ve specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.
        
        If you’ve specified the type of the data source as a File, you provide the Amazon S3 path to the file that you’re using as your data source.
    - 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.
    - networkInterface (dict) –
      
      Information about a network interface.
      - networkInterfaceId (string) –
        
        The ID of the network interface.
      - privateIpAddress (string) –
        
        The IPv4 address of the network interface within the subnet.
      - publicIpAddress (string) –
        
        The IPv4 public address of the network interface.
    - compute (dict) –
      
      Compute information for the simulation job
      - simulationUnitLimit (integer) –
        
        The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.
      - computeType (string) –
        
        Compute type response information for the simulation job.
      - gpuUnitLimit (integer) –
        
        Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.
- unprocessedJobs (list) –
  
  A list of unprocessed simulation job Amazon Resource Names (ARNs).
  - (string) –

Exceptions

RoboMaker.Client.exceptions.ResourceNotFoundException
RoboMaker.Client.exceptions.InvalidParameterException
RoboMaker.Client.exceptions.InternalServerException
RoboMaker.Client.exceptions.ThrottlingException