@mavogel/awscdk-rootmail 0.0.298 → 0.0.300

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketCorsCommand.d.ts

@@ -99,36 +99,36 @@ declare const GetBucketCorsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get cors configuration set on a bucket
  * ```javascript
  * // The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketCorsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CORSRules": [
+ *   CORSRules: [
  *     {
- *       "AllowedHeaders": [
+ *       AllowedHeaders: [
  *         "Authorization"
  *       ],
- *       "AllowedMethods": [
+ *       AllowedMethods: [
  *         "GET"
  *       ],
- *       "AllowedOrigins": [
+ *       AllowedOrigins: [
  *         "*"
  *       ],
- *       "MaxAgeSeconds": 3000
+ *       MaxAgeSeconds: 3000
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-get-cors-configuration-set-on-a-bucket-1481596855475
  * ```
  *
+ * @public
  */
 export declare class GetBucketCorsCommand extends GetBucketCorsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketEncryptionCommand.d.ts

@@ -126,6 +126,7 @@ declare const GetBucketEncryptionCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketEncryptionCommand extends GetBucketEncryptionCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts

@@ -104,6 +104,7 @@ declare const GetBucketIntelligentTieringConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketIntelligentTieringConfigurationCommand extends GetBucketIntelligentTieringConfigurationCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts

@@ -112,6 +112,7 @@ declare const GetBucketInventoryConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketInventoryConfigurationCommand extends GetBucketInventoryConfigurationCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts

@@ -209,35 +209,35 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get lifecycle configuration on a bucket
  * ```javascript
  * // The following example retrieves lifecycle configuration on set on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketLifecycleConfigurationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Rules": [
+ *   Rules: [
  *     {
- *       "ID": "Rule for TaxDocs/",
- *       "Prefix": "TaxDocs",
- *       "Status": "Enabled",
- *       "Transitions": [
+ *       ID: "Rule for TaxDocs/",
+ *       Prefix: "TaxDocs",
+ *       Status: "Enabled",
+ *       Transitions: [
  *         {
- *           "Days": 365,
- *           "StorageClass": "STANDARD_IA"
+ *           Days: 365,
+ *           StorageClass: "STANDARD_IA"
  *         }
  *       ]
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-get-lifecycle-configuration-on-a-bucket-1481666063200
  * ```
  *
+ * @public
  */
 export declare class GetBucketLifecycleConfigurationCommand extends GetBucketLifecycleConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketLocationCommand.d.ts

@@ -83,23 +83,23 @@ declare const GetBucketLocationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get bucket location
  * ```javascript
  * // The following example returns bucket location.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketLocationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "LocationConstraint": "us-west-2"
+ *   LocationConstraint: "us-west-2"
  * }
  * *\/
- * // example id: to-get-bucket-location-1481594573609
  * ```
  *
+ * @public
  */
 export declare class GetBucketLocationCommand extends GetBucketLocationCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketLoggingCommand.d.ts

@@ -93,6 +93,7 @@ declare const GetBucketLoggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketLoggingCommand extends GetBucketLoggingCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts

@@ -94,6 +94,7 @@ declare const GetBucketMetadataTableConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketMetadataTableConfigurationCommand extends GetBucketMetadataTableConfigurationCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts

@@ -111,6 +111,7 @@ declare const GetBucketMetricsConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketMetricsConfigurationCommand extends GetBucketMetricsConfigurationCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts

@@ -137,6 +137,7 @@ declare const GetBucketNotificationConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketNotificationConfigurationCommand extends GetBucketNotificationConfigurationCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts

@@ -82,6 +82,7 @@ declare const GetBucketOwnershipControlsCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketOwnershipControlsCommand extends GetBucketOwnershipControlsCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketPolicyCommand.d.ts

@@ -126,23 +126,23 @@ declare const GetBucketPolicyCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get bucket policy
  * ```javascript
  * // The following example returns bucket policy associated with a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketPolicyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "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\"]}]}"
+ *   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
  * ```
  *
+ * @public
  */
 export declare class GetBucketPolicyCommand extends GetBucketPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketPolicyStatusCommand.d.ts

@@ -88,6 +88,7 @@ declare const GetBucketPolicyStatusCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetBucketPolicyStatusCommand extends GetBucketPolicyStatusCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketReplicationCommand.d.ts

@@ -150,35 +150,35 @@ declare const GetBucketReplicationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get replication configuration set on a bucket
  * ```javascript
  * // The following example returns replication configuration set on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketReplicationCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ReplicationConfiguration": {
- *     "Role": "arn:aws:iam::acct-id:role/example-role",
- *     "Rules": [
+ *   ReplicationConfiguration: {
+ *     Role: "arn:aws:iam::acct-id:role/example-role",
+ *     Rules: [
  *       {
- *         "Destination": {
- *           "Bucket": "arn:aws:s3:::destination-bucket"
+ *         Destination: {
+ *           Bucket: "arn:aws:s3:::destination-bucket"
  *         },
- *         "ID": "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
- *         "Prefix": "Tax",
- *         "Status": "Enabled"
+ *         ID: "MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy",
+ *         Prefix: "Tax",
+ *         Status: "Enabled"
  *       }
  *     ]
  *   }
  * }
  * *\/
- * // example id: to-get-replication-configuration-set-on-a-bucket-1481593597175
  * ```
  *
+ * @public
  */
 export declare class GetBucketReplicationCommand extends GetBucketReplicationCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketRequestPaymentCommand.d.ts

