feat(client-s3-control): Amazon S3 Batch Operations now manages bucke…

…ts or prefixes in a single step.
aws · Nov 22, 2023 · 2ff1875 · 2ff1875
1 parent 27a5b6c
commit 2ff1875
Show file tree

Hide file tree

Showing 15 changed files with 610 additions and 365 deletions.
diff --git a/clients/client-s3-control/src/commands/CreateJobCommand.ts b/clients/client-s3-control/src/commands/CreateJobCommand.ts
@@ -233,6 +233,22 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
  *         ObjectReplicationStatuses: [ // ReplicationStatusFilterList
  *           "COMPLETED" || "FAILED" || "REPLICA" || "NONE",
  *         ],
+ *         KeyNameConstraint: { // KeyNameConstraint
+ *           MatchAnyPrefix: [ // NonEmptyMaxLength1024StringList
+ *             "STRING_VALUE",
+ *           ],
+ *           MatchAnySuffix: [
+ *             "STRING_VALUE",
+ *           ],
+ *           MatchAnySubstring: [
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *         ObjectSizeGreaterThanBytes: Number("long"),
+ *         ObjectSizeLessThanBytes: Number("long"),
+ *         MatchAnyStorageClass: [ // StorageClassList
+ *           "STANDARD" || "STANDARD_IA" || "ONEZONE_IA" || "GLACIER" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "GLACIER_IR",
+ *         ],
  *       },
  *       EnableManifestOutput: true || false, // required
  *     },

diff --git a/clients/client-s3-control/src/commands/DeleteStorageLensGroupCommand.ts b/clients/client-s3-control/src/commands/DeleteStorageLensGroupCommand.ts
@@ -38,13 +38,12 @@ export interface DeleteStorageLensGroupCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>
- * Deletes an existing S3 Storage Lens group.</p>
+ * <p> Deletes an existing S3 Storage Lens group.</p>
  *          <p>To use this operation, you must have the permission to perform the
- *       <code>s3:DeleteStorageLensGroup</code> action. For more information about the required Storage Lens
- *       Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
+ *             <code>s3:DeleteStorageLensGroup</code> action. For more information about the required
+ *          Storage Lens Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
  *          <p>For information about Storage Lens groups errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList">List of Amazon S3 Storage
- *       Lens error codes</a>.</p>
+ *             Lens error codes</a>.</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/DescribeJobCommand.ts b/clients/client-s3-control/src/commands/DescribeJobCommand.ts
@@ -247,6 +247,22 @@ export interface DescribeJobCommandOutput extends DescribeJobResult, __MetadataB
  * //           ObjectReplicationStatuses: [ // ReplicationStatusFilterList
  * //             "COMPLETED" || "FAILED" || "REPLICA" || "NONE",
  * //           ],
+ * //           KeyNameConstraint: { // KeyNameConstraint
+ * //             MatchAnyPrefix: [ // NonEmptyMaxLength1024StringList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             MatchAnySuffix: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             MatchAnySubstring: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           ObjectSizeGreaterThanBytes: Number("long"),
+ * //           ObjectSizeLessThanBytes: Number("long"),
+ * //           MatchAnyStorageClass: [ // StorageClassList
+ * //             "STANDARD" || "STANDARD_IA" || "ONEZONE_IA" || "GLACIER" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "GLACIER_IR",
+ * //           ],
  * //         },
  * //         EnableManifestOutput: true || false, // required
  * //       },

diff --git a/clients/client-s3-control/src/commands/GetBucketReplicationCommand.ts b/clients/client-s3-control/src/commands/GetBucketReplicationCommand.ts
@@ -46,7 +46,8 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationR
  *          <p>Returns the replication configuration of an S3 on Outposts bucket. For more information
  *          about S3 on Outposts, 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>. For information about S3 replication on Outposts
- *          configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
+ *          configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for
+ *             S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <note>
  *             <p>It can take a while to propagate <code>PUT</code> or <code>DELETE</code> requests for
  *             a replication configuration to all S3 on Outposts systems. Therefore, the replication

