@aws-sdk/client-s3 3.296.0 → 3.297.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.
Files changed (107) hide show
  1. package/dist-cjs/protocols/Aws_restXml.js +88 -436
  2. package/dist-es/protocols/Aws_restXml.js +88 -436
  3. package/dist-types/S3.d.ts +94 -0
  4. package/dist-types/S3Client.d.ts +24 -4
  5. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +16 -0
  6. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +16 -0
  7. package/dist-types/commands/CopyObjectCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateBucketCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteBucketCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteObjectCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteObjectsCommand.d.ts +16 -0
  26. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +16 -0
  27. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +16 -0
  28. package/dist-types/commands/GetBucketAclCommand.d.ts +16 -0
  29. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +16 -0
  30. package/dist-types/commands/GetBucketCorsCommand.d.ts +16 -0
  31. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -0
  32. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +16 -0
  33. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +16 -0
  34. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +16 -0
  35. package/dist-types/commands/GetBucketLocationCommand.d.ts +16 -0
  36. package/dist-types/commands/GetBucketLoggingCommand.d.ts +16 -0
  37. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +16 -0
  38. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +16 -0
  39. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +16 -0
  40. package/dist-types/commands/GetBucketPolicyCommand.d.ts +16 -0
  41. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +16 -0
  42. package/dist-types/commands/GetBucketReplicationCommand.d.ts +16 -0
  43. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +16 -0
  44. package/dist-types/commands/GetBucketTaggingCommand.d.ts +16 -0
  45. package/dist-types/commands/GetBucketVersioningCommand.d.ts +16 -0
  46. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +16 -0
  47. package/dist-types/commands/GetObjectAclCommand.d.ts +16 -0
  48. package/dist-types/commands/GetObjectAttributesCommand.d.ts +16 -0
  49. package/dist-types/commands/GetObjectCommand.d.ts +16 -0
  50. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +16 -0
  51. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +16 -0
  52. package/dist-types/commands/GetObjectRetentionCommand.d.ts +16 -0
  53. package/dist-types/commands/GetObjectTaggingCommand.d.ts +16 -0
  54. package/dist-types/commands/GetObjectTorrentCommand.d.ts +16 -0
  55. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +16 -0
  56. package/dist-types/commands/HeadBucketCommand.d.ts +16 -0
  57. package/dist-types/commands/HeadObjectCommand.d.ts +16 -0
  58. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +16 -0
  61. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +16 -0
  62. package/dist-types/commands/ListBucketsCommand.d.ts +16 -0
  63. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +16 -0
  64. package/dist-types/commands/ListObjectVersionsCommand.d.ts +16 -0
  65. package/dist-types/commands/ListObjectsCommand.d.ts +16 -0
  66. package/dist-types/commands/ListObjectsV2Command.d.ts +16 -0
  67. package/dist-types/commands/ListPartsCommand.d.ts +16 -0
  68. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +16 -0
  69. package/dist-types/commands/PutBucketAclCommand.d.ts +16 -0
  70. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +16 -0
  71. package/dist-types/commands/PutBucketCorsCommand.d.ts +16 -0
  72. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +16 -0
  73. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +16 -0
  74. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +16 -0
  75. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +16 -0
  76. package/dist-types/commands/PutBucketLoggingCommand.d.ts +16 -0
  77. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +16 -0
  78. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +16 -0
  79. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +16 -0
  80. package/dist-types/commands/PutBucketPolicyCommand.d.ts +16 -0
  81. package/dist-types/commands/PutBucketReplicationCommand.d.ts +16 -0
  82. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +16 -0
  83. package/dist-types/commands/PutBucketTaggingCommand.d.ts +16 -0
  84. package/dist-types/commands/PutBucketVersioningCommand.d.ts +16 -0
  85. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +16 -0
  86. package/dist-types/commands/PutObjectAclCommand.d.ts +16 -0
  87. package/dist-types/commands/PutObjectCommand.d.ts +17 -2
  88. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +16 -0
  89. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +16 -0
  90. package/dist-types/commands/PutObjectRetentionCommand.d.ts +16 -0
  91. package/dist-types/commands/PutObjectTaggingCommand.d.ts +16 -0
  92. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +16 -0
  93. package/dist-types/commands/RestoreObjectCommand.d.ts +16 -0
  94. package/dist-types/commands/SelectObjectContentCommand.d.ts +16 -0
  95. package/dist-types/commands/UploadPartCommand.d.ts +17 -2
  96. package/dist-types/commands/UploadPartCopyCommand.d.ts +16 -0
  97. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +17 -2
  98. package/dist-types/models/S3ServiceException.d.ts +2 -0
  99. package/dist-types/models/models_0.d.ts +684 -0
  100. package/dist-types/models/models_1.d.ts +90 -0
  101. package/dist-types/pagination/Interfaces.d.ts +3 -0
  102. package/dist-types/pagination/ListObjectsV2Paginator.d.ts +3 -0
  103. package/dist-types/pagination/ListPartsPaginator.d.ts +3 -0
  104. package/dist-types/ts3.4/commands/PutObjectCommand.d.ts +1 -2
  105. package/dist-types/ts3.4/commands/UploadPartCommand.d.ts +1 -2
  106. package/dist-types/ts3.4/commands/WriteGetObjectResponseCommand.d.ts +1 -2
  107. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketLoggingRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketLoggingCommand}.
