@aws-sdk/client-s3-control 3.171.0 → 3.178.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dist-cjs/S3Control.js +30 -0
- package/dist-cjs/commands/GetBucketVersioningCommand.js +38 -0
- package/dist-cjs/commands/PutBucketVersioningCommand.js +40 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +79 -5
- package/dist-cjs/protocols/Aws_restXml.js +143 -3
- package/dist-es/S3Control.js +30 -0
- package/dist-es/commands/GetBucketVersioningCommand.js +41 -0
- package/dist-es/commands/PutBucketVersioningCommand.js +43 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +62 -0
- package/dist-es/protocols/Aws_restXml.js +187 -0
- package/dist-types/S3Control.d.ts +116 -18
- package/dist-types/S3ControlClient.d.ts +4 -2
- package/dist-types/commands/CreateAccessPointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccessPointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccessPointPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketLifecycleConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetAccessPointCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +66 -0
- package/dist-types/commands/ListAccessPointsCommand.d.ts +1 -1
- package/dist-types/commands/PutAccessPointPolicyCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +88 -0
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +127 -12
- package/dist-types/protocols/Aws_restXml.d.ts +6 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/S3Control.d.ts +34 -0
- package/dist-types/ts3.4/S3ControlClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetBucketVersioningCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/PutBucketVersioningCommand.d.ts +31 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +79 -26
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +3 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -1
- package/package.json +31 -31
|
@@ -30,6 +30,7 @@ import { GetBucketCommandInput, GetBucketCommandOutput } from "./commands/GetBuc
|
|
|
30
30
|
import { GetBucketLifecycleConfigurationCommandInput, GetBucketLifecycleConfigurationCommandOutput } from "./commands/GetBucketLifecycleConfigurationCommand";
|
|
31
31
|
import { GetBucketPolicyCommandInput, GetBucketPolicyCommandOutput } from "./commands/GetBucketPolicyCommand";
|
|
32
32
|
import { GetBucketTaggingCommandInput, GetBucketTaggingCommandOutput } from "./commands/GetBucketTaggingCommand";
|
|
33
|
+
import { GetBucketVersioningCommandInput, GetBucketVersioningCommandOutput } from "./commands/GetBucketVersioningCommand";
|
|
33
34
|
import { GetJobTaggingCommandInput, GetJobTaggingCommandOutput } from "./commands/GetJobTaggingCommand";
|
|
34
35
|
import { GetMultiRegionAccessPointCommandInput, GetMultiRegionAccessPointCommandOutput } from "./commands/GetMultiRegionAccessPointCommand";
|
|
35
36
|
import { GetMultiRegionAccessPointPolicyCommandInput, GetMultiRegionAccessPointPolicyCommandOutput } from "./commands/GetMultiRegionAccessPointPolicyCommand";
|
|
@@ -49,6 +50,7 @@ import { PutAccessPointPolicyForObjectLambdaCommandInput, PutAccessPointPolicyFo
|
|
|
49
50
|
import { PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput } from "./commands/PutBucketLifecycleConfigurationCommand";
|
|
50
51
|
import { PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput } from "./commands/PutBucketPolicyCommand";
|
|
51
52
|
import { PutBucketTaggingCommandInput, PutBucketTaggingCommandOutput } from "./commands/PutBucketTaggingCommand";
|
|
53
|
+
import { PutBucketVersioningCommandInput, PutBucketVersioningCommandOutput } from "./commands/PutBucketVersioningCommand";
|
|
52
54
|
import { PutJobTaggingCommandInput, PutJobTaggingCommandOutput } from "./commands/PutJobTaggingCommand";
|
|
53
55
|
import { PutMultiRegionAccessPointPolicyCommandInput, PutMultiRegionAccessPointPolicyCommandOutput } from "./commands/PutMultiRegionAccessPointPolicyCommand";
|
|
54
56
|
import { PutPublicAccessBlockCommandInput, PutPublicAccessBlockCommandOutput } from "./commands/PutPublicAccessBlockCommand";
|
|
@@ -73,7 +75,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
73
75
|
* virtual private cloud (VPC) only access points</a> in the
|
|
74
76
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
75
77
|
* </note>
|
|
76
|
-
* <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
|
|
78
|
+
* <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_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples">Examples</a> section.</p>
|
|
77
79
|
* <p></p>
|
|
78
80
|
* <p>The following actions are related to <code>CreateAccessPoint</code>:</p>
|
|
79
81
|
* <ul>
|
|
@@ -262,7 +264,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
262
264
|
/**
|
|
263
265
|
* <p>Deletes the specified access point.</p>
|
|
264
266
|
*
|
|
265
|
-
* <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
|
|
267
|
+
* <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>
|
|
266
268
|
* <p>The following actions are related to <code>DeleteAccessPoint</code>:</p>
|
|
267
269
|
* <ul>
|
|
268
270
|
* <li>
|
|
@@ -313,7 +315,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
313
315
|
/**
|
|
314
316
|
* <p>Deletes the access point policy for the specified access point.</p>
|
|
315
317
|
* <p></p>
|
|
316
|
-
* <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
|
|
318
|
+
* <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>
|
|
317
319
|
* <p>The following actions are related to <code>DeleteAccessPointPolicy</code>:</p>
|
|
318
320
|
* <ul>
|
|
319
321
|
* <li>
|
|
@@ -359,7 +361,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
359
361
|
* delete markers) in the bucket must be deleted before the bucket itself can be deleted. For
|
|
360
362
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in
|
|
361
363
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
362
|
-
* <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
|
|
364
|
+
* <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_DeleteBucket.html#API_control_DeleteBucket_Examples">Examples</a> section.</p>
|
|
363
365
|
* <p class="title">
|
|
364
366
|
* <b>Related Resources</b>
|
|
365
367
|
* </p>
|
|
@@ -399,7 +401,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
399
401
|
* <code>s3-outposts:DeleteLifecycleConfiguration</code> action. By default, the bucket
|
|
400
402
|
* owner has this permission and the Outposts bucket owner can grant this permission to
|
|
401
403
|
* others.</p>
|
|
402
|
-
* <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
|
|
404
|
+
* <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_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
403
405
|
*
|
|
404
406
|
* <p>For more information about object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p>
|
|
405
407
|
* <p>Related actions include:</p>
|
|
@@ -447,7 +449,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
447
449
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
448
450
|
* Policies</a>. </p>
|
|
449
451
|
*
|
|
450
|
-
* <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
|
|
452
|
+
* <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_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples">Examples</a> section.</p>
|
|
451
453
|
*
|
|
452
454
|
* <p>The following actions are related to <code>DeleteBucketPolicy</code>:</p>
|
|
453
455
|
* <ul>
|
|
@@ -478,7 +480,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
478
480
|
* <code>PutBucketTagging</code> action. By default, the bucket owner has this permission
|
|
479
481
|
* and can grant this permission to others. </p>
|
|
480
482
|
*
|
|
481
|
-
* <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
|
|
483
|
+
* <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_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples">Examples</a> section.</p>
|
|
482
484
|
*
|
|
483
485
|
* <p>The following actions are related to <code>DeleteBucketTagging</code>:</p>
|
|
484
486
|
* <ul>
|
|
@@ -679,7 +681,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
679
681
|
* <p>Returns configuration information about the specified access point.</p>
|
|
680
682
|
* <p></p>
|
|
681
683
|
*
|
|
682
|
-
* <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
|
|
684
|
+
* <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>
|
|
683
685
|
* <p>The following actions are related to <code>GetAccessPoint</code>:</p>
|
|
684
686
|
* <ul>
|
|
685
687
|
* <li>
|
|
@@ -806,7 +808,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
806
808
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access
|
|
807
809
|
* Denied</code> error.</p>
|
|
808
810
|
* <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p>
|
|
809
|
-
* <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
|
|
811
|
+
* <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_GetBucket.html#API_control_GetBucket_Examples">Examples</a> section.</p>
|
|
810
812
|
* <ul>
|
|
811
813
|
* <li>
|
|
812
814
|
* <p>
|
|
@@ -845,7 +847,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
845
847
|
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
846
848
|
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
847
849
|
*
|
|
848
|
-
* <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
|
|
850
|
+
* <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_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
849
851
|
*
|
|
850
852
|
* <p>
|
|
851
853
|
* <code>GetBucketLifecycleConfiguration</code> has the following special error:</p>
|
|
@@ -911,7 +913,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
911
913
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
912
914
|
* Policies</a>.</p>
|
|
913
915
|
*
|
|
914
|
-
* <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
|
|
916
|
+
* <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_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples">Examples</a> section.</p>
|
|
915
917
|
*
|
|
916
918
|
* <p>The following actions are related to <code>GetBucketPolicy</code>:</p>
|
|
917
919
|
* <ul>
|
|
@@ -960,7 +962,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
960
962
|
* </ul>
|
|
961
963
|
* </li>
|
|
962
964
|
* </ul>
|
|
963
|
-
* <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
|
|
965
|
+
* <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_GetBucketTagging.html#API_control_GetBucketTagging_Examples">Examples</a> section.</p>
|
|
964
966
|
*
|
|
965
967
|
* <p>The following actions are related to <code>GetBucketTagging</code>:</p>
|
|
966
968
|
* <ul>
|
|
@@ -979,6 +981,43 @@ export declare class S3Control extends S3ControlClient {
|
|
|
979
981
|
getBucketTagging(args: GetBucketTaggingCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketTaggingCommandOutput>;
|
|
980
982
|
getBucketTagging(args: GetBucketTaggingCommandInput, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void): void;
|
|
981
983
|
getBucketTagging(args: GetBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketTaggingCommandOutput) => void): void;
|
|
984
|
+
/**
|
|
985
|
+
* <note>
|
|
986
|
+
* <p>This operation returns the versioning state only for S3 on Outposts buckets. To return the versioning
|
|
987
|
+
* state for an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> in
|
|
988
|
+
* the <i>Amazon S3 API Reference</i>. </p>
|
|
989
|
+
* </note>
|
|
990
|
+
* <p>Returns the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple
|
|
991
|
+
* distinct copies of your data and recover from unintended user actions and
|
|
992
|
+
* application failures.</p>
|
|
993
|
+
* <p>If you've never set versioning on your bucket, it has no versioning state. In that case,
|
|
994
|
+
* the <code>GetBucketVersioning</code> request does not return a versioning state
|
|
995
|
+
* value.</p>
|
|
996
|
+
* <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Versioning.html">Versioning</a> in the <i>Amazon S3
|
|
997
|
+
* User Guide</i>.</p>
|
|
998
|
+
* <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_GetBucketVersioning.html#API_control_GetBucketVersioning_Examples">Examples</a> section.</p>
|
|
999
|
+
* <p>The following operations are related to <code>GetBucketVersioning</code> for S3 on Outposts.</p>
|
|
1000
|
+
* <ul>
|
|
1001
|
+
* <li>
|
|
1002
|
+
* <p>
|
|
1003
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html">PutBucketVersioning</a>
|
|
1004
|
+
* </p>
|
|
1005
|
+
* </li>
|
|
1006
|
+
* <li>
|
|
1007
|
+
* <p>
|
|
1008
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>
|
|
1009
|
+
* </p>
|
|
1010
|
+
* </li>
|
|
1011
|
+
* <li>
|
|
1012
|
+
* <p>
|
|
1013
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
1014
|
+
* </p>
|
|
1015
|
+
* </li>
|
|
1016
|
+
* </ul>
|
|
1017
|
+
*/
|
|
1018
|
+
getBucketVersioning(args: GetBucketVersioningCommandInput, options?: __HttpHandlerOptions): Promise<GetBucketVersioningCommandOutput>;
|
|
1019
|
+
getBucketVersioning(args: GetBucketVersioningCommandInput, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void): void;
|
|
1020
|
+
getBucketVersioning(args: GetBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketVersioningCommandOutput) => void): void;
|
|
982
1021
|
/**
|
|
983
1022
|
* <p>Returns the tags on an S3 Batch Operations job. To use this operation, you must have
|
|
984
1023
|
* permission to perform the <code>s3:GetJobTagging</code> action. For more information, see
|
|
@@ -1142,7 +1181,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1142
1181
|
* the number specified in <code>maxResults</code>, whichever is less), the response will
|
|
1143
1182
|
* include a continuation token that you can use to list the additional access points.</p>
|
|
1144
1183
|
* <p></p>
|
|
1145
|
-
* <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
|
|
1184
|
+
* <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>
|
|
1146
1185
|
* <p>The following actions are related to <code>ListAccessPoints</code>:</p>
|
|
1147
1186
|
* <ul>
|
|
1148
1187
|
* <li>
|
|
@@ -1303,7 +1342,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1303
1342
|
* so a request made to this API replaces any existing policy associated with the specified
|
|
1304
1343
|
* access point.</p>
|
|
1305
1344
|
* <p></p>
|
|
1306
|
-
* <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
|
|
1345
|
+
* <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_PutAccessPointPolicy.html#API_control_PutAccessPointPolicy_Examples">Examples</a> section.</p>
|
|
1307
1346
|
* <p>The following actions are related to <code>PutAccessPointPolicy</code>:</p>
|
|
1308
1347
|
* <ul>
|
|
1309
1348
|
* <li>
|
|
@@ -1352,7 +1391,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1352
1391
|
* that delete/expire objects after a certain period of time and abort incomplete multipart
|
|
1353
1392
|
* uploads.</p>
|
|
1354
1393
|
* <p></p>
|
|
1355
|
-
* <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
|
|
1394
|
+
* <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_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
1356
1395
|
* <p>The following actions are related to
|
|
1357
1396
|
* <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
1358
1397
|
* <ul>
|
|
@@ -1399,7 +1438,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1399
1438
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
1400
1439
|
* Policies</a>.</p>
|
|
1401
1440
|
*
|
|
1402
|
-
* <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
|
|
1441
|
+
* <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_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples">Examples</a> section.</p>
|
|
1403
1442
|
*
|
|
1404
1443
|
* <p>The following actions are related to <code>PutBucketPolicy</code>:</p>
|
|
1405
1444
|
* <ul>
|
|
@@ -1490,7 +1529,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1490
1529
|
* </ul>
|
|
1491
1530
|
* </li>
|
|
1492
1531
|
* </ul>
|
|
1493
|
-
* <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
|
|
1532
|
+
* <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_PutBucketTagging.html#API_control_PutBucketTagging_Examples">Examples</a> section.</p>
|
|
1494
1533
|
*
|
|
1495
1534
|
* <p>The following actions are related to <code>PutBucketTagging</code>:</p>
|
|
1496
1535
|
* <ul>
|
|
@@ -1509,6 +1548,65 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1509
1548
|
putBucketTagging(args: PutBucketTaggingCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketTaggingCommandOutput>;
|
|
1510
1549
|
putBucketTagging(args: PutBucketTaggingCommandInput, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void): void;
|
|
1511
1550
|
putBucketTagging(args: PutBucketTaggingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketTaggingCommandOutput) => void): void;
|
|
1551
|
+
/**
|
|
1552
|
+
* <note>
|
|
1553
|
+
* <p>This operation sets the versioning state only for S3 on Outposts buckets. To set the
|
|
1554
|
+
* versioning state for an S3 bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a> in
|
|
1555
|
+
* the <i>Amazon S3 API Reference</i>. </p>
|
|
1556
|
+
* </note>
|
|
1557
|
+
* <p>Sets the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple
|
|
1558
|
+
* distinct copies of your data and recover from unintended user actions and
|
|
1559
|
+
* application failures.</p>
|
|
1560
|
+
* <p>You can set the versioning state to one of the following:</p>
|
|
1561
|
+
* <ul>
|
|
1562
|
+
* <li>
|
|
1563
|
+
* <p>
|
|
1564
|
+
* <b>Enabled</b> - Enables versioning for the objects in the bucket.
|
|
1565
|
+
* All objects added to the bucket receive a unique version ID.</p>
|
|
1566
|
+
* </li>
|
|
1567
|
+
* <li>
|
|
1568
|
+
* <p>
|
|
1569
|
+
* <b>Suspended</b> - Suspends versioning for the objects
|
|
1570
|
+
* in the bucket. All objects added to the bucket receive the version ID
|
|
1571
|
+
* <code>null</code>.</p>
|
|
1572
|
+
* </li>
|
|
1573
|
+
* </ul>
|
|
1574
|
+
* <p>If you've never set versioning on your bucket, it has no versioning state. In that
|
|
1575
|
+
* case, a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html">
|
|
1576
|
+
* GetBucketVersioning</a> request does not return a versioning state value.</p>
|
|
1577
|
+
* <p>When you enable S3 Versioning, for each object in your bucket, you have a current
|
|
1578
|
+
* version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle
|
|
1579
|
+
* rules to expire noncurrent versions after a specified time period. For more information,
|
|
1580
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsLifecycleManaging.html"> Creating and managing
|
|
1581
|
+
* a lifecycle configuration for your S3 on Outposts bucket</a> in the <i>Amazon S3
|
|
1582
|
+
* User Guide</i>.</p>
|
|
1583
|
+
* <p>If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same
|
|
1584
|
+
* permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy.
|
|
1585
|
+
* The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions
|
|
1586
|
+
* 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>
|
|
1587
|
+
* <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>
|
|
1588
|
+
* <p>The following operations are related to <code>PutBucketVersioning</code> for S3 on Outposts.</p>
|
|
1589
|
+
* <ul>
|
|
1590
|
+
* <li>
|
|
1591
|
+
* <p>
|
|
1592
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketVersioning.html">GetBucketVersioning</a>
|
|
1593
|
+
* </p>
|
|
1594
|
+
* </li>
|
|
1595
|
+
* <li>
|
|
1596
|
+
* <p>
|
|
1597
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>
|
|
1598
|
+
* </p>
|
|
1599
|
+
* </li>
|
|
1600
|
+
* <li>
|
|
1601
|
+
* <p>
|
|
1602
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
|
|
1603
|
+
* </p>
|
|
1604
|
+
* </li>
|
|
1605
|
+
* </ul>
|
|
1606
|
+
*/
|
|
1607
|
+
putBucketVersioning(args: PutBucketVersioningCommandInput, options?: __HttpHandlerOptions): Promise<PutBucketVersioningCommandOutput>;
|
|
1608
|
+
putBucketVersioning(args: PutBucketVersioningCommandInput, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void): void;
|
|
1609
|
+
putBucketVersioning(args: PutBucketVersioningCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketVersioningCommandOutput) => void): void;
|
|
1512
1610
|
/**
|
|
1513
1611
|
* <p>Sets the supplied tag-set on an S3 Batch Operations job.</p>
|
|
1514
1612
|
* <p>A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending
|
|
@@ -1607,7 +1705,7 @@ export declare class S3Control extends S3ControlClient {
|
|
|
1607
1705
|
/**
|
|
1608
1706
|
* <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an
|
|
1609
1707
|
* Amazon Web Services account. For this operation, users must have the
|
|
1610
|
-
* <code>s3:
|
|
1708
|
+
* <code>s3:PutAccountPublicAccessBlock</code> permission. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">
|
|
1611
1709
|
* Using Amazon S3 block public access</a>.</p>
|
|
1612
1710
|
* <p>Related actions include:</p>
|
|
1613
1711
|
* <ul>
|
|
@@ -40,6 +40,7 @@ import { GetBucketCommandInput, GetBucketCommandOutput } from "./commands/GetBuc
|
|
|
40
40
|
import { GetBucketLifecycleConfigurationCommandInput, GetBucketLifecycleConfigurationCommandOutput } from "./commands/GetBucketLifecycleConfigurationCommand";
|
|
41
41
|
import { GetBucketPolicyCommandInput, GetBucketPolicyCommandOutput } from "./commands/GetBucketPolicyCommand";
|
|
42
42
|
import { GetBucketTaggingCommandInput, GetBucketTaggingCommandOutput } from "./commands/GetBucketTaggingCommand";
|
|
43
|
+
import { GetBucketVersioningCommandInput, GetBucketVersioningCommandOutput } from "./commands/GetBucketVersioningCommand";
|
|
43
44
|
import { GetJobTaggingCommandInput, GetJobTaggingCommandOutput } from "./commands/GetJobTaggingCommand";
|
|
44
45
|
import { GetMultiRegionAccessPointCommandInput, GetMultiRegionAccessPointCommandOutput } from "./commands/GetMultiRegionAccessPointCommand";
|
|
45
46
|
import { GetMultiRegionAccessPointPolicyCommandInput, GetMultiRegionAccessPointPolicyCommandOutput } from "./commands/GetMultiRegionAccessPointPolicyCommand";
|
|
@@ -59,6 +60,7 @@ import { PutAccessPointPolicyForObjectLambdaCommandInput, PutAccessPointPolicyFo
|
|
|
59
60
|
import { PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput } from "./commands/PutBucketLifecycleConfigurationCommand";
|
|
60
61
|
import { PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput } from "./commands/PutBucketPolicyCommand";
|
|
61
62
|
import { PutBucketTaggingCommandInput, PutBucketTaggingCommandOutput } from "./commands/PutBucketTaggingCommand";
|
|
63
|
+
import { PutBucketVersioningCommandInput, PutBucketVersioningCommandOutput } from "./commands/PutBucketVersioningCommand";
|
|
62
64
|
import { PutJobTaggingCommandInput, PutJobTaggingCommandOutput } from "./commands/PutJobTaggingCommand";
|
|
63
65
|
import { PutMultiRegionAccessPointPolicyCommandInput, PutMultiRegionAccessPointPolicyCommandOutput } from "./commands/PutMultiRegionAccessPointPolicyCommand";
|
|
64
66
|
import { PutPublicAccessBlockCommandInput, PutPublicAccessBlockCommandOutput } from "./commands/PutPublicAccessBlockCommand";
|
|
@@ -66,8 +68,8 @@ import { PutStorageLensConfigurationCommandInput, PutStorageLensConfigurationCom
|
|
|
66
68
|
import { PutStorageLensConfigurationTaggingCommandInput, PutStorageLensConfigurationTaggingCommandOutput } from "./commands/PutStorageLensConfigurationTaggingCommand";
|
|
67
69
|
import { UpdateJobPriorityCommandInput, UpdateJobPriorityCommandOutput } from "./commands/UpdateJobPriorityCommand";
|
|
68
70
|
import { UpdateJobStatusCommandInput, UpdateJobStatusCommandOutput } from "./commands/UpdateJobStatusCommand";
|
|
69
|
-
export declare type ServiceInputTypes = CreateAccessPointCommandInput | CreateAccessPointForObjectLambdaCommandInput | CreateBucketCommandInput | CreateJobCommandInput | CreateMultiRegionAccessPointCommandInput | DeleteAccessPointCommandInput | DeleteAccessPointForObjectLambdaCommandInput | DeleteAccessPointPolicyCommandInput | DeleteAccessPointPolicyForObjectLambdaCommandInput | DeleteBucketCommandInput | DeleteBucketLifecycleConfigurationCommandInput | DeleteBucketPolicyCommandInput | DeleteBucketTaggingCommandInput | DeleteJobTaggingCommandInput | DeleteMultiRegionAccessPointCommandInput | DeletePublicAccessBlockCommandInput | DeleteStorageLensConfigurationCommandInput | DeleteStorageLensConfigurationTaggingCommandInput | DescribeJobCommandInput | DescribeMultiRegionAccessPointOperationCommandInput | GetAccessPointCommandInput | GetAccessPointConfigurationForObjectLambdaCommandInput | GetAccessPointForObjectLambdaCommandInput | GetAccessPointPolicyCommandInput | GetAccessPointPolicyForObjectLambdaCommandInput | GetAccessPointPolicyStatusCommandInput | GetAccessPointPolicyStatusForObjectLambdaCommandInput | GetBucketCommandInput | GetBucketLifecycleConfigurationCommandInput | GetBucketPolicyCommandInput | GetBucketTaggingCommandInput | GetJobTaggingCommandInput | GetMultiRegionAccessPointCommandInput | GetMultiRegionAccessPointPolicyCommandInput | GetMultiRegionAccessPointPolicyStatusCommandInput | GetPublicAccessBlockCommandInput | GetStorageLensConfigurationCommandInput | GetStorageLensConfigurationTaggingCommandInput | ListAccessPointsCommandInput | ListAccessPointsForObjectLambdaCommandInput | ListJobsCommandInput | ListMultiRegionAccessPointsCommandInput | ListRegionalBucketsCommandInput | ListStorageLensConfigurationsCommandInput | PutAccessPointConfigurationForObjectLambdaCommandInput | PutAccessPointPolicyCommandInput | PutAccessPointPolicyForObjectLambdaCommandInput | PutBucketLifecycleConfigurationCommandInput | PutBucketPolicyCommandInput | PutBucketTaggingCommandInput | PutJobTaggingCommandInput | PutMultiRegionAccessPointPolicyCommandInput | PutPublicAccessBlockCommandInput | PutStorageLensConfigurationCommandInput | PutStorageLensConfigurationTaggingCommandInput | UpdateJobPriorityCommandInput | UpdateJobStatusCommandInput;
|
|
70
|
-
export declare type ServiceOutputTypes = CreateAccessPointCommandOutput | CreateAccessPointForObjectLambdaCommandOutput | CreateBucketCommandOutput | CreateJobCommandOutput | CreateMultiRegionAccessPointCommandOutput | DeleteAccessPointCommandOutput | DeleteAccessPointForObjectLambdaCommandOutput | DeleteAccessPointPolicyCommandOutput | DeleteAccessPointPolicyForObjectLambdaCommandOutput | DeleteBucketCommandOutput | DeleteBucketLifecycleConfigurationCommandOutput | DeleteBucketPolicyCommandOutput | DeleteBucketTaggingCommandOutput | DeleteJobTaggingCommandOutput | DeleteMultiRegionAccessPointCommandOutput | DeletePublicAccessBlockCommandOutput | DeleteStorageLensConfigurationCommandOutput | DeleteStorageLensConfigurationTaggingCommandOutput | DescribeJobCommandOutput | DescribeMultiRegionAccessPointOperationCommandOutput | GetAccessPointCommandOutput | GetAccessPointConfigurationForObjectLambdaCommandOutput | GetAccessPointForObjectLambdaCommandOutput | GetAccessPointPolicyCommandOutput | GetAccessPointPolicyForObjectLambdaCommandOutput | GetAccessPointPolicyStatusCommandOutput | GetAccessPointPolicyStatusForObjectLambdaCommandOutput | GetBucketCommandOutput | GetBucketLifecycleConfigurationCommandOutput | GetBucketPolicyCommandOutput | GetBucketTaggingCommandOutput | GetJobTaggingCommandOutput | GetMultiRegionAccessPointCommandOutput | GetMultiRegionAccessPointPolicyCommandOutput | GetMultiRegionAccessPointPolicyStatusCommandOutput | GetPublicAccessBlockCommandOutput | GetStorageLensConfigurationCommandOutput | GetStorageLensConfigurationTaggingCommandOutput | ListAccessPointsCommandOutput | ListAccessPointsForObjectLambdaCommandOutput | ListJobsCommandOutput | ListMultiRegionAccessPointsCommandOutput | ListRegionalBucketsCommandOutput | ListStorageLensConfigurationsCommandOutput | PutAccessPointConfigurationForObjectLambdaCommandOutput | PutAccessPointPolicyCommandOutput | PutAccessPointPolicyForObjectLambdaCommandOutput | PutBucketLifecycleConfigurationCommandOutput | PutBucketPolicyCommandOutput | PutBucketTaggingCommandOutput | PutJobTaggingCommandOutput | PutMultiRegionAccessPointPolicyCommandOutput | PutPublicAccessBlockCommandOutput | PutStorageLensConfigurationCommandOutput | PutStorageLensConfigurationTaggingCommandOutput | UpdateJobPriorityCommandOutput | UpdateJobStatusCommandOutput;
|
|
71
|
+
export declare type ServiceInputTypes = CreateAccessPointCommandInput | CreateAccessPointForObjectLambdaCommandInput | CreateBucketCommandInput | CreateJobCommandInput | CreateMultiRegionAccessPointCommandInput | DeleteAccessPointCommandInput | DeleteAccessPointForObjectLambdaCommandInput | DeleteAccessPointPolicyCommandInput | DeleteAccessPointPolicyForObjectLambdaCommandInput | DeleteBucketCommandInput | DeleteBucketLifecycleConfigurationCommandInput | DeleteBucketPolicyCommandInput | DeleteBucketTaggingCommandInput | DeleteJobTaggingCommandInput | DeleteMultiRegionAccessPointCommandInput | DeletePublicAccessBlockCommandInput | DeleteStorageLensConfigurationCommandInput | DeleteStorageLensConfigurationTaggingCommandInput | DescribeJobCommandInput | DescribeMultiRegionAccessPointOperationCommandInput | GetAccessPointCommandInput | GetAccessPointConfigurationForObjectLambdaCommandInput | GetAccessPointForObjectLambdaCommandInput | GetAccessPointPolicyCommandInput | GetAccessPointPolicyForObjectLambdaCommandInput | GetAccessPointPolicyStatusCommandInput | GetAccessPointPolicyStatusForObjectLambdaCommandInput | GetBucketCommandInput | GetBucketLifecycleConfigurationCommandInput | GetBucketPolicyCommandInput | GetBucketTaggingCommandInput | GetBucketVersioningCommandInput | GetJobTaggingCommandInput | GetMultiRegionAccessPointCommandInput | GetMultiRegionAccessPointPolicyCommandInput | GetMultiRegionAccessPointPolicyStatusCommandInput | GetPublicAccessBlockCommandInput | GetStorageLensConfigurationCommandInput | GetStorageLensConfigurationTaggingCommandInput | ListAccessPointsCommandInput | ListAccessPointsForObjectLambdaCommandInput | ListJobsCommandInput | ListMultiRegionAccessPointsCommandInput | ListRegionalBucketsCommandInput | ListStorageLensConfigurationsCommandInput | PutAccessPointConfigurationForObjectLambdaCommandInput | PutAccessPointPolicyCommandInput | PutAccessPointPolicyForObjectLambdaCommandInput | PutBucketLifecycleConfigurationCommandInput | PutBucketPolicyCommandInput | PutBucketTaggingCommandInput | PutBucketVersioningCommandInput | PutJobTaggingCommandInput | PutMultiRegionAccessPointPolicyCommandInput | PutPublicAccessBlockCommandInput | PutStorageLensConfigurationCommandInput | PutStorageLensConfigurationTaggingCommandInput | UpdateJobPriorityCommandInput | UpdateJobStatusCommandInput;
|
|
72
|
+
export declare type ServiceOutputTypes = CreateAccessPointCommandOutput | CreateAccessPointForObjectLambdaCommandOutput | CreateBucketCommandOutput | CreateJobCommandOutput | CreateMultiRegionAccessPointCommandOutput | DeleteAccessPointCommandOutput | DeleteAccessPointForObjectLambdaCommandOutput | DeleteAccessPointPolicyCommandOutput | DeleteAccessPointPolicyForObjectLambdaCommandOutput | DeleteBucketCommandOutput | DeleteBucketLifecycleConfigurationCommandOutput | DeleteBucketPolicyCommandOutput | DeleteBucketTaggingCommandOutput | DeleteJobTaggingCommandOutput | DeleteMultiRegionAccessPointCommandOutput | DeletePublicAccessBlockCommandOutput | DeleteStorageLensConfigurationCommandOutput | DeleteStorageLensConfigurationTaggingCommandOutput | DescribeJobCommandOutput | DescribeMultiRegionAccessPointOperationCommandOutput | GetAccessPointCommandOutput | GetAccessPointConfigurationForObjectLambdaCommandOutput | GetAccessPointForObjectLambdaCommandOutput | GetAccessPointPolicyCommandOutput | GetAccessPointPolicyForObjectLambdaCommandOutput | GetAccessPointPolicyStatusCommandOutput | GetAccessPointPolicyStatusForObjectLambdaCommandOutput | GetBucketCommandOutput | GetBucketLifecycleConfigurationCommandOutput | GetBucketPolicyCommandOutput | GetBucketTaggingCommandOutput | GetBucketVersioningCommandOutput | GetJobTaggingCommandOutput | GetMultiRegionAccessPointCommandOutput | GetMultiRegionAccessPointPolicyCommandOutput | GetMultiRegionAccessPointPolicyStatusCommandOutput | GetPublicAccessBlockCommandOutput | GetStorageLensConfigurationCommandOutput | GetStorageLensConfigurationTaggingCommandOutput | ListAccessPointsCommandOutput | ListAccessPointsForObjectLambdaCommandOutput | ListJobsCommandOutput | ListMultiRegionAccessPointsCommandOutput | ListRegionalBucketsCommandOutput | ListStorageLensConfigurationsCommandOutput | PutAccessPointConfigurationForObjectLambdaCommandOutput | PutAccessPointPolicyCommandOutput | PutAccessPointPolicyForObjectLambdaCommandOutput | PutBucketLifecycleConfigurationCommandOutput | PutBucketPolicyCommandOutput | PutBucketTaggingCommandOutput | PutBucketVersioningCommandOutput | PutJobTaggingCommandOutput | PutMultiRegionAccessPointPolicyCommandOutput | PutPublicAccessBlockCommandOutput | PutStorageLensConfigurationCommandOutput | PutStorageLensConfigurationTaggingCommandOutput | UpdateJobPriorityCommandOutput | UpdateJobStatusCommandOutput;
|
|
71
73
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
72
74
|
/**
|
|
73
75
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -18,7 +18,7 @@ export interface CreateAccessPointCommandOutput extends CreateAccessPointResult,
|
|
|
18
18
|
* virtual private cloud (VPC) only access points</a> in the
|
|
19
19
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
20
20
|
* </note>
|
|
21
|
-
* <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
|
|
21
|
+
* <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_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples">Examples</a> section.</p>
|
|
22
22
|
* <p></p>
|
|
23
23
|
* <p>The following actions are related to <code>CreateAccessPoint</code>:</p>
|
|
24
24
|
* <ul>
|
|
@@ -9,7 +9,7 @@ export interface DeleteAccessPointCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes the specified access point.</p>
|
|
11
11
|
*
|
|
12
|
-
* <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
|
|
12
|
+
* <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>
|
|
13
13
|
* <p>The following actions are related to <code>DeleteAccessPoint</code>:</p>
|
|
14
14
|
* <ul>
|
|
15
15
|
* <li>
|
|
@@ -9,7 +9,7 @@ export interface DeleteAccessPointPolicyCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes the access point policy for the specified access point.</p>
|
|
11
11
|
* <p></p>
|
|
12
|
-
* <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
|
|
12
|
+
* <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>
|
|
13
13
|
* <p>The following actions are related to <code>DeleteAccessPointPolicy</code>:</p>
|
|
14
14
|
* <ul>
|
|
15
15
|
* <li>
|
|
@@ -14,7 +14,7 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {
|
|
|
14
14
|
* delete markers) in the bucket must be deleted before the bucket itself can be deleted. For
|
|
15
15
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in
|
|
16
16
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
17
|
-
* <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
|
|
17
|
+
* <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_DeleteBucket.html#API_control_DeleteBucket_Examples">Examples</a> section.</p>
|
|
18
18
|
* <p class="title">
|
|
19
19
|
* <b>Related Resources</b>
|
|
20
20
|
* </p>
|
|
@@ -21,7 +21,7 @@ export interface DeleteBucketLifecycleConfigurationCommandOutput extends __Metad
|
|
|
21
21
|
* <code>s3-outposts:DeleteLifecycleConfiguration</code> action. By default, the bucket
|
|
22
22
|
* owner has this permission and the Outposts bucket owner can grant this permission to
|
|
23
23
|
* others.</p>
|
|
24
|
-
* <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
|
|
24
|
+
* <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_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
25
25
|
*
|
|
26
26
|
* <p>For more information about object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p>
|
|
27
27
|
* <p>Related actions include:</p>
|
|
@@ -34,7 +34,7 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
34
34
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
35
35
|
* Policies</a>. </p>
|
|
36
36
|
*
|
|
37
|
-
* <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
|
|
37
|
+
* <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_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples">Examples</a> section.</p>
|
|
38
38
|
*
|
|
39
39
|
* <p>The following actions are related to <code>DeleteBucketPolicy</code>:</p>
|
|
40
40
|
* <ul>
|
|
@@ -18,7 +18,7 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {
|
|
|
18
18
|
* <code>PutBucketTagging</code> action. By default, the bucket owner has this permission
|
|
19
19
|
* and can grant this permission to others. </p>
|
|
20
20
|
*
|
|
21
|
-
* <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
|
|
21
|
+
* <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_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples">Examples</a> section.</p>
|
|
22
22
|
*
|
|
23
23
|
* <p>The following actions are related to <code>DeleteBucketTagging</code>:</p>
|
|
24
24
|
* <ul>
|
|
@@ -10,7 +10,7 @@ export interface GetAccessPointCommandOutput extends GetAccessPointResult, __Met
|
|
|
10
10
|
* <p>Returns configuration information about the specified access point.</p>
|
|
11
11
|
* <p></p>
|
|
12
12
|
*
|
|
13
|
-
* <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
|
|
13
|
+
* <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>
|
|
14
14
|
* <p>The following actions are related to <code>GetAccessPoint</code>:</p>
|
|
15
15
|
* <ul>
|
|
16
16
|
* <li>
|
|
@@ -18,7 +18,7 @@ export interface GetBucketCommandOutput extends GetBucketResult, __MetadataBeare
|
|
|
18
18
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access
|
|
19
19
|
* Denied</code> error.</p>
|
|
20
20
|
* <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p>
|
|
21
|
-
* <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
|
|
21
|
+
* <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_GetBucket.html#API_control_GetBucket_Examples">Examples</a> section.</p>
|
|
22
22
|
* <ul>
|
|
23
23
|
* <li>
|
|
24
24
|
* <p>
|
|
@@ -23,7 +23,7 @@ export interface GetBucketLifecycleConfigurationCommandOutput extends GetBucketL
|
|
|
23
23
|
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
24
24
|
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
25
25
|
*
|
|
26
|
-
* <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
|
|
26
|
+
* <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_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples">Examples</a> section.</p>
|
|
27
27
|
*
|
|
28
28
|
* <p>
|
|
29
29
|
* <code>GetBucketLifecycleConfiguration</code> has the following special error:</p>
|
|
@@ -33,7 +33,7 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyResult, __M
|
|
|
33
33
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
34
34
|
* Policies</a>.</p>
|
|
35
35
|
*
|
|
36
|
-
* <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
|
|
36
|
+
* <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_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples">Examples</a> section.</p>
|
|
37
37
|
*
|
|
38
38
|
* <p>The following actions are related to <code>GetBucketPolicy</code>:</p>
|
|
39
39
|
* <ul>
|
|
@@ -31,7 +31,7 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingResult, _
|
|
|
31
31
|
* </ul>
|
|
32
32
|
* </li>
|
|
33
33
|
* </ul>
|
|
34
|
-
* <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
|
|
34
|
+
* <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_GetBucketTagging.html#API_control_GetBucketTagging_Examples">Examples</a> section.</p>
|
|
35
35
|
*
|
|
36
36
|
* <p>The following actions are related to <code>GetBucketTagging</code>:</p>
|
|
37
37
|
* <ul>
|