diff --git a/clients/client-s3-control/src/commands/GetStorageLensGroupCommand.ts b/clients/client-s3-control/src/commands/GetStorageLensGroupCommand.ts
@@ -38,13 +38,12 @@ export interface GetStorageLensGroupCommandOutput extends GetStorageLensGroupRes
 
 /**
  * @public
- * <p>
- * Retrieves the Storage Lens group configuration details.</p>
+ * <p> Retrieves the Storage Lens group configuration details.</p>
  *          <p>To use this operation, you must have the permission to perform the
- *       <code>s3:GetStorageLensGroup</code> action. For more information about the required Storage Lens
- *       Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
+ *             <code>s3:GetStorageLensGroup</code> action. For more information about the required
+ *          Storage Lens Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
  *          <p>For information about Storage Lens groups errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList">List of Amazon S3 Storage
- *       Lens error codes</a>.</p>
+ *             Lens error codes</a>.</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/ListStorageLensGroupsCommand.ts b/clients/client-s3-control/src/commands/ListStorageLensGroupsCommand.ts
@@ -38,14 +38,12 @@ export interface ListStorageLensGroupsCommandOutput extends ListStorageLensGroup
 
 /**
  * @public
- * <p>
- * Lists all the Storage Lens groups in the specified home Region.
- * </p>
+ * <p> Lists all the Storage Lens groups in the specified home Region. </p>
  *          <p>To use this operation, you must have the permission to perform the
- *       <code>s3:ListStorageLensGroups</code> action. For more information about the required Storage Lens
- *       Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
+ *             <code>s3:ListStorageLensGroups</code> action. For more information about the required
+ *          Storage Lens Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
  *          <p>For information about Storage Lens groups errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList">List of Amazon S3 Storage
- *       Lens error codes</a>.</p>
+ *             Lens error codes</a>.</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/ListTagsForResourceCommand.ts b/clients/client-s3-control/src/commands/ListTagsForResourceCommand.ts
@@ -41,9 +41,10 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * <p> This operation allows you to list all the Amazon Web Services resource tags for the specified
  *          resource. </p>
  *          <p>To use this operation, you must have the permission to perform the
- *       <code>s3:ListTagsForResource</code> action. For more information about the required Storage Lens
- *       Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
- *          <p>For information about S3 Tagging errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList">List of Amazon S3 Tagging error codes</a>.</p>
+ *             <code>s3:ListTagsForResource</code> action. For more information about the required
+ *          Storage Lens Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
+ *          <p>For information about S3 Tagging errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList">List of Amazon S3
+ *             Tagging error codes</a>.</p>
  *          <note>
  *             <p>This operation is only supported for <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html">S3 Storage Lens
  *                groups</a>.</p>

diff --git a/clients/client-s3-control/src/commands/PutBucketReplicationCommand.ts b/clients/client-s3-control/src/commands/PutBucketReplicationCommand.ts
@@ -45,8 +45,8 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {}
  *             in the <i>Amazon S3 API Reference</i>. </p>
  *          </note>
  *          <p>Creates a replication configuration or replaces an existing one. For information about
- *          S3 replication on Outposts configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for S3 on Outposts</a> in the
- *             <i>Amazon S3 User Guide</i>.</p>
+ *          S3 replication on Outposts configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html">Replicating objects for
+ *             S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <note>
  *             <p>It can take a while to propagate <code>PUT</code> or <code>DELETE</code> requests for
  *             a replication configuration to all S3 on Outposts systems. Therefore, the replication
@@ -71,9 +71,9 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {}
  *             </li>
  *          </ul>
  *          <p>A replication configuration must include at least one rule and can contain a maximum of
- *          100. Each rule identifies a subset of objects to replicate by filtering the objects in
- *          the source Outposts bucket. To choose additional subsets of objects to replicate, add a
- *          rule for each subset.</p>
+ *          100. Each rule identifies a subset of objects to replicate by filtering the objects in the
+ *          source Outposts bucket. To choose additional subsets of objects to replicate, add a rule
+ *          for each subset.</p>
  *          <p>To specify a subset of the objects in the source Outposts bucket to apply a replication
  *          rule to, add the <code>Filter</code> element as a child of the <code>Rule</code> element.
  *          You can filter objects based on an object key prefix, one or more object tags, or both.
@@ -102,9 +102,10 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {}
  *             S3 on Outposts</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsBucketPolicy.html">Managing access to
  *             S3 on Outposts buckets</a>. </p>
  *          <note>
- *             <p>To perform this operation, the user or role must also have the <code>iam:CreateRole</code> and <code>iam:PassRole</code> permissions.
- *             For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">Granting a user
- *                permissions to pass a role to an Amazon Web Services service</a>.</p>
+ *             <p>To perform this operation, the user or role must also have the
+ *                <code>iam:CreateRole</code> and <code>iam:PassRole</code> permissions. For more
+ *             information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">Granting a user permissions to
+ *                pass a role to an Amazon Web Services service</a>.</p>
  *          </note>
  *          <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_PutBucketReplication.html#API_control_PutBucketReplication_Examples">Examples</a> section.</p>
  *          <p>The following operations are related to <code>PutBucketReplication</code>:</p>

diff --git a/clients/client-s3-control/src/commands/PutBucketVersioningCommand.ts b/clients/client-s3-control/src/commands/PutBucketVersioningCommand.ts
@@ -75,11 +75,11 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {}
  *          see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html"> Creating and managing
  *             a lifecycle configuration for your S3 on Outposts bucket</a> in the <i>Amazon S3
  *             User Guide</i>.</p>
- *          <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and you
- *          want to maintain the same permanent delete behavior when you enable versioning, you must
- *          add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage
- *          the deletes of the noncurrent object versions in the version-enabled bucket. For more
- *          information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">Versioning</a> in the <i>Amazon S3
+ *          <p>If you have an object expiration lifecycle configuration in your non-versioned bucket
+ *          and you want to maintain the same permanent delete behavior when you enable versioning, you
+ *          must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration
+ *          will manage the deletes of the noncurrent object versions in the version-enabled bucket.
+ *          For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">Versioning</a> in the <i>Amazon S3
  *             User Guide</i>.</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_PutBucketVersioning.html#API_control_PutBucketVersioning_Examples">Examples</a> section.</p>
  *          <p>The following operations are related to <code>PutBucketVersioning</code> for

diff --git a/clients/client-s3-control/src/commands/SubmitMultiRegionAccessPointRoutesCommand.ts b/clients/client-s3-control/src/commands/SubmitMultiRegionAccessPointRoutesCommand.ts
@@ -51,7 +51,8 @@ export interface SubmitMultiRegionAccessPointRoutesCommandOutput
  *          routing status for the specified Regions from active to passive, or from passive to active.
  *          A value of <code>0</code> indicates a passive status, which means that traffic won't be
  *          routed to the specified Region. A value of <code>100</code> indicates an active status,
- *          which means that traffic will be routed to the specified Region. At least one Region must be active at all times.</p>
+ *          which means that traffic will be routed to the specified Region. At least one Region must
+ *          be active at all times.</p>
  *          <p>When the routing configuration is changed, any in-progress operations (uploads, copies,
  *          deletes, and so on) to formerly active Regions will continue to run to their final
  *          completion state (success or failure). The routing configurations of any Regions that

diff --git a/clients/client-s3-control/src/commands/TagResourceCommand.ts b/clients/client-s3-control/src/commands/TagResourceCommand.ts
@@ -41,11 +41,13 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB
  * <p> Creates a new Amazon Web Services resource tag or updates an existing resource tag. You can add up to
  *          50 Amazon Web Services resource tags for each S3 resource. </p>
  *          <p>To use this operation, you must have the permission to perform the
- *       <code>s3:TagResource</code> action. For more information about the required Storage Lens
- *       Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
- *          <p>For information about S3 Tagging errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList">List of Amazon S3 Tagging error codes</a>.</p>
+ *             <code>s3:TagResource</code> action. For more information about the required Storage Lens
+ *          Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
+ *          <p>For information about S3 Tagging errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3TaggingErrorCodeList">List of Amazon S3
+ *             Tagging error codes</a>.</p>
  *          <note>
- *             <p>This operation is only supported for <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html">S3 Storage Lens groups</a>.</p>
+ *             <p>This operation is only supported for <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-lens-groups.html">S3 Storage Lens
+ *                groups</a>.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-s3-control/src/commands/UpdateStorageLensGroupCommand.ts b/clients/client-s3-control/src/commands/UpdateStorageLensGroupCommand.ts
@@ -38,13 +38,12 @@ export interface UpdateStorageLensGroupCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>
- * Updates the existing Storage Lens group.</p>
+ * <p> Updates the existing Storage Lens group.</p>
  *          <p>To use this operation, you must have the permission to perform the
- *       <code>s3:UpdateStorageLensGroup</code> action. For more information about the required Storage Lens
- *       Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
+ *             <code>s3:UpdateStorageLensGroup</code> action. For more information about the required
+ *          Storage Lens Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
  *          <p>For information about Storage Lens groups errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList">List of Amazon S3 Storage
- *       Lens error codes</a>.</p>
+ *             Lens error codes</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript