@aws-sdk/client-s3 3.288.0 → 3.290.0

package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts

@@ -82,6 +82,35 @@ export interface GetBucketLifecycleConfigurationCommandOutput extends GetBucketL
  * @see {@link GetBucketLifecycleConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get lifecycle configuration on a bucket
+ * ```javascript
+ * // The following example retrieves lifecycle configuration on set on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketLifecycleConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Rules": [
+ *     {
+ *       "ID": "Rule for TaxDocs/",
+ *       "Prefix": "TaxDocs",
+ *       "Status": "Enabled",
+ *       "Transitions": [
+ *         {
+ *           "Days": 365,
+ *           "StorageClass": "STANDARD_IA"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-lifecycle-configuration-on-a-bucket-1481666063200
+ * ```
+ *
  */
 export declare class GetBucketLifecycleConfigurationCommand extends $Command<GetBucketLifecycleConfigurationCommandInput, GetBucketLifecycleConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketLifecycleConfigurationCommandInput;

package/dist-types/commands/GetBucketLocationCommand.d.ts

@@ -46,6 +46,23 @@ export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput,
  * @see {@link GetBucketLocationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get bucket location
+ * ```javascript
+ * // The following example returns bucket location.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketLocationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LocationConstraint": "us-west-2"
+ * }
+ * *\/
+ * // example id: to-get-bucket-location-1481594573609
+ * ```
+ *
  */
 export declare class GetBucketLocationCommand extends $Command<GetBucketLocationCommandInput, GetBucketLocationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketLocationCommandInput;

package/dist-types/commands/GetBucketLoggingCommand.d.ts

@@ -43,6 +43,7 @@ export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, _
  * @see {@link GetBucketLoggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetBucketLoggingCommand extends $Command<GetBucketLoggingCommandInput, GetBucketLoggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketLoggingCommandInput;

package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts

@@ -62,6 +62,7 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
  * @see {@link GetBucketMetricsConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetBucketMetricsConfigurationCommand extends $Command<GetBucketMetricsConfigurationCommandInput, GetBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketMetricsConfigurationCommandInput;

package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts

@@ -46,6 +46,7 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific
  * @see {@link GetBucketNotificationConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetBucketNotificationConfigurationCommand extends $Command<GetBucketNotificationConfigurationCommandInput, GetBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketNotificationConfigurationCommandInput;

package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts

@@ -46,6 +46,7 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
  * @see {@link GetBucketOwnershipControlsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetBucketOwnershipControlsCommand extends $Command<GetBucketOwnershipControlsCommandInput, GetBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketOwnershipControlsCommandInput;

package/dist-types/commands/GetBucketPolicyCommand.d.ts

@@ -51,6 +51,23 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
  * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get bucket policy
+ * ```javascript
+ * // The following example returns bucket policy associated with a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"LogPolicy\",\"Statement\":[{\"Sid\":\"Enables the log delivery group to publish logs to your bucket \",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"111122223333\"},\"Action\":[\"s3:GetBucketAcl\",\"s3:GetObjectAcl\",\"s3:PutObject\"],\"Resource\":[\"arn:aws:s3:::policytest1/*\",\"arn:aws:s3:::policytest1\"]}]}"
+ * }
+ * *\/
+ * // example id: to-get-bucket-policy-1481595098424
+ * ```
+ *
  */
 export declare class GetBucketPolicyCommand extends $Command<GetBucketPolicyCommandInput, GetBucketPolicyCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketPolicyCommandInput;

package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts

@@ -57,6 +57,7 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
  * @see {@link GetBucketPolicyStatusCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetBucketPolicyStatusCommand extends $Command<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketPolicyStatusCommandInput;

package/dist-types/commands/GetBucketReplicationCommand.d.ts

@@ -58,6 +58,35 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
  * @see {@link GetBucketReplicationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get replication configuration set on a bucket
+ * ```javascript
+ * // The following example returns replication configuration set on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketReplicationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ReplicationConfiguration": {
+ *     "Role": "arn:aws:iam::acct-id:role/example-role",
+ *     "Rules": [
+ *       {
+ *         "Destination": {
+ *           "Bucket": "arn:aws:s3:::destination-bucket"
+ *         },
+ *         "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
+ *         "Prefix": "Tax",
+ *         "Status": "Enabled"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-replication-configuration-set-on-a-bucket-1481593597175
+ * ```
+ *
  */
 export declare class GetBucketReplicationCommand extends $Command<GetBucketReplicationCommandInput, GetBucketReplicationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketReplicationCommandInput;

package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts

@@ -38,6 +38,23 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
  * @see {@link GetBucketRequestPaymentCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get bucket versioning configuration
+ * ```javascript
+ * // The following example retrieves bucket versioning configuration.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketRequestPaymentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Payer": "BucketOwner"
+ * }
+ * *\/
+ * // example id: to-get-bucket-versioning-configuration-1483037183929
+ * ```
+ *
  */
 export declare class GetBucketRequestPaymentCommand extends $Command<GetBucketRequestPaymentCommandInput, GetBucketRequestPaymentCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketRequestPaymentCommandInput;

package/dist-types/commands/GetBucketTaggingCommand.d.ts

@@ -58,6 +58,32 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
  * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get tag set associated with a bucket
+ * ```javascript
+ * // The following example returns tag set associated with a bucket
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagSet": [
+ *     {
+ *       "Key": "key1",
+ *       "Value": "value1"
+ *     },
+ *     {
+ *       "Key": "key2",
+ *       "Value": "value2"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-get-tag-set-associated-with-a-bucket-1481593232107
+ * ```
+ *
  */
 export declare class GetBucketTaggingCommand extends $Command<GetBucketTaggingCommandInput, GetBucketTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketTaggingCommandInput;

package/dist-types/commands/GetBucketVersioningCommand.d.ts

@@ -51,6 +51,24 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
  * @see {@link GetBucketVersioningCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get bucket versioning configuration
+ * ```javascript
+ * // The following example retrieves bucket versioning configuration.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketVersioningCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "MFADelete": "Disabled",
+ *   "Status": "Enabled"
+ * }
+ * *\/
+ * // example id: to-get-bucket-versioning-configuration-1483037183929
+ * ```
+ *
  */
 export declare class GetBucketVersioningCommand extends $Command<GetBucketVersioningCommandInput, GetBucketVersioningCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketVersioningCommandInput;

package/dist-types/commands/GetBucketWebsiteCommand.d.ts

@@ -49,6 +49,28 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
  * @see {@link GetBucketWebsiteCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To get bucket website configuration
+ * ```javascript
+ * // The following example retrieves website configuration of a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketWebsiteCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ErrorDocument": {
+ *     "Key": "error.html"
+ *   },
+ *   "IndexDocument": {
+ *     "Suffix": "index.html"
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-bucket-website-configuration-1483037016926
+ * ```
+ *
  */
 export declare class GetBucketWebsiteCommand extends $Command<GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetBucketWebsiteCommandInput;

package/dist-types/commands/GetObjectAclCommand.d.ts

@@ -69,6 +69,64 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
  * @see {@link GetObjectAclCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @throws {@link NoSuchKey} (client fault)
+ *  <p>The specified key does not exist.</p>
+ *
+ *
+ * @example To retrieve object ACL
+ * ```javascript
+ * // The following example retrieves access control list (ACL) of an object.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new GetObjectAclCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Grants": [
+ *     {
+ *       "Grantee": {
+ *         "DisplayName": "owner-display-name",
+ *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         "Type": "CanonicalUser"
+ *       },
+ *       "Permission": "WRITE"
+ *     },
+ *     {
+ *       "Grantee": {
+ *         "DisplayName": "owner-display-name",
+ *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         "Type": "CanonicalUser"
+ *       },
+ *       "Permission": "WRITE_ACP"
+ *     },
+ *     {
+ *       "Grantee": {
+ *         "DisplayName": "owner-display-name",
+ *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         "Type": "CanonicalUser"
+ *       },
+ *       "Permission": "READ"
+ *     },
+ *     {
+ *       "Grantee": {
+ *         "DisplayName": "owner-display-name",
+ *         "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         "Type": "CanonicalUser"
+ *       },
+ *       "Permission": "READ_ACP"
+ *     }
+ *   ],
+ *   "Owner": {
+ *     "DisplayName": "owner-display-name",
+ *     "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
+ *   }
+ * }
+ * *\/
+ * // example id: to-retrieve-object-acl-1481833557740
+ * ```
+ *
  */
 export declare class GetObjectAclCommand extends $Command<GetObjectAclCommandInput, GetObjectAclCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectAclCommandInput;

package/dist-types/commands/GetObjectAttributesCommand.d.ts

@@ -178,6 +178,10 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
  * @see {@link GetObjectAttributesCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @throws {@link NoSuchKey} (client fault)
+ *  <p>The specified key does not exist.</p>
+ *
+ *
  */
 export declare class GetObjectAttributesCommand extends $Command<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectAttributesCommandInput;

package/dist-types/commands/GetObjectCommand.d.ts

@@ -190,6 +190,62 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
  * @see {@link GetObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @throws {@link InvalidObjectState} (client fault)
+ *  <p>Object is archived and inaccessible until restored.</p>
+ *
+ * @throws {@link NoSuchKey} (client fault)
+ *  <p>The specified key does not exist.</p>
+ *
+ *
+ * @example To retrieve a byte range of an object
+ * ```javascript
+ * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "SampleFile.txt",
+ *   "Range": "bytes=0-9"
+ * };
+ * const command = new GetObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AcceptRanges": "bytes",
+ *   "ContentLength": "10",
+ *   "ContentRange": "bytes 0-9/43",
+ *   "ContentType": "text/plain",
+ *   "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
+ *   "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
+ *   "Metadata": {},
+ *   "VersionId": "null"
+ * }
+ * *\/
+ * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
+ * ```
+ *
+ * @example To retrieve an object
+ * ```javascript
+ * // The following example retrieves an object for an S3 bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new GetObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AcceptRanges": "bytes",
+ *   "ContentLength": "3191",
+ *   "ContentType": "image/jpeg",
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
+ *   "Metadata": {},
+ *   "TagCount": 2,
+ *   "VersionId": "null"
+ * }
+ * *\/
+ * // example id: to-retrieve-an-object-1481827837012
+ * ```
+ *
  */
 export declare class GetObjectCommand extends $Command<GetObjectCommandInput, GetObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectCommandInput;

package/dist-types/commands/GetObjectLegalHoldCommand.d.ts

@@ -39,6 +39,7 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
  * @see {@link GetObjectLegalHoldCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetObjectLegalHoldCommand extends $Command<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectLegalHoldCommandInput;

package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts

@@ -40,6 +40,7 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
  * @see {@link GetObjectLockConfigurationCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetObjectLockConfigurationCommand extends $Command<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectLockConfigurationCommandInput;

package/dist-types/commands/GetObjectRetentionCommand.d.ts

@@ -38,6 +38,7 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
  * @see {@link GetObjectRetentionCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetObjectRetentionCommand extends $Command<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectRetentionCommandInput;

package/dist-types/commands/GetObjectTaggingCommand.d.ts

@@ -57,6 +57,58 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
  * @see {@link GetObjectTaggingCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To retrieve tag set of a specific object version
+ * ```javascript
+ * // The following example retrieves tag set of an object. The request specifies object version.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "exampleobject",
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ * };
+ * const command = new GetObjectTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagSet": [
+ *     {
+ *       "Key": "Key1",
+ *       "Value": "Value1"
+ *     }
+ *   ],
+ *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ * }
+ * *\/
+ * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
+ * ```
+ *
+ * @example To retrieve tag set of an object
+ * ```javascript
+ * // The following example retrieves tag set of an object.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new GetObjectTaggingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagSet": [
+ *     {
+ *       "Key": "Key4",
+ *       "Value": "Value4"
+ *     },
+ *     {
+ *       "Key": "Key3",
+ *       "Value": "Value3"
+ *     }
+ *   ],
+ *   "VersionId": "null"
+ * }
+ * *\/
+ * // example id: to-retrieve-tag-set-of-an-object-1481833847896
+ * ```
+ *
  */
 export declare class GetObjectTaggingCommand extends $Command<GetObjectTaggingCommandInput, GetObjectTaggingCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectTaggingCommandInput;

package/dist-types/commands/GetObjectTorrentCommand.d.ts

@@ -45,6 +45,19 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
  * @see {@link GetObjectTorrentCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
+ * @example To retrieve torrent files for an object
+ * ```javascript
+ * // The following example retrieves torrent files of an object.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new GetObjectTorrentCommand(input);
+ * await client.send(command);
+ * // example id: to-retrieve-torrent-files-for-an-object-1481834115959
+ * ```
+ *
  */
 export declare class GetObjectTorrentCommand extends $Command<GetObjectTorrentCommandInput, GetObjectTorrentCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetObjectTorrentCommandInput;

package/dist-types/commands/GetPublicAccessBlockCommand.d.ts

@@ -65,6 +65,7 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
  * @see {@link GetPublicAccessBlockCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class GetPublicAccessBlockCommand extends $Command<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig> {
     readonly input: GetPublicAccessBlockCommandInput;

package/dist-types/commands/HeadBucketCommand.d.ts

@@ -39,6 +39,21 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
  * @see {@link HeadBucketCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @throws {@link NotFound} (client fault)
+ *  <p>The specified content does not exist.</p>
+ *
+ *
+ * @example To determine if bucket exists
+ * ```javascript
+ * // This operation checks to see if a bucket exists.
+ * const input = {
+ *   "Bucket": "acl1"
+ * };
+ * const command = new HeadBucketCommand(input);
+ * await client.send(command);
+ * // example id: to-determine-if-bucket-exists-1473110292262
+ * ```
+ *
  */
 export declare class HeadBucketCommand extends $Command<HeadBucketCommandInput, HeadBucketCommandOutput, S3ClientResolvedConfig> {
     readonly input: HeadBucketCommandInput;

package/dist-types/commands/HeadObjectCommand.d.ts

@@ -138,6 +138,33 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
  * @see {@link HeadObjectCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ * @throws {@link NotFound} (client fault)
+ *  <p>The specified content does not exist.</p>
+ *
+ *
+ * @example To retrieve metadata of an object without returning the object itself
+ * ```javascript
+ * // The following example retrieves an object metadata.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Key": "HappyFace.jpg"
+ * };
+ * const command = new HeadObjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AcceptRanges": "bytes",
+ *   "ContentLength": "3191",
+ *   "ContentType": "image/jpeg",
+ *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
+ *   "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
+ *   "Metadata": {},
+ *   "VersionId": "null"
+ * }
+ * *\/
+ * // example id: to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480
+ * ```
+ *
  */
 export declare class HeadObjectCommand extends $Command<HeadObjectCommandInput, HeadObjectCommandOutput, S3ClientResolvedConfig> {
     readonly input: HeadObjectCommandInput;

package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts

@@ -64,6 +64,7 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
  * @see {@link ListBucketAnalyticsConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class ListBucketAnalyticsConfigurationsCommand extends $Command<ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketAnalyticsConfigurationsCommandInput;

package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts

@@ -51,6 +51,7 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
  * @see {@link ListBucketIntelligentTieringConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class ListBucketIntelligentTieringConfigurationsCommand extends $Command<ListBucketIntelligentTieringConfigurationsCommandInput, ListBucketIntelligentTieringConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketIntelligentTieringConfigurationsCommandInput;

package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts

@@ -63,6 +63,7 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
  * @see {@link ListBucketInventoryConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class ListBucketInventoryConfigurationsCommand extends $Command<ListBucketInventoryConfigurationsCommandInput, ListBucketInventoryConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketInventoryConfigurationsCommandInput;

package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts

@@ -65,6 +65,7 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
  * @see {@link ListBucketMetricsConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
  *
+ *
  */
 export declare class ListBucketMetricsConfigurationsCommand extends $Command<ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig> {
     readonly input: ListBucketMetricsConfigurationsCommandInput;