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
-
#cancel_capacity_task(params = {}) ⇒ Struct
Cancels the capacity task.
-
#cancel_order(params = {}) ⇒ Struct
Cancels the specified order for an Outpost.
-
#create_order(params = {}) ⇒ Types::CreateOrderOutput
Creates an order for an Outpost.
-
#create_outpost(params = {}) ⇒ Types::CreateOutpostOutput
Creates an Outpost.
-
#create_site(params = {}) ⇒ Types::CreateSiteOutput
Creates a site for an Outpost.
-
#delete_outpost(params = {}) ⇒ Struct
Deletes the specified Outpost.
-
#delete_site(params = {}) ⇒ Struct
Deletes the specified site.
-
#get_capacity_task(params = {}) ⇒ Types::GetCapacityTaskOutput
Gets details of the specified capacity task.
-
#get_catalog_item(params = {}) ⇒ Types::GetCatalogItemOutput
Gets information about the specified catalog item.
-
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Amazon Web Services uses this action to install Outpost servers. -
#get_order(params = {}) ⇒ Types::GetOrderOutput
Gets information about the specified order.
-
#get_outpost(params = {}) ⇒ Types::GetOutpostOutput
Gets information about the specified Outpost.
-
#get_outpost_instance_types(params = {}) ⇒ Types::GetOutpostInstanceTypesOutput
Gets the instance types for the specified Outpost.
-
#get_outpost_supported_instance_types(params = {}) ⇒ Types::GetOutpostSupportedInstanceTypesOutput
Gets the instance types that an Outpost can support in
InstanceTypeCapacity
. -
#get_site(params = {}) ⇒ Types::GetSiteOutput
Gets information about the specified Outpost site.
-
#get_site_address(params = {}) ⇒ Types::GetSiteAddressOutput
Gets the site address of the specified site.
-
#list_assets(params = {}) ⇒ Types::ListAssetsOutput
Lists the hardware assets for the specified Outpost.
-
#list_capacity_tasks(params = {}) ⇒ Types::ListCapacityTasksOutput
Lists the capacity tasks for your Amazon Web Services account.
-
#list_catalog_items(params = {}) ⇒ Types::ListCatalogItemsOutput
Lists the items in the catalog.
-
#list_orders(params = {}) ⇒ Types::ListOrdersOutput
Lists the Outpost orders for your Amazon Web Services account.
-
#list_outposts(params = {}) ⇒ Types::ListOutpostsOutput
Lists the Outposts for your Amazon Web Services account.
-
#list_sites(params = {}) ⇒ Types::ListSitesOutput
Lists the Outpost sites for your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#start_capacity_task(params = {}) ⇒ Types::StartCapacityTaskOutput
Starts the specified capacity task.
-
#start_connection(params = {}) ⇒ Types::StartConnectionResponse
Amazon Web Services uses this action to install Outpost servers. -
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
-
#update_outpost(params = {}) ⇒ Types::UpdateOutpostOutput
Updates an Outpost.
-
#update_site(params = {}) ⇒ Types::UpdateSiteOutput
Updates the specified site.
-
#update_site_address(params = {}) ⇒ Types::UpdateSiteAddressOutput
Updates the address of the specified site.
-
#update_site_rack_physical_properties(params = {}) ⇒ Types::UpdateSiteRackPhysicalPropertiesOutput
Update the physical and logistical details for a rack at a site.
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.
409 410 411 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#cancel_capacity_task(params = {}) ⇒ Struct
Cancels the capacity task.
437 438 439 440 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 437 def cancel_capacity_task(params = {}, = {}) req = build_request(:cancel_capacity_task, params) req.send_request() end |
#cancel_order(params = {}) ⇒ Struct
Cancels the specified order for an Outpost.
459 460 461 462 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 459 def cancel_order(params = {}, = {}) req = build_request(:cancel_order, params) req.send_request() end |
#create_order(params = {}) ⇒ Types::CreateOrderOutput
Creates an order for an Outpost.
524 525 526 527 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 524 def create_order(params = {}, = {}) req = build_request(:create_order, params) req.send_request() end |
#create_outpost(params = {}) ⇒ Types::CreateOutpostOutput
Creates an Outpost.
You can specify either an Availability one or an AZ ID.
592 593 594 595 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 592 def create_outpost(params = {}, = {}) req = build_request(:create_outpost, params) req.send_request() end |
#create_site(params = {}) ⇒ Types::CreateSiteOutput
Creates a site for an Outpost.
711 712 713 714 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 711 def create_site(params = {}, = {}) req = build_request(:create_site, params) req.send_request() end |
#delete_outpost(params = {}) ⇒ Struct
Deletes the specified Outpost.
733 734 735 736 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 733 def delete_outpost(params = {}, = {}) req = build_request(:delete_outpost, params) req.send_request() end |
#delete_site(params = {}) ⇒ Struct
Deletes the specified site.
755 756 757 758 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 755 def delete_site(params = {}, = {}) req = build_request(:delete_site, params) req.send_request() end |
#get_capacity_task(params = {}) ⇒ Types::GetCapacityTaskOutput
Gets details of the specified capacity task.
808 809 810 811 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 808 def get_capacity_task(params = {}, = {}) req = build_request(:get_capacity_task, params) req.send_request() end |
#get_catalog_item(params = {}) ⇒ Types::GetCatalogItemOutput
Gets information about the specified catalog item.
847 848 849 850 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 847 def get_catalog_item(params = {}, = {}) req = build_request(:get_catalog_item, params) req.send_request() end |
#get_connection(params = {}) ⇒ Types::GetConnectionResponse
Gets information about the specified connection.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
899 900 901 902 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 899 def get_connection(params = {}, = {}) req = build_request(:get_connection, params) req.send_request() end |
#get_order(params = {}) ⇒ Types::GetOrderOutput
Gets information about the specified order.
947 948 949 950 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 947 def get_order(params = {}, = {}) req = build_request(:get_order, params) req.send_request() end |
#get_outpost(params = {}) ⇒ Types::GetOutpostOutput
Gets information about the specified Outpost.
987 988 989 990 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 987 def get_outpost(params = {}, = {}) req = build_request(:get_outpost, params) req.send_request() end |
#get_outpost_instance_types(params = {}) ⇒ Types::GetOutpostInstanceTypesOutput
Gets the instance types for the specified Outpost.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1032 def get_outpost_instance_types(params = {}, = {}) req = build_request(:get_outpost_instance_types, params) req.send_request() end |
#get_outpost_supported_instance_types(params = {}) ⇒ Types::GetOutpostSupportedInstanceTypesOutput
Gets the instance types that an Outpost can support in
InstanceTypeCapacity
. This will generally include instance types
that are not currently configured and therefore cannot be launched
with the current Outpost capacity configuration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1080 def get_outpost_supported_instance_types(params = {}, = {}) req = build_request(:get_outpost_supported_instance_types, params) req.send_request() end |
#get_site(params = {}) ⇒ Types::GetSiteOutput
Gets information about the specified Outpost site.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1127 def get_site(params = {}, = {}) req = build_request(:get_site, params) req.send_request() end |
#get_site_address(params = {}) ⇒ Types::GetSiteAddressOutput
Gets the site address of the specified site.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1173 def get_site_address(params = {}, = {}) req = build_request(:get_site_address, params) req.send_request() end |
#list_assets(params = {}) ⇒ Types::ListAssetsOutput
Lists the hardware assets for the specified Outpost.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1235 def list_assets(params = {}, = {}) req = build_request(:list_assets, params) req.send_request() end |
#list_capacity_tasks(params = {}) ⇒ Types::ListCapacityTasksOutput
Lists the capacity tasks for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1293 def list_capacity_tasks(params = {}, = {}) req = build_request(:list_capacity_tasks, params) req.send_request() end |
#list_catalog_items(params = {}) ⇒ Types::ListCatalogItemsOutput
Lists the items in the catalog.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1359 def list_catalog_items(params = {}, = {}) req = build_request(:list_catalog_items, params) req.send_request() end |
#list_orders(params = {}) ⇒ Types::ListOrdersOutput
Lists the Outpost orders for your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1407 1408 1409 1410 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1407 def list_orders(params = {}, = {}) req = build_request(:list_orders, params) req.send_request() end |
#list_outposts(params = {}) ⇒ Types::ListOutpostsOutput
Lists the Outposts for your Amazon Web Services account.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1474 1475 1476 1477 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1474 def list_outposts(params = {}, = {}) req = build_request(:list_outposts, params) req.send_request() end |
#list_sites(params = {}) ⇒ Types::ListSitesOutput
Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.
Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1549 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.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1578 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_capacity_task(params = {}) ⇒ Types::StartCapacityTaskOutput
Starts the specified capacity task. You can have one active capacity task for an order.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1649 def start_capacity_task(params = {}, = {}) req = build_request(:start_capacity_task, params) req.send_request() end |
#start_connection(params = {}) ⇒ Types::StartConnectionResponse
Starts the connection required for Outpost server installation.
Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.
1707 1708 1709 1710 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1707 def start_connection(params = {}, = {}) req = build_request(:start_connection, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
1735 1736 1737 1738 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1735 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
1761 1762 1763 1764 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1761 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_outpost(params = {}) ⇒ Types::UpdateOutpostOutput
Updates an Outpost.
1813 1814 1815 1816 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1813 def update_outpost(params = {}, = {}) req = build_request(:update_outpost, params) req.send_request() end |
#update_site(params = {}) ⇒ Types::UpdateSiteOutput
Updates the specified site.
1872 1873 1874 1875 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1872 def update_site(params = {}, = {}) req = build_request(:update_site, params) req.send_request() end |
#update_site_address(params = {}) ⇒ Types::UpdateSiteAddressOutput
Updates the address of the specified site.
You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.
You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 1939 def update_site_address(params = {}, = {}) req = build_request(:update_site_address, params) req.send_request() end |
#update_site_rack_physical_properties(params = {}) ⇒ Types::UpdateSiteRackPhysicalPropertiesOutput
Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
To update a rack at a site with an order of IN_PROGRESS
, you must
wait for the order to complete or cancel the order.
2099 2100 2101 2102 |
# File 'gems/aws-sdk-outposts/lib/aws-sdk-outposts/client.rb', line 2099 def update_site_rack_physical_properties(params = {}, = {}) req = build_request(:update_site_rack_physical_properties, params) req.send_request() end |