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

Class: Aws::Outposts::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::Outposts::Client

show all

Defined in:: (unknown)

Overview

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

outposts = Aws::Outposts::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:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

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:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Outposts::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

#initialize(options = {}) ⇒ Aws::Outposts::Client constructor
Constructs an API client.

API Operations collapse

#create_outpost(options = {}) ⇒ Types::CreateOutpostOutput
Creates an Outpost.

.
#delete_outpost(options = {}) ⇒ Struct
Deletes the Outpost.

.
#delete_site(options = {}) ⇒ Struct
Deletes the site.

.
#get_outpost(options = {}) ⇒ Types::GetOutpostOutput
Gets information about the specified Outpost.

.
#get_outpost_instance_types(options = {}) ⇒ Types::GetOutpostInstanceTypesOutput
Lists the instance types for the specified Outpost.

.
#list_outposts(options = {}) ⇒ Types::ListOutpostsOutput
List the Outposts for your AWS account.

.
#list_sites(options = {}) ⇒ Types::ListSitesOutput
Lists the sites for the specified AWS account.

.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.

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

Constructor Details

#initialize(options = {}) ⇒ `Aws::Outposts::Client`

Constructs an API client.

Options Hash (options):

:access_key_id (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:active_endpoint_cache (Boolean) —
When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.
:convert_params (Boolean) — default: true —
When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.
:credentials (required, Credentials) —
Your AWS credentials. The following locations will be searched in order for credentials:
- :access_key_id, :secret_access_key, and :session_token options
- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
- HOME/.aws/credentials shared credentials file
- EC2 instance profile credentials See Plugins::RequestSigner for more details.
:disable_host_prefix_injection (Boolean) —
Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.
:endpoint (String) —
A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.
:endpoint_cache_max_entries (Integer) —
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_max_threads (Integer) —
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.
:endpoint_cache_poll_interval (Integer) —
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.
:endpoint_discovery (Boolean) —
When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.
:http_continue_timeout (Float) — default: 1 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_idle_timeout (Integer) — default: 5 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_open_timeout (Integer) — default: 15 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_proxy (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_read_timeout (Integer) — default: 60 —
See Seahorse::Client::Plugins::NetHttp for more details.
:http_wire_trace (Boolean) — default: false —
See Seahorse::Client::Plugins::NetHttp for more details.
:log_level (Symbol) — default: :info —
The log level to send messages to the logger at. See Plugins::Logging for more details.
:log_formatter (Logging::LogFormatter) —
The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.
:logger (Logger) — default: nil —
The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.
:profile (String) —
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.
:raise_response_errors (Boolean) — default: true —
When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.
:region (required, String) —
The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.
:retry_limit (Integer) — default: 3 —
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.
:secret_access_key (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:session_token (String) —
Used to set credentials statically. See Plugins::RequestSigner for more details.
:ssl_ca_bundle (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_directory (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_ca_store (String) —
See Seahorse::Client::Plugins::NetHttp for more details.
:ssl_verify_peer (Boolean) — default: true —
See Seahorse::Client::Plugins::NetHttp for more details.
:stub_responses (Boolean) — default: false —
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.
:validate_params (Boolean) — default: true —
When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_outpost(options = {}) ⇒ `Types::CreateOutpostOutput`

Creates an Outpost.

Examples:

Request syntax with placeholder values


resp = client.create_outpost({
  name: "OutpostName", # required
  description: "OutpostDescription",
  site_id: "SiteId", # required
  availability_zone: "AvailabilityZone",
  availability_zone_id: "AvailabilityZoneId",
})

Response structure


resp.outpost.outpost_id #=> String
resp.outpost.owner_id #=> String
resp.outpost.outpost_arn #=> String
resp.outpost.site_id #=> String
resp.outpost.name #=> String
resp.outpost.description #=> String
resp.outpost.life_cycle_status #=> String
resp.outpost.availability_zone #=> String
resp.outpost.availability_zone_id #=> String

Options Hash (options):

:name (required, String) —
The name of the Outpost.
:description (String) —
The Outpost description.
:site_id (required, String) —
The ID of the site.
:availability_zone (String) —
The Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId.
:availability_zone_id (String) —
The ID of the Availability Zone.

You must specify AvailabilityZone or AvailabilityZoneId.

Returns:

(Types::CreateOutpostOutput) —
Returns a response object which responds to the following methods:
- #outpost => Types::Outpost

See Also:

AWS API Documentation

#delete_outpost(options = {}) ⇒ `Struct`

Deletes the Outpost.

Examples:

Request syntax with placeholder values


resp = client.delete_outpost({
  outpost_id: "OutpostId", # required
})

Options Hash (options):

:outpost_id (required, String) —
The ID of the Outpost.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#delete_site(options = {}) ⇒ `Struct`

Deletes the site.

Examples:

Request syntax with placeholder values


resp = client.delete_site({
  site_id: "SiteId", # required
})

Options Hash (options):

:site_id (required, String) —
The ID of the site.

Returns:

(Struct) —
Returns an empty response.

See Also:

AWS API Documentation

#get_outpost(options = {}) ⇒ `Types::GetOutpostOutput`

Gets information about the specified Outpost.

Examples:

Request syntax with placeholder values


resp = client.get_outpost({
  outpost_id: "OutpostId", # required
})

Response structure


resp.outpost.outpost_id #=> String
resp.outpost.owner_id #=> String
resp.outpost.outpost_arn #=> String
resp.outpost.site_id #=> String
resp.outpost.name #=> String
resp.outpost.description #=> String
resp.outpost.life_cycle_status #=> String
resp.outpost.availability_zone #=> String
resp.outpost.availability_zone_id #=> String

Options Hash (options):

:outpost_id (required, String) —
The ID of the Outpost.

Returns:

(Types::GetOutpostOutput) —
Returns a response object which responds to the following methods:
- #outpost => Types::Outpost

See Also:

AWS API Documentation

#get_outpost_instance_types(options = {}) ⇒ `Types::GetOutpostInstanceTypesOutput`

Lists the instance types for the specified Outpost.

Examples:

Request syntax with placeholder values


resp = client.get_outpost_instance_types({
  outpost_id: "OutpostId", # required
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.instance_types #=> Array
resp.instance_types[0].instance_type #=> String
resp.next_token #=> String
resp.outpost_id #=> String
resp.outpost_arn #=> String

Options Hash (options):

:outpost_id (required, String) —
The ID of the Outpost.
:next_token (String) —
The pagination token.
:max_results (Integer) —
The maximum page size.

Returns:

(Types::GetOutpostInstanceTypesOutput) —
Returns a response object which responds to the following methods:
- #instance_types => Array<Types::InstanceTypeItem>
- #next_token => String
- #outpost_id => String
- #outpost_arn => String

See Also:

AWS API Documentation

#list_outposts(options = {}) ⇒ `Types::ListOutpostsOutput`

List the Outposts for your AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_outposts({
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.outposts #=> Array
resp.outposts[0].outpost_id #=> String
resp.outposts[0].owner_id #=> String
resp.outposts[0].outpost_arn #=> String
resp.outposts[0].site_id #=> String
resp.outposts[0].name #=> String
resp.outposts[0].description #=> String
resp.outposts[0].life_cycle_status #=> String
resp.outposts[0].availability_zone #=> String
resp.outposts[0].availability_zone_id #=> String
resp.next_token #=> String

Options Hash (options):

:next_token (String) —
The pagination token.
:max_results (Integer) —
The maximum page size.

Returns:

(Types::ListOutpostsOutput) —
Returns a response object which responds to the following methods:
- #outposts => Array<Types::Outpost>
- #next_token => String

See Also:

AWS API Documentation

#list_sites(options = {}) ⇒ `Types::ListSitesOutput`

Lists the sites for the specified AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_sites({
  next_token: "Token",
  max_results: 1,
})

Response structure


resp.sites #=> Array
resp.sites[0].site_id #=> String
resp.sites[0].account_id #=> String
resp.sites[0].name #=> String
resp.sites[0].description #=> String
resp.next_token #=> String

Options Hash (options):

:next_token (String) —
The pagination token.
:max_results (Integer) —
The maximum page size.

Returns:

(Types::ListSitesOutput) —
Returns a response object which responds to the following methods:
- #sites => Array<Types::Site>
- #next_token => String

See Also:

AWS API Documentation

#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

Parameters:

waiter_name (Symbol) —
The name of the waiter. See #waiter_names for a full list of supported waiters.
params (Hash) (defaults to: {}) —
Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

waiter (Waiters::Waiter) —
Yields a Waiter object that can be configured prior to waiting.

Returns:

(Boolean) —
Returns true if the waiter was successful.

Raises:

(Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —
Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —
Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —
Raised when you request to wait for an unknown state.

#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:

Returns:

(Array<Symbol>) —
the list of supported waiters.

Class: Aws::Outposts::Client

Overview

Region

Credentials

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::Outposts::Client

Instance Method Details

#create_outpost(options = {}) ⇒ Types::CreateOutpostOutput

#delete_outpost(options = {}) ⇒ Struct

#delete_site(options = {}) ⇒ Struct

#get_outpost(options = {}) ⇒ Types::GetOutpostOutput

#get_outpost_instance_types(options = {}) ⇒ Types::GetOutpostInstanceTypesOutput

#list_outposts(options = {}) ⇒ Types::ListOutpostsOutput

#list_sites(options = {}) ⇒ Types::ListSitesOutput

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

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::Outposts::Client`

#create_outpost(options = {}) ⇒ `Types::CreateOutpostOutput`

#delete_outpost(options = {}) ⇒ `Struct`

#delete_site(options = {}) ⇒ `Struct`

#get_outpost(options = {}) ⇒ `Types::GetOutpostOutput`

#get_outpost_instance_types(options = {}) ⇒ `Types::GetOutpostInstanceTypesOutput`

#list_outposts(options = {}) ⇒ `Types::ListOutpostsOutput`

#list_sites(options = {}) ⇒ `Types::ListSitesOutput`

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

#waiter_names ⇒ `Array<Symbol>`