8
10
  */
9
11
  export interface PutBucketLoggingCommandInput extends PutBucketLoggingRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketLoggingCommand}.
13
17
  */
14
18
  export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Set the logging parameters for a bucket and to specify permissions for who can view and
18
23
  * modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the
19
24
  * source bucket. To set the logging status of a bucket, you must be the bucket owner.</p>
@@ -100,6 +105,8 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
100
105
  * const response = await client.send(command);
101
106
  * ```
102
107
  *
108
+ * @param PutBucketLoggingCommandInput - {@link PutBucketLoggingCommandInput}
109
+ * @returns {@link PutBucketLoggingCommandOutput}
103
110
  * @see {@link PutBucketLoggingCommandInput} for command's `input` shape.
104
111
  * @see {@link PutBucketLoggingCommandOutput} for command's `response` shape.
105
112
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -135,11 +142,20 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
135
142
  export declare class PutBucketLoggingCommand extends $Command<PutBucketLoggingCommandInput, PutBucketLoggingCommandOutput, S3ClientResolvedConfig> {
136
143
  readonly input: PutBucketLoggingCommandInput;
137
144
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
145
+ /**
146
+ * @public
147
+ */
138
148
  constructor(input: PutBucketLoggingCommandInput);
139
149
  /**
140
150
  * @internal
141
151
  */
142
152
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketLoggingCommandInput, PutBucketLoggingCommandOutput>;
153
+ /**
154
+ * @internal
155
+ */
143
156
  private serialize;
157
+ /**
158
+ * @internal
159
+ */
144
160
  private deserialize;
145
161
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketMetricsConfigurationRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketMetricsConfigurationCommand}.
8
10
  */
9
11
  export interface PutBucketMetricsConfigurationCommandInput extends PutBucketMetricsConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketMetricsConfigurationCommand}.
13
17
  */
14
18
  export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
18
23
  * You can have up to 1,000 metrics configurations per bucket. If you're updating an existing
19
24
  * metrics configuration, note that this is a full replacement of the existing metrics
@@ -71,6 +76,8 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe
71
76
  * const response = await client.send(command);
72
77
  * ```
73
78
  *
79
+ * @param PutBucketMetricsConfigurationCommandInput - {@link PutBucketMetricsConfigurationCommandInput}
80
+ * @returns {@link PutBucketMetricsConfigurationCommandOutput}
74
81
  * @see {@link PutBucketMetricsConfigurationCommandInput} for command's `input` shape.
