@aws-sdk/client-s3 3.774.0 → 3.777.0

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

@@ -245,27 +245,27 @@ declare const PutBucketLifecycleConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Put bucket lifecycle
  * ```javascript
  * // The following example replaces existing lifecycle configuration, if any, on the specified bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "LifecycleConfiguration": {
- *     "Rules": [
+ *   Bucket: "examplebucket",
+ *   LifecycleConfiguration: {
+ *     Rules: [
  *       {
- *         "Expiration": {
- *           "Days": 3650
+ *         Expiration: {
+ *           Days: 3650
  *         },
- *         "Filter": {
- *           "Prefix": "documents/"
+ *         Filter: {
+ *           Prefix: "documents/"
  *         },
- *         "ID": "TestOnly",
- *         "Status": "Enabled",
- *         "Transitions": [
+ *         ID: "TestOnly",
+ *         Status: "Enabled",
+ *         Transitions: [
  *           {
- *             "Days": 365,
- *             "StorageClass": "GLACIER"
+ *             Days: 365,
+ *             StorageClass: "GLACIER"
  *           }
  *         ]
  *       }
@@ -273,10 +273,13 @@ declare const PutBucketLifecycleConfigurationCommand_base: {
  *   }
  * };
  * const command = new PutBucketLifecycleConfigurationCommand(input);
- * await client.send(command);
- * // example id: put-bucket-lifecycle-1482264533092
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketLifecycleConfigurationCommand extends PutBucketLifecycleConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -166,33 +166,36 @@ declare const PutBucketLoggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set logging configuration for a bucket
  * ```javascript
  * // The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.
  * const input = {
- *   "Bucket": "sourcebucket",
- *   "BucketLoggingStatus": {
- *     "LoggingEnabled": {
- *       "TargetBucket": "targetbucket",
- *       "TargetGrants": [
+ *   Bucket: "sourcebucket",
+ *   BucketLoggingStatus: {
+ *     LoggingEnabled: {
+ *       TargetBucket: "targetbucket",
+ *       TargetGrants: [
  *         {
- *           "Grantee": {
- *             "Type": "Group",
- *             "URI": "http://acs.amazonaws.com/groups/global/AllUsers"
+ *           Grantee: {
+ *             Type: "Group",
+ *             URI: "http://acs.amazonaws.com/groups/global/AllUsers"
  *           },
- *           "Permission": "READ"
+ *           Permission: "READ"
  *         }
  *       ],
- *       "TargetPrefix": "MyBucketLogs/"
+ *       TargetPrefix: "MyBucketLogs/"
  *     }
  *   }
  * };
  * const command = new PutBucketLoggingCommand(input);
- * await client.send(command);
- * // example id: set-logging-configuration-for-a-bucket-1482269119909
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketLoggingCommand extends PutBucketLoggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -168,28 +168,31 @@ declare const PutBucketNotificationConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set notification configuration for a bucket
  * ```javascript
  * // The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "NotificationConfiguration": {
- *     "TopicConfigurations": [
+ *   Bucket: "examplebucket",
+ *   NotificationConfiguration: {
+ *     TopicConfigurations: [
  *       {
- *         "Events": [
+ *         Events: [
  *           "s3:ObjectCreated:*"
  *         ],
- *         "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
+ *         TopicArn: "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
  *       }
  *     ]
  *   }
  * };
  * const command = new PutBucketNotificationConfigurationCommand(input);
- * await client.send(command);
- * // example id: set-notification-configuration-for-a-bucket-1482270296426
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketNotificationConfigurationCommand extends PutBucketNotificationConfigurationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -133,19 +133,22 @@ declare const PutBucketPolicyCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set bucket policy
  * ```javascript
  * // The following example sets a permission policy on a bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}"
+ *   Bucket: "examplebucket",
+ *   Policy: `{"Version": "2012-10-17", "Statement": [{ "Sid": "id-1","Effect": "Allow","Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Action": [ "s3:PutObject","s3:PutObjectAcl"], "Resource": ["arn:aws:s3:::acl3/*" ] } ]}`
  * };
  * const command = new PutBucketPolicyCommand(input);
- * await client.send(command);
- * // example id: set-bucket-policy-1482448903302
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketPolicyCommand extends PutBucketPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -192,31 +192,34 @@ declare const PutBucketReplicationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set replication configuration on a bucket
  * ```javascript
  * // The following example sets replication configuration on a bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "ReplicationConfiguration": {
- *     "Role": "arn:aws:iam::123456789012:role/examplerole",
- *     "Rules": [
+ *   Bucket: "examplebucket",
+ *   ReplicationConfiguration: {
+ *     Role: "arn:aws:iam::123456789012:role/examplerole",
+ *     Rules: [
  *       {
- *         "Destination": {
- *           "Bucket": "arn:aws:s3:::destinationbucket",
- *           "StorageClass": "STANDARD"
+ *         Destination: {
+ *           Bucket: "arn:aws:s3:::destinationbucket",
+ *           StorageClass: "STANDARD"
  *         },
- *         "Prefix": "",
- *         "Status": "Enabled"
+ *         Prefix: "",
+ *         Status: "Enabled"
  *       }
  *     ]
  *   }
  * };
  * const command = new PutBucketReplicationCommand(input);
- * await client.send(command);
- * // example id: id-1
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketReplicationCommand extends PutBucketReplicationCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -78,21 +78,24 @@ declare const PutBucketRequestPaymentCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set request payment configuration on a bucket.
  * ```javascript
  * // The following example sets request payment configuration on a bucket so that person requesting the download is charged.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "RequestPaymentConfiguration": {
- *     "Payer": "Requester"
+ *   Bucket: "examplebucket",
+ *   RequestPaymentConfiguration: {
+ *     Payer: "Requester"
  *   }
  * };
  * const command = new PutBucketRequestPaymentCommand(input);
- * await client.send(command);
- * // example id: set-request-payment-configuration-on-a-bucket-1482343596680
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketRequestPaymentCommand extends PutBucketRequestPaymentCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -123,30 +123,33 @@ declare const PutBucketTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set tags on a bucket
  * ```javascript
  * // The following example sets tags on a bucket. Any existing tags are replaced.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Tagging": {
- *     "TagSet": [
+ *   Bucket: "examplebucket",
+ *   Tagging: {
+ *     TagSet: [
  *       {
- *         "Key": "Key1",
- *         "Value": "Value1"
+ *         Key: "Key1",
+ *         Value: "Value1"
  *       },
  *       {
- *         "Key": "Key2",
- *         "Value": "Value2"
+ *         Key: "Key2",
+ *         Value: "Value2"
  *       }
  *     ]
  *   }
  * };
  * const command = new PutBucketTaggingCommand(input);
- * await client.send(command);
- * // example id: set-tags-on-a-bucket-1482346269066
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketTaggingCommand extends PutBucketTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -111,22 +111,25 @@ declare const PutBucketVersioningCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set versioning configuration on a bucket
  * ```javascript
  * // The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "VersioningConfiguration": {
- *     "MFADelete": "Disabled",
- *     "Status": "Enabled"
+ *   Bucket: "examplebucket",
+ *   VersioningConfiguration: {
+ *     MFADelete: "Disabled",
+ *     Status: "Enabled"
  *   }
  * };
  * const command = new PutBucketVersioningCommand(input);
- * await client.send(command);
- * // example id: set-versioning-configuration-on-a-bucket-1482344186279
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketVersioningCommand extends PutBucketVersioningCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -207,27 +207,30 @@ declare const PutBucketWebsiteCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example Set website configuration on a bucket
  * ```javascript
  * // The following example adds website configuration to a bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "ContentMD5": "",
- *   "WebsiteConfiguration": {
- *     "ErrorDocument": {
- *       "Key": "error.html"
+ *   Bucket: "examplebucket",
+ *   ContentMD5: "",
+ *   WebsiteConfiguration: {
+ *     ErrorDocument: {
+ *       Key: "error.html"
  *     },
- *     "IndexDocument": {
- *       "Suffix": "index.html"
+ *     IndexDocument: {
+ *       Suffix: "index.html"
  *     }
  *   }
  * };
  * const command = new PutBucketWebsiteCommand(input);
- * await client.send(command);
- * // example id: set-website-configuration-on-a-bucket-1482346836261
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutBucketWebsiteCommand extends PutBucketWebsiteCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -275,22 +275,25 @@ declare const PutObjectAclCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To grant permissions using object ACL
  * ```javascript
  * // The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.
  * const input = {
- *   "AccessControlPolicy": {},
- *   "Bucket": "examplebucket",
- *   "GrantFullControl": "emailaddress=user1@example.com,emailaddress=user2@example.com",
- *   "GrantRead": "uri=http://acs.amazonaws.com/groups/global/AllUsers",
- *   "Key": "HappyFace.jpg"
+ *   AccessControlPolicy:   { /* empty *\/ },
+ *   Bucket: "examplebucket",
+ *   GrantFullControl: "emailaddress=user1@example.com,emailaddress=user2@example.com",
+ *   GrantRead: "uri=http://acs.amazonaws.com/groups/global/AllUsers",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new PutObjectAclCommand(input);
- * await client.send(command);
- * // example id: to-grant-permissions-using-object-acl-1481835549285
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class PutObjectAclCommand extends PutObjectAclCommand_base {
     /** @internal type navigation helper, not in runtime. */