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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_robomaker::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_robomaker::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_robomaker::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the BatchDeleteWorlds operation.

Constructs a fluent builder for the BatchDescribeSimulationJob operation.

Constructs a fluent builder for the CancelDeploymentJob operation.

Constructs a fluent builder for the CancelSimulationJob operation.

Constructs a fluent builder for the CancelSimulationJobBatch operation.

Constructs a fluent builder for the CancelWorldExportJob operation.

Constructs a fluent builder for the CancelWorldGenerationJob operation.

Constructs a fluent builder for the CreateDeploymentJob operation.

Constructs a fluent builder for the CreateFleet operation.

Constructs a fluent builder for the CreateRobot operation.

Constructs a fluent builder for the CreateRobotApplication operation.

Constructs a fluent builder for the CreateRobotApplicationVersion operation.

Constructs a fluent builder for the CreateSimulationApplication operation.

Constructs a fluent builder for the CreateSimulationApplicationVersion operation.

Constructs a fluent builder for the CreateSimulationJob operation.

Constructs a fluent builder for the CreateWorldExportJob operation.

Constructs a fluent builder for the CreateWorldGenerationJob operation.

Constructs a fluent builder for the CreateWorldTemplate operation.

Constructs a fluent builder for the DeleteFleet operation.

Constructs a fluent builder for the DeleteRobot operation.

Constructs a fluent builder for the DeleteRobotApplication operation.

Constructs a fluent builder for the DeleteSimulationApplication operation.

Constructs a fluent builder for the DeleteWorldTemplate operation.

Constructs a fluent builder for the DeregisterRobot operation.

Constructs a fluent builder for the DescribeDeploymentJob operation.

Constructs a fluent builder for the DescribeFleet operation.

Constructs a fluent builder for the DescribeRobot operation.

Constructs a fluent builder for the DescribeRobotApplication operation.

Constructs a fluent builder for the DescribeSimulationApplication operation.

Constructs a fluent builder for the DescribeSimulationJob operation.

Constructs a fluent builder for the DescribeSimulationJobBatch operation.

Constructs a fluent builder for the DescribeWorld operation.

Constructs a fluent builder for the DescribeWorldExportJob operation.

Constructs a fluent builder for the DescribeWorldGenerationJob operation.

Constructs a fluent builder for the DescribeWorldTemplate operation.

source

pub fn get_world_template_body(&self) -> GetWorldTemplateBody

Constructs a fluent builder for the GetWorldTemplateBody operation.

Constructs a fluent builder for the ListDeploymentJobs operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results.

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

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListDeploymentJobs returns up to 200 results and a nextToken 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, call ListDeploymentJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListDeploymentJobsError>

Constructs a fluent builder for the ListFleets operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results.

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

  • On success, responds with ListFleetsOutput with field(s):
    • fleet_details(Option<Vec<Fleet>>):

      A list of fleet details meeting the request criteria.

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListFleetsError>

Constructs a fluent builder for the ListRobotApplications operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • version_qualifier(impl Into<String>) / set_version_qualifier(Option<String>):

      The version qualifier of the robot application.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results.

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

  • On success, responds with ListRobotApplicationsOutput with field(s):
    • robot_application_summaries(Option<Vec<RobotApplicationSummary>>):

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

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListRobotApplicationsError>

Constructs a fluent builder for the ListRobots operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results.

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

  • 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, call ListRobots again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListRobotsError>

Constructs a fluent builder for the ListSimulationApplications operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • version_qualifier(impl Into<String>) / set_version_qualifier(Option<String>):

      The version qualifier of the simulation application.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional list of filters to limit results.

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

  • On success, responds with ListSimulationApplicationsOutput with field(s):
    • simulation_application_summaries(Option<Vec<SimulationApplicationSummary>>):

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

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListSimulationApplicationsError>

Constructs a fluent builder for the ListSimulationJobBatches operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSimulationJobs operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results.

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

  • On success, responds with ListSimulationJobsOutput with field(s):
    • simulation_job_summaries(Option<Vec<SimulationJobSummary>>):

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

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListSimulationJobsError>

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ListWorldExportJobs operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListWorldExportJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results. You can use generationJobId and templateId.

  • On success, responds with ListWorldExportJobsOutput with field(s):
    • world_export_job_summaries(Option<Vec<WorldExportJobSummary>>):

      Summary information for world export jobs.

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListWorldExportJobsError>

Constructs a fluent builder for the ListWorldGenerationJobs operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results. You can use status and templateId.

  • On success, responds with ListWorldGenerationJobsOutput with field(s):
    • world_generation_job_summaries(Option<Vec<WorldGenerationJobSummary>>):

      Summary information for world generator jobs.

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListWorldGenerationJobsError>

Constructs a fluent builder for the ListWorlds operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

    • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

      Optional filters to limit results. You can use status.

  • On success, responds with ListWorldsOutput with field(s):
    • world_summaries(Option<Vec<WorldSummary>>):

      Summary information for worlds.

    • next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListWorldsError>

Constructs a fluent builder for the ListWorldTemplates operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • next_token(impl Into<String>) / set_next_token(Option<String>):

      If the previous paginated request did not return all of the remaining results, the response object’s nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    • max_results(i32) / set_max_results(Option<i32>):

      When this parameter is used, ListWorldTemplates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken 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, call ListWorldTemplates again and assign that token to the request object’s nextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • On failure, responds with SdkError<ListWorldTemplatesError>

Constructs a fluent builder for the RegisterRobot operation.

Constructs a fluent builder for the RestartSimulationJob operation.

Constructs a fluent builder for the StartSimulationJobBatch operation.

Constructs a fluent builder for the SyncDeploymentJob operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateRobotApplication operation.

Constructs a fluent builder for the UpdateSimulationApplication operation.

Constructs a fluent builder for the UpdateWorldTemplate operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more