75
82
  * @see {@link PutBucketMetricsConfigurationCommandOutput} for command's `response` shape.
76
83
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -80,11 +87,20 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe
80
87
  export declare class PutBucketMetricsConfigurationCommand extends $Command<PutBucketMetricsConfigurationCommandInput, PutBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
81
88
  readonly input: PutBucketMetricsConfigurationCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: PutBucketMetricsConfigurationCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketMetricsConfigurationCommandInput, PutBucketMetricsConfigurationCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketNotificationConfigurationRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketNotificationConfigurationCommand}.
8
10
  */
9
11
  export interface PutBucketNotificationConfigurationCommandInput extends PutBucketNotificationConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketNotificationConfigurationCommand}.
13
17
  */
14
18
  export interface PutBucketNotificationConfigurationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Enables notifications of specified events for a bucket. For more information about event
18
23
  * notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event
19
24
  * Notifications</a>.</p>
@@ -79,6 +84,8 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
79
84
  * const response = await client.send(command);
80
85
  * ```
81
86
  *
87
+ * @param PutBucketNotificationConfigurationCommandInput - {@link PutBucketNotificationConfigurationCommandInput}
88
+ * @returns {@link PutBucketNotificationConfigurationCommandOutput}
82
89
  * @see {@link PutBucketNotificationConfigurationCommandInput} for command's `input` shape.
83
90
  * @see {@link PutBucketNotificationConfigurationCommandOutput} for command's `response` shape.
84
91
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -109,11 +116,20 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
109
116
  export declare class PutBucketNotificationConfigurationCommand extends $Command<PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig> {
110
117
  readonly input: PutBucketNotificationConfigurationCommandInput;
111
118
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
119
+ /**
120
+ * @public
121
+ */
112
122
  constructor(input: PutBucketNotificationConfigurationCommandInput);
113
123
  /**
114
124
  * @internal
115
125
  */
116
126
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput>;
127
+ /**
128
+ * @internal
129
+ */
117
130
  private serialize;
131
+ /**
132
+ * @internal
133
+ */
118
134
  private deserialize;
119
135
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketOwnershipControlsRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketOwnershipControlsCommand}.
8
10
  */
9
11
  export interface PutBucketOwnershipControlsCommandInput extends PutBucketOwnershipControlsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketOwnershipControlsCommand}.
13
17
  */
14
18
  export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this
18
23
  * operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For
19
24
  * more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </p>
@@ -41,6 +46,8 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param PutBucketOwnershipControlsCommandInput - {@link PutBucketOwnershipControlsCommandInput}
50
+ * @returns {@link PutBucketOwnershipControlsCommandOutput}
44
51
  * @see {@link PutBucketOwnershipControlsCommandInput} for command's `input` shape.
45
52
  * @see {@link PutBucketOwnershipControlsCommandOutput} for command's `response` shape.
46
53
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -50,11 +57,20 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
50
57
  export declare class PutBucketOwnershipControlsCommand extends $Command<PutBucketOwnershipControlsCommandInput, PutBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
51
58
  readonly input: PutBucketOwnershipControlsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: PutBucketOwnershipControlsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketOwnershipControlsCommandInput, PutBucketOwnershipControlsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketPolicyRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketPolicyCommand}.
8
10
  */
9
11
  export interface PutBucketPolicyCommandInput extends PutBucketPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketPolicyCommand}.
13
17
  */
14
18
  export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than
18
23
  * the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
19
24
  * <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the
@@ -51,6 +56,8 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
51
56
  * const response = await client.send(command);
52
57
  * ```
53
58
  *
59
+ * @param PutBucketPolicyCommandInput - {@link PutBucketPolicyCommandInput}
60
+ * @returns {@link PutBucketPolicyCommandOutput}
54
61
  * @see {@link PutBucketPolicyCommandInput} for command's `input` shape.
55
62
  * @see {@link PutBucketPolicyCommandOutput} for command's `response` shape.
