Skip to content

Commit

Permalink
docs(client-s3-control): Documentation updates for Amazon S3-control.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Apr 11, 2024
1 parent bd8d5bf commit 59c84c3
Show file tree
Hide file tree
Showing 16 changed files with 61 additions and 69 deletions.
2 changes: 1 addition & 1 deletion clients/client-s3-control/src/commands/CreateJobCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare
* <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
* <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
* User Guide</i>.</p>
* </dd>
* </dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,10 @@ export interface CreateMultiRegionAccessPointCommandOutput
* <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>
* 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
* about the restrictions around managing Multi-Region Access Points, 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>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>This request is asynchronous, meaning that you might receive a response before the
* command has completed. When this request provides a response, it provides a token that you
* can use to monitor the status of the request with
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ export interface DeleteMultiRegionAccessPointCommandOutput
* <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
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>This request is asynchronous, meaning that you might receive a response before the
* command has completed. When this request provides a response, it provides a token that you
* can use to monitor the status of the request with
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ export interface DescribeMultiRegionAccessPointOperationCommandOutput
* <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>
* 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>
* <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
* <ul>
* <li>
Expand Down
6 changes: 2 additions & 4 deletions clients/client-s3-control/src/commands/GetBucketCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,14 @@ export interface GetBucketCommandInput extends GetBucketRequest {}
export interface GetBucketCommandOutput extends GetBucketResult, __MetadataBearer {}

/**
* <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
* <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
* account in order to use this action. Only users from Outposts bucket owner account with
* the right permissions can perform actions on an Outposts bucket. </p>
* <p> If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an
* <p>If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access
* Denied</code> error.</p>
* <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface GetDataAccessCommandOutput extends GetDataAccessResult, __Metad
* </dd>
* <dt>Additional Permissions</dt>
* <dd>
* <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>
* <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>
* </dd>
* </dl>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ export interface GetMultiRegionAccessPointCommandOutput extends GetMultiRegionAc
* </note>
* <p>Returns configuration information about the specified Multi-Region Access Point.</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
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
* <ul>
* <li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ export interface GetMultiRegionAccessPointPolicyCommandOutput
* </note>
* <p>Returns the access control policy of the specified Multi-Region Access Point.</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
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>The following actions are related to
* <code>GetMultiRegionAccessPointPolicy</code>:</p>
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ export interface GetMultiRegionAccessPointPolicyStatusCommandOutput
* <p>Indicates whether the specified Multi-Region Access Point has an access control policy that allows public
* access.</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
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>The following actions are related to
* <code>GetMultiRegionAccessPointPolicyStatus</code>:</p>
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ export interface GetMultiRegionAccessPointRoutesCommandOutput
* </p>
* </li>
* </ul>
* <note>
* <p>Your Amazon S3 bucket does not need to be in these five Regions.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
5 changes: 2 additions & 3 deletions clients/client-s3-control/src/commands/ListJobsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,8 @@ export interface ListJobsCommandInput extends ListJobsRequest {}
export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer {}

/**
* <p>Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 30 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>
* <p>Lists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90
* 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>
* <dl>
* <dt>Permissions</dt>
* <dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface ListMultiRegionAccessPointsCommandOutput extends ListMultiRegio
* Each call can return up to 100 Multi-Region Access Points, the maximum number of Multi-Region Access Points that can be
* associated with a single account.</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
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>The following actions are related to <code>ListMultiRegionAccessPoint</code>:</p>
* <ul>
* <li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ export interface PutMultiRegionAccessPointPolicyCommandOutput
* one policy, so a request made to this action replaces any existing policy that is
* associated with the specified Multi-Region Access Point.</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
* Multi-Region Access Points</a> in the <i>Amazon S3 User Guide</i>.</p>
* 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
* restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
* <p>The following actions are related to
* <code>PutMultiRegionAccessPointPolicy</code>:</p>
* <ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,6 @@ export interface SubmitMultiRegionAccessPointRoutesCommandOutput
* </p>
* </li>
* </ul>
* <note>
* <p>Your Amazon S3 bucket does not need to be in these five Regions.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit 59c84c3

Please sign in to comment.