BatchDeleteWorlds

$result = $client->batchDeleteWorlds([/* ... */]);
$promise = $client->batchDeleteWorldsAsync([/* ... */]);

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

Deletes one or more worlds in a batch operation.

Parameter Syntax

$result = $client->batchDeleteWorlds([
    'worlds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'unprocessedWorlds' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

BatchDescribeSimulationJob

$result = $client->batchDescribeSimulationJob([/* ... */]);
$promise = $client->batchDescribeSimulationJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchDescribeSimulationJob([
    'jobs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobs' => [
        [
            'arn' => '<string>',
            'clientRequestToken' => '<string>',
            'compute' => [
                'computeType' => 'CPU|GPU_AND_CPU',
                'gpuUnitLimit' => <integer>,
                'simulationUnitLimit' => <integer>,
            ],
            'dataSources' => [
                [
                    'destination' => '<string>',
                    'name' => '<string>',
                    's3Bucket' => '<string>',
                    's3Keys' => [
                        [
                            'etag' => '<string>',
                            's3Key' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'Prefix|Archive|File',
                ],
                // ...
            ],
            '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>',
            'iamRole' => '<string>',
            'lastStartedAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'loggingConfig' => [
                'recordAllRosTopics' => true || false,
            ],
            'maxJobDurationInSeconds' => <integer>,
            'name' => '<string>',
            'networkInterface' => [
                'networkInterfaceId' => '<string>',
                'privateIpAddress' => '<string>',
                'publicIpAddress' => '<string>',
            ],
            'outputLocation' => [
                's3Bucket' => '<string>',
                's3Prefix' => '<string>',
            ],
            'robotApplications' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>,
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>',
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>',
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>',
                            'path' => '<string>',
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                ],
                // ...
            ],
            'simulationApplications' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>,
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>',
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>',
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>',
                            'path' => '<string>',
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                    'worldConfigs' => [
                        [
                            'world' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'simulationTimeMillis' => <integer>,
            'status' => 'Pending|Preparing|Running|Restarting|Completed|Failed|RunningFailed|Terminating|Terminated|Canceled',
            'tags' => ['<string>', ...],
            'vpcConfig' => [
                'assignPublicIp' => true || false,
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
                'vpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'unprocessedJobs' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

CancelDeploymentJob

$result = $client->cancelDeploymentJob([/* ... */]);
$promise = $client->cancelDeploymentJobAsync([/* ... */]);

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

Cancels the specified deployment job.

Parameter Syntax

$result = $client->cancelDeploymentJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

CancelSimulationJob

$result = $client->cancelSimulationJob([/* ... */]);
$promise = $client->cancelSimulationJobAsync([/* ... */]);

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

Cancels the specified simulation job.

Parameter Syntax

$result = $client->cancelSimulationJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

CancelSimulationJobBatch

$result = $client->cancelSimulationJobBatch([/* ... */]);
$promise = $client->cancelSimulationJobBatchAsync([/* ... */]);

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

Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.

Parameter Syntax

$result = $client->cancelSimulationJobBatch([
    'batch' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

CancelWorldExportJob

$result = $client->cancelWorldExportJob([/* ... */]);
$promise = $client->cancelWorldExportJobAsync([/* ... */]);

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

Cancels the specified export job.

Parameter Syntax

$result = $client->cancelWorldExportJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

CancelWorldGenerationJob

$result = $client->cancelWorldGenerationJob([/* ... */]);
$promise = $client->cancelWorldGenerationJobAsync([/* ... */]);

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

Cancels the specified world generator job.

Parameter Syntax

$result = $client->cancelWorldGenerationJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

CreateDeploymentJob

$result = $client->createDeploymentJob([/* ... */]);
$promise = $client->createDeploymentJobAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->createDeploymentJob([
    'clientRequestToken' => '<string>', // REQUIRED
    'deploymentApplicationConfigs' => [ // REQUIRED
        [
            'application' => '<string>', // REQUIRED
            'applicationVersion' => '<string>', // REQUIRED
            'launchConfig' => [ // REQUIRED
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>', // REQUIRED
                'packageName' => '<string>', // REQUIRED
                'postLaunchFile' => '<string>',
                'preLaunchFile' => '<string>',
            ],
        ],
        // ...
    ],
    'deploymentConfig' => [
        'concurrentDeploymentPercentage' => <integer>,
        'downloadConditionFile' => [
            'bucket' => '<string>', // REQUIRED
            'etag' => '<string>',
            'key' => '<string>', // REQUIRED
        ],
        'failureThresholdPercentage' => <integer>,
        'robotDeploymentTimeoutInSeconds' => <integer>,
    ],
    'fleet' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'deploymentApplicationConfigs' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'postLaunchFile' => '<string>',
                'preLaunchFile' => '<string>',
            ],
        ],
        // ...
    ],
    'deploymentConfig' => [
        'concurrentDeploymentPercentage' => <integer>,
        'downloadConditionFile' => [
            'bucket' => '<string>',
            'etag' => '<string>',
            'key' => '<string>',
        ],
        'failureThresholdPercentage' => <integer>,
        'robotDeploymentTimeoutInSeconds' => <integer>,
    ],
    'failureCode' => 'ResourceNotFound|EnvironmentSetupError|EtagMismatch|FailureThresholdBreached|RobotDeploymentAborted|RobotDeploymentNoResponse|RobotAgentConnectionTimeout|GreengrassDeploymentFailed|InvalidGreengrassGroup|MissingRobotArchitecture|MissingRobotApplicationArchitecture|MissingRobotDeploymentResource|GreengrassGroupVersionDoesNotExist|LambdaDeleted|ExtractingBundleFailure|PreLaunchFileFailure|PostLaunchFileFailure|BadPermissionError|DownloadConditionFailed|BadLambdaAssociated|InternalServerError|RobotApplicationDoesNotExist|DeploymentFleetDoesNotExist|FleetDeploymentTimeout',
    'failureReason' => '<string>',
    'fleet' => '<string>',
    'status' => 'Pending|Preparing|InProgress|Failed|Succeeded|Canceled',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ConcurrentDeploymentException:

The failure percentage threshold percentage was met.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

CreateFleet

$result = $client->createFleet([/* ... */]);
$promise = $client->createFleetAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createFleet([
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

CreateRobot

$result = $client->createRobot([/* ... */]);
$promise = $client->createRobotAsync([/* ... */]);

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

Creates a robot.

Parameter Syntax

$result = $client->createRobot([
    'architecture' => 'X86_64|ARM64|ARMHF', // REQUIRED
    'greengrassGroupId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'architecture' => 'X86_64|ARM64|ARMHF',
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'greengrassGroupId' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceAlreadyExistsException:

The specified resource already exists.

CreateRobotApplication

$result = $client->createRobotApplication([/* ... */]);
$promise = $client->createRobotApplicationAsync([/* ... */]);

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

Creates a robot application.

Parameter Syntax

$result = $client->createRobotApplication([
    'environment' => [
        'uri' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'robotSoftwareSuite' => [ // REQUIRED
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'environment' => [
        'uri' => '<string>',
    ],
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'revisionId' => '<string>',
    'robotSoftwareSuite' => [
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'etag' => '<string>',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

CreateRobotApplicationVersion

$result = $client->createRobotApplicationVersion([/* ... */]);
$promise = $client->createRobotApplicationVersionAsync([/* ... */]);

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

Creates a version of a robot application.

Parameter Syntax

$result = $client->createRobotApplicationVersion([
    'application' => '<string>', // REQUIRED
    'currentRevisionId' => '<string>',
    'imageDigest' => '<string>',
    's3Etags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'environment' => [
        'uri' => '<string>',
    ],
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'revisionId' => '<string>',
    'robotSoftwareSuite' => [
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'etag' => '<string>',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

CreateSimulationApplication

$result = $client->createSimulationApplication([/* ... */]);
$promise = $client->createSimulationApplicationAsync([/* ... */]);

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

Creates a simulation application.

Parameter Syntax

$result = $client->createSimulationApplication([
    'environment' => [
        'uri' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'renderingEngine' => [
        'name' => 'OGRE',
        'version' => '<string>',
    ],
    'robotSoftwareSuite' => [ // REQUIRED
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'simulationSoftwareSuite' => [ // REQUIRED
        'name' => 'Gazebo|RosbagPlay|SimulationRuntime',
        'version' => '<string>',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'environment' => [
        'uri' => '<string>',
    ],
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'renderingEngine' => [
        'name' => 'OGRE',
        'version' => '<string>',
    ],
    'revisionId' => '<string>',
    'robotSoftwareSuite' => [
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'simulationSoftwareSuite' => [
        'name' => 'Gazebo|RosbagPlay|SimulationRuntime',
        'version' => '<string>',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'etag' => '<string>',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceAlreadyExistsException:

The specified resource already exists.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

CreateSimulationApplicationVersion

$result = $client->createSimulationApplicationVersion([/* ... */]);
$promise = $client->createSimulationApplicationVersionAsync([/* ... */]);

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

Creates a simulation application with a specific revision id.

Parameter Syntax

$result = $client->createSimulationApplicationVersion([
    'application' => '<string>', // REQUIRED
    'currentRevisionId' => '<string>',
    'imageDigest' => '<string>',
    's3Etags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'environment' => [
        'uri' => '<string>',
    ],
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'renderingEngine' => [
        'name' => 'OGRE',
        'version' => '<string>',
    ],
    'revisionId' => '<string>',
    'robotSoftwareSuite' => [
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'simulationSoftwareSuite' => [
        'name' => 'Gazebo|RosbagPlay|SimulationRuntime',
        'version' => '<string>',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'etag' => '<string>',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

CreateSimulationJob

$result = $client->createSimulationJob([/* ... */]);
$promise = $client->createSimulationJobAsync([/* ... */]);

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

Creates a simulation job.

Parameter Syntax

$result = $client->createSimulationJob([
    'clientRequestToken' => '<string>',
    'compute' => [
        'computeType' => 'CPU|GPU_AND_CPU',
        'gpuUnitLimit' => <integer>,
        'simulationUnitLimit' => <integer>,
    ],
    'dataSources' => [
        [
            'destination' => '<string>',
            'name' => '<string>', // REQUIRED
            's3Bucket' => '<string>', // REQUIRED
            's3Keys' => ['<string>', ...], // REQUIRED
            'type' => 'Prefix|Archive|File',
        ],
        // ...
    ],
    'failureBehavior' => 'Fail|Continue',
    'iamRole' => '<string>', // REQUIRED
    'loggingConfig' => [
        'recordAllRosTopics' => true || false,
    ],
    'maxJobDurationInSeconds' => <integer>, // REQUIRED
    'outputLocation' => [
        's3Bucket' => '<string>',
        's3Prefix' => '<string>',
    ],
    'robotApplications' => [
        [
            'application' => '<string>', // REQUIRED
            'applicationVersion' => '<string>',
            'launchConfig' => [ // REQUIRED
                'command' => ['<string>', ...],
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'portForwardingConfig' => [
                    'portMappings' => [
                        [
                            'applicationPort' => <integer>, // REQUIRED
                            'enableOnPublicIp' => true || false,
                            'jobPort' => <integer>, // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'streamUI' => true || false,
            ],
            'tools' => [
                [
                    'command' => '<string>', // REQUIRED
                    'exitBehavior' => 'FAIL|RESTART',
                    'name' => '<string>', // REQUIRED
                    'streamOutputToCloudWatch' => true || false,
                    'streamUI' => true || false,
                ],
                // ...
            ],
            'uploadConfigurations' => [
                [
                    'name' => '<string>', // REQUIRED
                    'path' => '<string>', // REQUIRED
                    'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE', // REQUIRED
                ],
                // ...
            ],
            'useDefaultTools' => true || false,
            'useDefaultUploadConfigurations' => true || false,
        ],
        // ...
    ],
    'simulationApplications' => [
        [
            'application' => '<string>', // REQUIRED
            'applicationVersion' => '<string>',
            'launchConfig' => [ // REQUIRED
                'command' => ['<string>', ...],
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'portForwardingConfig' => [
                    'portMappings' => [
                        [
                            'applicationPort' => <integer>, // REQUIRED
                            'enableOnPublicIp' => true || false,
                            'jobPort' => <integer>, // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'streamUI' => true || false,
            ],
            'tools' => [
                [
                    'command' => '<string>', // REQUIRED
                    'exitBehavior' => 'FAIL|RESTART',
                    'name' => '<string>', // REQUIRED
                    'streamOutputToCloudWatch' => true || false,
                    'streamUI' => true || false,
                ],
                // ...
            ],
            'uploadConfigurations' => [
                [
                    'name' => '<string>', // REQUIRED
                    'path' => '<string>', // REQUIRED
                    'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE', // REQUIRED
                ],
                // ...
            ],
            'useDefaultTools' => true || false,
            'useDefaultUploadConfigurations' => true || false,
            'worldConfigs' => [
                [
                    'world' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'vpcConfig' => [
        'assignPublicIp' => true || false,
        'securityGroups' => ['<string>', ...],
        'subnets' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'compute' => [
        'computeType' => 'CPU|GPU_AND_CPU',
        'gpuUnitLimit' => <integer>,
        'simulationUnitLimit' => <integer>,
    ],
    'dataSources' => [
        [
            'destination' => '<string>',
            'name' => '<string>',
            's3Bucket' => '<string>',
            's3Keys' => [
                [
                    'etag' => '<string>',
                    's3Key' => '<string>',
                ],
                // ...
            ],
            'type' => 'Prefix|Archive|File',
        ],
        // ...
    ],
    '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',
    'iamRole' => '<string>',
    'lastStartedAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'loggingConfig' => [
        'recordAllRosTopics' => true || false,
    ],
    'maxJobDurationInSeconds' => <integer>,
    'outputLocation' => [
        's3Bucket' => '<string>',
        's3Prefix' => '<string>',
    ],
    'robotApplications' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'command' => ['<string>', ...],
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'portForwardingConfig' => [
                    'portMappings' => [
                        [
                            'applicationPort' => <integer>,
                            'enableOnPublicIp' => true || false,
                            'jobPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'streamUI' => true || false,
            ],
            'tools' => [
                [
                    'command' => '<string>',
                    'exitBehavior' => 'FAIL|RESTART',
                    'name' => '<string>',
                    'streamOutputToCloudWatch' => true || false,
                    'streamUI' => true || false,
                ],
                // ...
            ],
            'uploadConfigurations' => [
                [
                    'name' => '<string>',
                    'path' => '<string>',
                    'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                ],
                // ...
            ],
            'useDefaultTools' => true || false,
            'useDefaultUploadConfigurations' => true || false,
        ],
        // ...
    ],
    'simulationApplications' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'command' => ['<string>', ...],
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'portForwardingConfig' => [
                    'portMappings' => [
                        [
                            'applicationPort' => <integer>,
                            'enableOnPublicIp' => true || false,
                            'jobPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'streamUI' => true || false,
            ],
            'tools' => [
                [
                    'command' => '<string>',
                    'exitBehavior' => 'FAIL|RESTART',
                    'name' => '<string>',
                    'streamOutputToCloudWatch' => true || false,
                    'streamUI' => true || false,
                ],
                // ...
            ],
            'uploadConfigurations' => [
                [
                    'name' => '<string>',
                    'path' => '<string>',
                    'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                ],
                // ...
            ],
            'useDefaultTools' => true || false,
            'useDefaultUploadConfigurations' => true || false,
            'worldConfigs' => [
                [
                    'world' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'simulationTimeMillis' => <integer>,
    'status' => 'Pending|Preparing|Running|Restarting|Completed|Failed|RunningFailed|Terminating|Terminated|Canceled',
    'tags' => ['<string>', ...],
    'vpcConfig' => [
        'assignPublicIp' => true || false,
        'securityGroups' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

CreateWorldExportJob

$result = $client->createWorldExportJob([/* ... */]);
$promise = $client->createWorldExportJobAsync([/* ... */]);

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

Creates a world export job.

Parameter Syntax

$result = $client->createWorldExportJob([
    'clientRequestToken' => '<string>',
    'iamRole' => '<string>', // REQUIRED
    'outputLocation' => [ // REQUIRED
        's3Bucket' => '<string>',
        's3Prefix' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'worlds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'failureCode' => 'InternalServiceError|LimitExceeded|ResourceNotFound|RequestThrottled|InvalidInput|AccessDenied',
    'iamRole' => '<string>',
    'outputLocation' => [
        's3Bucket' => '<string>',
        's3Prefix' => '<string>',
    ],
    'status' => 'Pending|Running|Completed|Failed|Canceling|Canceled',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

CreateWorldGenerationJob

$result = $client->createWorldGenerationJob([/* ... */]);
$promise = $client->createWorldGenerationJobAsync([/* ... */]);

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

Creates worlds using the specified template.

Parameter Syntax

$result = $client->createWorldGenerationJob([
    'clientRequestToken' => '<string>',
    'tags' => ['<string>', ...],
    'template' => '<string>', // REQUIRED
    'worldCount' => [ // REQUIRED
        'floorplanCount' => <integer>,
        'interiorCountPerFloorplan' => <integer>,
    ],
    'worldTags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'failureCode' => 'InternalServiceError|LimitExceeded|ResourceNotFound|RequestThrottled|InvalidInput|AllWorldGenerationFailed',
    'status' => 'Pending|Running|Completed|Failed|PartialFailed|Canceling|Canceled',
    'tags' => ['<string>', ...],
    'template' => '<string>',
    'worldCount' => [
        'floorplanCount' => <integer>,
        'interiorCountPerFloorplan' => <integer>,
    ],
    'worldTags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

ServiceUnavailableException:

The request has failed due to a temporary failure of the server.

CreateWorldTemplate

$result = $client->createWorldTemplate([/* ... */]);
$promise = $client->createWorldTemplateAsync([/* ... */]);

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

Creates a world template.

Parameter Syntax

$result = $client->createWorldTemplate([
    'clientRequestToken' => '<string>',
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'templateBody' => '<string>',
    'templateLocation' => [
        's3Bucket' => '<string>', // REQUIRED
        's3Key' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceAlreadyExistsException:

The specified resource already exists.

ResourceNotFoundException:

The specified resource does not exist.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DeleteFleet

$result = $client->deleteFleet([/* ... */]);
$promise = $client->deleteFleetAsync([/* ... */]);

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

Deletes a fleet.

Parameter Syntax

$result = $client->deleteFleet([
    'fleet' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DeleteRobot

$result = $client->deleteRobot([/* ... */]);
$promise = $client->deleteRobotAsync([/* ... */]);

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

Deletes a robot.

Parameter Syntax

$result = $client->deleteRobot([
    'robot' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DeleteRobotApplication

$result = $client->deleteRobotApplication([/* ... */]);
$promise = $client->deleteRobotApplicationAsync([/* ... */]);

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

Deletes a robot application.

Parameter Syntax

$result = $client->deleteRobotApplication([
    'application' => '<string>', // REQUIRED
    'applicationVersion' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DeleteSimulationApplication

$result = $client->deleteSimulationApplication([/* ... */]);
$promise = $client->deleteSimulationApplicationAsync([/* ... */]);

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

Deletes a simulation application.

Parameter Syntax

$result = $client->deleteSimulationApplication([
    'application' => '<string>', // REQUIRED
    'applicationVersion' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DeleteWorldTemplate

$result = $client->deleteWorldTemplate([/* ... */]);
$promise = $client->deleteWorldTemplateAsync([/* ... */]);

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

Deletes a world template.

Parameter Syntax

$result = $client->deleteWorldTemplate([
    'template' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DeregisterRobot

$result = $client->deregisterRobot([/* ... */]);
$promise = $client->deregisterRobotAsync([/* ... */]);

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

Deregisters a robot.

Parameter Syntax

$result = $client->deregisterRobot([
    'fleet' => '<string>', // REQUIRED
    'robot' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'fleet' => '<string>',
    'robot' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ResourceNotFoundException:

The specified resource does not exist.

DescribeDeploymentJob

$result = $client->describeDeploymentJob([/* ... */]);
$promise = $client->describeDeploymentJobAsync([/* ... */]);

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 a deployment job.

Parameter Syntax

$result = $client->describeDeploymentJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'deploymentApplicationConfigs' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'postLaunchFile' => '<string>',
                'preLaunchFile' => '<string>',
            ],
        ],
        // ...
    ],
    'deploymentConfig' => [
        'concurrentDeploymentPercentage' => <integer>,
        'downloadConditionFile' => [
            'bucket' => '<string>',
            'etag' => '<string>',
            'key' => '<string>',
        ],
        'failureThresholdPercentage' => <integer>,
        'robotDeploymentTimeoutInSeconds' => <integer>,
    ],
    'failureCode' => 'ResourceNotFound|EnvironmentSetupError|EtagMismatch|FailureThresholdBreached|RobotDeploymentAborted|RobotDeploymentNoResponse|RobotAgentConnectionTimeout|GreengrassDeploymentFailed|InvalidGreengrassGroup|MissingRobotArchitecture|MissingRobotApplicationArchitecture|MissingRobotDeploymentResource|GreengrassGroupVersionDoesNotExist|LambdaDeleted|ExtractingBundleFailure|PreLaunchFileFailure|PostLaunchFileFailure|BadPermissionError|DownloadConditionFailed|BadLambdaAssociated|InternalServerError|RobotApplicationDoesNotExist|DeploymentFleetDoesNotExist|FleetDeploymentTimeout',
    'failureReason' => '<string>',
    'fleet' => '<string>',
    'robotDeploymentSummary' => [
        [
            'arn' => '<string>',
            'deploymentFinishTime' => <DateTime>,
            'deploymentStartTime' => <DateTime>,
            'failureCode' => 'ResourceNotFound|EnvironmentSetupError|EtagMismatch|FailureThresholdBreached|RobotDeploymentAborted|RobotDeploymentNoResponse|RobotAgentConnectionTimeout|GreengrassDeploymentFailed|InvalidGreengrassGroup|MissingRobotArchitecture|MissingRobotApplicationArchitecture|MissingRobotDeploymentResource|GreengrassGroupVersionDoesNotExist|LambdaDeleted|ExtractingBundleFailure|PreLaunchFileFailure|PostLaunchFileFailure|BadPermissionError|DownloadConditionFailed|BadLambdaAssociated|InternalServerError|RobotApplicationDoesNotExist|DeploymentFleetDoesNotExist|FleetDeploymentTimeout',
            'failureReason' => '<string>',
            'progressDetail' => [
                'currentProgress' => 'Validating|DownloadingExtracting|ExecutingDownloadCondition|ExecutingPreLaunch|Launching|ExecutingPostLaunch|Finished',
                'estimatedTimeRemainingSeconds' => <integer>,
                'percentDone' => <float>,
                'targetResource' => '<string>',
            ],
            'status' => 'Available|Registered|PendingNewDeployment|Deploying|Failed|InSync|NoResponse',
        ],
        // ...
    ],
    'status' => 'Pending|Preparing|InProgress|Failed|Succeeded|Canceled',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DescribeFleet

$result = $client->describeFleet([/* ... */]);
$promise = $client->describeFleetAsync([/* ... */]);

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 a fleet.

Parameter Syntax

$result = $client->describeFleet([
    'fleet' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'lastDeploymentJob' => '<string>',
    'lastDeploymentStatus' => 'Pending|Preparing|InProgress|Failed|Succeeded|Canceled',
    'lastDeploymentTime' => <DateTime>,
    'name' => '<string>',
    'robots' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'fleetArn' => '<string>',
            'greenGrassGroupId' => '<string>',
            'lastDeploymentJob' => '<string>',
            'lastDeploymentTime' => <DateTime>,
            'name' => '<string>',
            'status' => 'Available|Registered|PendingNewDeployment|Deploying|Failed|InSync|NoResponse',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DescribeRobot

$result = $client->describeRobot([/* ... */]);
$promise = $client->describeRobotAsync([/* ... */]);

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 a robot.

Parameter Syntax

$result = $client->describeRobot([
    'robot' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'architecture' => 'X86_64|ARM64|ARMHF',
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'fleetArn' => '<string>',
    'greengrassGroupId' => '<string>',
    'lastDeploymentJob' => '<string>',
    'lastDeploymentTime' => <DateTime>,
    'name' => '<string>',
    'status' => 'Available|Registered|PendingNewDeployment|Deploying|Failed|InSync|NoResponse',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DescribeRobotApplication

$result = $client->describeRobotApplication([/* ... */]);
$promise = $client->describeRobotApplicationAsync([/* ... */]);

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 a robot application.

Parameter Syntax

$result = $client->describeRobotApplication([
    'application' => '<string>', // REQUIRED
    'applicationVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'environment' => [
        'uri' => '<string>',
    ],
    'imageDigest' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'revisionId' => '<string>',
    'robotSoftwareSuite' => [
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'etag' => '<string>',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DescribeSimulationApplication

$result = $client->describeSimulationApplication([/* ... */]);
$promise = $client->describeSimulationApplicationAsync([/* ... */]);

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 a simulation application.

Parameter Syntax

$result = $client->describeSimulationApplication([
    'application' => '<string>', // REQUIRED
    'applicationVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'environment' => [
        'uri' => '<string>',
    ],
    'imageDigest' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'renderingEngine' => [
        'name' => 'OGRE',
        'version' => '<string>',
    ],
    'revisionId' => '<string>',
    'robotSoftwareSuite' => [
        'name' => 'ROS|ROS2|General',
        'version' => 'Kinetic|Melodic|Dashing|Foxy',
    ],
    'simulationSoftwareSuite' => [
        'name' => 'Gazebo|RosbagPlay|SimulationRuntime',
        'version' => '<string>',
    ],
    'sources' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'etag' => '<string>',
            's3Bucket' => '<string>',
            's3Key' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DescribeSimulationJob

$result = $client->describeSimulationJob([/* ... */]);
$promise = $client->describeSimulationJobAsync([/* ... */]);

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 a simulation job.

Parameter Syntax

$result = $client->describeSimulationJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'compute' => [
        'computeType' => 'CPU|GPU_AND_CPU',
        'gpuUnitLimit' => <integer>,
        'simulationUnitLimit' => <integer>,
    ],
    'dataSources' => [
        [
            'destination' => '<string>',
            'name' => '<string>',
            's3Bucket' => '<string>',
            's3Keys' => [
                [
                    'etag' => '<string>',
                    's3Key' => '<string>',
                ],
                // ...
            ],
            'type' => 'Prefix|Archive|File',
        ],
        // ...
    ],
    '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>',
    'iamRole' => '<string>',
    'lastStartedAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'loggingConfig' => [
        'recordAllRosTopics' => true || false,
    ],
    'maxJobDurationInSeconds' => <integer>,
    'name' => '<string>',
    'networkInterface' => [
        'networkInterfaceId' => '<string>',
        'privateIpAddress' => '<string>',
        'publicIpAddress' => '<string>',
    ],
    'outputLocation' => [
        's3Bucket' => '<string>',
        's3Prefix' => '<string>',
    ],
    'robotApplications' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'command' => ['<string>', ...],
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'portForwardingConfig' => [
                    'portMappings' => [
                        [
                            'applicationPort' => <integer>,
                            'enableOnPublicIp' => true || false,
                            'jobPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'streamUI' => true || false,
            ],
            'tools' => [
                [
                    'command' => '<string>',
                    'exitBehavior' => 'FAIL|RESTART',
                    'name' => '<string>',
                    'streamOutputToCloudWatch' => true || false,
                    'streamUI' => true || false,
                ],
                // ...
            ],
            'uploadConfigurations' => [
                [
                    'name' => '<string>',
                    'path' => '<string>',
                    'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                ],
                // ...
            ],
            'useDefaultTools' => true || false,
            'useDefaultUploadConfigurations' => true || false,
        ],
        // ...
    ],
    'simulationApplications' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'command' => ['<string>', ...],
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'portForwardingConfig' => [
                    'portMappings' => [
                        [
                            'applicationPort' => <integer>,
                            'enableOnPublicIp' => true || false,
                            'jobPort' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'streamUI' => true || false,
            ],
            'tools' => [
                [
                    'command' => '<string>',
                    'exitBehavior' => 'FAIL|RESTART',
                    'name' => '<string>',
                    'streamOutputToCloudWatch' => true || false,
                    'streamUI' => true || false,
                ],
                // ...
            ],
            'uploadConfigurations' => [
                [
                    'name' => '<string>',
                    'path' => '<string>',
                    'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                ],
                // ...
            ],
            'useDefaultTools' => true || false,
            'useDefaultUploadConfigurations' => true || false,
            'worldConfigs' => [
                [
                    'world' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'simulationTimeMillis' => <integer>,
    'status' => 'Pending|Preparing|Running|Restarting|Completed|Failed|RunningFailed|Terminating|Terminated|Canceled',
    'tags' => ['<string>', ...],
    'vpcConfig' => [
        'assignPublicIp' => true || false,
        'securityGroups' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DescribeSimulationJobBatch

$result = $client->describeSimulationJobBatch([/* ... */]);
$promise = $client->describeSimulationJobBatchAsync([/* ... */]);

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 a simulation job batch.

Parameter Syntax

$result = $client->describeSimulationJobBatch([
    'batch' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'batchPolicy' => [
        'maxConcurrency' => <integer>,
        'timeoutInSeconds' => <integer>,
    ],
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'createdRequests' => [
        [
            'arn' => '<string>',
            'computeType' => 'CPU|GPU_AND_CPU',
            'dataSourceNames' => ['<string>', ...],
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'robotApplicationNames' => ['<string>', ...],
            'simulationApplicationNames' => ['<string>', ...],
            'status' => 'Pending|Preparing|Running|Restarting|Completed|Failed|RunningFailed|Terminating|Terminated|Canceled',
        ],
        // ...
    ],
    'failedRequests' => [
        [
            'failedAt' => <DateTime>,
            '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>',
            'request' => [
                'compute' => [
                    'computeType' => 'CPU|GPU_AND_CPU',
                    'gpuUnitLimit' => <integer>,
                    'simulationUnitLimit' => <integer>,
                ],
                'dataSources' => [
                    [
                        'destination' => '<string>',
                        'name' => '<string>',
                        's3Bucket' => '<string>',
                        's3Keys' => ['<string>', ...],
                        'type' => 'Prefix|Archive|File',
                    ],
                    // ...
                ],
                'failureBehavior' => 'Fail|Continue',
                'iamRole' => '<string>',
                'loggingConfig' => [
                    'recordAllRosTopics' => true || false,
                ],
                'maxJobDurationInSeconds' => <integer>,
                'outputLocation' => [
                    's3Bucket' => '<string>',
                    's3Prefix' => '<string>',
                ],
                'robotApplications' => [
                    [
                        'application' => '<string>',
                        'applicationVersion' => '<string>',
                        'launchConfig' => [
                            'command' => ['<string>', ...],
                            'environmentVariables' => ['<string>', ...],
                            'launchFile' => '<string>',
                            'packageName' => '<string>',
                            'portForwardingConfig' => [
                                'portMappings' => [
                                    [
                                        'applicationPort' => <integer>,
                                        'enableOnPublicIp' => true || false,
                                        'jobPort' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                            'streamUI' => true || false,
                        ],
                        'tools' => [
                            [
                                'command' => '<string>',
                                'exitBehavior' => 'FAIL|RESTART',
                                'name' => '<string>',
                                'streamOutputToCloudWatch' => true || false,
                                'streamUI' => true || false,
                            ],
                            // ...
                        ],
                        'uploadConfigurations' => [
                            [
                                'name' => '<string>',
                                'path' => '<string>',
                                'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                            ],
                            // ...
                        ],
                        'useDefaultTools' => true || false,
                        'useDefaultUploadConfigurations' => true || false,
                    ],
                    // ...
                ],
                'simulationApplications' => [
                    [
                        'application' => '<string>',
                        'applicationVersion' => '<string>',
                        'launchConfig' => [
                            'command' => ['<string>', ...],
                            'environmentVariables' => ['<string>', ...],
                            'launchFile' => '<string>',
                            'packageName' => '<string>',
                            'portForwardingConfig' => [
                                'portMappings' => [
                                    [
                                        'applicationPort' => <integer>,
                                        'enableOnPublicIp' => true || false,
                                        'jobPort' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                            'streamUI' => true || false,
                        ],
                        'tools' => [
                            [
                                'command' => '<string>',
                                'exitBehavior' => 'FAIL|RESTART',
                                'name' => '<string>',
                                'streamOutputToCloudWatch' => true || false,
                                'streamUI' => true || false,
                            ],
                            // ...
                        ],
                        'uploadConfigurations' => [
                            [
                                'name' => '<string>',
                                'path' => '<string>',
                                'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                            ],
                            // ...
                        ],
                        'useDefaultTools' => true || false,
                        'useDefaultUploadConfigurations' => true || false,
                        'worldConfigs' => [
                            [
                                'world' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'tags' => ['<string>', ...],
                'useDefaultApplications' => true || false,
                'vpcConfig' => [
                    'assignPublicIp' => true || false,
                    'securityGroups' => ['<string>', ...],
                    'subnets' => ['<string>', ...],
                ],
            ],
        ],
        // ...
    ],
    'failureCode' => 'InternalServiceError',
    'failureReason' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'pendingRequests' => [
        [
            'compute' => [
                'computeType' => 'CPU|GPU_AND_CPU',
                'gpuUnitLimit' => <integer>,
                'simulationUnitLimit' => <integer>,
            ],
            'dataSources' => [
                [
                    'destination' => '<string>',
                    'name' => '<string>',
                    's3Bucket' => '<string>',
                    's3Keys' => ['<string>', ...],
                    'type' => 'Prefix|Archive|File',
                ],
                // ...
            ],
            'failureBehavior' => 'Fail|Continue',
            'iamRole' => '<string>',
            'loggingConfig' => [
                'recordAllRosTopics' => true || false,
            ],
            'maxJobDurationInSeconds' => <integer>,
            'outputLocation' => [
                's3Bucket' => '<string>',
                's3Prefix' => '<string>',
            ],
            'robotApplications' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>,
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>',
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>',
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>',
                            'path' => '<string>',
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                ],
                // ...
            ],
            'simulationApplications' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>,
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>',
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>',
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>',
                            'path' => '<string>',
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                    'worldConfigs' => [
                        [
                            'world' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'tags' => ['<string>', ...],
            'useDefaultApplications' => true || false,
            'vpcConfig' => [
                'assignPublicIp' => true || false,
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'status' => 'Pending|InProgress|Failed|Completed|Canceled|Canceling|Completing|TimingOut|TimedOut',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DescribeWorld

$result = $client->describeWorld([/* ... */]);
$promise = $client->describeWorldAsync([/* ... */]);

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 a world.

Parameter Syntax

$result = $client->describeWorld([
    'world' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'generationJob' => '<string>',
    'tags' => ['<string>', ...],
    'template' => '<string>',
    'worldDescriptionBody' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

DescribeWorldExportJob

$result = $client->describeWorldExportJob([/* ... */]);
$promise = $client->describeWorldExportJobAsync([/* ... */]);

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 a world export job.

Parameter Syntax

$result = $client->describeWorldExportJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'failureCode' => 'InternalServiceError|LimitExceeded|ResourceNotFound|RequestThrottled|InvalidInput|AccessDenied',
    'failureReason' => '<string>',
    'iamRole' => '<string>',
    'outputLocation' => [
        's3Bucket' => '<string>',
        's3Prefix' => '<string>',
    ],
    'status' => 'Pending|Running|Completed|Failed|Canceling|Canceled',
    'tags' => ['<string>', ...],
    'worlds' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DescribeWorldGenerationJob

$result = $client->describeWorldGenerationJob([/* ... */]);
$promise = $client->describeWorldGenerationJobAsync([/* ... */]);

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 a world generation job.

Parameter Syntax

$result = $client->describeWorldGenerationJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'failureCode' => 'InternalServiceError|LimitExceeded|ResourceNotFound|RequestThrottled|InvalidInput|AllWorldGenerationFailed',
    'failureReason' => '<string>',
    'finishedWorldsSummary' => [
        'failureSummary' => [
            'failures' => [
                [
                    'failureCode' => 'InternalServiceError|LimitExceeded|ResourceNotFound|RequestThrottled|InvalidInput|AllWorldGenerationFailed',
                    'failureCount' => <integer>,
                    'sampleFailureReason' => '<string>',
                ],
                // ...
            ],
            'totalFailureCount' => <integer>,
        ],
        'finishedCount' => <integer>,
        'succeededWorlds' => ['<string>', ...],
    ],
    'status' => 'Pending|Running|Completed|Failed|PartialFailed|Canceling|Canceled',
    'tags' => ['<string>', ...],
    'template' => '<string>',
    'worldCount' => [
        'floorplanCount' => <integer>,
        'interiorCountPerFloorplan' => <integer>,
    ],
    'worldTags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

DescribeWorldTemplate

$result = $client->describeWorldTemplate([/* ... */]);
$promise = $client->describeWorldTemplateAsync([/* ... */]);

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 a world template.

Parameter Syntax

$result = $client->describeWorldTemplate([
    'template' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'version' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

GetWorldTemplateBody

$result = $client->getWorldTemplateBody([/* ... */]);
$promise = $client->getWorldTemplateBodyAsync([/* ... */]);

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

Gets the world template body.

Parameter Syntax

$result = $client->getWorldTemplateBody([
    'generationJob' => '<string>',
    'template' => '<string>',
]);

Parameter Details

Result Syntax

[
    'templateBody' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ListDeploymentJobs

$result = $client->listDeploymentJobs([/* ... */]);
$promise = $client->listDeploymentJobsAsync([/* ... */]);

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

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

Parameter Syntax

$result = $client->listDeploymentJobs([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deploymentJobs' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentApplicationConfigs' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'postLaunchFile' => '<string>',
                        'preLaunchFile' => '<string>',
                    ],
                ],
                // ...
            ],
            'deploymentConfig' => [
                'concurrentDeploymentPercentage' => <integer>,
                'downloadConditionFile' => [
                    'bucket' => '<string>',
                    'etag' => '<string>',
                    'key' => '<string>',
                ],
                'failureThresholdPercentage' => <integer>,
                'robotDeploymentTimeoutInSeconds' => <integer>,
            ],
            'failureCode' => 'ResourceNotFound|EnvironmentSetupError|EtagMismatch|FailureThresholdBreached|RobotDeploymentAborted|RobotDeploymentNoResponse|RobotAgentConnectionTimeout|GreengrassDeploymentFailed|InvalidGreengrassGroup|MissingRobotArchitecture|MissingRobotApplicationArchitecture|MissingRobotDeploymentResource|GreengrassGroupVersionDoesNotExist|LambdaDeleted|ExtractingBundleFailure|PreLaunchFileFailure|PostLaunchFileFailure|BadPermissionError|DownloadConditionFailed|BadLambdaAssociated|InternalServerError|RobotApplicationDoesNotExist|DeploymentFleetDoesNotExist|FleetDeploymentTimeout',
            'failureReason' => '<string>',
            'fleet' => '<string>',
            'status' => 'Pending|Preparing|InProgress|Failed|Succeeded|Canceled',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListFleets

$result = $client->listFleets([/* ... */]);
$promise = $client->listFleetsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listFleets([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'fleetDetails' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastDeploymentJob' => '<string>',
            'lastDeploymentStatus' => 'Pending|Preparing|InProgress|Failed|Succeeded|Canceled',
            'lastDeploymentTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListRobotApplications

$result = $client->listRobotApplications([/* ... */]);
$promise = $client->listRobotApplicationsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listRobotApplications([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'versionQualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'robotApplicationSummaries' => [
        [
            'arn' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'robotSoftwareSuite' => [
                'name' => 'ROS|ROS2|General',
                'version' => 'Kinetic|Melodic|Dashing|Foxy',
            ],
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ListRobots

$result = $client->listRobots([/* ... */]);
$promise = $client->listRobotsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listRobots([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'robots' => [
        [
            'architecture' => 'X86_64|ARM64|ARMHF',
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'fleetArn' => '<string>',
            'greenGrassGroupId' => '<string>',
            'lastDeploymentJob' => '<string>',
            'lastDeploymentTime' => <DateTime>,
            'name' => '<string>',
            'status' => 'Available|Registered|PendingNewDeployment|Deploying|Failed|InSync|NoResponse',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListSimulationApplications

$result = $client->listSimulationApplications([/* ... */]);
$promise = $client->listSimulationApplicationsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listSimulationApplications([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'versionQualifier' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'simulationApplicationSummaries' => [
        [
            'arn' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'robotSoftwareSuite' => [
                'name' => 'ROS|ROS2|General',
                'version' => 'Kinetic|Melodic|Dashing|Foxy',
            ],
            'simulationSoftwareSuite' => [
                'name' => 'Gazebo|RosbagPlay|SimulationRuntime',
                'version' => '<string>',
            ],
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ListSimulationJobBatches

$result = $client->listSimulationJobBatches([/* ... */]);
$promise = $client->listSimulationJobBatchesAsync([/* ... */]);

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

Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.

Parameter Syntax

$result = $client->listSimulationJobBatches([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'simulationJobBatchSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'createdRequestCount' => <integer>,
            'failedRequestCount' => <integer>,
            'lastUpdatedAt' => <DateTime>,
            'pendingRequestCount' => <integer>,
            'status' => 'Pending|InProgress|Failed|Completed|Canceled|Canceling|Completing|TimingOut|TimedOut',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ListSimulationJobs

$result = $client->listSimulationJobs([/* ... */]);
$promise = $client->listSimulationJobsAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listSimulationJobs([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'simulationJobSummaries' => [
        [
            'arn' => '<string>',
            'computeType' => 'CPU|GPU_AND_CPU',
            'dataSourceNames' => ['<string>', ...],
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'robotApplicationNames' => ['<string>', ...],
            'simulationApplicationNames' => ['<string>', ...],
            'status' => 'Pending|Preparing|Running|Restarting|Completed|Failed|RunningFailed|Terminating|Terminated|Canceled',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Lists all tags on a AWS RoboMaker resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ResourceNotFoundException:

The specified resource does not exist.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListWorldExportJobs

$result = $client->listWorldExportJobs([/* ... */]);
$promise = $client->listWorldExportJobsAsync([/* ... */]);

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

Lists world export jobs.

Parameter Syntax

$result = $client->listWorldExportJobs([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'worldExportJobSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'outputLocation' => [
                's3Bucket' => '<string>',
                's3Prefix' => '<string>',
            ],
            'status' => 'Pending|Running|Completed|Failed|Canceling|Canceled',
            'worlds' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListWorldGenerationJobs

$result = $client->listWorldGenerationJobs([/* ... */]);
$promise = $client->listWorldGenerationJobsAsync([/* ... */]);

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

Lists world generator jobs.

Parameter Syntax

$result = $client->listWorldGenerationJobs([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'worldGenerationJobSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'failedWorldCount' => <integer>,
            'status' => 'Pending|Running|Completed|Failed|PartialFailed|Canceling|Canceled',
            'succeededWorldCount' => <integer>,
            'template' => '<string>',
            'worldCount' => [
                'floorplanCount' => <integer>,
                'interiorCountPerFloorplan' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

ListWorldTemplates

$result = $client->listWorldTemplates([/* ... */]);
$promise = $client->listWorldTemplatesAsync([/* ... */]);

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

Lists world templates.

Parameter Syntax

$result = $client->listWorldTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'templateSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ListWorlds

$result = $client->listWorlds([/* ... */]);
$promise = $client->listWorldsAsync([/* ... */]);

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

Lists worlds.

Parameter Syntax

$result = $client->listWorlds([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'worldSummaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'generationJob' => '<string>',
            'template' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

RegisterRobot

$result = $client->registerRobot([/* ... */]);
$promise = $client->registerRobotAsync([/* ... */]);

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

Registers a robot with a fleet.

Parameter Syntax

$result = $client->registerRobot([
    'fleet' => '<string>', // REQUIRED
    'robot' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'fleet' => '<string>',
    'robot' => '<string>',
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFoundException:

The specified resource does not exist.

RestartSimulationJob

$result = $client->restartSimulationJob([/* ... */]);
$promise = $client->restartSimulationJobAsync([/* ... */]);

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

Restarts a running simulation job.

Parameter Syntax

$result = $client->restartSimulationJob([
    'job' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

StartSimulationJobBatch

$result = $client->startSimulationJobBatch([/* ... */]);
$promise = $client->startSimulationJobBatchAsync([/* ... */]);

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

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

Parameter Syntax

$result = $client->startSimulationJobBatch([
    'batchPolicy' => [
        'maxConcurrency' => <integer>,
        'timeoutInSeconds' => <integer>,
    ],
    'clientRequestToken' => '<string>',
    'createSimulationJobRequests' => [ // REQUIRED
        [
            'compute' => [
                'computeType' => 'CPU|GPU_AND_CPU',
                'gpuUnitLimit' => <integer>,
                'simulationUnitLimit' => <integer>,
            ],
            'dataSources' => [
                [
                    'destination' => '<string>',
                    'name' => '<string>', // REQUIRED
                    's3Bucket' => '<string>', // REQUIRED
                    's3Keys' => ['<string>', ...], // REQUIRED
                    'type' => 'Prefix|Archive|File',
                ],
                // ...
            ],
            'failureBehavior' => 'Fail|Continue',
            'iamRole' => '<string>',
            'loggingConfig' => [
                'recordAllRosTopics' => true || false,
            ],
            'maxJobDurationInSeconds' => <integer>, // REQUIRED
            'outputLocation' => [
                's3Bucket' => '<string>',
                's3Prefix' => '<string>',
            ],
            'robotApplications' => [
                [
                    'application' => '<string>', // REQUIRED
                    'applicationVersion' => '<string>',
                    'launchConfig' => [ // REQUIRED
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>, // REQUIRED
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>, // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>', // REQUIRED
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>', // REQUIRED
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'path' => '<string>', // REQUIRED
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE', // REQUIRED
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                ],
                // ...
            ],
            'simulationApplications' => [
                [
                    'application' => '<string>', // REQUIRED
                    'applicationVersion' => '<string>',
                    'launchConfig' => [ // REQUIRED
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>, // REQUIRED
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>, // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>', // REQUIRED
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>', // REQUIRED
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'path' => '<string>', // REQUIRED
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE', // REQUIRED
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                    'worldConfigs' => [
                        [
                            'world' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'tags' => ['<string>', ...],
            'useDefaultApplications' => true || false,
            'vpcConfig' => [
                'assignPublicIp' => true || false,
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...], // REQUIRED
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'batchPolicy' => [
        'maxConcurrency' => <integer>,
        'timeoutInSeconds' => <integer>,
    ],
    'clientRequestToken' => '<string>',
    'createdAt' => <DateTime>,
    'createdRequests' => [
        [
            'arn' => '<string>',
            'computeType' => 'CPU|GPU_AND_CPU',
            'dataSourceNames' => ['<string>', ...],
            'lastUpdatedAt' => <DateTime>,
            'name' => '<string>',
            'robotApplicationNames' => ['<string>', ...],
            'simulationApplicationNames' => ['<string>', ...],
            'status' => 'Pending|Preparing|Running|Restarting|Completed|Failed|RunningFailed|Terminating|Terminated|Canceled',
        ],
        // ...
    ],
    'failedRequests' => [
        [
            'failedAt' => <DateTime>,
            '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>',
            'request' => [
                'compute' => [
                    'computeType' => 'CPU|GPU_AND_CPU',
                    'gpuUnitLimit' => <integer>,
                    'simulationUnitLimit' => <integer>,
                ],
                'dataSources' => [
                    [
                        'destination' => '<string>',
                        'name' => '<string>',
                        's3Bucket' => '<string>',
                        's3Keys' => ['<string>', ...],
                        'type' => 'Prefix|Archive|File',
                    ],
                    // ...
                ],
                'failureBehavior' => 'Fail|Continue',
                'iamRole' => '<string>',
                'loggingConfig' => [
                    'recordAllRosTopics' => true || false,
                ],
                'maxJobDurationInSeconds' => <integer>,
                'outputLocation' => [
                    's3Bucket' => '<string>',
                    's3Prefix' => '<string>',
                ],
                'robotApplications' => [
                    [
                        'application' => '<string>',
                        'applicationVersion' => '<string>',
                        'launchConfig' => [
                            'command' => ['<string>', ...],
                            'environmentVariables' => ['<string>', ...],
                            'launchFile' => '<string>',
                            'packageName' => '<string>',
                            'portForwardingConfig' => [
                                'portMappings' => [
                                    [
                                        'applicationPort' => <integer>,
                                        'enableOnPublicIp' => true || false,
                                        'jobPort' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                            'streamUI' => true || false,
                        ],
                        'tools' => [
                            [
                                'command' => '<string>',
                                'exitBehavior' => 'FAIL|RESTART',
                                'name' => '<string>',
                                'streamOutputToCloudWatch' => true || false,
                                'streamUI' => true || false,
                            ],
                            // ...
                        ],
                        'uploadConfigurations' => [
                            [
                                'name' => '<string>',
                                'path' => '<string>',
                                'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                            ],
                            // ...
                        ],
                        'useDefaultTools' => true || false,
                        'useDefaultUploadConfigurations' => true || false,
                    ],
                    // ...
                ],
                'simulationApplications' => [
                    [
                        'application' => '<string>',
                        'applicationVersion' => '<string>',
                        'launchConfig' => [
                            'command' => ['<string>', ...],
                            'environmentVariables' => ['<string>', ...],
                            'launchFile' => '<string>',
                            'packageName' => '<string>',
                            'portForwardingConfig' => [
                                'portMappings' => [
                                    [
                                        'applicationPort' => <integer>,
                                        'enableOnPublicIp' => true || false,
                                        'jobPort' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                            'streamUI' => true || false,
                        ],
                        'tools' => [
                            [
                                'command' => '<string>',
                                'exitBehavior' => 'FAIL|RESTART',
                                'name' => '<string>',
                                'streamOutputToCloudWatch' => true || false,
                                'streamUI' => true || false,
                            ],
                            // ...
                        ],
                        'uploadConfigurations' => [
                            [
                                'name' => '<string>',
                                'path' => '<string>',
                                'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                            ],
                            // ...
                        ],
                        'useDefaultTools' => true || false,
                        'useDefaultUploadConfigurations' => true || false,
                        'worldConfigs' => [
                            [
                                'world' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'tags' => ['<string>', ...],
                'useDefaultApplications' => true || false,
                'vpcConfig' => [
                    'assignPublicIp' => true || false,
                    'securityGroups' => ['<string>', ...],
                    'subnets' => ['<string>', ...],
                ],
            ],
        ],
        // ...
    ],
    'failureCode' => 'InternalServiceError',
    'failureReason' => '<string>',
    'pendingRequests' => [
        [
            'compute' => [
                'computeType' => 'CPU|GPU_AND_CPU',
                'gpuUnitLimit' => <integer>,
                'simulationUnitLimit' => <integer>,
            ],
            'dataSources' => [
                [
                    'destination' => '<string>',
                    'name' => '<string>',
                    's3Bucket' => '<string>',
                    's3Keys' => ['<string>', ...],
                    'type' => 'Prefix|Archive|File',
                ],
                // ...
            ],
            'failureBehavior' => 'Fail|Continue',
            'iamRole' => '<string>',
            'loggingConfig' => [
                'recordAllRosTopics' => true || false,
            ],
            'maxJobDurationInSeconds' => <integer>,
            'outputLocation' => [
                's3Bucket' => '<string>',
                's3Prefix' => '<string>',
            ],
            'robotApplications' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>,
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>',
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>',
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>',
                            'path' => '<string>',
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                ],
                // ...
            ],
            'simulationApplications' => [
                [
                    'application' => '<string>',
                    'applicationVersion' => '<string>',
                    'launchConfig' => [
                        'command' => ['<string>', ...],
                        'environmentVariables' => ['<string>', ...],
                        'launchFile' => '<string>',
                        'packageName' => '<string>',
                        'portForwardingConfig' => [
                            'portMappings' => [
                                [
                                    'applicationPort' => <integer>,
                                    'enableOnPublicIp' => true || false,
                                    'jobPort' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        'streamUI' => true || false,
                    ],
                    'tools' => [
                        [
                            'command' => '<string>',
                            'exitBehavior' => 'FAIL|RESTART',
                            'name' => '<string>',
                            'streamOutputToCloudWatch' => true || false,
                            'streamUI' => true || false,
                        ],
                        // ...
                    ],
                    'uploadConfigurations' => [
                        [
                            'name' => '<string>',
                            'path' => '<string>',
                            'uploadBehavior' => 'UPLOAD_ON_TERMINATE|UPLOAD_ROLLING_AUTO_REMOVE',
                        ],
                        // ...
                    ],
                    'useDefaultTools' => true || false,
                    'useDefaultUploadConfigurations' => true || false,
                    'worldConfigs' => [
                        [
                            'world' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'tags' => ['<string>', ...],
            'useDefaultApplications' => true || false,
            'vpcConfig' => [
                'assignPublicIp' => true || false,
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'status' => 'Pending|InProgress|Failed|Completed|Canceled|Canceling|Completing|TimingOut|TimedOut',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InvalidParameterException:

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

LimitExceededException:

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ThrottlingException:

AWS RoboMaker is temporarily unable to process the request. Try your call again.

IdempotentParameterMismatchException:

The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

InternalServerException:

AWS RoboMaker experienced a service issue. Try your call again.

SyncDeploymentJob

$result = $client->syncDeploymentJob([/* ... */]);
$promise = $client->syncDeploymentJobAsync([/* ... */]);

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

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

Parameter Syntax

$result = $client->syncDeploymentJob([
    'clientRequestToken' => '<string>', // REQUIRED
    'fleet' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'deploymentApplicationConfigs' => [
        [
            'application' => '<string>',
            'applicationVersion' => '<string>',
            'launchConfig' => [
                'environmentVariables' => ['<string>', ...],
                'launchFile' => '<string>',
                'packageName' => '<string>',
                'postLaunchFile' => '<string>',
                'preLaunchFile' => '<string>',
            ],
        ],
        // ...
    ],
    'deploymentConfig' => [
        'concurrentDeploymentPercentage' => <integer>,
        'downloadConditionFile' => [
            'bucket' => '<string>',
            'etag' => '<string>',
            'key' => '<string>',
        ],
        'failureThresholdPercentage' => <integer>,
        'robotDeploymentTimeoutInSeconds' => <integer>,
    ],
    'failureCode' => 'ResourceNotFound|EnvironmentSetupError|EtagMismatch|FailureThresholdBreached|RobotDeploymentAborted|RobotDeploymentNoResponse|RobotAgentConnectionTimeout|GreengrassDeploymentFailed|InvalidGreengrassGroup|MissingRobotArchitecture|MissingRobotApplicationArchitecture|MissingRobotDeploymentResource|GreengrassGroupVersionDoesNotExist|LambdaDeleted|ExtractingBundleFailure|PreLaunchFileFailure|PostLaunchFileFailure|BadPermissionError|DownloadConditionFailed|BadLambdaAssociated|InternalServerError|RobotApplicationDoesNotExist|DeploymentFleetDoesNotExist|FleetDeploymentTimeout',
    'failureReason' => '<string>',
    'fleet' => '<string>',
    'status' => 'Pending|Preparing|InProgress|Failed|Succeeded|Canceled',
]

Result Details