56
63
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -72,11 +79,20 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
72
79
  export declare class PutBucketPolicyCommand extends $Command<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput, S3ClientResolvedConfig> {
73
80
  readonly input: PutBucketPolicyCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: PutBucketPolicyCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketReplicationRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketReplicationCommand}.
8
10
  */
9
11
  export interface PutBucketReplicationCommandInput extends PutBucketReplicationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketReplicationCommand}.
13
17
  */
14
18
  export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Creates a replication configuration or replaces an existing one. For more information,
18
23
  * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </p>
19
24
  * <p>Specify the replication configuration in the request body. In the replication
@@ -86,6 +91,8 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
86
91
  * const response = await client.send(command);
87
92
  * ```
88
93
  *
94
+ * @param PutBucketReplicationCommandInput - {@link PutBucketReplicationCommandInput}
95
+ * @returns {@link PutBucketReplicationCommandOutput}
89
96
  * @see {@link PutBucketReplicationCommandInput} for command's `input` shape.
90
97
  * @see {@link PutBucketReplicationCommandOutput} for command's `response` shape.
91
98
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -119,11 +126,20 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
119
126
  export declare class PutBucketReplicationCommand extends $Command<PutBucketReplicationCommandInput, PutBucketReplicationCommandOutput, S3ClientResolvedConfig> {
120
127
  readonly input: PutBucketReplicationCommandInput;
121
128
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
129
+ /**
130
+ * @public
131
+ */
122
132
  constructor(input: PutBucketReplicationCommandInput);
123
133
  /**
124
134
  * @internal
125
135
  */
126
136
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketReplicationCommandInput, PutBucketReplicationCommandOutput>;
137
+ /**
138
+ * @internal
139
+ */
127
140
  private serialize;
141
+ /**
142
+ * @internal
143
+ */
128
144
  private deserialize;
129
145
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketRequestPaymentRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketRequestPaymentCommand}.
8
10
  */
9
11
  export interface PutBucketRequestPaymentCommandInput extends PutBucketRequestPaymentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketRequestPaymentCommand}.
13
17
  */
14
18
  export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the request payment configuration for a bucket. By default, the bucket owner pays
18
23
  * for downloads from the bucket. This configuration parameter enables the bucket owner (only)
19
24
  * to specify that the person requesting the download will be charged for the download. For
@@ -42,6 +47,8 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
42
47
  * const response = await client.send(command);
43
48
  * ```
44
49
  *
50
+ * @param PutBucketRequestPaymentCommandInput - {@link PutBucketRequestPaymentCommandInput}
51
+ * @returns {@link PutBucketRequestPaymentCommandOutput}
45
52
  * @see {@link PutBucketRequestPaymentCommandInput} for command's `input` shape.
46
53
  * @see {@link PutBucketRequestPaymentCommandOutput} for command's `response` shape.
47
54
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -65,11 +72,20 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
65
72
  export declare class PutBucketRequestPaymentCommand extends $Command<PutBucketRequestPaymentCommandInput, PutBucketRequestPaymentCommandOutput, S3ClientResolvedConfig> {
66
73
  readonly input: PutBucketRequestPaymentCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: PutBucketRequestPaymentCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketRequestPaymentCommandInput, PutBucketRequestPaymentCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketTaggingRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketTaggingCommand}.
8
10
  */
9
11
  export interface PutBucketTaggingCommandInput extends PutBucketTaggingRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketTaggingCommand}.
13
17
  */
14
18
  export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the tags for a bucket.</p>
18
23
  * <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign
19
24
  * up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of
@@ -99,6 +104,8 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
99
104
  * const response = await client.send(command);
100
105
  * ```
101
106
  *
107
+ * @param PutBucketTaggingCommandInput - {@link PutBucketTaggingCommandInput}
108
+ * @returns {@link PutBucketTaggingCommandOutput}
102
109
  * @see {@link PutBucketTaggingCommandInput} for command's `input` shape.
103
110
  * @see {@link PutBucketTaggingCommandOutput} for command's `response` shape.
104
111
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -131,11 +138,20 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
131
138
  export declare class PutBucketTaggingCommand extends $Command<PutBucketTaggingCommandInput, PutBucketTaggingCommandOutput, S3ClientResolvedConfig> {
132
139
  readonly input: PutBucketTaggingCommandInput;
133
140
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
141
+ /**
142
+ * @public
143
+ */
134
144
  constructor(input: PutBucketTaggingCommandInput);
135
145
  /**
136
146
  * @internal
137
147
  */
138
148
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketTaggingCommandInput, PutBucketTaggingCommandOutput>;
149
+ /**
150
+ * @internal
151
+ */
139
152
  private serialize;
153
+ /**
154
+ * @internal
155
+ */
140
156
  private deserialize;
141
157
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketVersioningRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketVersioningCommand}.
8
10
  */
9
11
  export interface PutBucketVersioningCommandInput extends PutBucketVersioningRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketVersioningCommand}.
13
17
  */
14
18
  export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the versioning state of an existing bucket.</p>
18
23
  * <p>You can set the versioning state with one of the following values:</p>
19
24
  * <p>
@@ -67,6 +72,8 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
67
72
  * const response = await client.send(command);
68
73
  * ```
69
74
  *
75
+ * @param PutBucketVersioningCommandInput - {@link PutBucketVersioningCommandInput}
76
+ * @returns {@link PutBucketVersioningCommandOutput}
70
77
  * @see {@link PutBucketVersioningCommandInput} for command's `input` shape.
71
78
  * @see {@link PutBucketVersioningCommandOutput} for command's `response` shape.
72
79
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -91,11 +98,20 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
91
98
  export declare class PutBucketVersioningCommand extends $Command<PutBucketVersioningCommandInput, PutBucketVersioningCommandOutput, S3ClientResolvedConfig> {
92
99
  readonly input: PutBucketVersioningCommandInput;
93
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
94
104
  constructor(input: PutBucketVersioningCommandInput);
95
105
  /**
96
106
  * @internal
97
107
  */
98
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketVersioningCommandInput, PutBucketVersioningCommandOutput>;
109
+ /**
110
+ * @internal
111
+ */
99
112
  private serialize;
113
+ /**
114
+ * @internal
115
+ */
100
116
  private deserialize;
101
117
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutBucketWebsiteRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutBucketWebsiteCommand}.
8
10
  */
9
11
  export interface PutBucketWebsiteCommandInput extends PutBucketWebsiteRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutBucketWebsiteCommand}.
13
17
  */
14
18
  export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the configuration of the website that is specified in the <code>website</code>
18
23
  * subresource. To configure a bucket as a website, you can add this subresource on the bucket
19
24
  * with website configuration information such as the file name of the index document and any
@@ -146,6 +151,8 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {
146
151
  * const response = await client.send(command);
147
152
  * ```
148
153
  *
154
+ * @param PutBucketWebsiteCommandInput - {@link PutBucketWebsiteCommandInput}
155
+ * @returns {@link PutBucketWebsiteCommandOutput}
149
156
  * @see {@link PutBucketWebsiteCommandInput} for command's `input` shape.
150
157
  * @see {@link PutBucketWebsiteCommandOutput} for command's `response` shape.
151
158
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -175,11 +182,20 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {
175
182
  export declare class PutBucketWebsiteCommand extends $Command<PutBucketWebsiteCommandInput, PutBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
176
183
  readonly input: PutBucketWebsiteCommandInput;
177
184
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
185
+ /**
186
+ * @public
187
+ */
178
188
  constructor(input: PutBucketWebsiteCommandInput);
179
189
  /**
180
190
  * @internal
181
191
  */
182
192
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketWebsiteCommandInput, PutBucketWebsiteCommandOutput>;
193
+ /**
194
+ * @internal
195
+ */
183
196
  private serialize;
197
+ /**
198
+ * @internal
199
+ */
184
200
  private deserialize;
185
201
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PutObjectAclOutput, PutObjectAclRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutObjectAclCommand}.
8
10
  */
9
11
  export interface PutObjectAclCommandInput extends PutObjectAclRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutObjectAclCommand}.
13
17
  */
14
18
  export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Uses the <code>acl</code> subresource to set the access control list (ACL) permissions
18
23
  * for a new or existing object in an S3 bucket. You must have <code>WRITE_ACP</code>
19
24
  * permission to set the ACL of an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions">What
@@ -203,6 +208,8 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
203
208
  * const response = await client.send(command);
204
209
  * ```
205
210
  *
211
+ * @param PutObjectAclCommandInput - {@link PutObjectAclCommandInput}
212
+ * @returns {@link PutObjectAclCommandOutput}
206
213
  * @see {@link PutObjectAclCommandInput} for command's `input` shape.
207
214
  * @see {@link PutObjectAclCommandOutput} for command's `response` shape.
208
215
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -230,11 +237,20 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
230
237
  export declare class PutObjectAclCommand extends $Command<PutObjectAclCommandInput, PutObjectAclCommandOutput, S3ClientResolvedConfig> {
231
238
  readonly input: PutObjectAclCommandInput;
232
239
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
240
+ /**
241
+ * @public
242
+ */
233
243
  constructor(input: PutObjectAclCommandInput);
234
244
  /**
235
245
  * @internal
236
246
  */
237
247
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutObjectAclCommandInput, PutObjectAclCommandOutput>;
248
+ /**
249
+ * @internal
250
+ */
238
251
  private serialize;
252
+ /**
253
+ * @internal
254
+ */
239
255
  private deserialize;
240
256
  }
@@ -5,9 +5,11 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
5
5
  import { PutObjectOutput, PutObjectRequest } from "../models/models_0";
6
6
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
7
7
  /**
8
+ * @public
9
+ *
8
10
  * The input for {@link PutObjectCommand}.
9
11
  */
10
- type PutObjectCommandInputType = Omit<PutObjectRequest, "Body"> & {
12
+ export type PutObjectCommandInputType = Omit<PutObjectRequest, "Body"> & {
11
13
  /**
12
14
  * For *`PutObjectRequest["Body"]`*, see {@link PutObjectRequest.Body}.
13
15
  */
@@ -19,11 +21,14 @@ type PutObjectCommandInputType = Omit<PutObjectRequest, "Body"> & {
19
21
  export interface PutObjectCommandInput extends PutObjectCommandInputType {
20
22
  }
21
23
  /**
24
+ * @public
25
+ *
22
26
  * The output of {@link PutObjectCommand}.
23
27
  */
24
28
  export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBearer {
25
29
  }
26
30
  /**
31
+ * @public
27
32
  * <p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object
28
33
  * to it.</p>
29
34
  * <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the
@@ -133,6 +138,8 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
133
138
  * const response = await client.send(command);
134
139
  * ```
135
140
  *
141
+ * @param PutObjectCommandInput - {@link PutObjectCommandInput}
142
+ * @returns {@link PutObjectCommandOutput}
136
143
  * @see {@link PutObjectCommandInput} for command's `input` shape.
137
144
  * @see {@link PutObjectCommandOutput} for command's `response` shape.
138
145
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -287,12 +294,20 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
287
294
  export declare class PutObjectCommand extends $Command<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig> {
288
295
  readonly input: PutObjectCommandInput;
289
296
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
297
+ /**
298
+ * @public
299
+ */
290
300
  constructor(input: PutObjectCommandInput);
291
301
  /**
292
302
  * @internal
293
303
  */
294
304
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutObjectCommandInput, PutObjectCommandOutput>;
305
+ /**
306
+ * @internal
307
+ */
295
308
  private serialize;
309
+ /**
310
+ * @internal
311
+ */
296
312
  private deserialize;
297
313
  }
298
- export {};