Amazon S3 on Outposts Update: 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).

Author: AWS

.changes/next-release/feature-AmazonS3onOutposts-f4092ca.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon S3 on Outposts",
+    "contributor": "",
+    "description": "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)."
+}

services/s3outposts/src/main/resources/codegen-resources/paginators-1.json

@@ -5,6 +5,12 @@
       "limit_key": "MaxResults",
       "output_token": "NextToken",
       "result_key": "Endpoints"
+    },
+    "ListSharedEndpoints": {
+      "input_token": "NextToken",
+      "limit_key": "MaxResults",
+      "output_token": "NextToken",
+      "result_key": "Endpoints"
     }
   }
 }

services/s3outposts/src/main/resources/codegen-resources/service-2.json

@@ -28,7 +28,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"ConflictException"}
       ],
-      "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p> <p>This action creates an endpoint and associates it with the specified Outposts.</p> <note> <p>It can take up to 5 minutes for this action to complete.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
+      "documentation":"<p>Creates an endpoint and associates it with the specified Outpost.</p> <note> <p>It can take up to 5 minutes for this action to finish.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
     },
     "DeleteEndpoint":{
       "name":"DeleteEndpoint",
@@ -43,7 +43,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"ValidationException"}
       ],
-      "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p> <p>This action deletes an endpoint.</p> <note> <p>It can take up to 5 minutes for this action to complete.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
+      "documentation":"<p>Deletes an endpoint.</p> <note> <p>It can take up to 5 minutes for this action to finish.</p> </note> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html\">ListEndpoints</a> </p> </li> </ul>"
     },
     "ListEndpoints":{
       "name":"ListEndpoints",
@@ -59,7 +59,23 @@
         {"shape":"AccessDeniedException"},
         {"shape":"ValidationException"}
       ],
-      "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p> <p>This action lists endpoints associated with the Outposts. </p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> </ul>"
+      "documentation":"<p>Lists endpoints associated with the specified Outpost. </p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> </ul>"
+    },
+    "ListSharedEndpoints":{
+      "name":"ListSharedEndpoints",
+      "http":{
+        "method":"GET",
+        "requestUri":"/S3Outposts/ListSharedEndpoints"
+      },
+      "input":{"shape":"ListSharedEndpointsRequest"},
+      "output":{"shape":"ListSharedEndpointsResult"},
+      "errors":[
+        {"shape":"InternalServerException"},
+        {"shape":"ResourceNotFoundException"},
+        {"shape":"AccessDeniedException"},
+        {"shape":"ValidationException"}
+      ],
+      "documentation":"<p>Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).</p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html\">CreateEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html\">DeleteEndpoint</a> </p> </li> </ul>"
     }
   },
   "shapes":{
@@ -92,23 +108,23 @@
       "members":{
         "OutpostId":{
           "shape":"OutpostId",
-          "documentation":"<p>The ID of the AWS Outposts. </p>"
+          "documentation":"<p>The ID of the Outposts. </p>"
         },
         "SubnetId":{
           "shape":"SubnetId",
-          "documentation":"<p>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.</p>"
+          "documentation":"<p>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.</p>"
         },
         "SecurityGroupId":{
           "shape":"SecurityGroupId",
           "documentation":"<p>The ID of the security group to use with the endpoint.</p>"
         },
         "AccessType":{
           "shape":"EndpointAccessType",
-          "documentation":"<p>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.</p>"
+          "documentation":"<p>The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose <code>Private</code>. To use the endpoint with an on-premises network, choose <code>CustomerOwnedIp</code>. If you choose <code>CustomerOwnedIp</code>, you must also provide the customer-owned IP address pool (CoIP pool).</p> <note> <p> <code>Private</code> is the default access type value.</p> </note>"
         },
         "CustomerOwnedIpv4Pool":{
           "shape":"CustomerOwnedIpv4Pool",
-          "documentation":"<p>The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will be allocated from this pool for the endpoint.</p>"
+          "documentation":"<p>The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.</p>"
         }
       }
     },
@@ -141,7 +157,7 @@
         },
         "OutpostId":{
           "shape":"OutpostId",
-          "documentation":"<p>The ID of the AWS Outposts. </p>",
+          "documentation":"<p>The ID of the Outposts. </p>",
           "location":"querystring",
           "locationName":"outpostId"
         }
@@ -156,7 +172,7 @@
         },
         "OutpostsId":{
           "shape":"OutpostId",
-          "documentation":"<p>The ID of the AWS Outposts.</p>"
+          "documentation":"<p>The ID of the Outposts.</p>"
         },
         "CidrBlock":{
           "shape":"CidrBlock",
@@ -188,14 +204,14 @@
         },
         "AccessType":{
           "shape":"EndpointAccessType",
-          "documentation":"<p/>"
+          "documentation":"<p>The type of connectivity used to access the Amazon S3 on Outposts endpoint.</p>"
         },
         "CustomerOwnedIpv4Pool":{
           "shape":"CustomerOwnedIpv4Pool",
-          "documentation":"<p>The ID of the customer-owned IPv4 pool used for the endpoint.</p>"
+          "documentation":"<p>The ID of the customer-owned IPv4 address pool used for the endpoint.</p>"
         }
       },
-      "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html\"> Accessing S3 on Outposts using VPC only access points</a>.</p>"
+      "documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/WorkingWithS3Outposts.html\"> Accessing S3 on Outposts using VPC-only access points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
     },
     "EndpointAccessType":{
       "type":"string",
@@ -240,13 +256,13 @@
       "members":{
         "NextToken":{
           "shape":"NextToken",
-          "documentation":"<p>The next endpoint requested in the list.</p>",
+          "documentation":"<p>If a previous response from this operation included a <code>NextToken</code> value, provide that value here to retrieve the next page of results.</p>",
           "location":"querystring",
           "locationName":"nextToken"
         },
         "MaxResults":{
           "shape":"MaxResults",
-          "documentation":"<p>The max number of endpoints that can be returned on the request.</p>",
+          "documentation":"<p>The maximum number of endpoints that will be returned in the response.</p>",
           "location":"querystring",
           "locationName":"maxResults"
         }
@@ -257,11 +273,48 @@
       "members":{
         "Endpoints":{
           "shape":"Endpoints",
-          "documentation":"<p>Returns an array of endpoints associated with AWS Outposts.</p>"
+          "documentation":"<p>The list of endpoints associated with the specified Outpost.</p>"
+        },
+        "NextToken":{
+          "shape":"NextToken",
+          "documentation":"<p>If the number of endpoints associated with the specified Outpost exceeds <code>MaxResults</code>, you can include this value in subsequent calls to this operation to retrieve more results.</p>"
+        }
+      }
+    },
+    "ListSharedEndpointsRequest":{
+      "type":"structure",
+      "required":["OutpostId"],
+      "members":{
+        "NextToken":{
+          "shape":"NextToken",
+          "documentation":"<p>If a previous response from this operation included a <code>NextToken</code> value, you can provide that value here to retrieve the next page of results.</p>",
+          "location":"querystring",
+          "locationName":"nextToken"
+        },
+        "MaxResults":{
+          "shape":"MaxResults",
+          "documentation":"<p>The maximum number of endpoints that will be returned in the response.</p>",
+          "location":"querystring",
+          "locationName":"maxResults"
+        },
+        "OutpostId":{
+          "shape":"OutpostId",
+          "documentation":"<p>The ID of the Amazon Web Services Outpost.</p>",
+          "location":"querystring",
+          "locationName":"outpostId"
+        }
+      }
+    },
+    "ListSharedEndpointsResult":{
+      "type":"structure",
+      "members":{
+        "Endpoints":{
+          "shape":"Endpoints",
+          "documentation":"<p>The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).</p>"
         },
         "NextToken":{
           "shape":"NextToken",
-          "documentation":"<p>The next endpoint returned in the list.</p>"
+          "documentation":"<p>If the number of endpoints associated with the specified Outpost exceeds <code>MaxResults</code>, you can include this value in subsequent calls to this operation to retrieve more results.</p>"
         }
       }
     },