aws-sdk-s3outposts 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f1c9b684883f7b22fdc9de0dc95d5631391ea8bcea05ce79fc764f661de98df
-  data.tar.gz: 5047fd3bd3611aee510bc743e6f6aaaa788dead46bb1fefbaa551534dc70c770
+  metadata.gz: d924db0cfa8d31b3faabd3c9c31e33c123755f42e218d1c5ec9c4d10d92c858a
+  data.tar.gz: 245c8e21e1259f7d5cb7cb802a3efe64f1a01f13ea1f88c87f94c43271aa5cd9
 SHA512:
-  metadata.gz: 125e45a82512d7a5a834b6a0fd8e6a53d70a033a3b3340c5d4e032fd1bb42cad22a9b09c34ab14667bcce63a88a8c6d35a0480aec4af24e27316800595625b3b
-  data.tar.gz: cdf5998f33a3791ad967cd0363d6ec5af5e84616902f108a78a07eb7f144004152ea3cc2442de0e209a82a18aa426fde5d1cb58c4c018c6fe6d823e8ac6d7b46
+  metadata.gz: b7a5245c5fdc5b3fc3bbae0a2b79a50f2449bf4560434c605a2fa6c45bbfe9bb012496ce94cabef3480e1e0da17510bb14c10193c4732eb5e1d9f1ac35609838
+  data.tar.gz: ad243f7a720b5ebb7a7dd3897d1f0e49a69c35ac95992d2b06cf561c1b7c57d904edd1e5288e1a553b40ffde4fcdaa1f404917e66d4ef9a4cf61f3383760b42b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.13.0 (2022-03-16)
+------------------
+
+* Feature - S3 on Outposts is releasing a new API, ListSharedEndpoints, that lists all endpoints associated with S3 on Outpost, that has been shared by Resource Access Manager (RAM).
+
 1.12.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.12.0
+1.13.0

data/lib/aws-sdk-s3outposts/client.rb

@@ -351,16 +351,9 @@ module Aws::S3Outposts
 
     # @!group API Operations
 
-    # Amazon S3 on Outposts Access Points simplify managing data access at
-    # scale for shared datasets in S3 on Outposts. S3 on Outposts uses
-    # endpoints to connect to Outposts buckets so that you can perform
-    # actions within your virtual private cloud (VPC). For more information,
-    # see [ Accessing S3 on Outposts using VPC only access points][1].
+    # Creates an endpoint and associates it with the specified Outpost.
     #
-    # This action creates an endpoint and associates it with the specified
-    # Outposts.
-    #
-    # <note markdown="1"> It can take up to 5 minutes for this action to complete.
+    # <note markdown="1"> It can take up to 5 minutes for this action to finish.
     #
     #  </note>
     #
@@ -368,35 +361,39 @@ module Aws::S3Outposts
     #
     # Related actions include:
     #
-    # * [DeleteEndpoint][2]
+    # * [DeleteEndpoint][1]
     #
-    # * [ListEndpoints][3]
+    # * [ListEndpoints][2]
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html
-    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
-    # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
+    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html
     #
     # @option params [required, String] :outpost_id
-    #   The ID of the AWS Outposts.
+    #   The ID of the Outposts.
     #
     # @option params [required, String] :subnet_id
     #   The ID of the subnet in the selected VPC. The endpoint subnet must
-    #   belong to the Outpost that has the Amazon S3 on Outposts provisioned.
+    #   belong to the Outpost that has Amazon S3 on Outposts provisioned.
     #
     # @option params [required, String] :security_group_id
     #   The ID of the security group to use with the endpoint.
     #
     # @option params [String] :access_type
-    #   The type of access for the on-premise network connectivity for the
-    #   Outpost endpoint. To access the endpoint from an on-premises network,
-    #   you must specify the access type and provide the customer owned IPv4
-    #   pool.
+    #   The type of access for the network connectivity for the Amazon S3 on
+    #   Outposts endpoint. To use the Amazon Web Services VPC, choose
+    #   `Private`. To use the endpoint with an on-premises network, choose
+    #   `CustomerOwnedIp`. If you choose `CustomerOwnedIp`, you must also
+    #   provide the customer-owned IP address pool (CoIP pool).
+    #
+    #   <note markdown="1"> `Private` is the default access type value.
+    #
+    #    </note>
     #
     # @option params [String] :customer_owned_ipv_4_pool
-    #   The ID of the customer-owned IPv4 pool for the endpoint. IP addresses
-    #   will be allocated from this pool for the endpoint.
+    #   The ID of the customer-owned IPv4 address pool (CoIP pool) for the
+    #   endpoint. IP addresses are allocated from this pool for the endpoint.
     #
     # @return [Types::CreateEndpointResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -425,15 +422,9 @@ module Aws::S3Outposts
       req.send_request(options)
     end
 
-    # Amazon S3 on Outposts Access Points simplify managing data access at
-    # scale for shared datasets in S3 on Outposts. S3 on Outposts uses
-    # endpoints to connect to Outposts buckets so that you can perform
-    # actions within your virtual private cloud (VPC). For more information,
-    # see [ Accessing S3 on Outposts using VPC only access points][1].
-    #
-    # This action deletes an endpoint.
+    # Deletes an endpoint.
     #
-    # <note markdown="1"> It can take up to 5 minutes for this action to complete.
+    # <note markdown="1"> It can take up to 5 minutes for this action to finish.
     #
     #  </note>
     #
@@ -441,21 +432,20 @@ module Aws::S3Outposts
     #
     # Related actions include:
     #
-    # * [CreateEndpoint][2]
+    # * [CreateEndpoint][1]
     #
-    # * [ListEndpoints][3]
+    # * [ListEndpoints][2]
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html
-    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html
-    # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html
+    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html
     #
     # @option params [required, String] :endpoint_id
     #   The ID of the endpoint.
     #
     # @option params [required, String] :outpost_id
-    #   The ID of the AWS Outposts.
+    #   The ID of the Outposts.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -475,33 +465,25 @@ module Aws::S3Outposts
       req.send_request(options)
     end
 
-    # Amazon S3 on Outposts Access Points simplify managing data access at
-    # scale for shared datasets in S3 on Outposts. S3 on Outposts uses
-    # endpoints to connect to Outposts buckets so that you can perform
-    # actions within your virtual private cloud (VPC). For more information,
-    # see [ Accessing S3 on Outposts using VPC only access points][1].
-    #
-    # This action lists endpoints associated with the Outposts.
-    #
-    #
+    # Lists endpoints associated with the specified Outpost.
     #
     # Related actions include:
     #
-    # * [CreateEndpoint][2]
+    # * [CreateEndpoint][1]
     #
-    # * [DeleteEndpoint][3]
+    # * [DeleteEndpoint][2]
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html
-    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html
-    # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html
+    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
     #
     # @option params [String] :next_token
-    #   The next endpoint requested in the list.
+    #   If a previous response from this operation included a `NextToken`
+    #   value, provide that value here to retrieve the next page of results.
     #
     # @option params [Integer] :max_results
-    #   The max number of endpoints that can be returned on the request.
+    #   The maximum number of endpoints that will be returned in the response.
     #
     # @return [Types::ListEndpointsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -543,6 +525,72 @@ module Aws::S3Outposts
       req.send_request(options)
     end
 
