A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/RoboMaker/Client.html below:

Client — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RoboMaker::Client Overview

An API client for AWS RoboMaker. To construct a client, you need to configure a :region and :credentials.

robomaker = Aws::RoboMaker::Client.new(
  region: region_name,
  credentials: credentials,
  )

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::RoboMaker::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse Instance Attribute Summary Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse API Operations collapse Instance Method Summary collapse Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Instance Method Details #cancel_deployment_job(options = {}) ⇒ Struct

Cancels the specified deployment job.

#cancel_simulation_job(options = {}) ⇒ Struct

Cancels the specified simulation job.

#cancel_simulation_job_batch(options = {}) ⇒ Struct

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

#cancel_world_export_job(options = {}) ⇒ Struct

Cancels the specified export job.

#cancel_world_generation_job(options = {}) ⇒ Struct

Cancels the specified world generator job.

#create_deployment_job(options = {}) ⇒ Types::CreateDeploymentJobResponse

Deploys a specific version of a robot application to robots in a fleet.

The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.

After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

#create_fleet(options = {}) ⇒ Types::CreateFleetResponse

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

#create_simulation_job(options = {}) ⇒ Types::CreateSimulationJobResponse

Creates a simulation job.

After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

#delete_fleet(options = {}) ⇒ Struct #delete_robot(options = {}) ⇒ Struct #delete_robot_application(options = {}) ⇒ Struct

Deletes a robot application.

#delete_simulation_application(options = {}) ⇒ Struct

Deletes a simulation application.

#delete_world_template(options = {}) ⇒ Struct

Deletes a world template.

#list_deployment_jobs(options = {}) ⇒ Types::ListDeploymentJobsResponse

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

#list_fleets(options = {}) ⇒ Types::ListFleetsResponse

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

#list_robot_applications(options = {}) ⇒ Types::ListRobotApplicationsResponse

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

#list_robots(options = {}) ⇒ Types::ListRobotsResponse

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

#list_simulation_applications(options = {}) ⇒ Types::ListSimulationApplicationsResponse

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

#list_simulation_job_batches(options = {}) ⇒ Types::ListSimulationJobBatchesResponse

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

#list_simulation_jobs(options = {}) ⇒ Types::ListSimulationJobsResponse

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

#restart_simulation_job(options = {}) ⇒ Struct

Restarts a running simulation job.

#sync_deployment_job(options = {}) ⇒ Types::SyncDeploymentJobResponse

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

#tag_resource(options = {}) ⇒ Struct

Adds or edits tags for a AWS RoboMaker resource.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

#untag_resource(options = {}) ⇒ Struct

Removes the specified tags from the specified AWS RoboMaker resource.

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end
Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end
Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4