@@ -68,23 +68,23 @@ declare const GetBucketRequestPaymentCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get bucket versioning configuration
  * ```javascript
  * // The following example retrieves bucket versioning configuration.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketRequestPaymentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Payer": "BucketOwner"
+ *   Payer: "BucketOwner"
  * }
  * *\/
- * // example id: to-get-bucket-versioning-configuration-1483037183929
  * ```
  *
+ * @public
  */
 export declare class GetBucketRequestPaymentCommand extends GetBucketRequestPaymentCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketTaggingCommand.d.ts

@@ -92,32 +92,32 @@ declare const GetBucketTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get tag set associated with a bucket
  * ```javascript
  * // The following example returns tag set associated with a bucket
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TagSet": [
+ *   TagSet: [
  *     {
- *       "Key": "key1",
- *       "Value": "value1"
+ *       Key: "key1",
+ *       Value: "value1"
  *     },
  *     {
- *       "Key": "key2",
- *       "Value": "value2"
+ *       Key: "key2",
+ *       Value: "value2"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-get-tag-set-associated-with-a-bucket-1481593232107
  * ```
  *
+ * @public
  */
 export declare class GetBucketTaggingCommand extends GetBucketTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketVersioningCommand.d.ts

@@ -81,24 +81,24 @@ declare const GetBucketVersioningCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get bucket versioning configuration
  * ```javascript
  * // The following example retrieves bucket versioning configuration.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketVersioningCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "MFADelete": "Disabled",
- *   "Status": "Enabled"
+ *   MFADelete: "Disabled",
+ *   Status: "Enabled"
  * }
  * *\/
- * // example id: to-get-bucket-versioning-configuration-1483037183929
  * ```
  *
+ * @public
  */
 export declare class GetBucketVersioningCommand extends GetBucketVersioningCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetBucketWebsiteCommand.d.ts

@@ -101,28 +101,28 @@ declare const GetBucketWebsiteCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To get bucket website configuration
  * ```javascript
  * // The following example retrieves website configuration of a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new GetBucketWebsiteCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ErrorDocument": {
- *     "Key": "error.html"
+ *   ErrorDocument: {
+ *     Key: "error.html"
  *   },
- *   "IndexDocument": {
- *     "Suffix": "index.html"
+ *   IndexDocument: {
+ *     Suffix: "index.html"
  *   }
  * }
  * *\/
- * // example id: to-get-bucket-website-configuration-1483037016926
  * ```
  *
+ * @public
  */
 export declare class GetBucketWebsiteCommand extends GetBucketWebsiteCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectAclCommand.d.ts

@@ -118,61 +118,61 @@ declare const GetObjectAclCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve object ACL
  * ```javascript
  * // The following example retrieves access control list (ACL) of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectAclCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Grants": [
+ *   Grants: [
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "WRITE"
+ *       Permission: "WRITE"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "WRITE_ACP"
+ *       Permission: "WRITE_ACP"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "READ"
+ *       Permission: "READ"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "READ_ACP"
+ *       Permission: "READ_ACP"
  *     }
  *   ],
- *   "Owner": {
- *     "DisplayName": "owner-display-name",
- *     "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
+ *   Owner: {
+ *     DisplayName: "owner-display-name",
+ *     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
  *   }
  * }
  * *\/
- * // example id: to-retrieve-object-acl-1481833557740
  * ```
  *
+ * @public
  */
 export declare class GetObjectAclCommand extends GetObjectAclCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectAttributesCommand.d.ts

@@ -312,6 +312,7 @@ declare const GetObjectAttributesCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectAttributesCommand extends GetObjectAttributesCommand_base {

package/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectCommand.d.ts

@@ -112,7 +112,7 @@ declare const GetObjectCommand_base: {
  *                      Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
  *                <p>
  *                   <b>Directory buckets </b> -
- *                   For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
+ *                   Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
  * Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p>
  *             </dd>
  *             <dt>Encryption</dt>
@@ -235,6 +235,11 @@ declare const GetObjectCommand_base: {
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
  * // { // GetObjectOutput
  * //   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   DeleteMarker: true || false,
@@ -303,56 +308,65 @@ declare const GetObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To retrieve an object
+ *
+ * @example To retrieve a byte range of an object
  * ```javascript
- * // The following example retrieves an object for an S3 bucket.
+ * // 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": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "SampleFile.txt",
+ *   Range: "bytes=0-9"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "3191",
- *   "ContentType": "image/jpeg",
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "LastModified": "2016-12-15T01:19:41.000Z",
- *   "Metadata": {},
- *   "TagCount": 2,
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 10,
+ *   ContentRange: "bytes 0-9/43",
+ *   ContentType: "text/plain",
+ *   ETag: `"0d94420ffd0bc68cd3d152506b97a9cc"`,
+ *   LastModified: "2014-10-09T22:57:28.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-an-object-1481827837012
  * ```
  *
- * @example To retrieve a byte range of an object
+ * @example To retrieve 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.
+ * // The following example retrieves an object for an S3 bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "SampleFile.txt",
- *   "Range": "bytes=0-9"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "10",
- *   "ContentRange": "bytes 0-9/43",
- *   "ContentType": "text/plain",
- *   "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
- *   "LastModified": "2014-10-09T22:57:28.000Z",
- *   "Metadata": {},
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 3191,
+ *   ContentType: "image/jpeg",
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   LastModified: "2016-12-15T01:19:41.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   TagCount: 2,
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
  * ```
  *
+ * @public
  */
 export declare class GetObjectCommand extends GetObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */