feat(client-s3-control): Adds support for S3 Express One Zone, and In…

…vocationSchemaVersion 2.0 for S3 Batch Operations.
aws · Nov 28, 2023 · 27037e8 · 27037e8
1 parent 428953b
commit 27037e8
Show file tree

Hide file tree

Showing 51 changed files with 630 additions and 245 deletions.
diff --git a/clients/client-s3-control/src/commands/CreateAccessPointCommand.ts b/clients/client-s3-control/src/commands/CreateAccessPointCommand.ts
@@ -38,7 +38,10 @@ export interface CreateAccessPointCommandOutput extends CreateAccessPointResult,
 
 /**
  * @public
- * <p>Creates an access point and associates it with the specified bucket. For more information, see
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Creates an access point and associates it with the specified bucket. For more information, see
  *             <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing
  *             Data Access with Amazon S3 Access Points</a> in the
  *             <i>Amazon S3 User Guide</i>.</p>

diff --git a/clients/client-s3-control/src/commands/CreateAccessPointForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/CreateAccessPointForObjectLambdaCommand.ts
@@ -43,7 +43,10 @@ export interface CreateAccessPointForObjectLambdaCommandOutput
 
 /**
  * @public
- * <p>Creates an Object Lambda Access Point. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Creates an Object Lambda Access Point. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
  *             Object Lambda Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <p>The following actions are related to
  *          <code>CreateAccessPointForObjectLambda</code>:</p>

diff --git a/clients/client-s3-control/src/commands/CreateJobCommand.ts b/clients/client-s3-control/src/commands/CreateJobCommand.ts
@@ -38,10 +38,17 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
 
 /**
  * @public
- * <p>You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
+ * <p>This operation creates an S3 Batch Operations job.</p>
+ *          <p>You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects.
  *          Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more
  *          information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
- *          <p>This action creates a S3 Batch Operations job.</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>For information about permissions required to use the Batch Operations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Granting permissions for S3 Batch Operations</a> in the <i>Amazon S3
+ *                      User Guide</i>.</p>
+ *             </dd>
+ *          </dl>
  *          <p></p>
  *          <p>Related actions include:</p>
  *          <ul>
@@ -83,6 +90,10 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
  *   Operation: { // JobOperation
  *     LambdaInvoke: { // LambdaInvokeOperation
  *       FunctionArn: "STRING_VALUE",
+ *       InvocationSchemaVersion: "STRING_VALUE",
+ *       UserArguments: { // UserArguments
+ *         "<keys>": "STRING_VALUE",
+ *       },
  *     },
  *     S3PutObjectCopy: { // S3CopyObjectOperation
  *       TargetResource: "STRING_VALUE",

diff --git a/clients/client-s3-control/src/commands/CreateMultiRegionAccessPointCommand.ts b/clients/client-s3-control/src/commands/CreateMultiRegionAccessPointCommand.ts
@@ -44,7 +44,10 @@ export interface CreateMultiRegionAccessPointCommandOutput
 
 /**
  * @public
- * <p>Creates a Multi-Region Access Point and associates it with the specified buckets. For more information
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Creates a Multi-Region Access Point and associates it with the specified buckets. For more information
  *          about creating Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html">Creating
  *             Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <p>This action will always be routed to the US West (Oregon) Region. For more information

diff --git a/clients/client-s3-control/src/commands/DeleteAccessPointCommand.ts b/clients/client-s3-control/src/commands/DeleteAccessPointCommand.ts
@@ -38,7 +38,10 @@ export interface DeleteAccessPointCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>Deletes the specified access point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the specified access point.</p>
  *          <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples">Examples</a> section.</p>
  *          <p>The following actions are related to <code>DeleteAccessPoint</code>:</p>
  *          <ul>

diff --git a/clients/client-s3-control/src/commands/DeleteAccessPointForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/DeleteAccessPointForObjectLambdaCommand.ts
@@ -41,7 +41,10 @@ export interface DeleteAccessPointForObjectLambdaCommandOutput extends __Metadat
 
 /**
  * @public
- * <p>Deletes the specified Object Lambda Access Point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the specified Object Lambda Access Point.</p>
  *          <p>The following actions are related to
  *          <code>DeleteAccessPointForObjectLambda</code>:</p>
  *          <ul>

diff --git a/clients/client-s3-control/src/commands/DeleteAccessPointPolicyCommand.ts b/clients/client-s3-control/src/commands/DeleteAccessPointPolicyCommand.ts
@@ -38,7 +38,10 @@ export interface DeleteAccessPointPolicyCommandOutput extends __MetadataBearer {
 
 /**
  * @public
- * <p>Deletes the access point policy for the specified access point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the access point policy for the specified access point.</p>
  *          <p></p>
  *          <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicy.html#API_control_DeleteAccessPointPolicy_Examples">Examples</a> section.</p>
  *          <p>The following actions are related to <code>DeleteAccessPointPolicy</code>:</p>

diff --git a/clients/client-s3-control/src/commands/DeleteAccessPointPolicyForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/DeleteAccessPointPolicyForObjectLambdaCommand.ts
@@ -42,7 +42,10 @@ export interface DeleteAccessPointPolicyForObjectLambdaCommandOutput extends __M
 
 /**
  * @public
- * <p>Removes the resource policy for an Object Lambda Access Point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Removes the resource policy for an Object Lambda Access Point.</p>
  *          <p>The following actions are related to
  *          <code>DeleteAccessPointPolicyForObjectLambda</code>:</p>
  *          <ul>

diff --git a/clients/client-s3-control/src/commands/DeleteJobTaggingCommand.ts b/clients/client-s3-control/src/commands/DeleteJobTaggingCommand.ts
@@ -38,13 +38,17 @@ export interface DeleteJobTaggingCommandOutput extends DeleteJobTaggingResult, _
 
 /**
  * @public
- * <p>Removes the entire tag set from the specified S3 Batch Operations job. To use
- *          the
- *             <code>DeleteJobTagging</code> operation, you must have permission to
- *          perform the <code>s3:DeleteJobTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling
- *             access and labeling jobs using tags</a> in the
- *          <i>Amazon S3 User Guide</i>.</p>
- *          <p></p>
+ * <p>Removes the entire tag set from the specified S3 Batch Operations job.</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>To use the
+ *                   <code>DeleteJobTagging</code> operation, you must have permission to
+ *                   perform the <code>s3:DeleteJobTagging</code> action. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags">Controlling
+ *                      access and labeling jobs using tags</a> in the
+ *                   <i>Amazon S3 User Guide</i>.</p>
+ *             </dd>
+ *          </dl>
  *          <p>Related actions include:</p>
  *          <ul>
  *             <li>

diff --git a/clients/client-s3-control/src/commands/DeleteMultiRegionAccessPointCommand.ts b/clients/client-s3-control/src/commands/DeleteMultiRegionAccessPointCommand.ts
@@ -44,7 +44,10 @@ export interface DeleteMultiRegionAccessPointCommandOutput
 
 /**
  * @public
- * <p>Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,
  *          only the Multi-Region Access Point itself.</p>
  *          <p>This action will always be routed to the US West (Oregon) Region. For more information
  *          about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing

diff --git a/clients/client-s3-control/src/commands/DeletePublicAccessBlockCommand.ts b/clients/client-s3-control/src/commands/DeletePublicAccessBlockCommand.ts
@@ -38,7 +38,10 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer {
 
 /**
  * @public
- * <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon Web Services account. For more
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon Web Services account. For more
  *          information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html"> Using Amazon S3 block
  *             public access</a>.</p>
  *          <p>Related actions include:</p>

diff --git a/clients/client-s3-control/src/commands/DeleteStorageLensConfigurationCommand.ts b/clients/client-s3-control/src/commands/DeleteStorageLensConfigurationCommand.ts
@@ -41,7 +41,10 @@ export interface DeleteStorageLensConfigurationCommandOutput extends __MetadataB
 
 /**
  * @public
- * <p>Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your storage
  *             activity and usage with Amazon S3 Storage Lens </a> in the
  *             <i>Amazon S3 User Guide</i>.</p>
  *          <note>

diff --git a/clients/client-s3-control/src/commands/DeleteStorageLensConfigurationTaggingCommand.ts b/clients/client-s3-control/src/commands/DeleteStorageLensConfigurationTaggingCommand.ts
@@ -47,7 +47,10 @@ export interface DeleteStorageLensConfigurationTaggingCommandOutput
 
 /**
  * @public
- * <p>Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see
  *             <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html">Assessing your
  *             storage activity and usage with Amazon S3 Storage Lens </a> in the
  *             <i>Amazon S3 User Guide</i>.</p>

diff --git a/clients/client-s3-control/src/commands/DescribeJobCommand.ts b/clients/client-s3-control/src/commands/DescribeJobCommand.ts
@@ -40,7 +40,12 @@ export interface DescribeJobCommandOutput extends DescribeJobResult, __MetadataB
  * @public
  * <p>Retrieves the configuration parameters and status for a Batch Operations job. For more
  *          information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the <i>Amazon S3 User Guide</i>.</p>
- *          <p></p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>To use the <code>DescribeJob</code> operation, you must have permission to perform the <code>s3:DescribeJob</code> action.</p>
+ *             </dd>
+ *          </dl>
  *          <p>Related actions include:</p>
  *          <ul>
  *             <li>
@@ -99,6 +104,10 @@ export interface DescribeJobCommandOutput extends DescribeJobResult, __MetadataB
  * //     Operation: { // JobOperation
  * //       LambdaInvoke: { // LambdaInvokeOperation
  * //         FunctionArn: "STRING_VALUE",
+ * //         InvocationSchemaVersion: "STRING_VALUE",
+ * //         UserArguments: { // UserArguments
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
  * //       },
  * //       S3PutObjectCopy: { // S3CopyObjectOperation
  * //         TargetResource: "STRING_VALUE",

diff --git a/clients/client-s3-control/src/commands/DescribeMultiRegionAccessPointOperationCommand.ts b/clients/client-s3-control/src/commands/DescribeMultiRegionAccessPointOperationCommand.ts
@@ -48,7 +48,10 @@ export interface DescribeMultiRegionAccessPointOperationCommandOutput
 
 /**
  * @public
- * <p>Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information
  *          about managing Multi-Region Access Points and how asynchronous requests work, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
  *             Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>

diff --git a/clients/client-s3-control/src/commands/GetAccessPointCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointCommand.ts
@@ -38,7 +38,10 @@ export interface GetAccessPointCommandOutput extends GetAccessPointResult, __Met
 
 /**
  * @public
- * <p>Returns configuration information about the specified access point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns configuration information about the specified access point.</p>
  *          <p></p>
  *          <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html#API_control_GetAccessPoint_Examples">Examples</a> section.</p>
  *          <p>The following actions are related to <code>GetAccessPoint</code>:</p>

diff --git a/clients/client-s3-control/src/commands/GetAccessPointConfigurationForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointConfigurationForObjectLambdaCommand.ts
@@ -47,7 +47,10 @@ export interface GetAccessPointConfigurationForObjectLambdaCommandOutput
 
 /**
  * @public
- * <p>Returns configuration for an Object Lambda Access Point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns configuration for an Object Lambda Access Point.</p>
  *          <p>The following actions are related to
  *             <code>GetAccessPointConfigurationForObjectLambda</code>:</p>
  *          <ul>

diff --git a/clients/client-s3-control/src/commands/GetAccessPointForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointForObjectLambdaCommand.ts
@@ -43,7 +43,10 @@ export interface GetAccessPointForObjectLambdaCommandOutput
 
 /**
  * @public
- * <p>Returns configuration information about the specified Object Lambda Access Point</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns configuration information about the specified Object Lambda Access Point</p>
  *          <p>The following actions are related to <code>GetAccessPointForObjectLambda</code>:</p>
  *          <ul>
  *             <li>

diff --git a/clients/client-s3-control/src/commands/GetAccessPointPolicyCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointPolicyCommand.ts
@@ -38,7 +38,10 @@ export interface GetAccessPointPolicyCommandOutput extends GetAccessPointPolicyR
 
 /**
  * @public
- * <p>Returns the access point policy associated with the specified access point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns the access point policy associated with the specified access point.</p>
  *          <p>The following actions are related to <code>GetAccessPointPolicy</code>:</p>
  *          <ul>
  *             <li>

diff --git a/clients/client-s3-control/src/commands/GetAccessPointPolicyForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointPolicyForObjectLambdaCommand.ts
@@ -46,7 +46,10 @@ export interface GetAccessPointPolicyForObjectLambdaCommandOutput
 
 /**
  * @public
- * <p>Returns the resource policy for an Object Lambda Access Point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns the resource policy for an Object Lambda Access Point.</p>
  *          <p>The following actions are related to
  *          <code>GetAccessPointPolicyForObjectLambda</code>:</p>
  *          <ul>

diff --git a/clients/client-s3-control/src/commands/GetAccessPointPolicyStatusCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointPolicyStatusCommand.ts
@@ -38,7 +38,10 @@ export interface GetAccessPointPolicyStatusCommandOutput extends GetAccessPointP
 
 /**
  * @public
- * <p>Indicates whether the specified access point currently has a policy that allows public access.
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Indicates whether the specified access point currently has a policy that allows public access.
  *          For more information about public access through access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing Data Access with Amazon S3
  *             access points</a> in the <i>Amazon S3 User Guide</i>.</p>
  * @example

diff --git a/clients/client-s3-control/src/commands/GetAccessPointPolicyStatusForObjectLambdaCommand.ts b/clients/client-s3-control/src/commands/GetAccessPointPolicyStatusForObjectLambdaCommand.ts
@@ -47,7 +47,10 @@ export interface GetAccessPointPolicyStatusForObjectLambdaCommandOutput
 
 /**
  * @public
- * <p>Returns the status of the resource policy associated with an Object Lambda Access Point.</p>
+ * <note>
+ *             <p>This operation is not supported by directory buckets.</p>
+ *          </note>
+ *          <p>Returns the status of the resource policy associated with an Object Lambda Access Point.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-s3-control/src/commands/GetBucketCommand.ts b/clients/client-s3-control/src/commands/GetBucketCommand.ts
@@ -38,8 +38,10 @@ export interface GetBucketCommandOutput extends GetBucketResult, __MetadataBeare
 
 /**
  * @public
- * <p>Gets an Amazon S3 on Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html"> Using Amazon S3 on Outposts</a> in the
+ * <note>
+ *             <p>Gets an Amazon S3 on Outposts bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html"> Using Amazon S3 on Outposts</a> in the
  *             <i>Amazon S3 User Guide</i>.</p>
+ *          </note>
  *          <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
  *          Outposts bucket, the calling identity must have the <code>s3-outposts:GetBucket</code>
  *          permissions on the specified Outposts bucket and belong to the Outposts bucket owner's