+    # 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]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html
+    # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html
+    #
+    # @option params [String] :next_token
+    #   If a previous response from this operation included a `NextToken`
+    #   value, you can provide that value here to retrieve the next page of
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of endpoints that will be returned in the response.
+    #
+    # @option params [required, String] :outpost_id
+    #   The ID of the Amazon Web Services Outpost.
+    #
+    # @return [Types::ListSharedEndpointsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListSharedEndpointsResult#endpoints #endpoints} => Array&lt;Types::Endpoint&gt;
+    #   * {Types::ListSharedEndpointsResult#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_shared_endpoints({
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     outpost_id: "OutpostId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.endpoints #=> Array
+    #   resp.endpoints[0].endpoint_arn #=> String
+    #   resp.endpoints[0].outposts_id #=> String
+    #   resp.endpoints[0].cidr_block #=> String
+    #   resp.endpoints[0].status #=> String, one of "Pending", "Available", "Deleting"
+    #   resp.endpoints[0].creation_time #=> Time
+    #   resp.endpoints[0].network_interfaces #=> Array
+    #   resp.endpoints[0].network_interfaces[0].network_interface_id #=> String
+    #   resp.endpoints[0].vpc_id #=> String
+    #   resp.endpoints[0].subnet_id #=> String
+    #   resp.endpoints[0].security_group_id #=> String
+    #   resp.endpoints[0].access_type #=> String, one of "Private", "CustomerOwnedIp"
+    #   resp.endpoints[0].customer_owned_ipv_4_pool #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListSharedEndpoints AWS API Documentation
+    #
+    # @overload list_shared_endpoints(params = {})
+    # @param [Hash] params ({})
+    def list_shared_endpoints(params = {}, options = {})
+      req = build_request(:list_shared_endpoints, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -556,7 +604,7 @@ module Aws::S3Outposts
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-s3outposts'
-      context[:gem_version] = '1.12.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-s3outposts/client_api.rb

@@ -31,6 +31,8 @@ module Aws::S3Outposts
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     ListEndpointsRequest = Shapes::StructureShape.new(name: 'ListEndpointsRequest')
     ListEndpointsResult = Shapes::StructureShape.new(name: 'ListEndpointsResult')
+    ListSharedEndpointsRequest = Shapes::StructureShape.new(name: 'ListSharedEndpointsRequest')
+    ListSharedEndpointsResult = Shapes::StructureShape.new(name: 'ListSharedEndpointsResult')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     NetworkInterface = Shapes::StructureShape.new(name: 'NetworkInterface')
     NetworkInterfaceId = Shapes::StringShape.new(name: 'NetworkInterfaceId')
@@ -89,6 +91,15 @@ module Aws::S3Outposts
     ListEndpointsResult.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListEndpointsResult.struct_class = Types::ListEndpointsResult
 
+    ListSharedEndpointsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListSharedEndpointsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListSharedEndpointsRequest.add_member(:outpost_id, Shapes::ShapeRef.new(shape: OutpostId, required: true, location: "querystring", location_name: "outpostId"))
+    ListSharedEndpointsRequest.struct_class = Types::ListSharedEndpointsRequest
+
+    ListSharedEndpointsResult.add_member(:endpoints, Shapes::ShapeRef.new(shape: Endpoints, location_name: "Endpoints"))
+    ListSharedEndpointsResult.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListSharedEndpointsResult.struct_class = Types::ListSharedEndpointsResult
+
     NetworkInterface.add_member(:network_interface_id, Shapes::ShapeRef.new(shape: NetworkInterfaceId, location_name: "NetworkInterfaceId"))
     NetworkInterface.struct_class = Types::NetworkInterface
 
@@ -161,6 +172,24 @@ module Aws::S3Outposts
           }
         )
       end)
+
+      api.add_operation(:list_shared_endpoints, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListSharedEndpoints"
+        o.http_method = "GET"
+        o.http_request_uri = "/S3Outposts/ListSharedEndpoints"
+        o.input = Shapes::ShapeRef.new(shape: ListSharedEndpointsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListSharedEndpointsResult)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
     end
 
   end

data/lib/aws-sdk-s3outposts/types.rb

@@ -48,13 +48,12 @@ module Aws::S3Outposts
     #       }
     #
     # @!attribute [rw] outpost_id
-    #   The ID of the AWS Outposts.
+    #   The ID of the Outposts.
     #   @return [String]
     #
     # @!attribute [rw] subnet_id
     #   The ID of the subnet in the selected VPC. The endpoint subnet must
-    #   belong to the Outpost that has the Amazon S3 on Outposts
-    #   provisioned.
+    #   belong to the Outpost that has Amazon S3 on Outposts provisioned.
     #   @return [String]
     #
     # @!attribute [rw] security_group_id
@@ -62,15 +61,21 @@ module Aws::S3Outposts
     #   @return [String]
     #
     # @!attribute [rw] access_type
-    #   The type of access for the on-premise network connectivity for the
-    #   Outpost endpoint. To access the endpoint from an on-premises
-    #   network, you must specify the access type and provide the customer
-    #   owned IPv4 pool.
+    #   The type of access for the network connectivity for the Amazon S3 on
+    #   Outposts endpoint. To use the Amazon Web Services VPC, choose
+    #   `Private`. To use the endpoint with an on-premises network, choose
+    #   `CustomerOwnedIp`. If you choose `CustomerOwnedIp`, you must also
+    #   provide the customer-owned IP address pool (CoIP pool).
+    #
+    #   <note markdown="1"> `Private` is the default access type value.
+    #
+    #    </note>
     #   @return [String]
     #
     # @!attribute [rw] customer_owned_ipv_4_pool
-    #   The ID of the customer-owned IPv4 pool for the endpoint. IP
-    #   addresses will be allocated from this pool for the endpoint.
+    #   The ID of the customer-owned IPv4 address pool (CoIP pool) for the
+    #   endpoint. IP addresses are allocated from this pool for the
+    #   endpoint.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/CreateEndpointRequest AWS API Documentation
@@ -110,7 +115,7 @@ module Aws::S3Outposts
     #   @return [String]
     #
     # @!attribute [rw] outpost_id
-    #   The ID of the AWS Outposts.
+    #   The ID of the Outposts.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/DeleteEndpointRequest AWS API Documentation
@@ -126,18 +131,19 @@ module Aws::S3Outposts
     # scale for shared datasets in S3 on Outposts. S3 on Outposts uses
     # endpoints to connect to Outposts buckets so that you can perform
     # actions within your virtual private cloud (VPC). For more information,
-    # see [ Accessing S3 on Outposts using VPC only access points][1].
+    # see [ Accessing S3 on Outposts using VPC-only access points][1] in the
+    # *Amazon Simple Storage Service User Guide*.
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html
+    # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html
     #
     # @!attribute [rw] endpoint_arn
     #   The Amazon Resource Name (ARN) of the endpoint.
     #   @return [String]
     #
     # @!attribute [rw] outposts_id
-    #   The ID of the AWS Outposts.
+    #   The ID of the Outposts.
     #   @return [String]
     #
     # @!attribute [rw] cidr_block
@@ -169,10 +175,13 @@ module Aws::S3Outposts
     #   @return [String]
     #
     # @!attribute [rw] access_type
+    #   The type of connectivity used to access the Amazon S3 on Outposts
+    #   endpoint.
     #   @return [String]
     #
     # @!attribute [rw] customer_owned_ipv_4_pool
-    #   The ID of the customer-owned IPv4 pool used for the endpoint.
+    #   The ID of the customer-owned IPv4 address pool used for the
+    #   endpoint.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/Endpoint AWS API Documentation
@@ -215,11 +224,13 @@ module Aws::S3Outposts
     #       }
     #
     # @!attribute [rw] next_token
-    #   The next endpoint requested in the list.
+    #   If a previous response from this operation included a `NextToken`
+    #   value, provide that value here to retrieve the next page of results.
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   The max number of endpoints that can be returned on the request.
+    #   The maximum number of endpoints that will be returned in the
+    #   response.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListEndpointsRequest AWS API Documentation
@@ -232,11 +243,13 @@ module Aws::S3Outposts
     end
 
     # @!attribute [rw] endpoints
-    #   Returns an array of endpoints associated with AWS Outposts.
+    #   The list of endpoints associated with the specified Outpost.
     #   @return [Array<Types::Endpoint>]
     #
     # @!attribute [rw] next_token
-    #   The next endpoint returned in the list.
+    #   If the number of endpoints associated with the specified Outpost
+    #   exceeds `MaxResults`, you can include this value in subsequent calls
+    #   to this operation to retrieve more results.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListEndpointsResult AWS API Documentation
@@ -248,6 +261,61 @@ module Aws::S3Outposts
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListSharedEndpointsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #         outpost_id: "OutpostId", # required
+    #       }
+    #
+    # @!attribute [rw] next_token
+    #   If a previous response from this operation included a `NextToken`
+    #   value, you can provide that value here to retrieve the next page of
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of endpoints that will be returned in the
+    #   response.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] outpost_id
+    #   The ID of the Amazon Web Services Outpost.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListSharedEndpointsRequest AWS API Documentation
+    #
+    class ListSharedEndpointsRequest < Struct.new(
+      :next_token,
+      :max_results,
+      :outpost_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] endpoints
+    #   The list of endpoints associated with the specified Outpost that
+    #   have been shared by Amazon Web Services Resource Access Manager
+    #   (RAM).
+    #   @return [Array<Types::Endpoint>]
+    #
+    # @!attribute [rw] next_token
+    #   If the number of endpoints associated with the specified Outpost
+    #   exceeds `MaxResults`, you can include this value in subsequent calls
+    #   to this operation to retrieve more results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListSharedEndpointsResult AWS API Documentation
+    #
+    class ListSharedEndpointsResult < Struct.new(
+      :endpoints,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The container for the network interface.
     #
     # @!attribute [rw] network_interface_id

data/lib/aws-sdk-s3outposts.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-s3outposts/customizations'
 # @!group service
 module Aws::S3Outposts
 
-  GEM_VERSION = '1.12.0'
+  GEM_VERSION = '1.13.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-s3outposts
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core