@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 { GetBucketPolicyOutput, GetBucketPolicyRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketPolicyCommand}.
8
10
  */
9
11
  export interface GetBucketPolicyCommandInput extends GetBucketPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketPolicyCommand}.
13
17
  */
14
18
  export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the policy of a specified bucket. If you are using an identity other than the
18
23
  * root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
19
24
  * <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the
@@ -47,6 +52,8 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param GetBucketPolicyCommandInput - {@link GetBucketPolicyCommandInput}
56
+ * @returns {@link GetBucketPolicyCommandOutput}
50
57
  * @see {@link GetBucketPolicyCommandInput} for command's `input` shape.
51
58
  * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape.
52
59
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -72,11 +79,20 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
72
79
  export declare class GetBucketPolicyCommand extends $Command<GetBucketPolicyCommandInput, GetBucketPolicyCommandOutput, S3ClientResolvedConfig> {
73
80
  readonly input: GetBucketPolicyCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: GetBucketPolicyCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketPolicyCommandInput, GetBucketPolicyCommandOutput>;
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 { GetBucketPolicyStatusOutput, GetBucketPolicyStatusRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketPolicyStatusCommand}.
8
10
  */
9
11
  export interface GetBucketPolicyStatusCommandInput extends GetBucketPolicyStatusRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketPolicyStatusCommand}.
13
17
  */
14
18
  export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatusOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
18
23
  * In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</code>
19
24
  * permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
@@ -53,6 +58,8 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
53
58
  * const response = await client.send(command);
54
59
  * ```
55
60
  *
61
+ * @param GetBucketPolicyStatusCommandInput - {@link GetBucketPolicyStatusCommandInput}
62
+ * @returns {@link GetBucketPolicyStatusCommandOutput}
56
63
  * @see {@link GetBucketPolicyStatusCommandInput} for command's `input` shape.
57
64
  * @see {@link GetBucketPolicyStatusCommandOutput} for command's `response` shape.
58
65
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -62,11 +69,20 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
62
69
  export declare class GetBucketPolicyStatusCommand extends $Command<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput, S3ClientResolvedConfig> {
63
70
  readonly input: GetBucketPolicyStatusCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: GetBucketPolicyStatusCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetBucketReplicationOutput, GetBucketReplicationRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketReplicationCommand}.
8
10
  */
9
11
  export interface GetBucketReplicationCommandInput extends GetBucketReplicationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketReplicationCommand}.
13
17
  */
14
18
  export interface GetBucketReplicationCommandOutput extends GetBucketReplicationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the replication configuration of a bucket.</p>
18
23
  * <note>
19
24
  * <p> It can take a while to propagate the put or delete a replication configuration to
@@ -54,6 +59,8 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
54
59
  * const response = await client.send(command);
55
60
  * ```
56
61
  *
62
+ * @param GetBucketReplicationCommandInput - {@link GetBucketReplicationCommandInput}
63
+ * @returns {@link GetBucketReplicationCommandOutput}
57
64
  * @see {@link GetBucketReplicationCommandInput} for command's `input` shape.
58
65
  * @see {@link GetBucketReplicationCommandOutput} for command's `response` shape.
59
66
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -91,11 +98,20 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
91
98
  export declare class GetBucketReplicationCommand extends $Command<GetBucketReplicationCommandInput, GetBucketReplicationCommandOutput, S3ClientResolvedConfig> {
92
99
  readonly input: GetBucketReplicationCommandInput;
93
100
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
101
+ /**
102
+ * @public
103
+ */
94
104
  constructor(input: GetBucketReplicationCommandInput);
95
105
  /**
96
106
  * @internal
97
107
  */
98
108
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketReplicationCommandInput, GetBucketReplicationCommandOutput>;
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 { GetBucketRequestPaymentOutput, GetBucketRequestPaymentRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketRequestPaymentCommand}.
8
10
  */
9
11
  export interface GetBucketRequestPaymentCommandInput extends GetBucketRequestPaymentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketRequestPaymentCommand}.
13
17
  */
14
18
  export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPaymentOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the request payment configuration of a bucket. To use this version of the
18
23
  * operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p>
19
24
  * <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p>
@@ -34,6 +39,8 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param GetBucketRequestPaymentCommandInput - {@link GetBucketRequestPaymentCommandInput}
43
+ * @returns {@link GetBucketRequestPaymentCommandOutput}
37
44
  * @see {@link GetBucketRequestPaymentCommandInput} for command's `input` shape.
38
45
  * @see {@link GetBucketRequestPaymentCommandOutput} for command's `response` shape.
39
46
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -59,11 +66,20 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
59
66
  export declare class GetBucketRequestPaymentCommand extends $Command<GetBucketRequestPaymentCommandInput, GetBucketRequestPaymentCommandOutput, S3ClientResolvedConfig> {
60
67
  readonly input: GetBucketRequestPaymentCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: GetBucketRequestPaymentCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketRequestPaymentCommandInput, GetBucketRequestPaymentCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetBucketTaggingOutput, GetBucketTaggingRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketTaggingCommand}.
8
10
  */
