Struct aws_sdk_robomaker::client::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS RoboMaker
Client for invoking operations on AWS RoboMaker. Each operation on AWS RoboMaker is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_robomaker::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_robomaker::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_robomaker::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn batch_delete_worlds(&self) -> BatchDeleteWorlds
pub fn batch_delete_worlds(&self) -> BatchDeleteWorlds
Constructs a fluent builder for the BatchDeleteWorlds
operation.
- The fluent builder is configurable:
worlds(Vec<String>)
/set_worlds(Option<Vec<String>>)
:A list of Amazon Resource Names (arns) that correspond to worlds to delete.
- On success, responds with
BatchDeleteWorldsOutput
with field(s):unprocessed_worlds(Option<Vec<String>>)
:A list of unprocessed worlds associated with the call. These worlds were not deleted.
- On failure, responds with
SdkError<BatchDeleteWorldsError>
sourcepub fn batch_describe_simulation_job(&self) -> BatchDescribeSimulationJob
pub fn batch_describe_simulation_job(&self) -> BatchDescribeSimulationJob
Constructs a fluent builder for the BatchDescribeSimulationJob
operation.
- The fluent builder is configurable:
jobs(Vec<String>)
/set_jobs(Option<Vec<String>>)
:A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
- On success, responds with
BatchDescribeSimulationJobOutput
with field(s):jobs(Option<Vec<SimulationJob>>)
:A list of simulation jobs.
unprocessed_jobs(Option<Vec<String>>)
:A list of unprocessed simulation job Amazon Resource Names (ARNs).
- On failure, responds with
SdkError<BatchDescribeSimulationJobError>
sourcepub fn cancel_deployment_job(&self) -> CancelDeploymentJob
pub fn cancel_deployment_job(&self) -> CancelDeploymentJob
Constructs a fluent builder for the CancelDeploymentJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The deployment job ARN to cancel.
- On success, responds with
CancelDeploymentJobOutput
- On failure, responds with
SdkError<CancelDeploymentJobError>
sourcepub fn cancel_simulation_job(&self) -> CancelSimulationJob
pub fn cancel_simulation_job(&self) -> CancelSimulationJob
Constructs a fluent builder for the CancelSimulationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The simulation job ARN to cancel.
- On success, responds with
CancelSimulationJobOutput
- On failure, responds with
SdkError<CancelSimulationJobError>
sourcepub fn cancel_simulation_job_batch(&self) -> CancelSimulationJobBatch
pub fn cancel_simulation_job_batch(&self) -> CancelSimulationJobBatch
Constructs a fluent builder for the CancelSimulationJobBatch
operation.
- The fluent builder is configurable:
batch(impl Into<String>)
/set_batch(Option<String>)
:The id of the batch to cancel.
- On success, responds with
CancelSimulationJobBatchOutput
- On failure, responds with
SdkError<CancelSimulationJobBatchError>
sourcepub fn cancel_world_export_job(&self) -> CancelWorldExportJob
pub fn cancel_world_export_job(&self) -> CancelWorldExportJob
Constructs a fluent builder for the CancelWorldExportJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (arn) of the world export job to cancel.
- On success, responds with
CancelWorldExportJobOutput
- On failure, responds with
SdkError<CancelWorldExportJobError>
sourcepub fn cancel_world_generation_job(&self) -> CancelWorldGenerationJob
pub fn cancel_world_generation_job(&self) -> CancelWorldGenerationJob
Constructs a fluent builder for the CancelWorldGenerationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (arn) of the world generator job to cancel.
- On success, responds with
CancelWorldGenerationJobOutput
- On failure, responds with
SdkError<CancelWorldGenerationJobError>
sourcepub fn create_deployment_job(&self) -> CreateDeploymentJob
pub fn create_deployment_job(&self) -> CreateDeploymentJob
Constructs a fluent builder for the CreateDeploymentJob
operation.
- The fluent builder is configurable:
deployment_config(DeploymentConfig)
/set_deployment_config(Option<DeploymentConfig>)
:The requested deployment configuration.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
fleet(impl Into<String>)
/set_fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet to deploy.
deployment_application_configs(Vec<DeploymentApplicationConfig>)
/set_deployment_application_configs(Option<Vec<DeploymentApplicationConfig>>)
:The deployment application configuration.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the deployment job.
- On success, responds with
CreateDeploymentJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the deployment job.
fleet(Option<String>)
:The target fleet for the deployment job.
status(Option<DeploymentStatus>)
:The status of the deployment job.
deployment_application_configs(Option<Vec<DeploymentApplicationConfig>>)
:The deployment application configuration.
failure_reason(Option<String>)
:The failure reason of the deployment job if it failed.
failure_code(Option<DeploymentJobErrorCode>)
:The failure code of the simulation job if it failed:
- BadPermissionError
-
AWS Greengrass requires a service-level role permission to access other services. The role must include the
AWSGreengrassResourceAccessRolePolicy
managed policy. - ExtractingBundleFailure
-
The robot application could not be extracted from the bundle.
- FailureThresholdBreached
-
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
- GreengrassDeploymentFailed
-
The robot application could not be deployed to the robot.
- GreengrassGroupVersionDoesNotExist
-
The AWS Greengrass group or version associated with a robot is missing.
- InternalServerError
-
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
- MissingRobotApplicationArchitecture
-
The robot application does not have a source that matches the architecture of the robot.
- MissingRobotDeploymentResource
-
One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
- PostLaunchFileFailure
-
The post-launch script failed.
- PreLaunchFileFailure
-
The pre-launch script failed.
- ResourceNotFound
-
One or more deployment resources are missing. For example, do robot application source bundles still exist?
- RobotDeploymentNoResponse
-
There is no response from the robot. It might not be powered on or connected to the internet.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the fleet was created.
deployment_config(Option<DeploymentConfig>)
:The deployment configuration.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the deployment job.
- On failure, responds with
SdkError<CreateDeploymentJobError>
sourcepub fn create_fleet(&self) -> CreateFleet
pub fn create_fleet(&self) -> CreateFleet
Constructs a fluent builder for the CreateFleet
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the fleet.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the fleet.
- On success, responds with
CreateFleetOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
name(Option<String>)
:The name of the fleet.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the fleet was created.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the fleet.
- On failure, responds with
SdkError<CreateFleetError>
sourcepub fn create_robot(&self) -> CreateRobot
pub fn create_robot(&self) -> CreateRobot
Constructs a fluent builder for the CreateRobot
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name for the robot.
architecture(Architecture)
/set_architecture(Option<Architecture>)
:The target architecture of the robot.
greengrass_group_id(impl Into<String>)
/set_greengrass_group_id(Option<String>)
:The Greengrass group id.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the robot.
- On success, responds with
CreateRobotOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the robot.
name(Option<String>)
:The name of the robot.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the robot was created.
greengrass_group_id(Option<String>)
:The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
architecture(Option<Architecture>)
:The target architecture of the robot.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the robot.
- On failure, responds with
SdkError<CreateRobotError>
sourcepub fn create_robot_application(&self) -> CreateRobotApplication
pub fn create_robot_application(&self) -> CreateRobotApplication
Constructs a fluent builder for the CreateRobotApplication
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the robot application.
sources(Vec<SourceConfig>)
/set_sources(Option<Vec<SourceConfig>>)
:The sources of the robot application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribuition) used by the robot application.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the robot application.
environment(Environment)
/set_environment(Option<Environment>)
:The object that contains that URI of the Docker image that you use for your robot application.
- On success, responds with
CreateRobotApplicationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the robot application.
name(Option<String>)
:The name of the robot application.
version(Option<String>)
:The version of the robot application.
sources(Option<Vec<Source>>)
:The sources of the robot application.
robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribution) used by the robot application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the robot application was last updated.
revision_id(Option<String>)
:The revision id of the robot application.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the robot application.
environment(Option<Environment>)
:An object that contains the Docker image URI used to a create your robot application.
- On failure, responds with
SdkError<CreateRobotApplicationError>
sourcepub fn create_robot_application_version(&self) -> CreateRobotApplicationVersion
pub fn create_robot_application_version(&self) -> CreateRobotApplicationVersion
Constructs a fluent builder for the CreateRobotApplicationVersion
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The application information for the robot application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.
s3_etags(Vec<String>)
/set_s3_etags(Option<Vec<String>>)
:The Amazon S3 identifier for the zip file bundle that you use for your robot application.
image_digest(impl Into<String>)
/set_image_digest(Option<String>)
:A SHA256 identifier for the Docker image that you use for your robot application.
- On success, responds with
CreateRobotApplicationVersionOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the robot application.
name(Option<String>)
:The name of the robot application.
version(Option<String>)
:The version of the robot application.
sources(Option<Vec<Source>>)
:The sources of the robot application.
robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribution) used by the robot application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the robot application was last updated.
revision_id(Option<String>)
:The revision id of the robot application.
environment(Option<Environment>)
:The object that contains the Docker image URI used to create your robot application.
- On failure, responds with
SdkError<CreateRobotApplicationVersionError>
sourcepub fn create_simulation_application(&self) -> CreateSimulationApplication
pub fn create_simulation_application(&self) -> CreateSimulationApplication
Constructs a fluent builder for the CreateSimulationApplication
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the simulation application.
sources(Vec<SourceConfig>)
/set_sources(Option<Vec<SourceConfig>>)
:The sources of the simulation application.
simulation_software_suite(SimulationSoftwareSuite)
/set_simulation_software_suite(Option<SimulationSoftwareSuite>)
:The simulation software suite used by the simulation application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribution) used by the simulation application.
rendering_engine(RenderingEngine)
/set_rendering_engine(Option<RenderingEngine>)
:The rendering engine for the simulation application.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the simulation application.
environment(Environment)
/set_environment(Option<Environment>)
:The object that contains the Docker image URI used to create your simulation application.
- On success, responds with
CreateSimulationApplicationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the simulation application.
name(Option<String>)
:The name of the simulation application.
version(Option<String>)
:The version of the simulation application.
sources(Option<Vec<Source>>)
:The sources of the simulation application.
simulation_software_suite(Option<SimulationSoftwareSuite>)
:The simulation software suite used by the simulation application.
robot_software_suite(Option<RobotSoftwareSuite>)
:Information about the robot software suite (ROS distribution).
rendering_engine(Option<RenderingEngine>)
:The rendering engine for the simulation application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation application was last updated.
revision_id(Option<String>)
:The revision id of the simulation application.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the simulation application.
environment(Option<Environment>)
:The object that contains the Docker image URI that you used to create your simulation application.
- On failure, responds with
SdkError<CreateSimulationApplicationError>
sourcepub fn create_simulation_application_version(
&self
) -> CreateSimulationApplicationVersion
pub fn create_simulation_application_version(
&self
) -> CreateSimulationApplicationVersion
Constructs a fluent builder for the CreateSimulationApplicationVersion
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The application information for the simulation application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.
s3_etags(Vec<String>)
/set_s3_etags(Option<Vec<String>>)
:The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.
image_digest(impl Into<String>)
/set_image_digest(Option<String>)
:The SHA256 digest used to identify the Docker image URI used to created the simulation application.
- On success, responds with
CreateSimulationApplicationVersionOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the simulation application.
name(Option<String>)
:The name of the simulation application.
version(Option<String>)
:The version of the simulation application.
sources(Option<Vec<Source>>)
:The sources of the simulation application.
simulation_software_suite(Option<SimulationSoftwareSuite>)
:The simulation software suite used by the simulation application.
robot_software_suite(Option<RobotSoftwareSuite>)
:Information about the robot software suite (ROS distribution).
rendering_engine(Option<RenderingEngine>)
:The rendering engine for the simulation application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation application was last updated.
revision_id(Option<String>)
:The revision ID of the simulation application.
environment(Option<Environment>)
:The object that contains the Docker image URI used to create the simulation application.
- On failure, responds with
SdkError<CreateSimulationApplicationVersionError>
sourcepub fn create_simulation_job(&self) -> CreateSimulationJob
pub fn create_simulation_job(&self) -> CreateSimulationJob
Constructs a fluent builder for the CreateSimulationJob
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
output_location(OutputLocation)
/set_output_location(Option<OutputLocation>)
:Location for output files generated by the simulation job.
logging_config(LoggingConfig)
/set_logging_config(Option<LoggingConfig>)
:The logging configuration.
max_job_duration_in_seconds(i64)
/set_max_job_duration_in_seconds(i64)
:The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When
maxJobDurationInSeconds
is reached, the simulation job will status will transition toCompleted
.iam_role(impl Into<String>)
/set_iam_role(Option<String>)
:The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
failure_behavior(FailureBehavior)
/set_failure_behavior(Option<FailureBehavior>)
:The failure behavior the simulation job.
- Continue
-
Leaves the instance running for its maximum timeout duration after a
4XX
error code. - Fail
-
Stop the simulation job and terminate the instance.
robot_applications(Vec<RobotApplicationConfig>)
/set_robot_applications(Option<Vec<RobotApplicationConfig>>)
:The robot application to use in the simulation job.
simulation_applications(Vec<SimulationApplicationConfig>)
/set_simulation_applications(Option<Vec<SimulationApplicationConfig>>)
:The simulation application to use in the simulation job.
data_sources(Vec<DataSourceConfig>)
/set_data_sources(Option<Vec<DataSourceConfig>>)
:Specify data sources to mount read-only files from S3 into your simulation. These files are available under
/opt/robomaker/datasources/data_source_name
.There is a limit of 100 files and a combined size of 25GB for all
DataSourceConfig
objects.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the simulation job.
vpc_config(VpcConfig)
/set_vpc_config(Option<VpcConfig>)
:If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.
compute(Compute)
/set_compute(Option<Compute>)
:Compute information for the simulation job.
- On success, responds with
CreateSimulationJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the simulation job.
status(Option<SimulationJobStatus>)
:The status of the simulation job.
last_started_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job was last started.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job was last updated.
failure_behavior(Option<FailureBehavior>)
:the failure behavior for the simulation job.
failure_code(Option<SimulationJobErrorCode>)
:The failure code of the simulation job if it failed:
- InternalServiceError
-
Internal service error.
- RobotApplicationCrash
-
Robot application exited abnormally.
- SimulationApplicationCrash
-
Simulation application exited abnormally.
- BadPermissionsRobotApplication
-
Robot application bundle could not be downloaded.
- BadPermissionsSimulationApplication
-
Simulation application bundle could not be downloaded.
- BadPermissionsS3Output
-
Unable to publish outputs to customer-provided S3 bucket.
- BadPermissionsCloudwatchLogs
-
Unable to publish logs to customer-provided CloudWatch Logs resource.
- SubnetIpLimitExceeded
-
Subnet IP limit exceeded.
- ENILimitExceeded
-
ENI limit exceeded.
- BadPermissionsUserCredentials
-
Unable to use the Role provided.
- InvalidBundleRobotApplication
-
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
- InvalidBundleSimulationApplication
-
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
- RobotApplicationVersionMismatchedEtag
-
Etag for RobotApplication does not match value during version creation.
- SimulationApplicationVersionMismatchedEtag
-
Etag for SimulationApplication does not match value during version creation.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
output_location(Option<OutputLocation>)
:Simulation job output files location.
logging_config(Option<LoggingConfig>)
:The logging configuration.
max_job_duration_in_seconds(i64)
:The maximum simulation job duration in seconds.
simulation_time_millis(i64)
:The simulation job execution duration in milliseconds.
iam_role(Option<String>)
:The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
robot_applications(Option<Vec<RobotApplicationConfig>>)
:The robot application used by the simulation job.
simulation_applications(Option<Vec<SimulationApplicationConfig>>)
:The simulation application used by the simulation job.
data_sources(Option<Vec<DataSource>>)
:The data sources for the simulation job.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the simulation job.
vpc_config(Option<VpcConfigResponse>)
:Information about the vpc configuration.
compute(Option<ComputeResponse>)
:Compute information for the simulation job.
- On failure, responds with
SdkError<CreateSimulationJobError>
sourcepub fn create_world_export_job(&self) -> CreateWorldExportJob
pub fn create_world_export_job(&self) -> CreateWorldExportJob
Constructs a fluent builder for the CreateWorldExportJob
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
worlds(Vec<String>)
/set_worlds(Option<Vec<String>>)
:A list of Amazon Resource Names (arns) that correspond to worlds to export.
output_location(OutputLocation)
/set_output_location(Option<OutputLocation>)
:The output location.
iam_role(impl Into<String>)
/set_iam_role(Option<String>)
:The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world export job.
- On success, responds with
CreateWorldExportJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the world export job.
status(Option<WorldExportJobStatus>)
:The status of the world export job.
- Pending
-
The world export job request is pending.
- Running
-
The world export job is running.
- Completed
-
The world export job completed.
- Failed
-
The world export job failed. See
failureCode
for more information. - Canceled
-
The world export job was cancelled.
- Canceling
-
The world export job is being cancelled.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world export job was created.
failure_code(Option<WorldExportJobErrorCode>)
:The failure code of the world export job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
- AllWorldGenerationFailed
-
All of the worlds in the world generation job failed. This can happen if your
worldCount
is greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
output_location(Option<OutputLocation>)
:The output location.
iam_role(Option<String>)
:The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world export job.
- On failure, responds with
SdkError<CreateWorldExportJobError>
sourcepub fn create_world_generation_job(&self) -> CreateWorldGenerationJob
pub fn create_world_generation_job(&self) -> CreateWorldGenerationJob
Constructs a fluent builder for the CreateWorldGenerationJob
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
template(impl Into<String>)
/set_template(Option<String>)
:The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
world_count(WorldCount)
/set_world_count(Option<WorldCount>)
:Information about the world count.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world generator job.
world_tags(HashMap<String, String>)
/set_world_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the generated worlds.
- On success, responds with
CreateWorldGenerationJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the world generator job.
status(Option<WorldGenerationJobStatus>)
:The status of the world generator job.
- Pending
-
The world generator job request is pending.
- Running
-
The world generator job is running.
- Completed
-
The world generator job completed.
- Failed
-
The world generator job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generator job was cancelled.
- Canceling
-
The world generator job is being cancelled.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world generator job was created.
failure_code(Option<WorldGenerationJobErrorCode>)
:The failure code of the world generator job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
template(Option<String>)
:The Amazon Resource Name (arn) of the world template.
world_count(Option<WorldCount>)
:Information about the world count.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world generator job.
world_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the generated worlds.
- On failure, responds with
SdkError<CreateWorldGenerationJobError>
sourcepub fn create_world_template(&self) -> CreateWorldTemplate
pub fn create_world_template(&self) -> CreateWorldTemplate
Constructs a fluent builder for the CreateWorldTemplate
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the world template.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:The world template body.
template_location(TemplateLocation)
/set_template_location(Option<TemplateLocation>)
:The location of the world template.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world template.
- On success, responds with
CreateWorldTemplateOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the world template.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world template was created.
name(Option<String>)
:The name of the world template.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world template.
- On failure, responds with
SdkError<CreateWorldTemplateError>
sourcepub fn delete_fleet(&self) -> DeleteFleet
pub fn delete_fleet(&self) -> DeleteFleet
Constructs a fluent builder for the DeleteFleet
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
- On success, responds with
DeleteFleetOutput
- On failure, responds with
SdkError<DeleteFleetError>
sourcepub fn delete_robot(&self) -> DeleteRobot
pub fn delete_robot(&self) -> DeleteRobot
Constructs a fluent builder for the DeleteRobot
operation.
- The fluent builder is configurable:
robot(impl Into<String>)
/set_robot(Option<String>)
:The Amazon Resource Name (ARN) of the robot.
- On success, responds with
DeleteRobotOutput
- On failure, responds with
SdkError<DeleteRobotError>
sourcepub fn delete_robot_application(&self) -> DeleteRobotApplication
pub fn delete_robot_application(&self) -> DeleteRobotApplication
Constructs a fluent builder for the DeleteRobotApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The Amazon Resource Name (ARN) of the the robot application.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:The version of the robot application to delete.
- On success, responds with
DeleteRobotApplicationOutput
- On failure, responds with
SdkError<DeleteRobotApplicationError>
sourcepub fn delete_simulation_application(&self) -> DeleteSimulationApplication
pub fn delete_simulation_application(&self) -> DeleteSimulationApplication
Constructs a fluent builder for the DeleteSimulationApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The application information for the simulation application to delete.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:The version of the simulation application to delete.
- On success, responds with
DeleteSimulationApplicationOutput
- On failure, responds with
SdkError<DeleteSimulationApplicationError>
sourcepub fn delete_world_template(&self) -> DeleteWorldTemplate
pub fn delete_world_template(&self) -> DeleteWorldTemplate
Constructs a fluent builder for the DeleteWorldTemplate
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:The Amazon Resource Name (arn) of the world template you want to delete.
- On success, responds with
DeleteWorldTemplateOutput
- On failure, responds with
SdkError<DeleteWorldTemplateError>
sourcepub fn deregister_robot(&self) -> DeregisterRobot
pub fn deregister_robot(&self) -> DeregisterRobot
Constructs a fluent builder for the DeregisterRobot
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
robot(impl Into<String>)
/set_robot(Option<String>)
:The Amazon Resource Name (ARN) of the robot.
- On success, responds with
DeregisterRobotOutput
with field(s):fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
robot(Option<String>)
:The Amazon Resource Name (ARN) of the robot.
- On failure, responds with
SdkError<DeregisterRobotError>
sourcepub fn describe_deployment_job(&self) -> DescribeDeploymentJob
pub fn describe_deployment_job(&self) -> DescribeDeploymentJob
Constructs a fluent builder for the DescribeDeploymentJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (ARN) of the deployment job.
- On success, responds with
DescribeDeploymentJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the deployment job.
fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
status(Option<DeploymentStatus>)
:The status of the deployment job.
deployment_config(Option<DeploymentConfig>)
:The deployment configuration.
deployment_application_configs(Option<Vec<DeploymentApplicationConfig>>)
:The deployment application configuration.
failure_reason(Option<String>)
:A short description of the reason why the deployment job failed.
failure_code(Option<DeploymentJobErrorCode>)
:The deployment job failure code.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the deployment job was created.
robot_deployment_summary(Option<Vec<RobotDeployment>>)
:A list of robot deployment summaries.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified deployment job.
- On failure, responds with
SdkError<DescribeDeploymentJobError>
sourcepub fn describe_fleet(&self) -> DescribeFleet
pub fn describe_fleet(&self) -> DescribeFleet
Constructs a fluent builder for the DescribeFleet
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
- On success, responds with
DescribeFleetOutput
with field(s):name(Option<String>)
:The name of the fleet.
arn(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
robots(Option<Vec<Robot>>)
:A list of robots.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the fleet was created.
last_deployment_status(Option<DeploymentStatus>)
:The status of the last deployment.
last_deployment_job(Option<String>)
:The Amazon Resource Name (ARN) of the last deployment job.
last_deployment_time(Option<DateTime>)
:The time of the last deployment.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified fleet.
- On failure, responds with
SdkError<DescribeFleetError>
sourcepub fn describe_robot(&self) -> DescribeRobot
pub fn describe_robot(&self) -> DescribeRobot
Constructs a fluent builder for the DescribeRobot
operation.
- The fluent builder is configurable:
robot(impl Into<String>)
/set_robot(Option<String>)
:The Amazon Resource Name (ARN) of the robot to be described.
- On success, responds with
DescribeRobotOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the robot.
name(Option<String>)
:The name of the robot.
fleet_arn(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
status(Option<RobotStatus>)
:The status of the fleet.
greengrass_group_id(Option<String>)
:The Greengrass group id.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the robot was created.
architecture(Option<Architecture>)
:The target architecture of the robot application.
last_deployment_job(Option<String>)
:The Amazon Resource Name (ARN) of the last deployment job.
last_deployment_time(Option<DateTime>)
:The time of the last deployment job.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified robot.
- On failure, responds with
SdkError<DescribeRobotError>
sourcepub fn describe_robot_application(&self) -> DescribeRobotApplication
pub fn describe_robot_application(&self) -> DescribeRobotApplication
Constructs a fluent builder for the DescribeRobotApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The Amazon Resource Name (ARN) of the robot application.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:The version of the robot application to describe.
- On success, responds with
DescribeRobotApplicationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the robot application.
name(Option<String>)
:The name of the robot application.
version(Option<String>)
:The version of the robot application.
sources(Option<Vec<Source>>)
:The sources of the robot application.
robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribution) used by the robot application.
revision_id(Option<String>)
:The revision id of the robot application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the robot application was last updated.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified robot application.
environment(Option<Environment>)
:The object that contains the Docker image URI used to create the robot application.
image_digest(Option<String>)
:A SHA256 identifier for the Docker image that you use for your robot application.
- On failure, responds with
SdkError<DescribeRobotApplicationError>
sourcepub fn describe_simulation_application(&self) -> DescribeSimulationApplication
pub fn describe_simulation_application(&self) -> DescribeSimulationApplication
Constructs a fluent builder for the DescribeSimulationApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The application information for the simulation application.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:The version of the simulation application to describe.
- On success, responds with
DescribeSimulationApplicationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the robot simulation application.
name(Option<String>)
:The name of the simulation application.
version(Option<String>)
:The version of the simulation application.
sources(Option<Vec<Source>>)
:The sources of the simulation application.
simulation_software_suite(Option<SimulationSoftwareSuite>)
:The simulation software suite used by the simulation application.
robot_software_suite(Option<RobotSoftwareSuite>)
:Information about the robot software suite (ROS distribution).
rendering_engine(Option<RenderingEngine>)
:The rendering engine for the simulation application.
revision_id(Option<String>)
:The revision id of the simulation application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation application was last updated.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified simulation application.
environment(Option<Environment>)
:The object that contains the Docker image URI used to create the simulation application.
image_digest(Option<String>)
:A SHA256 identifier for the Docker image that you use for your simulation application.
- On failure, responds with
SdkError<DescribeSimulationApplicationError>
sourcepub fn describe_simulation_job(&self) -> DescribeSimulationJob
pub fn describe_simulation_job(&self) -> DescribeSimulationJob
Constructs a fluent builder for the DescribeSimulationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (ARN) of the simulation job to be described.
- On success, responds with
DescribeSimulationJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the simulation job.
name(Option<String>)
:The name of the simulation job.
status(Option<SimulationJobStatus>)
:The status of the simulation job.
last_started_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job was last started.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job was last updated.
failure_behavior(Option<FailureBehavior>)
:The failure behavior for the simulation job.
failure_code(Option<SimulationJobErrorCode>)
:The failure code of the simulation job if it failed:
- InternalServiceError
-
Internal service error.
- RobotApplicationCrash
-
Robot application exited abnormally.
- SimulationApplicationCrash
-
Simulation application exited abnormally.
- BadPermissionsRobotApplication
-
Robot application bundle could not be downloaded.
- BadPermissionsSimulationApplication
-
Simulation application bundle could not be downloaded.
- BadPermissionsS3Output
-
Unable to publish outputs to customer-provided S3 bucket.
- BadPermissionsCloudwatchLogs
-
Unable to publish logs to customer-provided CloudWatch Logs resource.
- SubnetIpLimitExceeded
-
Subnet IP limit exceeded.
- ENILimitExceeded
-
ENI limit exceeded.
- BadPermissionsUserCredentials
-
Unable to use the Role provided.
- InvalidBundleRobotApplication
-
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
- InvalidBundleSimulationApplication
-
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
- RobotApplicationVersionMismatchedEtag
-
Etag for RobotApplication does not match value during version creation.
- SimulationApplicationVersionMismatchedEtag
-
Etag for SimulationApplication does not match value during version creation.
failure_reason(Option<String>)
:Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
output_location(Option<OutputLocation>)
:Location for output files generated by the simulation job.
logging_config(Option<LoggingConfig>)
:The logging configuration.
max_job_duration_in_seconds(i64)
:The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulation_time_millis(i64)
:The simulation job execution duration in milliseconds.
iam_role(Option<String>)
:The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
robot_applications(Option<Vec<RobotApplicationConfig>>)
:A list of robot applications.
simulation_applications(Option<Vec<SimulationApplicationConfig>>)
:A list of simulation applications.
data_sources(Option<Vec<DataSource>>)
:The data sources for the simulation job.
tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified simulation job.
vpc_config(Option<VpcConfigResponse>)
:The VPC configuration.
network_interface(Option<NetworkInterface>)
:The network interface information for the simulation job.
compute(Option<ComputeResponse>)
:Compute information for the simulation job.
- On failure, responds with
SdkError<DescribeSimulationJobError>
sourcepub fn describe_simulation_job_batch(&self) -> DescribeSimulationJobBatch
pub fn describe_simulation_job_batch(&self) -> DescribeSimulationJobBatch
Constructs a fluent builder for the DescribeSimulationJobBatch
operation.
- The fluent builder is configurable:
batch(impl Into<String>)
/set_batch(Option<String>)
:The id of the batch to describe.
- On success, responds with
DescribeSimulationJobBatchOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the batch.
status(Option<SimulationJobBatchStatus>)
:The status of the batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job batch was last updated.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job batch was created.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
batch_policy(Option<BatchPolicy>)
:The batch policy.
failure_code(Option<SimulationJobBatchErrorCode>)
:The failure code of the simulation job batch.
failure_reason(Option<String>)
:The reason the simulation job batch failed.
failed_requests(Option<Vec<FailedCreateSimulationJobRequest>>)
:A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
pending_requests(Option<Vec<SimulationJobRequest>>)
:A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
created_requests(Option<Vec<SimulationJobSummary>>)
:A list of created simulation job summaries.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the simulation job batch.
- On failure, responds with
SdkError<DescribeSimulationJobBatchError>
sourcepub fn describe_world(&self) -> DescribeWorld
pub fn describe_world(&self) -> DescribeWorld
Constructs a fluent builder for the DescribeWorld
operation.
- The fluent builder is configurable:
world(impl Into<String>)
/set_world(Option<String>)
:The Amazon Resource Name (arn) of the world you want to describe.
- On success, responds with
DescribeWorldOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (arn) of the world.
generation_job(Option<String>)
:The Amazon Resource Name (arn) of the world generation job that generated the world.
template(Option<String>)
:The world template.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world was created.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world.
world_description_body(Option<String>)
:Returns the JSON formatted string that describes the contents of your world.
- On failure, responds with
SdkError<DescribeWorldError>
sourcepub fn describe_world_export_job(&self) -> DescribeWorldExportJob
pub fn describe_world_export_job(&self) -> DescribeWorldExportJob
Constructs a fluent builder for the DescribeWorldExportJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (arn) of the world export job to describe.
- On success, responds with
DescribeWorldExportJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the world export job.
status(Option<WorldExportJobStatus>)
:The status of the world export job.
- Pending
-
The world export job request is pending.
- Running
-
The world export job is running.
- Completed
-
The world export job completed.
- Failed
-
The world export job failed. See
failureCode
andfailureReason
for more information. - Canceled
-
The world export job was cancelled.
- Canceling
-
The world export job is being cancelled.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world export job was created.
failure_code(Option<WorldExportJobErrorCode>)
:The failure code of the world export job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
failure_reason(Option<String>)
:The reason why the world export job failed.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
worlds(Option<Vec<String>>)
:A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
output_location(Option<OutputLocation>)
:The output location.
iam_role(Option<String>)
:The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world export job.
- On failure, responds with
SdkError<DescribeWorldExportJobError>
sourcepub fn describe_world_generation_job(&self) -> DescribeWorldGenerationJob
pub fn describe_world_generation_job(&self) -> DescribeWorldGenerationJob
Constructs a fluent builder for the DescribeWorldGenerationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (arn) of the world generation job to describe.
- On success, responds with
DescribeWorldGenerationJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the world generation job.
status(Option<WorldGenerationJobStatus>)
:The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCode
for more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world generation job was created.
failure_code(Option<WorldGenerationJobErrorCode>)
:The failure code of the world generation job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
failure_reason(Option<String>)
:The reason why the world generation job failed.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
template(Option<String>)
:The Amazon Resource Name (arn) of the world template.
world_count(Option<WorldCount>)
:Information about the world count.
finished_worlds_summary(Option<FinishedWorldsSummary>)
:Summary information about finished worlds.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world generation job.
world_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the generated worlds.
- On failure, responds with
SdkError<DescribeWorldGenerationJobError>
sourcepub fn describe_world_template(&self) -> DescribeWorldTemplate
pub fn describe_world_template(&self) -> DescribeWorldTemplate
Constructs a fluent builder for the DescribeWorldTemplate
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:The Amazon Resource Name (arn) of the world template you want to describe.
- On success, responds with
DescribeWorldTemplateOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the world template.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
name(Option<String>)
:The name of the world template.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world template was created.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world template was last updated.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the world template.
version(Option<String>)
:The version of the world template that you’re using.
- On failure, responds with
SdkError<DescribeWorldTemplateError>
sourcepub fn get_world_template_body(&self) -> GetWorldTemplateBody
pub fn get_world_template_body(&self) -> GetWorldTemplateBody
Constructs a fluent builder for the GetWorldTemplateBody
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:The Amazon Resource Name (arn) of the world template.
generation_job(impl Into<String>)
/set_generation_job(Option<String>)
:The Amazon Resource Name (arn) of the world generator job.
- On success, responds with
GetWorldTemplateBodyOutput
with field(s):template_body(Option<String>)
:The world template body.
- On failure, responds with
SdkError<GetWorldTemplateBodyError>
sourcepub fn list_deployment_jobs(&self) -> ListDeploymentJobs
pub fn list_deployment_jobs(&self) -> ListDeploymentJobs
Constructs a fluent builder for the ListDeploymentJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results.
The filter names
status
andfleetName
are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusInProgress
or the statusPending
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListDeploymentJobs
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListDeploymentJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListDeploymentJobs
request with the returnednextToken
value. This value can be between 1 and 200. If this parameter is not used, thenListDeploymentJobs
returns up to 200 results and anextToken
value if applicable.
- On success, responds with
ListDeploymentJobsOutput
with field(s):deployment_jobs(Option<Vec<DeploymentJob>>)
:A list of deployment jobs that meet the criteria of the request.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListDeploymentJobs
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListDeploymentJobsError>
sourcepub fn list_fleets(&self) -> ListFleets
pub fn list_fleets(&self) -> ListFleets
Constructs a fluent builder for the ListFleets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListFleets
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListFleets
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListFleets
request with the returnednextToken
value. This value can be between 1 and 200. If this parameter is not used, thenListFleets
returns up to 200 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results.
The filter name
name
is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
- On success, responds with
ListFleetsOutput
with field(s):fleet_details(Option<Vec<Fleet>>)
:A list of fleet details meeting the request criteria.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListFleets
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListFleetsError>
sourcepub fn list_robot_applications(&self) -> ListRobotApplications
pub fn list_robot_applications(&self) -> ListRobotApplications
Constructs a fluent builder for the ListRobotApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
version_qualifier(impl Into<String>)
/set_version_qualifier(Option<String>)
:The version qualifier of the robot application.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListRobotApplications
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListRobotApplications
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListRobotApplications
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListRobotApplications
returns up to 100 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results.
The filter name
name
is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
- On success, responds with
ListRobotApplicationsOutput
with field(s):robot_application_summaries(Option<Vec<RobotApplicationSummary>>)
:A list of robot application summaries that meet the criteria of the request.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListRobotApplications
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListRobotApplicationsError>
sourcepub fn list_robots(&self) -> ListRobots
pub fn list_robots(&self) -> ListRobots
Constructs a fluent builder for the ListRobots
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListRobots
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListRobots
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListRobots
request with the returnednextToken
value. This value can be between 1 and 200. If this parameter is not used, thenListRobots
returns up to 200 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results.
The filter names
status
andfleetName
are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusRegistered
or the statusAvailable
.
- On success, responds with
ListRobotsOutput
with field(s):robots(Option<Vec<Robot>>)
:A list of robots that meet the criteria of the request.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListRobots
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListRobotsError>
sourcepub fn list_simulation_applications(&self) -> ListSimulationApplications
pub fn list_simulation_applications(&self) -> ListSimulationApplications
Constructs a fluent builder for the ListSimulationApplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
version_qualifier(impl Into<String>)
/set_version_qualifier(Option<String>)
:The version qualifier of the simulation application.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListSimulationApplications
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListSimulationApplications
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListSimulationApplications
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListSimulationApplications
returns up to 100 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional list of filters to limit results.
The filter name
name
is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
- On success, responds with
ListSimulationApplicationsOutput
with field(s):simulation_application_summaries(Option<Vec<SimulationApplicationSummary>>)
:A list of simulation application summaries that meet the criteria of the request.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListSimulationApplications
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListSimulationApplicationsError>
sourcepub fn list_simulation_job_batches(&self) -> ListSimulationJobBatches
pub fn list_simulation_job_batches(&self) -> ListSimulationJobBatches
Constructs a fluent builder for the ListSimulationJobBatches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListSimulationJobBatches
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListSimulationJobBatches
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListSimulationJobBatches
request with the returnednextToken
value.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results.
- On success, responds with
ListSimulationJobBatchesOutput
with field(s):simulation_job_batch_summaries(Option<Vec<SimulationJobBatchSummary>>)
:A list of simulation job batch summaries.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListSimulationJobBatches
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListSimulationJobBatchesError>
sourcepub fn list_simulation_jobs(&self) -> ListSimulationJobs
pub fn list_simulation_jobs(&self) -> ListSimulationJobs
Constructs a fluent builder for the ListSimulationJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListSimulationJobs
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListSimulationJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListSimulationJobs
request with the returnednextToken
value. This value can be between 1 and 1000. If this parameter is not used, thenListSimulationJobs
returns up to 1000 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results.
The filter names
status
andsimulationApplicationName
androbotApplicationName
are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the statusPreparing
or the statusRunning
.
- On success, responds with
ListSimulationJobsOutput
with field(s):simulation_job_summaries(Option<Vec<SimulationJobSummary>>)
:A list of simulation job summaries that meet the criteria of the request.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListSimulationJobs
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListSimulationJobsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:The list of all tags added to the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn list_world_export_jobs(&self) -> ListWorldExportJobs
pub fn list_world_export_jobs(&self) -> ListWorldExportJobs
Constructs a fluent builder for the ListWorldExportJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorldExportJobs
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListWorldExportJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListWorldExportJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListWorldExportJobs
returns up to 100 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results. You can use
generationJobId
andtemplateId
.
- On success, responds with
ListWorldExportJobsOutput
with field(s):world_export_job_summaries(Option<Vec<WorldExportJobSummary>>)
:Summary information for world export jobs.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorldExportJobsRequest
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListWorldExportJobsError>
sourcepub fn list_world_generation_jobs(&self) -> ListWorldGenerationJobs
pub fn list_world_generation_jobs(&self) -> ListWorldGenerationJobs
Constructs a fluent builder for the ListWorldGenerationJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorldGenerationJobsRequest
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListWorldGeneratorJobs
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListWorldGeneratorJobs
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListWorldGeneratorJobs
returns up to 100 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results. You can use
status
andtemplateId
.
- On success, responds with
ListWorldGenerationJobsOutput
with field(s):world_generation_job_summaries(Option<Vec<WorldGenerationJobSummary>>)
:Summary information for world generator jobs.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorldGeneratorJobsRequest
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListWorldGenerationJobsError>
sourcepub fn list_worlds(&self) -> ListWorlds
pub fn list_worlds(&self) -> ListWorlds
Constructs a fluent builder for the ListWorlds
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorlds
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListWorlds
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListWorlds
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListWorlds
returns up to 100 results and anextToken
value if applicable.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Optional filters to limit results. You can use
status
.
- On success, responds with
ListWorldsOutput
with field(s):world_summaries(Option<Vec<WorldSummary>>)
:Summary information for worlds.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorlds
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListWorldsError>
sourcepub fn list_world_templates(&self) -> ListWorldTemplates
pub fn list_world_templates(&self) -> ListWorldTemplates
Constructs a fluent builder for the ListWorldTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorldTemplates
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.max_results(i32)
/set_max_results(Option<i32>)
:When this parameter is used,
ListWorldTemplates
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListWorldTemplates
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListWorldTemplates
returns up to 100 results and anextToken
value if applicable.
- On success, responds with
ListWorldTemplatesOutput
with field(s):template_summaries(Option<Vec<TemplateSummary>>)
:Summary information for templates.
next_token(Option<String>)
:If the previous paginated request did not return all of the remaining results, the response object’s
nextToken
parameter value is set to a token. To retrieve the next set of results, callListWorldTemplates
again and assign that token to the request object’snextToken
parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.
- On failure, responds with
SdkError<ListWorldTemplatesError>
sourcepub fn register_robot(&self) -> RegisterRobot
pub fn register_robot(&self) -> RegisterRobot
Constructs a fluent builder for the RegisterRobot
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
robot(impl Into<String>)
/set_robot(Option<String>)
:The Amazon Resource Name (ARN) of the robot.
- On success, responds with
RegisterRobotOutput
with field(s):fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet that the robot will join.
robot(Option<String>)
:Information about the robot registration.
- On failure, responds with
SdkError<RegisterRobotError>
sourcepub fn restart_simulation_job(&self) -> RestartSimulationJob
pub fn restart_simulation_job(&self) -> RestartSimulationJob
Constructs a fluent builder for the RestartSimulationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:The Amazon Resource Name (ARN) of the simulation job.
- On success, responds with
RestartSimulationJobOutput
- On failure, responds with
SdkError<RestartSimulationJobError>
sourcepub fn start_simulation_job_batch(&self) -> StartSimulationJobBatch
pub fn start_simulation_job_batch(&self) -> StartSimulationJobBatch
Constructs a fluent builder for the StartSimulationJobBatch
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
batch_policy(BatchPolicy)
/set_batch_policy(Option<BatchPolicy>)
:The batch policy.
create_simulation_job_requests(Vec<SimulationJobRequest>)
/set_create_simulation_job_requests(Option<Vec<SimulationJobRequest>>)
:A list of simulation job requests to create in the batch.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the deployment job batch.
- On success, responds with
StartSimulationJobBatchOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (arn) of the batch.
status(Option<SimulationJobBatchStatus>)
:The status of the simulation job batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation job batch was created.
client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
batch_policy(Option<BatchPolicy>)
:The batch policy.
failure_code(Option<SimulationJobBatchErrorCode>)
:The failure code if the simulation job batch failed.
failure_reason(Option<String>)
:The reason the simulation job batch failed.
failed_requests(Option<Vec<FailedCreateSimulationJobRequest>>)
:A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
pending_requests(Option<Vec<SimulationJobRequest>>)
:A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
created_requests(Option<Vec<SimulationJobSummary>>)
:A list of created simulation job request summaries.
tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the deployment job batch.
- On failure, responds with
SdkError<StartSimulationJobBatchError>
sourcepub fn sync_deployment_job(&self) -> SyncDeploymentJob
pub fn sync_deployment_job(&self) -> SyncDeploymentJob
Constructs a fluent builder for the SyncDeploymentJob
operation.
- The fluent builder is configurable:
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
fleet(impl Into<String>)
/set_fleet(Option<String>)
:The target fleet for the synchronization.
- On success, responds with
SyncDeploymentJobOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the synchronization request.
fleet(Option<String>)
:The Amazon Resource Name (ARN) of the fleet.
status(Option<DeploymentStatus>)
:The status of the synchronization job.
deployment_config(Option<DeploymentConfig>)
:Information about the deployment configuration.
deployment_application_configs(Option<Vec<DeploymentApplicationConfig>>)
:Information about the deployment application configurations.
failure_reason(Option<String>)
:The failure reason if the job fails.
failure_code(Option<DeploymentJobErrorCode>)
:The failure code if the job fails:
- InternalServiceError
-
Internal service error.
- RobotApplicationCrash
-
Robot application exited abnormally.
- SimulationApplicationCrash
-
Simulation application exited abnormally.
- BadPermissionsRobotApplication
-
Robot application bundle could not be downloaded.
- BadPermissionsSimulationApplication
-
Simulation application bundle could not be downloaded.
- BadPermissionsS3Output
-
Unable to publish outputs to customer-provided S3 bucket.
- BadPermissionsCloudwatchLogs
-
Unable to publish logs to customer-provided CloudWatch Logs resource.
- SubnetIpLimitExceeded
-
Subnet IP limit exceeded.
- ENILimitExceeded
-
ENI limit exceeded.
- BadPermissionsUserCredentials
-
Unable to use the Role provided.
- InvalidBundleRobotApplication
-
Robot bundle cannot be extracted (invalid format, bundling error, or other issue).
- InvalidBundleSimulationApplication
-
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).
- RobotApplicationVersionMismatchedEtag
-
Etag for RobotApplication does not match value during version creation.
- SimulationApplicationVersionMismatchedEtag
-
Etag for SimulationApplication does not match value during version creation.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the fleet was created.
- On failure, responds with
SdkError<SyncDeploymentJobError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A map that contains tag keys and tag values that are attached to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A map that contains tag keys and tag values that will be unattached from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_robot_application(&self) -> UpdateRobotApplication
pub fn update_robot_application(&self) -> UpdateRobotApplication
Constructs a fluent builder for the UpdateRobotApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The application information for the robot application.
sources(Vec<SourceConfig>)
/set_sources(Option<Vec<SourceConfig>>)
:The sources of the robot application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribution) used by the robot application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:The revision id for the robot application.
environment(Environment)
/set_environment(Option<Environment>)
:The object that contains the Docker image URI for your robot application.
- On success, responds with
UpdateRobotApplicationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the updated robot application.
name(Option<String>)
:The name of the robot application.
version(Option<String>)
:The version of the robot application.
sources(Option<Vec<Source>>)
:The sources of the robot application.
robot_software_suite(Option<RobotSoftwareSuite>)
:The robot software suite (ROS distribution) used by the robot application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the robot application was last updated.
revision_id(Option<String>)
:The revision id of the robot application.
environment(Option<Environment>)
:The object that contains the Docker image URI for your robot application.
- On failure, responds with
SdkError<UpdateRobotApplicationError>
sourcepub fn update_simulation_application(&self) -> UpdateSimulationApplication
pub fn update_simulation_application(&self) -> UpdateSimulationApplication
Constructs a fluent builder for the UpdateSimulationApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:The application information for the simulation application.
sources(Vec<SourceConfig>)
/set_sources(Option<Vec<SourceConfig>>)
:The sources of the simulation application.
simulation_software_suite(SimulationSoftwareSuite)
/set_simulation_software_suite(Option<SimulationSoftwareSuite>)
:The simulation software suite used by the simulation application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:Information about the robot software suite (ROS distribution).
rendering_engine(RenderingEngine)
/set_rendering_engine(Option<RenderingEngine>)
:The rendering engine for the simulation application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:The revision id for the robot application.
environment(Environment)
/set_environment(Option<Environment>)
:The object that contains the Docker image URI for your simulation application.
- On success, responds with
UpdateSimulationApplicationOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the updated simulation application.
name(Option<String>)
:The name of the simulation application.
version(Option<String>)
:The version of the robot application.
sources(Option<Vec<Source>>)
:The sources of the simulation application.
simulation_software_suite(Option<SimulationSoftwareSuite>)
:The simulation software suite used by the simulation application.
robot_software_suite(Option<RobotSoftwareSuite>)
:Information about the robot software suite (ROS distribution).
rendering_engine(Option<RenderingEngine>)
:The rendering engine for the simulation application.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the simulation application was last updated.
revision_id(Option<String>)
:The revision id of the simulation application.
environment(Option<Environment>)
:The object that contains the Docker image URI used for your simulation application.
- On failure, responds with
SdkError<UpdateSimulationApplicationError>
sourcepub fn update_world_template(&self) -> UpdateWorldTemplate
pub fn update_world_template(&self) -> UpdateWorldTemplate
Constructs a fluent builder for the UpdateWorldTemplate
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:The Amazon Resource Name (arn) of the world template to update.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the template.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:The world template body.
template_location(TemplateLocation)
/set_template_location(Option<TemplateLocation>)
:The location of the world template.
- On success, responds with
UpdateWorldTemplateOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (arn) of the world template.
name(Option<String>)
:The name of the world template.
created_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world template was created.
last_updated_at(Option<DateTime>)
:The time, in milliseconds since the epoch, when the world template was last updated.
- On failure, responds with
SdkError<UpdateWorldTemplateError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more