Class: Aws::Outposts::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Outposts::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb
Overview
An API client for Outposts. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Outposts::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_outpost(params = {}) ⇒ Types::CreateOutpostOutput
Creates an Outpost.
-
#delete_outpost(params = {}) ⇒ Struct
Deletes the Outpost.
-
#delete_site(params = {}) ⇒ Struct
Deletes the site.
-
#get_outpost(params = {}) ⇒ Types::GetOutpostOutput
Gets information about the specified Outpost.
-
#get_outpost_instance_types(params = {}) ⇒ Types::GetOutpostInstanceTypesOutput
Lists the instance types for the specified Outpost.
-
#list_outposts(params = {}) ⇒ Types::ListOutpostsOutput
List the Outposts for your AWS account.
-
#list_sites(params = {}) ⇒ Types::ListSitesOutput
Lists the sites for the specified AWS account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_outpost(params = {}) ⇒ Types::CreateOutpostOutput
Creates an Outpost.
389 390 391 392 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 389 def create_outpost(params = {}, = {}) req = build_request(:create_outpost, params) req.send_request() end |
#delete_outpost(params = {}) ⇒ Struct
Deletes the Outpost.
411 412 413 414 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 411 def delete_outpost(params = {}, = {}) req = build_request(:delete_outpost, params) req.send_request() end |
#delete_site(params = {}) ⇒ Struct
Deletes the site.
433 434 435 436 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 433 def delete_site(params = {}, = {}) req = build_request(:delete_site, params) req.send_request() end |
#get_outpost(params = {}) ⇒ Types::GetOutpostOutput
Gets information about the specified Outpost.
471 472 473 474 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 471 def get_outpost(params = {}, = {}) req = build_request(:get_outpost, params) req.send_request() end |
#get_outpost_instance_types(params = {}) ⇒ Types::GetOutpostInstanceTypesOutput
Lists the instance types for the specified Outpost.
514 515 516 517 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 514 def get_outpost_instance_types(params = {}, = {}) req = build_request(:get_outpost_instance_types, params) req.send_request() end |
#list_outposts(params = {}) ⇒ Types::ListOutpostsOutput
List the Outposts for your AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
561 562 563 564 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 561 def list_outposts(params = {}, = {}) req = build_request(:list_outposts, params) req.send_request() end |
#list_sites(params = {}) ⇒ Types::ListSitesOutput
Lists the sites for the specified AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
603 604 605 606 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 603 def list_sites(params = {}, = {}) req = build_request(:list_sites, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
632 633 634 635 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 632 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
660 661 662 663 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 660 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
686 687 688 689 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 686 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |