Struct aws_sdk_robomaker::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.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_robomaker::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_robomaker::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CancelDeploymentJob
operation has
a Client::cancel_deployment_job
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.cancel_deployment_job()
.job("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn batch_delete_worlds(&self) -> BatchDeleteWorldsFluentBuilder
pub fn batch_delete_worlds(&self) -> BatchDeleteWorldsFluentBuilder
Constructs a fluent builder for the BatchDeleteWorlds
operation.
- The fluent builder is configurable:
worlds(impl Into<String>)
/set_worlds(Option<Vec::<String>>)
:
required: trueA 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>
source§impl Client
impl Client
sourcepub fn batch_describe_simulation_job(
&self
) -> BatchDescribeSimulationJobFluentBuilder
pub fn batch_describe_simulation_job( &self ) -> BatchDescribeSimulationJobFluentBuilder
Constructs a fluent builder for the BatchDescribeSimulationJob
operation.
- The fluent builder is configurable:
jobs(impl Into<String>)
/set_jobs(Option<Vec::<String>>)
:
required: trueA 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>
source§impl Client
impl Client
sourcepub fn cancel_deployment_job(&self) -> CancelDeploymentJobFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn cancel_deployment_job(&self) -> CancelDeploymentJobFluentBuilder
Constructs a fluent builder for the CancelDeploymentJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe deployment job ARN to cancel.
- On success, responds with
CancelDeploymentJobOutput
- On failure, responds with
SdkError<CancelDeploymentJobError>
source§impl Client
impl Client
sourcepub fn cancel_simulation_job(&self) -> CancelSimulationJobFluentBuilder
pub fn cancel_simulation_job(&self) -> CancelSimulationJobFluentBuilder
Constructs a fluent builder for the CancelSimulationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe simulation job ARN to cancel.
- On success, responds with
CancelSimulationJobOutput
- On failure, responds with
SdkError<CancelSimulationJobError>
source§impl Client
impl Client
sourcepub fn cancel_simulation_job_batch(
&self
) -> CancelSimulationJobBatchFluentBuilder
pub fn cancel_simulation_job_batch( &self ) -> CancelSimulationJobBatchFluentBuilder
Constructs a fluent builder for the CancelSimulationJobBatch
operation.
- The fluent builder is configurable:
batch(impl Into<String>)
/set_batch(Option<String>)
:
required: trueThe id of the batch to cancel.
- On success, responds with
CancelSimulationJobBatchOutput
- On failure, responds with
SdkError<CancelSimulationJobBatchError>
source§impl Client
impl Client
sourcepub fn cancel_world_export_job(&self) -> CancelWorldExportJobFluentBuilder
pub fn cancel_world_export_job(&self) -> CancelWorldExportJobFluentBuilder
Constructs a fluent builder for the CancelWorldExportJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe Amazon Resource Name (arn) of the world export job to cancel.
- On success, responds with
CancelWorldExportJobOutput
- On failure, responds with
SdkError<CancelWorldExportJobError>
source§impl Client
impl Client
sourcepub fn cancel_world_generation_job(
&self
) -> CancelWorldGenerationJobFluentBuilder
pub fn cancel_world_generation_job( &self ) -> CancelWorldGenerationJobFluentBuilder
Constructs a fluent builder for the CancelWorldGenerationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe Amazon Resource Name (arn) of the world generator job to cancel.
- On success, responds with
CancelWorldGenerationJobOutput
- On failure, responds with
SdkError<CancelWorldGenerationJobError>
source§impl Client
impl Client
sourcepub fn create_deployment_job(&self) -> CreateDeploymentJobFluentBuilder
👎Deprecated: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn create_deployment_job(&self) -> CreateDeploymentJobFluentBuilder
Constructs a fluent builder for the CreateDeploymentJob
operation.
- The fluent builder is configurable:
deployment_config(DeploymentConfig)
/set_deployment_config(Option<DeploymentConfig>)
:
required: falseThe requested deployment configuration.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: trueUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
fleet(impl Into<String>)
/set_fleet(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet to deploy.
deployment_application_configs(DeploymentApplicationConfig)
/set_deployment_application_configs(Option<Vec::<DeploymentApplicationConfig>>)
:
required: trueThe deployment application configuration.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_fleet(&self) -> CreateFleetFluentBuilder
👎Deprecated: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn create_fleet(&self) -> CreateFleetFluentBuilder
Constructs a fluent builder for the CreateFleet
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the fleet.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_robot(&self) -> CreateRobotFluentBuilder
👎Deprecated: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn create_robot(&self) -> CreateRobotFluentBuilder
Constructs a fluent builder for the CreateRobot
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name for the robot.
architecture(Architecture)
/set_architecture(Option<Architecture>)
:
required: trueThe target architecture of the robot.
greengrass_group_id(impl Into<String>)
/set_greengrass_group_id(Option<String>)
:
required: trueThe Greengrass group id.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_robot_application(&self) -> CreateRobotApplicationFluentBuilder
pub fn create_robot_application(&self) -> CreateRobotApplicationFluentBuilder
Constructs a fluent builder for the CreateRobotApplication
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the robot application.
sources(SourceConfig)
/set_sources(Option<Vec::<SourceConfig>>)
:
required: falseThe sources of the robot application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:
required: trueThe robot software suite (ROS distribuition) used by the robot application.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA map that contains tag keys and tag values that are attached to the robot application.
environment(Environment)
/set_environment(Option<Environment>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_robot_application_version(
&self
) -> CreateRobotApplicationVersionFluentBuilder
pub fn create_robot_application_version( &self ) -> CreateRobotApplicationVersionFluentBuilder
Constructs a fluent builder for the CreateRobotApplicationVersion
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe application information for the robot application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:
required: falseThe 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(impl Into<String>)
/set_s3_etags(Option<Vec::<String>>)
:
required: falseThe 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>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_simulation_application(
&self
) -> CreateSimulationApplicationFluentBuilder
pub fn create_simulation_application( &self ) -> CreateSimulationApplicationFluentBuilder
Constructs a fluent builder for the CreateSimulationApplication
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the simulation application.
sources(SourceConfig)
/set_sources(Option<Vec::<SourceConfig>>)
:
required: falseThe sources of the simulation application.
simulation_software_suite(SimulationSoftwareSuite)
/set_simulation_software_suite(Option<SimulationSoftwareSuite>)
:
required: trueThe simulation software suite used by the simulation application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:
required: trueThe robot software suite (ROS distribution) used by the simulation application.
rendering_engine(RenderingEngine)
/set_rendering_engine(Option<RenderingEngine>)
:
required: falseThe rendering engine for the simulation application.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA map that contains tag keys and tag values that are attached to the simulation application.
environment(Environment)
/set_environment(Option<Environment>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_simulation_application_version(
&self
) -> CreateSimulationApplicationVersionFluentBuilder
pub fn create_simulation_application_version( &self ) -> CreateSimulationApplicationVersionFluentBuilder
Constructs a fluent builder for the CreateSimulationApplicationVersion
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe application information for the simulation application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:
required: falseThe 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(impl Into<String>)
/set_s3_etags(Option<Vec::<String>>)
:
required: falseThe 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_simulation_job(&self) -> CreateSimulationJobFluentBuilder
pub fn create_simulation_job(&self) -> CreateSimulationJobFluentBuilder
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>)
:
required: falseUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
output_location(OutputLocation)
/set_output_location(Option<OutputLocation>)
:
required: falseLocation for output files generated by the simulation job.
logging_config(LoggingConfig)
/set_logging_config(Option<LoggingConfig>)
:
required: falseThe logging configuration.
max_job_duration_in_seconds(i64)
/set_max_job_duration_in_seconds(Option<i64>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: falseThe 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(RobotApplicationConfig)
/set_robot_applications(Option<Vec::<RobotApplicationConfig>>)
:
required: falseThe robot application to use in the simulation job.
simulation_applications(SimulationApplicationConfig)
/set_simulation_applications(Option<Vec::<SimulationApplicationConfig>>)
:
required: falseThe simulation application to use in the simulation job.
data_sources(DataSourceConfig)
/set_data_sources(Option<Vec::<DataSourceConfig>>)
:
required: falseSpecify 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(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA map that contains tag keys and tag values that are attached to the simulation job.
vpc_config(VpcConfig)
/set_vpc_config(Option<VpcConfig>)
:
required: falseIf 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>)
:
required: falseCompute 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>
source§impl Client
impl Client
sourcepub fn create_world_export_job(&self) -> CreateWorldExportJobFluentBuilder
pub fn create_world_export_job(&self) -> CreateWorldExportJobFluentBuilder
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>)
:
required: falseUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
worlds(impl Into<String>)
/set_worlds(Option<Vec::<String>>)
:
required: trueA list of Amazon Resource Names (arns) that correspond to worlds to export.
output_location(OutputLocation)
/set_output_location(Option<OutputLocation>)
:
required: trueThe output location.
iam_role(impl Into<String>)
/set_iam_role(Option<String>)
:
required: trueThe IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_world_generation_job(
&self
) -> CreateWorldGenerationJobFluentBuilder
pub fn create_world_generation_job( &self ) -> CreateWorldGenerationJobFluentBuilder
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>)
:
required: falseUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
template(impl Into<String>)
/set_template(Option<String>)
:
required: trueThe Amazon Resource Name (arn) of the world template describing the worlds you want to create.
world_count(WorldCount)
/set_world_count(Option<WorldCount>)
:
required: trueInformation about the world count.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA map that contains tag keys and tag values that are attached to the world generator job.
world_tags(impl Into<String>, impl Into<String>)
/set_world_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_world_template(&self) -> CreateWorldTemplateFluentBuilder
pub fn create_world_template(&self) -> CreateWorldTemplateFluentBuilder
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>)
:
required: falseUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the world template.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:
required: falseThe world template body.
template_location(TemplateLocation)
/set_template_location(Option<TemplateLocation>)
:
required: falseThe location of the world template.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn delete_fleet(&self) -> DeleteFleetFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder
Constructs a fluent builder for the DeleteFleet
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet.
- On success, responds with
DeleteFleetOutput
- On failure, responds with
SdkError<DeleteFleetError>
source§impl Client
impl Client
sourcepub fn delete_robot(&self) -> DeleteRobotFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn delete_robot(&self) -> DeleteRobotFluentBuilder
Constructs a fluent builder for the DeleteRobot
operation.
- The fluent builder is configurable:
robot(impl Into<String>)
/set_robot(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the robot.
- On success, responds with
DeleteRobotOutput
- On failure, responds with
SdkError<DeleteRobotError>
source§impl Client
impl Client
sourcepub fn delete_robot_application(&self) -> DeleteRobotApplicationFluentBuilder
pub fn delete_robot_application(&self) -> DeleteRobotApplicationFluentBuilder
Constructs a fluent builder for the DeleteRobotApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the the robot application.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:
required: falseThe version of the robot application to delete.
- On success, responds with
DeleteRobotApplicationOutput
- On failure, responds with
SdkError<DeleteRobotApplicationError>
source§impl Client
impl Client
sourcepub fn delete_simulation_application(
&self
) -> DeleteSimulationApplicationFluentBuilder
pub fn delete_simulation_application( &self ) -> DeleteSimulationApplicationFluentBuilder
Constructs a fluent builder for the DeleteSimulationApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe application information for the simulation application to delete.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:
required: falseThe version of the simulation application to delete.
- On success, responds with
DeleteSimulationApplicationOutput
- On failure, responds with
SdkError<DeleteSimulationApplicationError>
source§impl Client
impl Client
sourcepub fn delete_world_template(&self) -> DeleteWorldTemplateFluentBuilder
pub fn delete_world_template(&self) -> DeleteWorldTemplateFluentBuilder
Constructs a fluent builder for the DeleteWorldTemplate
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:
required: trueThe Amazon Resource Name (arn) of the world template you want to delete.
- On success, responds with
DeleteWorldTemplateOutput
- On failure, responds with
SdkError<DeleteWorldTemplateError>
source§impl Client
impl Client
sourcepub fn deregister_robot(&self) -> DeregisterRobotFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn deregister_robot(&self) -> DeregisterRobotFluentBuilder
Constructs a fluent builder for the DeregisterRobot
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet.
robot(impl Into<String>)
/set_robot(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_deployment_job(&self) -> DescribeDeploymentJobFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn describe_deployment_job(&self) -> DescribeDeploymentJobFluentBuilder
Constructs a fluent builder for the DescribeDeploymentJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_fleet(&self) -> DescribeFleetFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn describe_fleet(&self) -> DescribeFleetFluentBuilder
Constructs a fluent builder for the DescribeFleet
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_robot(&self) -> DescribeRobotFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn describe_robot(&self) -> DescribeRobotFluentBuilder
Constructs a fluent builder for the DescribeRobot
operation.
- The fluent builder is configurable:
robot(impl Into<String>)
/set_robot(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_robot_application(
&self
) -> DescribeRobotApplicationFluentBuilder
pub fn describe_robot_application( &self ) -> DescribeRobotApplicationFluentBuilder
Constructs a fluent builder for the DescribeRobotApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the robot application.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_simulation_application(
&self
) -> DescribeSimulationApplicationFluentBuilder
pub fn describe_simulation_application( &self ) -> DescribeSimulationApplicationFluentBuilder
Constructs a fluent builder for the DescribeSimulationApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe application information for the simulation application.
application_version(impl Into<String>)
/set_application_version(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_simulation_job(&self) -> DescribeSimulationJobFluentBuilder
pub fn describe_simulation_job(&self) -> DescribeSimulationJobFluentBuilder
Constructs a fluent builder for the DescribeSimulationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_simulation_job_batch(
&self
) -> DescribeSimulationJobBatchFluentBuilder
pub fn describe_simulation_job_batch( &self ) -> DescribeSimulationJobBatchFluentBuilder
Constructs a fluent builder for the DescribeSimulationJobBatch
operation.
- The fluent builder is configurable:
batch(impl Into<String>)
/set_batch(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_world(&self) -> DescribeWorldFluentBuilder
pub fn describe_world(&self) -> DescribeWorldFluentBuilder
Constructs a fluent builder for the DescribeWorld
operation.
- The fluent builder is configurable:
world(impl Into<String>)
/set_world(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_world_export_job(&self) -> DescribeWorldExportJobFluentBuilder
pub fn describe_world_export_job(&self) -> DescribeWorldExportJobFluentBuilder
Constructs a fluent builder for the DescribeWorldExportJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_world_generation_job(
&self
) -> DescribeWorldGenerationJobFluentBuilder
pub fn describe_world_generation_job( &self ) -> DescribeWorldGenerationJobFluentBuilder
Constructs a fluent builder for the DescribeWorldGenerationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn describe_world_template(&self) -> DescribeWorldTemplateFluentBuilder
pub fn describe_world_template(&self) -> DescribeWorldTemplateFluentBuilder
Constructs a fluent builder for the DescribeWorldTemplate
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn get_world_template_body(&self) -> GetWorldTemplateBodyFluentBuilder
pub fn get_world_template_body(&self) -> GetWorldTemplateBodyFluentBuilder
Constructs a fluent builder for the GetWorldTemplateBody
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:
required: falseThe Amazon Resource Name (arn) of the world template.
generation_job(impl Into<String>)
/set_generation_job(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_deployment_jobs(&self) -> ListDeploymentJobsFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn list_deployment_jobs(&self) -> ListDeploymentJobsFluentBuilder
Constructs a fluent builder for the ListDeploymentJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>)
:
required: falseIf 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>)
:
required: falseWhen 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>
source§impl Client
impl Client
sourcepub fn list_fleets(&self) -> ListFleetsFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn list_fleets(&self) -> ListFleetsFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>
source§impl Client
impl Client
sourcepub fn list_robot_applications(&self) -> ListRobotApplicationsFluentBuilder
pub fn list_robot_applications(&self) -> ListRobotApplicationsFluentBuilder
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>)
:
required: falseThe version qualifier of the robot application.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>
source§impl Client
impl Client
sourcepub fn list_robots(&self) -> ListRobotsFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn list_robots(&self) -> ListRobotsFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>
source§impl Client
impl Client
sourcepub fn list_simulation_applications(
&self
) -> ListSimulationApplicationsFluentBuilder
pub fn list_simulation_applications( &self ) -> ListSimulationApplicationsFluentBuilder
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>)
:
required: falseThe version qualifier of the simulation application.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>
source§impl Client
impl Client
sourcepub fn list_simulation_job_batches(
&self
) -> ListSimulationJobBatchesFluentBuilder
pub fn list_simulation_job_batches( &self ) -> ListSimulationJobBatchesFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>
source§impl Client
impl Client
sourcepub fn list_simulation_jobs(&self) -> ListSimulationJobsFluentBuilder
pub fn list_simulation_jobs(&self) -> ListSimulationJobsFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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(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>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn list_world_export_jobs(&self) -> ListWorldExportJobsFluentBuilder
pub fn list_world_export_jobs(&self) -> ListWorldExportJobsFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional filters to limit results. You can use
generationJobId
andtemplateId
.
- On success, responds with
ListWorldExportJobsOutput
with field(s):world_export_job_summaries(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>
source§impl Client
impl Client
sourcepub fn list_world_generation_jobs(&self) -> ListWorldGenerationJobsFluentBuilder
pub fn list_world_generation_jobs(&self) -> ListWorldGenerationJobsFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional filters to limit results. You can use
status
andtemplateId
.
- On success, responds with
ListWorldGenerationJobsOutput
with field(s):world_generation_job_summaries(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>
source§impl Client
impl Client
sourcepub fn list_world_templates(&self) -> ListWorldTemplatesFluentBuilder
pub fn list_world_templates(&self) -> ListWorldTemplatesFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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>
source§impl Client
impl Client
sourcepub fn list_worlds(&self) -> ListWorldsFluentBuilder
pub fn list_worlds(&self) -> ListWorldsFluentBuilder
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>)
:
required: falseIf 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>)
:
required: falseWhen 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseOptional 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>
source§impl Client
impl Client
sourcepub fn register_robot(&self) -> RegisterRobotFluentBuilder
👎Deprecated: AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn register_robot(&self) -> RegisterRobotFluentBuilder
Constructs a fluent builder for the RegisterRobot
operation.
- The fluent builder is configurable:
fleet(impl Into<String>)
/set_fleet(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the fleet.
robot(impl Into<String>)
/set_robot(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn restart_simulation_job(&self) -> RestartSimulationJobFluentBuilder
pub fn restart_simulation_job(&self) -> RestartSimulationJobFluentBuilder
Constructs a fluent builder for the RestartSimulationJob
operation.
- The fluent builder is configurable:
job(impl Into<String>)
/set_job(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the simulation job.
- On success, responds with
RestartSimulationJobOutput
- On failure, responds with
SdkError<RestartSimulationJobError>
source§impl Client
impl Client
sourcepub fn start_simulation_job_batch(&self) -> StartSimulationJobBatchFluentBuilder
pub fn start_simulation_job_batch(&self) -> StartSimulationJobBatchFluentBuilder
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>)
:
required: falseUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
batch_policy(BatchPolicy)
/set_batch_policy(Option<BatchPolicy>)
:
required: falseThe batch policy.
create_simulation_job_requests(SimulationJobRequest)
/set_create_simulation_job_requests(Option<Vec::<SimulationJobRequest>>)
:
required: trueA list of simulation job requests to create in the batch.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn sync_deployment_job(&self) -> SyncDeploymentJobFluentBuilder
👎Deprecated: Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html.
pub fn sync_deployment_job(&self) -> SyncDeploymentJobFluentBuilder
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>)
:
required: trueUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.
fleet(impl Into<String>)
/set_fleet(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueA 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>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA 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>
source§impl Client
impl Client
sourcepub fn update_robot_application(&self) -> UpdateRobotApplicationFluentBuilder
pub fn update_robot_application(&self) -> UpdateRobotApplicationFluentBuilder
Constructs a fluent builder for the UpdateRobotApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe application information for the robot application.
sources(SourceConfig)
/set_sources(Option<Vec::<SourceConfig>>)
:
required: falseThe sources of the robot application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:
required: trueThe robot software suite (ROS distribution) used by the robot application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:
required: falseThe revision id for the robot application.
environment(Environment)
/set_environment(Option<Environment>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn update_simulation_application(
&self
) -> UpdateSimulationApplicationFluentBuilder
pub fn update_simulation_application( &self ) -> UpdateSimulationApplicationFluentBuilder
Constructs a fluent builder for the UpdateSimulationApplication
operation.
- The fluent builder is configurable:
application(impl Into<String>)
/set_application(Option<String>)
:
required: trueThe application information for the simulation application.
sources(SourceConfig)
/set_sources(Option<Vec::<SourceConfig>>)
:
required: falseThe sources of the simulation application.
simulation_software_suite(SimulationSoftwareSuite)
/set_simulation_software_suite(Option<SimulationSoftwareSuite>)
:
required: trueThe simulation software suite used by the simulation application.
robot_software_suite(RobotSoftwareSuite)
/set_robot_software_suite(Option<RobotSoftwareSuite>)
:
required: trueInformation about the robot software suite (ROS distribution).
rendering_engine(RenderingEngine)
/set_rendering_engine(Option<RenderingEngine>)
:
required: falseThe rendering engine for the simulation application.
current_revision_id(impl Into<String>)
/set_current_revision_id(Option<String>)
:
required: falseThe revision id for the robot application.
environment(Environment)
/set_environment(Option<Environment>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn update_world_template(&self) -> UpdateWorldTemplateFluentBuilder
pub fn update_world_template(&self) -> UpdateWorldTemplateFluentBuilder
Constructs a fluent builder for the UpdateWorldTemplate
operation.
- The fluent builder is configurable:
template(impl Into<String>)
/set_template(Option<String>)
:
required: trueThe Amazon Resource Name (arn) of the world template to update.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the template.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:
required: falseThe world template body.
template_location(TemplateLocation)
/set_template_location(Option<TemplateLocation>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more