Class: Aws::S3Outposts::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::S3Outposts::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-s3outposts/client.rb
Overview
An API client for S3Outposts. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::S3Outposts::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_endpoint(params = {}) ⇒ Types::CreateEndpointResult
Creates an endpoint and associates it with the specified Outpost.
-
#delete_endpoint(params = {}) ⇒ Struct
Deletes an endpoint.
-
#list_endpoints(params = {}) ⇒ Types::ListEndpointsResult
Lists endpoints associated with the specified Outpost.
-
#list_outposts_with_s3(params = {}) ⇒ Types::ListOutpostsWithS3Result
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
-
#list_shared_endpoints(params = {}) ⇒ Types::ListSharedEndpointsResult
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 385 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
708 709 710 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 708 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
711 712 713 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 711 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
686 687 688 689 690 691 692 693 694 695 696 697 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 686 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-s3outposts' context[:gem_version] = '1.27.0' Seahorse::Client::Request.new(handlers, context) end |
#create_endpoint(params = {}) ⇒ Types::CreateEndpointResult
Creates an endpoint and associates it with the specified Outpost.
<note markdown=“1”> It can take up to 5 minutes for this action to finish.
</note>
Related actions include:
- DeleteEndpoint][1
- ListEndpoints][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html
457 458 459 460 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 457 def create_endpoint(params = {}, = {}) req = build_request(:create_endpoint, params) req.send_request() end |
#delete_endpoint(params = {}) ⇒ Struct
Deletes an endpoint.
<note markdown=“1”> It can take up to 5 minutes for this action to finish.
</note>
Related actions include:
- CreateEndpoint][1
- ListEndpoints][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html
500 501 502 503 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 500 def delete_endpoint(params = {}, = {}) req = build_request(:delete_endpoint, params) req.send_request() end |
#list_endpoints(params = {}) ⇒ Types::ListEndpointsResult
Lists endpoints associated with the specified Outpost.
Related actions include:
- CreateEndpoint][1
- DeleteEndpoint][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
562 563 564 565 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 562 def list_endpoints(params = {}, = {}) req = build_request(:list_endpoints, params) req.send_request() end |
#list_outposts_with_s3(params = {}) ⇒ Types::ListOutpostsWithS3Result
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
609 610 611 612 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 609 def list_outposts_with_s3(params = {}, = {}) req = build_request(:list_outposts_with_s3, params) req.send_request() end |
#list_shared_endpoints(params = {}) ⇒ Types::ListSharedEndpointsResult
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
Related actions include:
- CreateEndpoint][1
- DeleteEndpoint][2
[1]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
677 678 679 680 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 677 def list_shared_endpoints(params = {}, = {}) req = build_request(:list_shared_endpoints, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
701 702 703 |
# File 'lib/aws-sdk-s3outposts/client.rb', line 701 def waiter_names [] end |