Skip to content

Commit 59c84c3

Browse files
author
awstools
committed
docs(client-s3-control): Documentation updates for Amazon S3-control.
1 parent bd8d5bf commit 59c84c3

16 files changed

+61
-69
lines changed

clients/client-s3-control/src/commands/CreateJobCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
3535
* <dl>
3636
* <dt>Permissions</dt>
3737
* <dd>
38-
* <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
38+
* <p>For information about permissions required to use the Batch Operations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-iam-role-policies.html">Granting permissions for S3 Batch Operations</a> in the <i>Amazon S3
3939
* User Guide</i>.</p>
4040
* </dd>
4141
* </dl>

clients/client-s3-control/src/commands/CreateMultiRegionAccessPointCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,10 @@ export interface CreateMultiRegionAccessPointCommandOutput
3838
* <p>This operation is not supported by directory buckets.</p>
3939
* </note>
4040
* <p>Creates a Multi-Region Access Point and associates it with the specified buckets. For more information
41-
* about creating Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html">Creating
42-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
41+
* 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>
4342
* <p>This action will always be routed to the US West (Oregon) Region. For more information
44-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
45-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
43+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
44+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
4645
* <p>This request is asynchronous, meaning that you might receive a response before the
4746
* command has completed. When this request provides a response, it provides a token that you
4847
* can use to monitor the status of the request with

clients/client-s3-control/src/commands/DeleteMultiRegionAccessPointCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ export interface DeleteMultiRegionAccessPointCommandOutput
4040
* <p>Deletes a Multi-Region Access Point. This action does not delete the buckets associated with the Multi-Region Access Point,
4141
* only the Multi-Region Access Point itself.</p>
4242
* <p>This action will always be routed to the US West (Oregon) Region. For more information
43-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
44-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
43+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
44+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
4545
* <p>This request is asynchronous, meaning that you might receive a response before the
4646
* command has completed. When this request provides a response, it provides a token that you
4747
* can use to monitor the status of the request with

clients/client-s3-control/src/commands/DescribeMultiRegionAccessPointOperationCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ export interface DescribeMultiRegionAccessPointOperationCommandOutput
4242
* <p>This operation is not supported by directory buckets.</p>
4343
* </note>
4444
* <p>Retrieves the status of an asynchronous request to manage a Multi-Region Access Point. For more information
45-
* 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
46-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
45+
* about managing Multi-Region Access Points and how asynchronous requests work, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MrapOperations.html">Using Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
4746
* <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
4847
* <ul>
4948
* <li>

clients/client-s3-control/src/commands/GetBucketCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,14 @@ export interface GetBucketCommandInput extends GetBucketRequest {}
2828
export interface GetBucketCommandOutput extends GetBucketResult, __MetadataBearer {}
2929

3030
/**
31-
* <note>
32-
* <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
31+
* <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
3332
* <i>Amazon S3 User Guide</i>.</p>
34-
* </note>
3533
* <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
3634
* Outposts bucket, the calling identity must have the <code>s3-outposts:GetBucket</code>
3735
* permissions on the specified Outposts bucket and belong to the Outposts bucket owner's
3836
* account in order to use this action. Only users from Outposts bucket owner account with
3937
* the right permissions can perform actions on an Outposts bucket. </p>
40-
* <p> If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an
38+
* <p>If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an
4139
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access
4240
* Denied</code> error.</p>
4341
* <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p>

clients/client-s3-control/src/commands/GetDataAccessCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface GetDataAccessCommandOutput extends GetDataAccessResult, __Metad
3737
* </dd>
3838
* <dt>Additional Permissions</dt>
3939
* <dd>
40-
* <p>The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: <code>sts:AssumeRole</code>, for directory users or groups <code>sts:SetContext</code>, and for IAM users or roles <code>sts:SourceIdentity</code>. </p>
40+
* <p>The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: <code>sts:AssumeRole</code>, for directory users or groups <code>sts:SetContext</code>, and for IAM users or roles <code>sts:SetSourceIdentity</code>. </p>
4141
* </dd>
4242
* </dl>
4343
* @example

clients/client-s3-control/src/commands/GetMultiRegionAccessPointCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ export interface GetMultiRegionAccessPointCommandOutput extends GetMultiRegionAc
3434
* </note>
3535
* <p>Returns configuration information about the specified Multi-Region Access Point.</p>
3636
* <p>This action will always be routed to the US West (Oregon) Region. For more information
37-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
38-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
37+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
38+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
3939
* <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
4040
* <ul>
4141
* <li>

clients/client-s3-control/src/commands/GetMultiRegionAccessPointPolicyCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ export interface GetMultiRegionAccessPointPolicyCommandOutput
3939
* </note>
4040
* <p>Returns the access control policy of the specified Multi-Region Access Point.</p>
4141
* <p>This action will always be routed to the US West (Oregon) Region. For more information
42-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
43-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
42+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
43+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
4444
* <p>The following actions are related to
4545
* <code>GetMultiRegionAccessPointPolicy</code>:</p>
4646
* <ul>

clients/client-s3-control/src/commands/GetMultiRegionAccessPointPolicyStatusCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ export interface GetMultiRegionAccessPointPolicyStatusCommandOutput
4444
* <p>Indicates whether the specified Multi-Region Access Point has an access control policy that allows public
4545
* access.</p>
4646
* <p>This action will always be routed to the US West (Oregon) Region. For more information
47-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
48-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
47+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
48+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
4949
* <p>The following actions are related to
5050
* <code>GetMultiRegionAccessPointPolicyStatus</code>:</p>
5151
* <ul>

clients/client-s3-control/src/commands/GetMultiRegionAccessPointRoutesCommand.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,6 @@ export interface GetMultiRegionAccessPointRoutesCommandOutput
6868
* </p>
6969
* </li>
7070
* </ul>
71-
* <note>
72-
* <p>Your Amazon S3 bucket does not need to be in these five Regions.</p>
73-
* </note>
7471
* @example
7572
* Use a bare-bones client and the command you need to make an API call.
7673
* ```javascript

clients/client-s3-control/src/commands/ListJobsCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ export interface ListJobsCommandInput extends ListJobsRequest {}
2828
export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 30 days for
32-
* the Amazon Web Services account making the request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops.html">S3 Batch Operations</a> in the
33-
* <i>Amazon S3 User Guide</i>.</p>
31+
* <p>Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90
32+
* days for the Amazon Web Services account making the request. 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>
3433
* <dl>
3534
* <dt>Permissions</dt>
3635
* <dd>

clients/client-s3-control/src/commands/ListMultiRegionAccessPointsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface ListMultiRegionAccessPointsCommandOutput extends ListMultiRegio
3636
* Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be
3737
* associated with a single account.</p>
3838
* <p>This action will always be routed to the US West (Oregon) Region. For more information
39-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
40-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
39+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
40+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
4141
* <p>The following actions are related to <code>ListMultiRegionAccessPoint</code>:</p>
4242
* <ul>
4343
* <li>

clients/client-s3-control/src/commands/PutMultiRegionAccessPointPolicyCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ export interface PutMultiRegionAccessPointPolicyCommandOutput
4141
* one policy, so a request made to this action replaces any existing policy that is
4242
* associated with the specified Multi-Region Access Point.</p>
4343
* <p>This action will always be routed to the US West (Oregon) Region. For more information
44-
* about the restrictions around managing Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ManagingMultiRegionAccessPoints.html">Managing
45-
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
44+
* about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
45+
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
4646
* <p>The following actions are related to
4747
* <code>PutMultiRegionAccessPointPolicy</code>:</p>
4848
* <ul>

clients/client-s3-control/src/commands/SubmitMultiRegionAccessPointRoutesCommand.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,6 @@ export interface SubmitMultiRegionAccessPointRoutesCommandOutput
8383
* </p>
8484
* </li>
8585
* </ul>
86-
* <note>
87-
* <p>Your Amazon S3 bucket does not need to be in these five Regions.</p>
88-
* </note>
8986
* @example
9087
* Use a bare-bones client and the command you need to make an API call.
9188
* ```javascript

0 commit comments

Comments
 (0)