@aws-sdk/client-s3 3.325.0 → 3.327.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/dist-types/commands/AbortMultipartUploadCommand.d.ts +8 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +41 -14
- package/dist-types/commands/CopyObjectCommand.d.ts +194 -144
- package/dist-types/commands/CreateBucketCommand.d.ts +134 -118
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +91 -48
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +6 -2
- package/dist-types/commands/DeleteBucketCommand.d.ts +5 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +7 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +12 -8
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +5 -2
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +6 -2
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +5 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -5
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +6 -2
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +10 -3
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +8 -3
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/DeleteObjectCommand.d.ts +19 -11
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +8 -4
- package/dist-types/commands/DeleteObjectsCommand.d.ts +57 -36
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +12 -7
- package/dist-types/commands/GetBucketAclCommand.d.ts +35 -10
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +43 -7
- package/dist-types/commands/GetBucketCorsCommand.d.ts +28 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +23 -7
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +32 -2
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +35 -2
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +62 -4
- package/dist-types/commands/GetBucketLocationCommand.d.ts +16 -2
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +22 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +31 -6
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +70 -2
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +16 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +17 -3
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +9 -1
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +8 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +11 -0
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +7 -0
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +32 -3
- package/dist-types/commands/GetObjectAclCommand.d.ts +27 -7
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +77 -45
- package/dist-types/commands/GetObjectCommand.d.ts +159 -112
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +16 -2
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +11 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +17 -5
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +8 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +12 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +23 -9
- package/dist-types/commands/HeadObjectCommand.d.ts +77 -33
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +46 -4
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +37 -2
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +43 -5
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +37 -7
- package/dist-types/commands/ListBucketsCommand.d.ts +18 -32
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +39 -2
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +53 -6
- package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
- package/dist-types/commands/ListObjectsV2Command.d.ts +47 -12
- package/dist-types/commands/ListPartsCommand.d.ts +40 -4
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +8 -3
- package/dist-types/commands/PutBucketAclCommand.d.ts +118 -111
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +11 -10
- package/dist-types/commands/PutBucketCorsCommand.d.ts +7 -5
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +21 -17
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +35 -59
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +54 -65
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +68 -62
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +49 -39
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +8 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +13 -12
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +8 -2
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +12 -4
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +35 -28
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +5 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +16 -12
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +11 -9
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/PutObjectAclCommand.d.ts +129 -119
- package/dist-types/commands/PutObjectCommand.d.ts +94 -84
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +13 -8
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +9 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +13 -9
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +6 -4
- package/dist-types/commands/RestoreObjectCommand.d.ts +182 -199
- package/dist-types/commands/SelectObjectContentCommand.d.ts +109 -90
- package/dist-types/commands/UploadPartCommand.d.ts +42 -22
- package/dist-types/commands/UploadPartCopyCommand.d.ts +85 -63
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +36 -21
- package/dist-types/models/models_0.d.ts +468 -382
- package/dist-types/models/models_1.d.ts +82 -80
- package/package.json +9 -9
|
@@ -20,8 +20,8 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Sets the permissions on an existing bucket using access control lists (ACL). For more
|
|
23
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set
|
|
24
|
-
*
|
|
23
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a
|
|
24
|
+
* bucket, you must have <code>WRITE_ACP</code> permission.</p>
|
|
25
25
|
* <p>You can use one of the following two ways to set a bucket's permissions:</p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
@@ -40,49 +40,125 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* that updates a bucket ACL using the request body, then you can continue to use that
|
|
41
41
|
* approach.</p>
|
|
42
42
|
* <important>
|
|
43
|
-
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
43
|
+
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
44
|
+
* are disabled and no longer affect permissions. You must use policies to grant access to
|
|
45
|
+
* your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return
|
|
46
|
+
* the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are
|
|
47
|
+
* still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
|
|
48
|
+
* ownership</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
48
49
|
* </important>
|
|
49
|
-
* <
|
|
50
|
-
* <
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* <ul>
|
|
54
|
-
* <li>
|
|
55
|
-
* <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports
|
|
56
|
-
* a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL
|
|
57
|
-
* has a predefined set of grantees and permissions. Specify the canned ACL name as the
|
|
58
|
-
* value of <code>x-amz-acl</code>. If you use this header, you cannot use other access
|
|
59
|
-
* control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* <li>
|
|
62
|
-
* <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
|
|
63
|
-
* <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and
|
|
64
|
-
* <code>x-amz-grant-full-control</code> headers. When using these headers, you
|
|
65
|
-
* specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
|
|
66
|
-
* will receive the permission. If you use these ACL-specific headers, you cannot use
|
|
67
|
-
* the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the
|
|
68
|
-
* set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
69
|
-
* Overview</a>.</p>
|
|
70
|
-
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
71
|
-
* following:</p>
|
|
50
|
+
* <dl>
|
|
51
|
+
* <dt>Permissions</dt>
|
|
52
|
+
* <dd>
|
|
53
|
+
* <p>You can set access permissions using one of the following methods:</p>
|
|
72
54
|
* <ul>
|
|
73
55
|
* <li>
|
|
56
|
+
* <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports
|
|
57
|
+
* a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL
|
|
58
|
+
* has a predefined set of grantees and permissions. Specify the canned ACL name as the
|
|
59
|
+
* value of <code>x-amz-acl</code>. If you use this header, you cannot use other access
|
|
60
|
+
* control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
61
|
+
* ACL</a>.</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
|
|
65
|
+
* <code>x-amz-grant-read-acp</code>, <code>x-amz-grant-write-acp</code>, and
|
|
66
|
+
* <code>x-amz-grant-full-control</code> headers. When using these headers, you
|
|
67
|
+
* specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
|
|
68
|
+
* will receive the permission. If you use these ACL-specific headers, you cannot use
|
|
69
|
+
* the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the
|
|
70
|
+
* set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
71
|
+
* List (ACL) Overview</a>.</p>
|
|
72
|
+
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
73
|
+
* following:</p>
|
|
74
|
+
* <ul>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>
|
|
77
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
78
|
+
* Amazon Web Services account</p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>
|
|
82
|
+
* <code>uri</code> – if you are granting permissions to a predefined
|
|
83
|
+
* group</p>
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>
|
|
87
|
+
* <code>emailAddress</code> – if the value specified is the email address of
|
|
88
|
+
* an Amazon Web Services account</p>
|
|
89
|
+
* <note>
|
|
90
|
+
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
91
|
+
* <ul>
|
|
92
|
+
* <li>
|
|
93
|
+
* <p>US East (N. Virginia)</p>
|
|
94
|
+
* </li>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>US West (N. California)</p>
|
|
97
|
+
* </li>
|
|
98
|
+
* <li>
|
|
99
|
+
* <p> US West (Oregon)</p>
|
|
100
|
+
* </li>
|
|
101
|
+
* <li>
|
|
102
|
+
* <p> Asia Pacific (Singapore)</p>
|
|
103
|
+
* </li>
|
|
104
|
+
* <li>
|
|
105
|
+
* <p>Asia Pacific (Sydney)</p>
|
|
106
|
+
* </li>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>Asia Pacific (Tokyo)</p>
|
|
109
|
+
* </li>
|
|
110
|
+
* <li>
|
|
111
|
+
* <p>Europe (Ireland)</p>
|
|
112
|
+
* </li>
|
|
113
|
+
* <li>
|
|
114
|
+
* <p>South America (São Paulo)</p>
|
|
115
|
+
* </li>
|
|
116
|
+
* </ul>
|
|
117
|
+
* <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p>
|
|
118
|
+
* </note>
|
|
119
|
+
* </li>
|
|
120
|
+
* </ul>
|
|
121
|
+
* <p>For example, the following <code>x-amz-grant-write</code> header grants create,
|
|
122
|
+
* overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and
|
|
123
|
+
* two Amazon Web Services accounts identified by their email addresses.</p>
|
|
74
124
|
* <p>
|
|
75
|
-
* <code>
|
|
125
|
+
* <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
|
126
|
+
* id="111122223333", id="555566667777" </code>
|
|
127
|
+
* </p>
|
|
76
128
|
* </li>
|
|
129
|
+
* </ul>
|
|
130
|
+
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
|
|
131
|
+
* both.</p>
|
|
132
|
+
* </dd>
|
|
133
|
+
* <dt>Grantee Values</dt>
|
|
134
|
+
* <dd>
|
|
135
|
+
* <p>You can specify the person (grantee) to whom you're assigning access rights (using
|
|
136
|
+
* request elements) in the following ways:</p>
|
|
137
|
+
* <ul>
|
|
77
138
|
* <li>
|
|
139
|
+
* <p>By the person's ID:</p>
|
|
78
140
|
* <p>
|
|
79
|
-
* <code
|
|
80
|
-
*
|
|
141
|
+
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
142
|
+
* xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
|
143
|
+
* </Grantee></code>
|
|
144
|
+
* </p>
|
|
145
|
+
* <p>DisplayName is optional and ignored in the request</p>
|
|
81
146
|
* </li>
|
|
82
147
|
* <li>
|
|
148
|
+
* <p>By URI:</p>
|
|
83
149
|
* <p>
|
|
84
|
-
* <code
|
|
85
|
-
*
|
|
150
|
+
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
151
|
+
* xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
|
|
152
|
+
* </p>
|
|
153
|
+
* </li>
|
|
154
|
+
* <li>
|
|
155
|
+
* <p>By Email address:</p>
|
|
156
|
+
* <p>
|
|
157
|
+
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
158
|
+
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code>
|
|
159
|
+
* </p>
|
|
160
|
+
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
|
|
161
|
+
* acl request, appears as the CanonicalUser. </p>
|
|
86
162
|
* <note>
|
|
87
163
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
88
164
|
* <ul>
|
|
@@ -115,82 +191,9 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
|
|
|
115
191
|
* </note>
|
|
116
192
|
* </li>
|
|
117
193
|
* </ul>
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
* <p>
|
|
122
|
-
* <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
|
123
|
-
* id="111122223333", id="555566667777" </code>
|
|
124
|
-
* </p>
|
|
125
|
-
* </li>
|
|
126
|
-
* </ul>
|
|
127
|
-
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
|
|
128
|
-
* both.</p>
|
|
129
|
-
* <p>
|
|
130
|
-
* <b>Grantee Values</b>
|
|
131
|
-
* </p>
|
|
132
|
-
* <p>You can specify the person (grantee) to whom you're assigning access rights (using
|
|
133
|
-
* request elements) in the following ways:</p>
|
|
134
|
-
* <ul>
|
|
135
|
-
* <li>
|
|
136
|
-
* <p>By the person's ID:</p>
|
|
137
|
-
* <p>
|
|
138
|
-
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
139
|
-
* xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
|
140
|
-
* </Grantee></code>
|
|
141
|
-
* </p>
|
|
142
|
-
* <p>DisplayName is optional and ignored in the request</p>
|
|
143
|
-
* </li>
|
|
144
|
-
* <li>
|
|
145
|
-
* <p>By URI:</p>
|
|
146
|
-
* <p>
|
|
147
|
-
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
148
|
-
* xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
|
|
149
|
-
* </p>
|
|
150
|
-
* </li>
|
|
151
|
-
* <li>
|
|
152
|
-
* <p>By Email address:</p>
|
|
153
|
-
* <p>
|
|
154
|
-
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
155
|
-
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee></code>
|
|
156
|
-
* </p>
|
|
157
|
-
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
|
|
158
|
-
* acl request, appears as the CanonicalUser. </p>
|
|
159
|
-
* <note>
|
|
160
|
-
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
161
|
-
* <ul>
|
|
162
|
-
* <li>
|
|
163
|
-
* <p>US East (N. Virginia)</p>
|
|
164
|
-
* </li>
|
|
165
|
-
* <li>
|
|
166
|
-
* <p>US West (N. California)</p>
|
|
167
|
-
* </li>
|
|
168
|
-
* <li>
|
|
169
|
-
* <p> US West (Oregon)</p>
|
|
170
|
-
* </li>
|
|
171
|
-
* <li>
|
|
172
|
-
* <p> Asia Pacific (Singapore)</p>
|
|
173
|
-
* </li>
|
|
174
|
-
* <li>
|
|
175
|
-
* <p>Asia Pacific (Sydney)</p>
|
|
176
|
-
* </li>
|
|
177
|
-
* <li>
|
|
178
|
-
* <p>Asia Pacific (Tokyo)</p>
|
|
179
|
-
* </li>
|
|
180
|
-
* <li>
|
|
181
|
-
* <p>Europe (Ireland)</p>
|
|
182
|
-
* </li>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p>South America (São Paulo)</p>
|
|
185
|
-
* </li>
|
|
186
|
-
* </ul>
|
|
187
|
-
* <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p>
|
|
188
|
-
* </note>
|
|
189
|
-
* </li>
|
|
190
|
-
* </ul>
|
|
191
|
-
* <p class="title">
|
|
192
|
-
* <b>Related Resources</b>
|
|
193
|
-
* </p>
|
|
194
|
+
* </dd>
|
|
195
|
+
* </dl>
|
|
196
|
+
* <p>The following operations are related to <code>PutBucketAcl</code>:</p>
|
|
194
197
|
* <ul>
|
|
195
198
|
* <li>
|
|
196
199
|
* <p>
|
|
@@ -246,6 +249,8 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
|
|
|
246
249
|
* };
|
|
247
250
|
* const command = new PutBucketAclCommand(input);
|
|
248
251
|
* const response = await client.send(command);
|
|
252
|
+
* // {};
|
|
253
|
+
*
|
|
249
254
|
* ```
|
|
250
255
|
*
|
|
251
256
|
* @param PutBucketAclCommandInput - {@link PutBucketAclCommandInput}
|
|
@@ -254,6 +259,8 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
|
|
|
254
259
|
* @see {@link PutBucketAclCommandOutput} for command's `response` shape.
|
|
255
260
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
256
261
|
*
|
|
262
|
+
* @throws {@link S3ServiceException}
|
|
263
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
257
264
|
*
|
|
258
265
|
* @example Put bucket acl
|
|
259
266
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
|
|
|
27
27
|
* selecting data export, you specify a destination bucket and an optional destination prefix
|
|
28
28
|
* where the file is written. You can export the data to a destination bucket in a different
|
|
29
29
|
* account. However, the destination bucket must be in the same Region as the bucket that you
|
|
30
|
-
* are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3
|
|
31
|
-
* Analysis</a>. </p>
|
|
30
|
+
* are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3
|
|
31
|
+
* Analytics – Storage Class Analysis</a>. </p>
|
|
32
32
|
* <important>
|
|
33
33
|
* <p>You must create a bucket policy on the destination bucket where the exported file is
|
|
34
34
|
* written to grant permissions to Amazon S3 to write objects to the bucket. For an example
|
|
@@ -37,11 +37,10 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
|
|
|
37
37
|
* <p>To use this operation, you must have permissions to perform the
|
|
38
38
|
* <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
39
39
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
40
|
-
* 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
|
|
41
|
-
* Resources</a>.</p>
|
|
42
|
-
* <p
|
|
43
|
-
* <
|
|
44
|
-
* </p>
|
|
40
|
+
* 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
|
|
41
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>PutBucketAnalyticsConfiguration</code> has the following special errors:</p>
|
|
45
44
|
* <ul>
|
|
46
45
|
* <li>
|
|
47
46
|
* <ul>
|
|
@@ -104,9 +103,7 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
|
|
|
104
103
|
* </ul>
|
|
105
104
|
* </li>
|
|
106
105
|
* </ul>
|
|
107
|
-
* <p
|
|
108
|
-
* <b>Related Resources</b>
|
|
109
|
-
* </p>
|
|
106
|
+
* <p>The following operations are related to <code>PutBucketAnalyticsConfiguration</code>:</p>
|
|
110
107
|
* <ul>
|
|
111
108
|
* <li>
|
|
112
109
|
* <p>
|
|
@@ -169,6 +166,8 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
|
|
|
169
166
|
* };
|
|
170
167
|
* const command = new PutBucketAnalyticsConfigurationCommand(input);
|
|
171
168
|
* const response = await client.send(command);
|
|
169
|
+
* // {};
|
|
170
|
+
*
|
|
172
171
|
* ```
|
|
173
172
|
*
|
|
174
173
|
* @param PutBucketAnalyticsConfigurationCommandInput - {@link PutBucketAnalyticsConfigurationCommandInput}
|
|
@@ -177,6 +176,8 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
|
|
|
177
176
|
* @see {@link PutBucketAnalyticsConfigurationCommandOutput} for command's `response` shape.
|
|
178
177
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
179
178
|
*
|
|
179
|
+
* @throws {@link S3ServiceException}
|
|
180
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
180
181
|
*
|
|
181
182
|
*/
|
|
182
183
|
export declare class PutBucketAnalyticsConfigurationCommand extends $Command<PutBucketAnalyticsConfigurationCommandInput, PutBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -53,11 +53,9 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
53
53
|
* </p>
|
|
54
54
|
* </li>
|
|
55
55
|
* </ul>
|
|
56
|
-
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
57
|
-
*
|
|
58
|
-
* <p
|
|
59
|
-
* <b>Related Resources</b>
|
|
60
|
-
* </p>
|
|
56
|
+
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in
|
|
57
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
58
|
+
* <p>The following operations are related to <code>PutBucketCors</code>:</p>
|
|
61
59
|
* <ul>
|
|
62
60
|
* <li>
|
|
63
61
|
* <p>
|
|
@@ -109,6 +107,8 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
109
107
|
* };
|
|
110
108
|
* const command = new PutBucketCorsCommand(input);
|
|
111
109
|
* const response = await client.send(command);
|
|
110
|
+
* // {};
|
|
111
|
+
*
|
|
112
112
|
* ```
|
|
113
113
|
*
|
|
114
114
|
* @param PutBucketCorsCommandInput - {@link PutBucketCorsCommandInput}
|
|
@@ -117,6 +117,8 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
117
117
|
* @see {@link PutBucketCorsCommandOutput} for command's `response` shape.
|
|
118
118
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
119
119
|
*
|
|
120
|
+
* @throws {@link S3ServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
120
122
|
*
|
|
121
123
|
* @example To set cors configuration on a bucket.
|
|
122
124
|
* ```javascript
|
|
@@ -19,28 +19,28 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>This action uses the <code>encryption</code> subresource to configure default
|
|
23
|
-
*
|
|
24
|
-
* <p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
22
|
+
* <p>This action uses the <code>encryption</code> subresource to configure default encryption
|
|
23
|
+
* and Amazon S3 Bucket Keys for an existing bucket.</p>
|
|
24
|
+
* <p>By default, all buckets have a default encryption configuration that
|
|
25
|
+
* uses server-side encryption with Amazon S3 managed keys (SSE-S3).
|
|
26
|
+
* You can optionally configure default encryption for a bucket by using server-side
|
|
27
|
+
* encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption by using
|
|
28
|
+
* SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default encryption,
|
|
29
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3
|
|
30
|
+
* bucket default encryption</a> in the <i>Amazon S3 User Guide</i>. For more
|
|
31
|
+
* information about S3 Bucket Keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
32
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
32
33
|
* <important>
|
|
33
|
-
* <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">
|
|
34
|
-
* Version 4)</a>. </p>
|
|
34
|
+
* <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">
|
|
35
|
+
* Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p>
|
|
35
36
|
* </important>
|
|
36
37
|
* <p>To use this operation, you must have permissions to perform the
|
|
37
38
|
* <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission
|
|
38
39
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
39
|
-
* 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
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* </p>
|
|
40
|
+
* 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
|
|
41
|
+
* Access Permissions to Your Amazon S3 Resources</a> in the
|
|
42
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
43
|
+
* <p>The following operations are related to <code>PutBucketEncryption</code>:</p>
|
|
44
44
|
* <ul>
|
|
45
45
|
* <li>
|
|
46
46
|
* <p>
|
|
@@ -78,6 +78,8 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
78
78
|
* };
|
|
79
79
|
* const command = new PutBucketEncryptionCommand(input);
|
|
80
80
|
* const response = await client.send(command);
|
|
81
|
+
* // {};
|
|
82
|
+
*
|
|
81
83
|
* ```
|
|
82
84
|
*
|
|
83
85
|
* @param PutBucketEncryptionCommandInput - {@link PutBucketEncryptionCommandInput}
|
|
@@ -86,6 +88,8 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
86
88
|
* @see {@link PutBucketEncryptionCommandOutput} for command's `response` shape.
|
|
87
89
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
88
90
|
*
|
|
91
|
+
* @throws {@link S3ServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
89
93
|
*
|
|
90
94
|
*/
|
|
91
95
|
export declare class PutBucketEncryptionCommand extends $Command<PutBucketEncryptionCommandInput, PutBucketEncryptionCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -19,13 +19,12 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket.
|
|
23
|
-
*
|
|
22
|
+
* <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to
|
|
23
|
+
* 1,000 S3 Intelligent-Tiering configurations per bucket.</p>
|
|
24
24
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
25
25
|
* <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
|
|
26
26
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
27
|
-
* <p>Operations related to
|
|
28
|
-
* <code>PutBucketIntelligentTieringConfiguration</code> include: </p>
|
|
27
|
+
* <p>Operations related to <code>PutBucketIntelligentTieringConfiguration</code> include: </p>
|
|
29
28
|
* <ul>
|
|
30
29
|
* <li>
|
|
31
30
|
* <p>
|
|
@@ -45,62 +44,35 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
|
|
|
45
44
|
* </ul>
|
|
46
45
|
* <note>
|
|
47
46
|
* <p>You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically
|
|
48
|
-
* move objects stored in the S3 Intelligent-Tiering storage class to the
|
|
49
|
-
*
|
|
47
|
+
* move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access
|
|
48
|
+
* or Deep Archive Access tier.</p>
|
|
50
49
|
* </note>
|
|
51
|
-
* <p
|
|
52
|
-
* <
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
* <
|
|
56
|
-
* <p
|
|
57
|
-
* <
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* <
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
* </
|
|
68
|
-
*
|
|
69
|
-
* </
|
|
70
|
-
* <
|
|
71
|
-
* <p
|
|
72
|
-
* <
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* <i>Code:</i> TooManyConfigurations</p>
|
|
78
|
-
* </li>
|
|
79
|
-
* <li>
|
|
80
|
-
* <p>
|
|
81
|
-
* <i>Cause:</i> You are attempting to create a new configuration
|
|
82
|
-
* but have already reached the 1,000-configuration limit. </p>
|
|
83
|
-
* </li>
|
|
84
|
-
* </ul>
|
|
85
|
-
* </li>
|
|
86
|
-
* <li>
|
|
87
|
-
* <p class="title">
|
|
88
|
-
* <b>HTTP 403 Forbidden Error</b>
|
|
89
|
-
* </p>
|
|
90
|
-
* <ul>
|
|
91
|
-
* <li>
|
|
92
|
-
* <p>
|
|
93
|
-
* <i>Code:</i> AccessDenied</p>
|
|
94
|
-
* </li>
|
|
95
|
-
* <li>
|
|
96
|
-
* <p>
|
|
97
|
-
* <i>Cause:</i> You are not the owner of the specified bucket,
|
|
98
|
-
* or you do not have the <code>s3:PutIntelligentTieringConfiguration</code> bucket
|
|
99
|
-
* permission to set the configuration on the bucket. </p>
|
|
100
|
-
* </li>
|
|
101
|
-
* </ul>
|
|
102
|
-
* </li>
|
|
103
|
-
* </ul>
|
|
50
|
+
* <p>
|
|
51
|
+
* <code>PutBucketIntelligentTieringConfiguration</code> has the following special errors:</p>
|
|
52
|
+
* <dl>
|
|
53
|
+
* <dt>HTTP 400 Bad Request Error</dt>
|
|
54
|
+
* <dd>
|
|
55
|
+
* <p>
|
|
56
|
+
* <i>Code:</i> InvalidArgument</p>
|
|
57
|
+
* <p>
|
|
58
|
+
* <i>Cause:</i> Invalid Argument</p>
|
|
59
|
+
* </dd>
|
|
60
|
+
* <dt>HTTP 400 Bad Request Error</dt>
|
|
61
|
+
* <dd>
|
|
62
|
+
* <p>
|
|
63
|
+
* <i>Code:</i> TooManyConfigurations</p>
|
|
64
|
+
* <p>
|
|
65
|
+
* <i>Cause:</i> You are attempting to create a new configuration
|
|
66
|
+
* but have already reached the 1,000-configuration limit. </p>
|
|
67
|
+
* </dd>
|
|
68
|
+
* <dt>HTTP 403 Forbidden Error</dt>
|
|
69
|
+
* <dd>
|
|
70
|
+
* <p>
|
|
71
|
+
* <i>Cause:</i> You are not the owner of the specified bucket,
|
|
72
|
+
* or you do not have the <code>s3:PutIntelligentTieringConfiguration</code>
|
|
73
|
+
* bucket permission to set the configuration on the bucket. </p>
|
|
74
|
+
* </dd>
|
|
75
|
+
* </dl>
|
|
104
76
|
* @example
|
|
105
77
|
* Use a bare-bones client and the command you need to make an API call.
|
|
106
78
|
* ```javascript
|
|
@@ -139,6 +111,8 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
|
|
|
139
111
|
* };
|
|
140
112
|
* const command = new PutBucketIntelligentTieringConfigurationCommand(input);
|
|
141
113
|
* const response = await client.send(command);
|
|
114
|
+
* // {};
|
|
115
|
+
*
|
|
142
116
|
* ```
|
|
143
117
|
*
|
|
144
118
|
* @param PutBucketIntelligentTieringConfigurationCommandInput - {@link PutBucketIntelligentTieringConfigurationCommandInput}
|
|
@@ -147,6 +121,8 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
|
|
|
147
121
|
* @see {@link PutBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
|
|
148
122
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
149
123
|
*
|
|
124
|
+
* @throws {@link S3ServiceException}
|
|
125
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
150
126
|
*
|
|
151
127
|
*/
|
|
152
128
|
export declare class PutBucketIntelligentTieringConfigurationCommand extends $Command<PutBucketIntelligentTieringConfigurationCommandInput, PutBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
|