@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
|
@@ -22,11 +22,11 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
|
|
|
22
22
|
* <p>Returns the tag-set of an object. You send the GET request against the tagging
|
|
23
23
|
* subresource associated with the object.</p>
|
|
24
24
|
* <p>To use this operation, you must have permission to perform the
|
|
25
|
-
* <code>s3:GetObjectTagging</code> action. By default, the GET action returns
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
25
|
+
* <code>s3:GetObjectTagging</code> action. By default, the GET action returns information
|
|
26
|
+
* about current version of an object. For a versioned bucket, you can have multiple versions
|
|
27
|
+
* of an object in your bucket. To retrieve tags of any other version, use the versionId query
|
|
28
|
+
* parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code>
|
|
29
|
+
* action.</p>
|
|
30
30
|
* <p> By default, the bucket owner has this permission and can grant this permission to
|
|
31
31
|
* others.</p>
|
|
32
32
|
* <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
|
|
@@ -63,6 +63,16 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
|
|
|
63
63
|
* };
|
|
64
64
|
* const command = new GetObjectTaggingCommand(input);
|
|
65
65
|
* const response = await client.send(command);
|
|
66
|
+
* // { // GetObjectTaggingOutput
|
|
67
|
+
* // VersionId: "STRING_VALUE",
|
|
68
|
+
* // TagSet: [ // TagSet // required
|
|
69
|
+
* // { // Tag
|
|
70
|
+
* // Key: "STRING_VALUE", // required
|
|
71
|
+
* // Value: "STRING_VALUE", // required
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
66
76
|
* ```
|
|
67
77
|
*
|
|
68
78
|
* @param GetObjectTaggingCommandInput - {@link GetObjectTaggingCommandInput}
|
|
@@ -71,6 +81,8 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
|
|
|
71
81
|
* @see {@link GetObjectTaggingCommandOutput} for command's `response` shape.
|
|
72
82
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
73
83
|
*
|
|
84
|
+
* @throws {@link S3ServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
74
86
|
*
|
|
75
87
|
* @example To retrieve tag set of a specific object version
|
|
76
88
|
* ```javascript
|
|
@@ -20,7 +20,7 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
|
|
23
|
-
* distributing large files
|
|
23
|
+
* distributing large files.</p>
|
|
24
24
|
* <note>
|
|
25
25
|
* <p>You can get torrent only for objects that are less than 5 GB in size, and that are
|
|
26
26
|
* not encrypted using server-side encryption with a customer-provided encryption
|
|
@@ -50,6 +50,11 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
|
|
|
50
50
|
* };
|
|
51
51
|
* const command = new GetObjectTorrentCommand(input);
|
|
52
52
|
* const response = await client.send(command);
|
|
53
|
+
* // { // GetObjectTorrentOutput
|
|
54
|
+
* // Body: "STREAMING_BLOB_VALUE",
|
|
55
|
+
* // RequestCharged: "requester",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
53
58
|
* ```
|
|
54
59
|
*
|
|
55
60
|
* @param GetObjectTorrentCommandInput - {@link GetObjectTorrentCommandInput}
|
|
@@ -58,6 +63,8 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
|
|
|
58
63
|
* @see {@link GetObjectTorrentCommandOutput} for command's `response` shape.
|
|
59
64
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
60
65
|
*
|
|
66
|
+
* @throws {@link S3ServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
61
68
|
*
|
|
62
69
|
* @example To retrieve torrent files for an object
|
|
63
70
|
* ```javascript
|
|
@@ -22,7 +22,7 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
|
|
|
22
22
|
* <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use
|
|
23
23
|
* this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
|
|
24
24
|
* For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
25
|
-
*
|
|
25
|
+
* Policy</a>.</p>
|
|
26
26
|
* <important>
|
|
27
27
|
* <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
|
|
28
28
|
* an object, it checks the <code>PublicAccessBlock</code> configuration for both the
|
|
@@ -68,6 +68,15 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
|
|
|
68
68
|
* };
|
|
69
69
|
* const command = new GetPublicAccessBlockCommand(input);
|
|
70
70
|
* const response = await client.send(command);
|
|
71
|
+
* // { // GetPublicAccessBlockOutput
|
|
72
|
+
* // PublicAccessBlockConfiguration: { // PublicAccessBlockConfiguration
|
|
73
|
+
* // BlockPublicAcls: true || false,
|
|
74
|
+
* // IgnorePublicAcls: true || false,
|
|
75
|
+
* // BlockPublicPolicy: true || false,
|
|
76
|
+
* // RestrictPublicBuckets: true || false,
|
|
77
|
+
* // },
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
71
80
|
* ```
|
|
72
81
|
*
|
|
73
82
|
* @param GetPublicAccessBlockCommandInput - {@link GetPublicAccessBlockCommandInput}
|
|
@@ -76,6 +85,8 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
|
|
|
76
85
|
* @see {@link GetPublicAccessBlockCommandOutput} for command's `response` shape.
|
|
77
86
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
78
87
|
*
|
|
88
|
+
* @throws {@link S3ServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
79
90
|
*
|
|
80
91
|
*/
|
|
81
92
|
export declare class GetPublicAccessBlockCommand extends $Command<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -19,17 +19,27 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>This action is useful to determine if a bucket exists and you have permission to
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* <p>If the bucket does not exist or you do not have permission to access it, the
|
|
26
|
-
*
|
|
27
|
-
*
|
|
22
|
+
* <p>This action is useful to determine if a bucket exists and you have permission to access
|
|
23
|
+
* it. The action returns a <code>200 OK</code> if the bucket exists and you have permission
|
|
24
|
+
* to access it.</p>
|
|
25
|
+
* <p>If the bucket does not exist or you do not have permission to access it, the
|
|
26
|
+
* <code>HEAD</code> request returns a generic <code>400 Bad Request</code>, <code>403
|
|
27
|
+
* Forbidden</code> or <code>404 Not Found</code> code. A message body is not included, so
|
|
28
|
+
* you cannot determine the exception beyond these error codes.</p>
|
|
28
29
|
* <p>To use this operation, you must have permissions to perform the
|
|
29
30
|
* <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
|
|
30
|
-
* can grant this permission to others. For 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
|
|
31
|
-
* Resources</a>.</p>
|
|
32
|
-
* <p>To use this API against an access point, you must provide the alias of the access point in place of the
|
|
31
|
+
* can grant this permission to others. For 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
|
|
32
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
33
|
+
* <p>To use this API operation against an access point, you must provide the alias of the access point in place of the
|
|
34
|
+
* bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to
|
|
35
|
+
* the access point hostname. The access point hostname takes the form
|
|
36
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
|
|
37
|
+
* When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more
|
|
38
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a>.</p>
|
|
39
|
+
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
40
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
41
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
42
|
+
* Error Codes</a>.</p>
|
|
33
43
|
* @example
|
|
34
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
45
|
* ```javascript
|
|
@@ -42,6 +52,8 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
|
|
|
42
52
|
* };
|
|
43
53
|
* const command = new HeadBucketCommand(input);
|
|
44
54
|
* const response = await client.send(command);
|
|
55
|
+
* // {};
|
|
56
|
+
*
|
|
45
57
|
* ```
|
|
46
58
|
*
|
|
47
59
|
* @param HeadBucketCommandInput - {@link HeadBucketCommandInput}
|
|
@@ -53,6 +65,8 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
|
|
|
53
65
|
* @throws {@link NotFound} (client fault)
|
|
54
66
|
* <p>The specified content does not exist.</p>
|
|
55
67
|
*
|
|
68
|
+
* @throws {@link S3ServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
56
70
|
*
|
|
57
71
|
* @example To determine if bucket exists
|
|
58
72
|
* ```javascript
|
|
@@ -19,14 +19,15 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>The HEAD action retrieves metadata from an object without returning the object
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>The HEAD action retrieves metadata from an object without returning the object itself.
|
|
23
|
+
* This action is useful if you're only interested in an object's metadata. To use HEAD, you
|
|
24
|
+
* must have READ access to the object.</p>
|
|
25
25
|
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
|
|
26
26
|
* object. The response is identical to the <code>GET</code> response except that there is no
|
|
27
27
|
* response body. Because of this, if the <code>HEAD</code> request generates an error, it
|
|
28
|
-
* returns a generic <code>
|
|
29
|
-
*
|
|
28
|
+
* returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> or <code>404 Not
|
|
29
|
+
* Found</code> code. It is not possible to retrieve the exact exception beyond these error
|
|
30
|
+
* codes.</p>
|
|
30
31
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
31
32
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
32
33
|
* metadata from the object, you must use the following headers:</p>
|
|
@@ -41,25 +42,25 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
41
42
|
* <p>x-amz-server-side-encryption-customer-key-MD5</p>
|
|
42
43
|
* </li>
|
|
43
44
|
* </ul>
|
|
44
|
-
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
45
|
-
* Customer-Provided Encryption Keys)</a>.</p>
|
|
45
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
46
|
+
* (Using Customer-Provided Encryption Keys)</a>.</p>
|
|
46
47
|
* <note>
|
|
47
48
|
* <ul>
|
|
48
49
|
* <li>
|
|
49
|
-
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
50
|
+
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
51
|
+
* should not be sent for GET requests if your object uses server-side encryption
|
|
52
|
+
* with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
|
|
53
|
+
* keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
|
|
54
|
+
* BadRequest error.</p>
|
|
54
55
|
* </li>
|
|
55
56
|
* <li>
|
|
56
|
-
* <p>
|
|
57
|
-
*
|
|
57
|
+
* <p> The last modified property in this case is the creation date of the
|
|
58
|
+
* object.</p>
|
|
58
59
|
* </li>
|
|
59
60
|
* </ul>
|
|
60
61
|
* </note>
|
|
61
|
-
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
|
|
62
|
-
* Headers</a>.</p>
|
|
62
|
+
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
|
|
63
|
+
* Request Headers</a>.</p>
|
|
63
64
|
* <p>Consider the following when using request headers:</p>
|
|
64
65
|
* <ul>
|
|
65
66
|
* <li>
|
|
@@ -99,23 +100,25 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
99
100
|
* </li>
|
|
100
101
|
* </ul>
|
|
101
102
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
102
|
-
* <
|
|
103
|
-
* <
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
103
|
+
* <dl>
|
|
104
|
+
* <dt>Permissions</dt>
|
|
105
|
+
* <dd>
|
|
106
|
+
* <p>You need the relevant read object (or version) permission for this operation. For more
|
|
107
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a>.
|
|
108
|
+
* If the object you request does not exist, the error Amazon S3 returns depends
|
|
109
|
+
* on whether you also have the s3:ListBucket permission.</p>
|
|
110
|
+
* <ul>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
|
|
113
|
+
* an HTTP status code 404 ("no such key") error.</p>
|
|
114
|
+
* </li>
|
|
115
|
+
* <li>
|
|
116
|
+
* <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
|
|
117
|
+
* status code 403 ("access denied") error.</p>
|
|
118
|
+
* </li>
|
|
119
|
+
* </ul>
|
|
120
|
+
* </dd>
|
|
121
|
+
* </dl>
|
|
119
122
|
* <p>The following actions are related to <code>HeadObject</code>:</p>
|
|
120
123
|
* <ul>
|
|
121
124
|
* <li>
|
|
@@ -154,6 +157,45 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
154
157
|
* };
|
|
155
158
|
* const command = new HeadObjectCommand(input);
|
|
156
159
|
* const response = await client.send(command);
|
|
160
|
+
* // { // HeadObjectOutput
|
|
161
|
+
* // DeleteMarker: true || false,
|
|
162
|
+
* // AcceptRanges: "STRING_VALUE",
|
|
163
|
+
* // Expiration: "STRING_VALUE",
|
|
164
|
+
* // Restore: "STRING_VALUE",
|
|
165
|
+
* // ArchiveStatus: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS",
|
|
166
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
167
|
+
* // ContentLength: Number("long"),
|
|
168
|
+
* // ChecksumCRC32: "STRING_VALUE",
|
|
169
|
+
* // ChecksumCRC32C: "STRING_VALUE",
|
|
170
|
+
* // ChecksumSHA1: "STRING_VALUE",
|
|
171
|
+
* // ChecksumSHA256: "STRING_VALUE",
|
|
172
|
+
* // ETag: "STRING_VALUE",
|
|
173
|
+
* // MissingMeta: Number("int"),
|
|
174
|
+
* // VersionId: "STRING_VALUE",
|
|
175
|
+
* // CacheControl: "STRING_VALUE",
|
|
176
|
+
* // ContentDisposition: "STRING_VALUE",
|
|
177
|
+
* // ContentEncoding: "STRING_VALUE",
|
|
178
|
+
* // ContentLanguage: "STRING_VALUE",
|
|
179
|
+
* // ContentType: "STRING_VALUE",
|
|
180
|
+
* // Expires: new Date("TIMESTAMP"),
|
|
181
|
+
* // WebsiteRedirectLocation: "STRING_VALUE",
|
|
182
|
+
* // ServerSideEncryption: "AES256" || "aws:kms",
|
|
183
|
+
* // Metadata: { // Metadata
|
|
184
|
+
* // "<keys>": "STRING_VALUE",
|
|
185
|
+
* // },
|
|
186
|
+
* // SSECustomerAlgorithm: "STRING_VALUE",
|
|
187
|
+
* // SSECustomerKeyMD5: "STRING_VALUE",
|
|
188
|
+
* // SSEKMSKeyId: "STRING_VALUE",
|
|
189
|
+
* // BucketKeyEnabled: true || false,
|
|
190
|
+
* // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
|
|
191
|
+
* // RequestCharged: "requester",
|
|
192
|
+
* // ReplicationStatus: "COMPLETE" || "PENDING" || "FAILED" || "REPLICA",
|
|
193
|
+
* // PartsCount: Number("int"),
|
|
194
|
+
* // ObjectLockMode: "GOVERNANCE" || "COMPLIANCE",
|
|
195
|
+
* // ObjectLockRetainUntilDate: new Date("TIMESTAMP"),
|
|
196
|
+
* // ObjectLockLegalHoldStatus: "ON" || "OFF",
|
|
197
|
+
* // };
|
|
198
|
+
*
|
|
157
199
|
* ```
|
|
158
200
|
*
|
|
159
201
|
* @param HeadObjectCommandInput - {@link HeadObjectCommandInput}
|
|
@@ -165,6 +207,8 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
165
207
|
* @throws {@link NotFound} (client fault)
|
|
166
208
|
* <p>The specified content does not exist.</p>
|
|
167
209
|
*
|
|
210
|
+
* @throws {@link S3ServiceException}
|
|
211
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
168
212
|
*
|
|
169
213
|
* @example To retrieve metadata of an object without returning the object itself
|
|
170
214
|
* ```javascript
|
|
@@ -21,8 +21,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
|
|
23
23
|
* configurations per bucket.</p>
|
|
24
|
-
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
25
|
-
*
|
|
24
|
+
* <p>This action supports list pagination and does not return more than 100 configurations at
|
|
25
|
+
* a time. You should always check the <code>IsTruncated</code> element in the response. If
|
|
26
26
|
* there are no more configurations to list, <code>IsTruncated</code> is set to false. If
|
|
27
27
|
* there are more configurations to list, <code>IsTruncated</code> is set to true, and there
|
|
28
28
|
* will be a value in <code>NextContinuationToken</code>. You use the
|
|
@@ -32,8 +32,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
32
32
|
* <p>To use this operation, you must have permissions to perform the
|
|
33
33
|
* <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
34
34
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
35
|
-
* 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
|
|
36
|
-
* Resources</a>.</p>
|
|
35
|
+
* 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
|
|
36
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
37
37
|
* <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
38
38
|
* Analysis</a>. </p>
|
|
39
39
|
* <p>The following operations are related to
|
|
@@ -68,6 +68,46 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
68
68
|
* };
|
|
69
69
|
* const command = new ListBucketAnalyticsConfigurationsCommand(input);
|
|
70
70
|
* const response = await client.send(command);
|
|
71
|
+
* // { // ListBucketAnalyticsConfigurationsOutput
|
|
72
|
+
* // IsTruncated: true || false,
|
|
73
|
+
* // ContinuationToken: "STRING_VALUE",
|
|
74
|
+
* // NextContinuationToken: "STRING_VALUE",
|
|
75
|
+
* // AnalyticsConfigurationList: [ // AnalyticsConfigurationList
|
|
76
|
+
* // { // AnalyticsConfiguration
|
|
77
|
+
* // Id: "STRING_VALUE", // required
|
|
78
|
+
* // Filter: { // AnalyticsFilter Union: only one key present
|
|
79
|
+
* // Prefix: "STRING_VALUE",
|
|
80
|
+
* // Tag: { // Tag
|
|
81
|
+
* // Key: "STRING_VALUE", // required
|
|
82
|
+
* // Value: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // And: { // AnalyticsAndOperator
|
|
85
|
+
* // Prefix: "STRING_VALUE",
|
|
86
|
+
* // Tags: [ // TagSet
|
|
87
|
+
* // {
|
|
88
|
+
* // Key: "STRING_VALUE", // required
|
|
89
|
+
* // Value: "STRING_VALUE", // required
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // },
|
|
93
|
+
* // },
|
|
94
|
+
* // StorageClassAnalysis: { // StorageClassAnalysis
|
|
95
|
+
* // DataExport: { // StorageClassAnalysisDataExport
|
|
96
|
+
* // OutputSchemaVersion: "V_1", // required
|
|
97
|
+
* // Destination: { // AnalyticsExportDestination
|
|
98
|
+
* // S3BucketDestination: { // AnalyticsS3BucketDestination
|
|
99
|
+
* // Format: "CSV", // required
|
|
100
|
+
* // BucketAccountId: "STRING_VALUE",
|
|
101
|
+
* // Bucket: "STRING_VALUE", // required
|
|
102
|
+
* // Prefix: "STRING_VALUE",
|
|
103
|
+
* // },
|
|
104
|
+
* // },
|
|
105
|
+
* // },
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // ],
|
|
109
|
+
* // };
|
|
110
|
+
*
|
|
71
111
|
* ```
|
|
72
112
|
*
|
|
73
113
|
* @param ListBucketAnalyticsConfigurationsCommandInput - {@link ListBucketAnalyticsConfigurationsCommandInput}
|
|
@@ -76,6 +116,8 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
76
116
|
* @see {@link ListBucketAnalyticsConfigurationsCommandOutput} for command's `response` shape.
|
|
77
117
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
78
118
|
*
|
|
119
|
+
* @throws {@link S3ServiceException}
|
|
120
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
79
121
|
*
|
|
80
122
|
*/
|
|
81
123
|
export declare class ListBucketAnalyticsConfigurationsCommand extends $Command<ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -23,8 +23,7 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
|
|
|
23
23
|
* <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>
|
|
24
24
|
* <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>
|
|
25
25
|
* <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>
|
|
26
|
-
* <p>Operations related to
|
|
27
|
-
* <code>ListBucketIntelligentTieringConfigurations</code> include: </p>
|
|
26
|
+
* <p>Operations related to <code>ListBucketIntelligentTieringConfigurations</code> include: </p>
|
|
28
27
|
* <ul>
|
|
29
28
|
* <li>
|
|
30
29
|
* <p>
|
|
@@ -54,6 +53,40 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
|
|
|
54
53
|
* };
|
|
55
54
|
* const command = new ListBucketIntelligentTieringConfigurationsCommand(input);
|
|
56
55
|
* const response = await client.send(command);
|
|
56
|
+
* // { // ListBucketIntelligentTieringConfigurationsOutput
|
|
57
|
+
* // IsTruncated: true || false,
|
|
58
|
+
* // ContinuationToken: "STRING_VALUE",
|
|
59
|
+
* // NextContinuationToken: "STRING_VALUE",
|
|
60
|
+
* // IntelligentTieringConfigurationList: [ // IntelligentTieringConfigurationList
|
|
61
|
+
* // { // IntelligentTieringConfiguration
|
|
62
|
+
* // Id: "STRING_VALUE", // required
|
|
63
|
+
* // Filter: { // IntelligentTieringFilter
|
|
64
|
+
* // Prefix: "STRING_VALUE",
|
|
65
|
+
* // Tag: { // Tag
|
|
66
|
+
* // Key: "STRING_VALUE", // required
|
|
67
|
+
* // Value: "STRING_VALUE", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // And: { // IntelligentTieringAndOperator
|
|
70
|
+
* // Prefix: "STRING_VALUE",
|
|
71
|
+
* // Tags: [ // TagSet
|
|
72
|
+
* // {
|
|
73
|
+
* // Key: "STRING_VALUE", // required
|
|
74
|
+
* // Value: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // Status: "Enabled" || "Disabled", // required
|
|
80
|
+
* // Tierings: [ // TieringList // required
|
|
81
|
+
* // { // Tiering
|
|
82
|
+
* // Days: Number("int"), // required
|
|
83
|
+
* // AccessTier: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS", // required
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // };
|
|
89
|
+
*
|
|
57
90
|
* ```
|
|
58
91
|
*
|
|
59
92
|
* @param ListBucketIntelligentTieringConfigurationsCommandInput - {@link ListBucketIntelligentTieringConfigurationsCommandInput}
|
|
@@ -62,6 +95,8 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
|
|
|
62
95
|
* @see {@link ListBucketIntelligentTieringConfigurationsCommandOutput} for command's `response` shape.
|
|
63
96
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
64
97
|
*
|
|
98
|
+
* @throws {@link S3ServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
65
100
|
*
|
|
66
101
|
*/
|
|
67
102
|
export declare class ListBucketIntelligentTieringConfigurationsCommand extends $Command<ListBucketIntelligentTieringConfigurationsCommandInput, ListBucketIntelligentTieringConfigurationsCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -21,9 +21,9 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
|
|
23
23
|
* analytics configurations per bucket.</p>
|
|
24
|
-
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
25
|
-
*
|
|
26
|
-
*
|
|
24
|
+
* <p>This action supports list pagination and does not return more than 100 configurations at
|
|
25
|
+
* a time. Always check the <code>IsTruncated</code> element in the response. If there are no
|
|
26
|
+
* more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
27
27
|
* configurations to list, <code>IsTruncated</code> is set to true, and there is a value in
|
|
28
28
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
29
29
|
* to continue the pagination of the list by passing the value in continuation-token in the
|
|
@@ -31,8 +31,8 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
31
31
|
* <p> To use this operation, you must have permissions to perform the
|
|
32
32
|
* <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
|
|
33
33
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
34
|
-
* 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
|
|
35
|
-
* Resources</a>.</p>
|
|
34
|
+
* 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
|
|
35
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
36
36
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>
|
|
37
37
|
* </p>
|
|
38
38
|
* <p>The following operations are related to
|
|
@@ -67,6 +67,42 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
67
67
|
* };
|
|
68
68
|
* const command = new ListBucketInventoryConfigurationsCommand(input);
|
|
69
69
|
* const response = await client.send(command);
|
|
70
|
+
* // { // ListBucketInventoryConfigurationsOutput
|
|
71
|
+
* // ContinuationToken: "STRING_VALUE",
|
|
72
|
+
* // InventoryConfigurationList: [ // InventoryConfigurationList
|
|
73
|
+
* // { // InventoryConfiguration
|
|
74
|
+
* // Destination: { // InventoryDestination
|
|
75
|
+
* // S3BucketDestination: { // InventoryS3BucketDestination
|
|
76
|
+
* // AccountId: "STRING_VALUE",
|
|
77
|
+
* // Bucket: "STRING_VALUE", // required
|
|
78
|
+
* // Format: "CSV" || "ORC" || "Parquet", // required
|
|
79
|
+
* // Prefix: "STRING_VALUE",
|
|
80
|
+
* // Encryption: { // InventoryEncryption
|
|
81
|
+
* // SSES3: {},
|
|
82
|
+
* // SSEKMS: { // SSEKMS
|
|
83
|
+
* // KeyId: "STRING_VALUE", // required
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // },
|
|
87
|
+
* // },
|
|
88
|
+
* // IsEnabled: true || false, // required
|
|
89
|
+
* // Filter: { // InventoryFilter
|
|
90
|
+
* // Prefix: "STRING_VALUE", // required
|
|
91
|
+
* // },
|
|
92
|
+
* // Id: "STRING_VALUE", // required
|
|
93
|
+
* // IncludedObjectVersions: "All" || "Current", // required
|
|
94
|
+
* // OptionalFields: [ // InventoryOptionalFields
|
|
95
|
+
* // "Size" || "LastModifiedDate" || "StorageClass" || "ETag" || "IsMultipartUploaded" || "ReplicationStatus" || "EncryptionStatus" || "ObjectLockRetainUntilDate" || "ObjectLockMode" || "ObjectLockLegalHoldStatus" || "IntelligentTieringAccessTier" || "BucketKeyStatus" || "ChecksumAlgorithm",
|
|
96
|
+
* // ],
|
|
97
|
+
* // Schedule: { // InventorySchedule
|
|
98
|
+
* // Frequency: "Daily" || "Weekly", // required
|
|
99
|
+
* // },
|
|
100
|
+
* // },
|
|
101
|
+
* // ],
|
|
102
|
+
* // IsTruncated: true || false,
|
|
103
|
+
* // NextContinuationToken: "STRING_VALUE",
|
|
104
|
+
* // };
|
|
105
|
+
*
|
|
70
106
|
* ```
|
|
71
107
|
*
|
|
72
108
|
* @param ListBucketInventoryConfigurationsCommandInput - {@link ListBucketInventoryConfigurationsCommandInput}
|
|
@@ -75,6 +111,8 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
75
111
|
* @see {@link ListBucketInventoryConfigurationsCommandOutput} for command's `response` shape.
|
|
76
112
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
77
113
|
*
|
|
114
|
+
* @throws {@link S3ServiceException}
|
|
115
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
78
116
|
*
|
|
79
117
|
*/
|
|
80
118
|
export declare class ListBucketInventoryConfigurationsCommand extends $Command<ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -22,9 +22,9 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
22
22
|
* <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
|
|
23
23
|
* the request metrics of the bucket and do not provide information on daily storage metrics.
|
|
24
24
|
* You can have up to 1,000 configurations per bucket.</p>
|
|
25
|
-
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
26
|
-
*
|
|
27
|
-
*
|
|
25
|
+
* <p>This action supports list pagination and does not return more than 100 configurations at
|
|
26
|
+
* a time. Always check the <code>IsTruncated</code> element in the response. If there are no
|
|
27
|
+
* more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
28
28
|
* configurations to list, <code>IsTruncated</code> is set to true, and there is a value in
|
|
29
29
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
30
30
|
* to continue the pagination of the list by passing the value in
|
|
@@ -32,11 +32,10 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
32
32
|
* <p>To use this operation, you must have permissions to perform the
|
|
33
33
|
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
34
34
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
35
|
-
* 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
|
|
36
|
-
* Resources</a>.</p>
|
|
35
|
+
* 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
|
|
36
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
37
37
|
* <p>For more information about metrics configurations and CloudWatch request metrics, see
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
39
|
-
* CloudWatch</a>.</p>
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p>
|
|
40
39
|
* <p>The following operations are related to
|
|
41
40
|
* <code>ListBucketMetricsConfigurations</code>:</p>
|
|
42
41
|
* <ul>
|
|
@@ -69,6 +68,35 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
69
68
|
* };
|
|
70
69
|
* const command = new ListBucketMetricsConfigurationsCommand(input);
|
|
71
70
|
* const response = await client.send(command);
|
|
71
|
+
* // { // ListBucketMetricsConfigurationsOutput
|
|
72
|
+
* // IsTruncated: true || false,
|
|
73
|
+
* // ContinuationToken: "STRING_VALUE",
|
|
74
|
+
* // NextContinuationToken: "STRING_VALUE",
|
|
75
|
+
* // MetricsConfigurationList: [ // MetricsConfigurationList
|
|
76
|
+
* // { // MetricsConfiguration
|
|
77
|
+
* // Id: "STRING_VALUE", // required
|
|
78
|
+
* // Filter: { // MetricsFilter Union: only one key present
|
|
79
|
+
* // Prefix: "STRING_VALUE",
|
|
80
|
+
* // Tag: { // Tag
|
|
81
|
+
* // Key: "STRING_VALUE", // required
|
|
82
|
+
* // Value: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // AccessPointArn: "STRING_VALUE",
|
|
85
|
+
* // And: { // MetricsAndOperator
|
|
86
|
+
* // Prefix: "STRING_VALUE",
|
|
87
|
+
* // Tags: [ // TagSet
|
|
88
|
+
* // {
|
|
89
|
+
* // Key: "STRING_VALUE", // required
|
|
90
|
+
* // Value: "STRING_VALUE", // required
|
|
91
|
+
* // },
|
|
92
|
+
* // ],
|
|
93
|
+
* // AccessPointArn: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // },
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // };
|
|
99
|
+
*
|
|
72
100
|
* ```
|
|
73
101
|
*
|
|
74
102
|
* @param ListBucketMetricsConfigurationsCommandInput - {@link ListBucketMetricsConfigurationsCommandInput}
|
|
@@ -77,6 +105,8 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
77
105
|
* @see {@link ListBucketMetricsConfigurationsCommandOutput} for command's `response` shape.
|
|
78
106
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
79
107
|
*
|
|
108
|
+
* @throws {@link S3ServiceException}
|
|
109
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
80
110
|
*
|
|
81
111
|
*/
|
|
82
112
|
export declare class ListBucketMetricsConfigurationsCommand extends $Command<ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig> {
|