9
11
  export interface GetBucketTaggingCommandInput extends GetBucketTaggingRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketTaggingCommand}.
13
17
  */
14
18
  export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the tag set associated with the bucket.</p>
18
23
  * <p>To use this operation, you must have permission to perform the
19
24
  * <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this
@@ -54,6 +59,8 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
54
59
  * const response = await client.send(command);
55
60
  * ```
56
61
  *
62
+ * @param GetBucketTaggingCommandInput - {@link GetBucketTaggingCommandInput}
63
+ * @returns {@link GetBucketTaggingCommandOutput}
57
64
  * @see {@link GetBucketTaggingCommandInput} for command's `input` shape.
58
65
  * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape.
59
66
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -88,11 +95,20 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
88
95
  export declare class GetBucketTaggingCommand extends $Command<GetBucketTaggingCommandInput, GetBucketTaggingCommandOutput, S3ClientResolvedConfig> {
89
96
  readonly input: GetBucketTaggingCommandInput;
90
97
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
98
+ /**
99
+ * @public
100
+ */
91
101
  constructor(input: GetBucketTaggingCommandInput);
92
102
  /**
93
103
  * @internal
94
104
  */
95
105
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketTaggingCommandInput, GetBucketTaggingCommandOutput>;
106
+ /**
107
+ * @internal
108
+ */
96
109
  private serialize;
110
+ /**
111
+ * @internal
112
+ */
97
113
  private deserialize;
98
114
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetBucketVersioningOutput, GetBucketVersioningRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketVersioningCommand}.
8
10
  */
9
11
  export interface GetBucketVersioningCommandInput extends GetBucketVersioningRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketVersioningCommand}.
13
17
  */
14
18
  export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the versioning state of a bucket.</p>
18
23
  * <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p>
19
24
  * <p>This implementation also returns the MFA Delete status of the versioning state. If the
@@ -47,6 +52,8 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param GetBucketVersioningCommandInput - {@link GetBucketVersioningCommandInput}
56
+ * @returns {@link GetBucketVersioningCommandOutput}
50
57
  * @see {@link GetBucketVersioningCommandInput} for command's `input` shape.
51
58
  * @see {@link GetBucketVersioningCommandOutput} for command's `response` shape.
52
59
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -73,11 +80,20 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
73
80
  export declare class GetBucketVersioningCommand extends $Command<GetBucketVersioningCommandInput, GetBucketVersioningCommandOutput, S3ClientResolvedConfig> {
74
81
  readonly input: GetBucketVersioningCommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: GetBucketVersioningCommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketVersioningCommandInput, GetBucketVersioningCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetBucketWebsiteOutput, GetBucketWebsiteRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBucketWebsiteCommand}.
8
10
  */
9
11
  export interface GetBucketWebsiteCommandInput extends GetBucketWebsiteRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBucketWebsiteCommand}.
13
17
  */
14
18
  export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can
18
23
  * configure a bucket as website by adding a website configuration. For more information about
19
24
  * hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on
@@ -45,6 +50,8 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param GetBucketWebsiteCommandInput - {@link GetBucketWebsiteCommandInput}
54
+ * @returns {@link GetBucketWebsiteCommandOutput}
48
55
  * @see {@link GetBucketWebsiteCommandInput} for command's `input` shape.
49
56
  * @see {@link GetBucketWebsiteCommandOutput} for command's `response` shape.
50
57
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -75,11 +82,20 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
75
82
  export declare class GetBucketWebsiteCommand extends $Command<GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
76
83
  readonly input: GetBucketWebsiteCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: GetBucketWebsiteCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetObjectAclOutput, GetObjectAclRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetObjectAclCommand}.
8
10
  */
9
11
  export interface GetObjectAclCommandInput extends GetObjectAclRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetObjectAclCommand}.
13
17
  */
14
18
  export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the access control list (ACL) of an object. To use this operation, you must have
18
23
  * <code>s3:GetObjectAcl</code> permissions or <code>READ_ACP</code> access to the object.
19
24
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#acl-access-policy-permission-mapping">Mapping of ACL permissions and access policy permissions</a> in the <i>Amazon S3
@@ -65,6 +70,8 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
65
70
  * const response = await client.send(command);
66
71
  * ```
67
72
  *
73
+ * @param GetObjectAclCommandInput - {@link GetObjectAclCommandInput}
74
+ * @returns {@link GetObjectAclCommandOutput}
68
75
  * @see {@link GetObjectAclCommandInput} for command's `input` shape.
69
76
  * @see {@link GetObjectAclCommandOutput} for command's `response` shape.
70
77
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -131,11 +138,20 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
131
138
  export declare class GetObjectAclCommand extends $Command<GetObjectAclCommandInput, GetObjectAclCommandOutput, S3ClientResolvedConfig> {
132
139
  readonly input: GetObjectAclCommandInput;
133
140
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
141
+ /**
142
+ * @public
143
+ */
134
144
  constructor(input: GetObjectAclCommandInput);
135
145
  /**
136
146
  * @internal
137
147
  */
138
148
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectAclCommandInput, GetObjectAclCommandOutput>;
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 { GetObjectAttributesOutput, GetObjectAttributesRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetObjectAttributesCommand}.
8
10
  */
9
11
  export interface GetObjectAttributesCommandInput extends GetObjectAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetObjectAttributesCommand}.
13
17
  */
14
18
  export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves all the metadata from an object without returning the object itself. This
18
23
  * action is useful if you're interested only in an object's metadata. To use
19
24
  * <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
@@ -174,6 +179,8 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
174
179
  * const response = await client.send(command);
175
180
  * ```
176
181
  *
182
+ * @param GetObjectAttributesCommandInput - {@link GetObjectAttributesCommandInput}
183
+ * @returns {@link GetObjectAttributesCommandOutput}
177
184
  * @see {@link GetObjectAttributesCommandInput} for command's `input` shape.
178
185
  * @see {@link GetObjectAttributesCommandOutput} for command's `response` shape.
179
186
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -186,11 +193,20 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
186
193
  export declare class GetObjectAttributesCommand extends $Command<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig> {
187
194
  readonly input: GetObjectAttributesCommandInput;
188
195
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
196
+ /**
197
+ * @public
198
+ */
189
199
  constructor(input: GetObjectAttributesCommandInput);
190
200
  /**
191
201
  * @internal
192
202
  */
193
203
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput>;
204
+ /**
205
+ * @internal
206
+ */
194
207
  private serialize;
208
+ /**
209
+ * @internal
210
+ */
195
211
  private deserialize;
196
212
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetObjectOutput, GetObjectRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetObjectCommand}.
8
10
  */
9
11
  export interface GetObjectCommandInput extends GetObjectRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetObjectCommand}.
13
17
  */
14
18
  export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOutput, "Body">, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code>
18
23
  * access to the object. If you grant <code>READ</code> access to the anonymous user, you can
19
24
  * return the object without using an authorization header.</p>
@@ -186,6 +191,8 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
186
191
  * const response = await client.send(command);
187
192
  * ```
188
193
  *
194
+ * @param GetObjectCommandInput - {@link GetObjectCommandInput}
195
+ * @returns {@link GetObjectCommandOutput}
189
196
  * @see {@link GetObjectCommandInput} for command's `input` shape.
190
197
  * @see {@link GetObjectCommandOutput} for command's `response` shape.
191
198
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -250,11 +257,20 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
250
257
  export declare class GetObjectCommand extends $Command<GetObjectCommandInput, GetObjectCommandOutput, S3ClientResolvedConfig> {
251
258
  readonly input: GetObjectCommandInput;
252
259
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
260
+ /**
261
+ * @public
262
+ */
253
263
  constructor(input: GetObjectCommandInput);
254
264
  /**
255
265
  * @internal
256
266
  */
257
267
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectCommandInput, GetObjectCommandOutput>;
268
+ /**
269
+ * @internal
270
+ */
258
271
  private serialize;
272
+ /**
273
+ * @internal
274
+ */
259
275
  private deserialize;
260
276
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetObjectLegalHoldOutput, GetObjectLegalHoldRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetObjectLegalHoldCommand}.
8
10
  */
9
11
  export interface GetObjectLegalHoldCommandInput extends GetObjectLegalHoldRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetObjectLegalHoldCommand}.
13
17
  */
14
18
  export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
18
23
  * Objects</a>.</p>
19
24
  * <p>This action is not supported by Amazon S3 on Outposts.</p>
@@ -35,6 +40,8 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param GetObjectLegalHoldCommandInput - {@link GetObjectLegalHoldCommandInput}
44
+ * @returns {@link GetObjectLegalHoldCommandOutput}
38
45
  * @see {@link GetObjectLegalHoldCommandInput} for command's `input` shape.
39
46
  * @see {@link GetObjectLegalHoldCommandOutput} for command's `response` shape.
40
47
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -44,11 +51,20 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
44
51
  export declare class GetObjectLegalHoldCommand extends $Command<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput, S3ClientResolvedConfig> {
45
52
  readonly input: GetObjectLegalHoldCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: GetObjectLegalHoldCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetObjectLockConfigurationOutput, GetObjectLockConfigurationRequest } from "../models/models_0";
5
5
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetObjectLockConfigurationCommand}.
8
10
  */
9
11
  export interface GetObjectLockConfigurationCommandInput extends GetObjectLockConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetObjectLockConfigurationCommand}.
13
17
  */
14
18
  export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockConfigurationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock
18
23
  * configuration will be applied by default to every new object placed in the specified
19
24
  * bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
@@ -36,6 +41,8 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param GetObjectLockConfigurationCommandInput - {@link GetObjectLockConfigurationCommandInput}
45
+ * @returns {@link GetObjectLockConfigurationCommandOutput}
39
46
  * @see {@link GetObjectLockConfigurationCommandInput} for command's `input` shape.
40
47
  * @see {@link GetObjectLockConfigurationCommandOutput} for command's `response` shape.
41
48
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
@@ -45,11 +52,20 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
45
52
  export declare class GetObjectLockConfigurationCommand extends $Command<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput, S3ClientResolvedConfig> {
46
53
  readonly input: GetObjectLockConfigurationCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetObjectLockConfigurationCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }