@aws-sdk/client-s3-control 3.457.0 → 3.458.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 (168) hide show
  1. package/README.md +232 -72
  2. package/dist-cjs/S3Control.js +40 -0
  3. package/dist-cjs/commands/AssociateAccessGrantsIdentityCenterCommand.js +58 -0
  4. package/dist-cjs/commands/CreateAccessGrantCommand.js +58 -0
  5. package/dist-cjs/commands/CreateAccessGrantsInstanceCommand.js +58 -0
  6. package/dist-cjs/commands/CreateAccessGrantsLocationCommand.js +58 -0
  7. package/dist-cjs/commands/DeleteAccessGrantCommand.js +58 -0
  8. package/dist-cjs/commands/DeleteAccessGrantsInstanceCommand.js +58 -0
  9. package/dist-cjs/commands/DeleteAccessGrantsInstanceResourcePolicyCommand.js +58 -0
  10. package/dist-cjs/commands/DeleteAccessGrantsLocationCommand.js +58 -0
  11. package/dist-cjs/commands/DissociateAccessGrantsIdentityCenterCommand.js +58 -0
  12. package/dist-cjs/commands/GetAccessGrantCommand.js +58 -0
  13. package/dist-cjs/commands/GetAccessGrantsInstanceCommand.js +58 -0
  14. package/dist-cjs/commands/GetAccessGrantsInstanceForPrefixCommand.js +58 -0
  15. package/dist-cjs/commands/GetAccessGrantsInstanceResourcePolicyCommand.js +58 -0
  16. package/dist-cjs/commands/GetAccessGrantsLocationCommand.js +58 -0
  17. package/dist-cjs/commands/GetDataAccessCommand.js +59 -0
  18. package/dist-cjs/commands/ListAccessGrantsCommand.js +58 -0
  19. package/dist-cjs/commands/ListAccessGrantsInstancesCommand.js +58 -0
  20. package/dist-cjs/commands/ListAccessGrantsLocationsCommand.js +58 -0
  21. package/dist-cjs/commands/PutAccessGrantsInstanceResourcePolicyCommand.js +58 -0
  22. package/dist-cjs/commands/UpdateAccessGrantsLocationCommand.js +58 -0
  23. package/dist-cjs/commands/index.js +20 -0
  24. package/dist-cjs/models/index.js +1 -0
  25. package/dist-cjs/models/models_0.js +32 -38
  26. package/dist-cjs/models/models_1.js +40 -0
  27. package/dist-cjs/pagination/ListAccessGrantsInstancesPaginator.js +29 -0
  28. package/dist-cjs/pagination/ListAccessGrantsLocationsPaginator.js +29 -0
  29. package/dist-cjs/pagination/ListAccessGrantsPaginator.js +29 -0
  30. package/dist-cjs/pagination/index.js +3 -0
  31. package/dist-cjs/protocols/Aws_restXml.js +1697 -156
  32. package/dist-es/S3Control.js +40 -0
  33. package/dist-es/commands/AssociateAccessGrantsIdentityCenterCommand.js +54 -0
  34. package/dist-es/commands/CreateAccessGrantCommand.js +54 -0
  35. package/dist-es/commands/CreateAccessGrantsInstanceCommand.js +54 -0
  36. package/dist-es/commands/CreateAccessGrantsLocationCommand.js +54 -0
  37. package/dist-es/commands/DeleteAccessGrantCommand.js +54 -0
  38. package/dist-es/commands/DeleteAccessGrantsInstanceCommand.js +54 -0
  39. package/dist-es/commands/DeleteAccessGrantsInstanceResourcePolicyCommand.js +54 -0
  40. package/dist-es/commands/DeleteAccessGrantsLocationCommand.js +54 -0
  41. package/dist-es/commands/DissociateAccessGrantsIdentityCenterCommand.js +54 -0
  42. package/dist-es/commands/GetAccessGrantCommand.js +54 -0
  43. package/dist-es/commands/GetAccessGrantsInstanceCommand.js +54 -0
  44. package/dist-es/commands/GetAccessGrantsInstanceForPrefixCommand.js +54 -0
  45. package/dist-es/commands/GetAccessGrantsInstanceResourcePolicyCommand.js +54 -0
  46. package/dist-es/commands/GetAccessGrantsLocationCommand.js +54 -0
  47. package/dist-es/commands/GetDataAccessCommand.js +55 -0
  48. package/dist-es/commands/ListAccessGrantsCommand.js +54 -0
  49. package/dist-es/commands/ListAccessGrantsInstancesCommand.js +54 -0
  50. package/dist-es/commands/ListAccessGrantsLocationsCommand.js +54 -0
  51. package/dist-es/commands/PutAccessGrantsInstanceResourcePolicyCommand.js +54 -0
  52. package/dist-es/commands/UpdateAccessGrantsLocationCommand.js +54 -0
  53. package/dist-es/commands/index.js +20 -0
  54. package/dist-es/models/index.js +1 -0
  55. package/dist-es/models/models_0.js +28 -34
  56. package/dist-es/models/models_1.js +35 -0
  57. package/dist-es/pagination/ListAccessGrantsInstancesPaginator.js +25 -0
  58. package/dist-es/pagination/ListAccessGrantsLocationsPaginator.js +25 -0
  59. package/dist-es/pagination/ListAccessGrantsPaginator.js +25 -0
  60. package/dist-es/pagination/index.js +3 -0
  61. package/dist-es/protocols/Aws_restXml.js +1733 -233
  62. package/dist-types/S3Control.d.ts +140 -0
  63. package/dist-types/S3ControlClient.d.ts +22 -2
  64. package/dist-types/commands/AssociateAccessGrantsIdentityCenterCommand.d.ts +82 -0
  65. package/dist-types/commands/CreateAccessGrantCommand.d.ts +118 -0
  66. package/dist-types/commands/CreateAccessGrantsInstanceCommand.d.ts +93 -0
  67. package/dist-types/commands/CreateAccessGrantsLocationCommand.d.ts +111 -0
  68. package/dist-types/commands/DeleteAccessGrantCommand.d.ts +78 -0
  69. package/dist-types/commands/DeleteAccessGrantsInstanceCommand.d.ts +77 -0
  70. package/dist-types/commands/DeleteAccessGrantsInstanceResourcePolicyCommand.d.ts +77 -0
  71. package/dist-types/commands/DeleteAccessGrantsLocationCommand.d.ts +78 -0
  72. package/dist-types/commands/DeleteStorageLensGroupCommand.d.ts +5 -4
  73. package/dist-types/commands/DissociateAccessGrantsIdentityCenterCommand.d.ts +81 -0
  74. package/dist-types/commands/GetAccessGrantCommand.d.ts +93 -0
  75. package/dist-types/commands/GetAccessGrantsInstanceCommand.d.ts +82 -0
  76. package/dist-types/commands/GetAccessGrantsInstanceForPrefixCommand.d.ts +85 -0
  77. package/dist-types/commands/GetAccessGrantsInstanceResourcePolicyCommand.d.ts +81 -0
  78. package/dist-types/commands/GetAccessGrantsLocationCommand.d.ts +84 -0
  79. package/dist-types/commands/GetDataAccessCommand.d.ts +94 -0
  80. package/dist-types/commands/GetStorageLensGroupCommand.d.ts +5 -4
  81. package/dist-types/commands/ListAccessGrantsCommand.d.ts +104 -0
  82. package/dist-types/commands/ListAccessGrantsInstancesCommand.d.ts +89 -0
  83. package/dist-types/commands/ListAccessGrantsLocationsCommand.d.ts +91 -0
  84. package/dist-types/commands/ListStorageLensGroupsCommand.d.ts +8 -5
  85. package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -10
  86. package/dist-types/commands/PutAccessGrantsInstanceResourcePolicyCommand.d.ts +83 -0
  87. package/dist-types/commands/PutAccessPointConfigurationForObjectLambdaCommand.d.ts +1 -1
  88. package/dist-types/commands/PutAccessPointPolicyCommand.d.ts +1 -1
  89. package/dist-types/commands/PutAccessPointPolicyForObjectLambdaCommand.d.ts +1 -1
  90. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  91. package/dist-types/commands/PutBucketPolicyCommand.d.ts +1 -1
  92. package/dist-types/commands/PutBucketReplicationCommand.d.ts +1 -1
  93. package/dist-types/commands/PutBucketTaggingCommand.d.ts +1 -1
  94. package/dist-types/commands/PutBucketVersioningCommand.d.ts +1 -1
  95. package/dist-types/commands/PutJobTaggingCommand.d.ts +1 -1
  96. package/dist-types/commands/PutMultiRegionAccessPointPolicyCommand.d.ts +1 -1
  97. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  98. package/dist-types/commands/PutStorageLensConfigurationCommand.d.ts +1 -1
  99. package/dist-types/commands/PutStorageLensConfigurationTaggingCommand.d.ts +1 -1
  100. package/dist-types/commands/SubmitMultiRegionAccessPointRoutesCommand.d.ts +1 -1
  101. package/dist-types/commands/TagResourceCommand.d.ts +12 -10
  102. package/dist-types/commands/UntagResourceCommand.d.ts +12 -8
  103. package/dist-types/commands/UpdateAccessGrantsLocationCommand.d.ts +90 -0
  104. package/dist-types/commands/UpdateJobPriorityCommand.d.ts +1 -1
  105. package/dist-types/commands/UpdateJobStatusCommand.d.ts +1 -1
  106. package/dist-types/commands/UpdateStorageLensGroupCommand.d.ts +6 -5
  107. package/dist-types/commands/index.d.ts +20 -0
  108. package/dist-types/models/index.d.ts +1 -0
  109. package/dist-types/models/models_0.d.ts +1246 -854
  110. package/dist-types/models/models_1.d.ts +775 -0
  111. package/dist-types/pagination/ListAccessGrantsInstancesPaginator.d.ts +7 -0
  112. package/dist-types/pagination/ListAccessGrantsLocationsPaginator.d.ts +7 -0
  113. package/dist-types/pagination/ListAccessGrantsPaginator.d.ts +7 -0
  114. package/dist-types/pagination/index.d.ts +3 -0
  115. package/dist-types/protocols/Aws_restXml.d.ts +180 -0
  116. package/dist-types/ts3.4/S3Control.d.ts +370 -0
  117. package/dist-types/ts3.4/S3ControlClient.d.ts +120 -0
  118. package/dist-types/ts3.4/commands/AssociateAccessGrantsIdentityCenterCommand.d.ts +38 -0
  119. package/dist-types/ts3.4/commands/CreateAccessGrantCommand.d.ts +39 -0
  120. package/dist-types/ts3.4/commands/CreateAccessGrantsInstanceCommand.d.ts +42 -0
  121. package/dist-types/ts3.4/commands/CreateAccessGrantsLocationCommand.d.ts +42 -0
  122. package/dist-types/ts3.4/commands/DeleteAccessGrantCommand.d.ts +34 -0
  123. package/dist-types/ts3.4/commands/DeleteAccessGrantsInstanceCommand.d.ts +38 -0
  124. package/dist-types/ts3.4/commands/DeleteAccessGrantsInstanceResourcePolicyCommand.d.ts +38 -0
  125. package/dist-types/ts3.4/commands/DeleteAccessGrantsLocationCommand.d.ts +38 -0
  126. package/dist-types/ts3.4/commands/DissociateAccessGrantsIdentityCenterCommand.d.ts +38 -0
  127. package/dist-types/ts3.4/commands/GetAccessGrantCommand.d.ts +38 -0
  128. package/dist-types/ts3.4/commands/GetAccessGrantsInstanceCommand.d.ts +42 -0
  129. package/dist-types/ts3.4/commands/GetAccessGrantsInstanceForPrefixCommand.d.ts +42 -0
  130. package/dist-types/ts3.4/commands/GetAccessGrantsInstanceResourcePolicyCommand.d.ts +42 -0
  131. package/dist-types/ts3.4/commands/GetAccessGrantsLocationCommand.d.ts +42 -0
  132. package/dist-types/ts3.4/commands/GetDataAccessCommand.d.ts +35 -0
  133. package/dist-types/ts3.4/commands/ListAccessGrantsCommand.d.ts +38 -0
  134. package/dist-types/ts3.4/commands/ListAccessGrantsInstancesCommand.d.ts +42 -0
  135. package/dist-types/ts3.4/commands/ListAccessGrantsLocationsCommand.d.ts +42 -0
  136. package/dist-types/ts3.4/commands/ListStorageLensGroupsCommand.d.ts +2 -4
  137. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  138. package/dist-types/ts3.4/commands/PutAccessGrantsInstanceResourcePolicyCommand.d.ts +42 -0
  139. package/dist-types/ts3.4/commands/PutAccessPointConfigurationForObjectLambdaCommand.d.ts +1 -1
  140. package/dist-types/ts3.4/commands/PutAccessPointPolicyCommand.d.ts +1 -1
  141. package/dist-types/ts3.4/commands/PutAccessPointPolicyForObjectLambdaCommand.d.ts +1 -1
  142. package/dist-types/ts3.4/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  143. package/dist-types/ts3.4/commands/PutBucketPolicyCommand.d.ts +1 -1
  144. package/dist-types/ts3.4/commands/PutBucketReplicationCommand.d.ts +1 -1
  145. package/dist-types/ts3.4/commands/PutBucketTaggingCommand.d.ts +1 -1
  146. package/dist-types/ts3.4/commands/PutBucketVersioningCommand.d.ts +1 -1
  147. package/dist-types/ts3.4/commands/PutJobTaggingCommand.d.ts +1 -1
  148. package/dist-types/ts3.4/commands/PutMultiRegionAccessPointPolicyCommand.d.ts +1 -1
  149. package/dist-types/ts3.4/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  150. package/dist-types/ts3.4/commands/PutStorageLensConfigurationCommand.d.ts +1 -1
  151. package/dist-types/ts3.4/commands/PutStorageLensConfigurationTaggingCommand.d.ts +1 -1
  152. package/dist-types/ts3.4/commands/SubmitMultiRegionAccessPointRoutesCommand.d.ts +1 -1
  153. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  154. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  155. package/dist-types/ts3.4/commands/UpdateAccessGrantsLocationCommand.d.ts +42 -0
  156. package/dist-types/ts3.4/commands/UpdateJobPriorityCommand.d.ts +1 -1
  157. package/dist-types/ts3.4/commands/UpdateJobStatusCommand.d.ts +1 -1
  158. package/dist-types/ts3.4/commands/UpdateStorageLensGroupCommand.d.ts +1 -1
  159. package/dist-types/ts3.4/commands/index.d.ts +20 -0
  160. package/dist-types/ts3.4/models/index.d.ts +1 -0
  161. package/dist-types/ts3.4/models/models_0.d.ts +228 -170
  162. package/dist-types/ts3.4/models/models_1.d.ts +205 -0
  163. package/dist-types/ts3.4/pagination/ListAccessGrantsInstancesPaginator.d.ts +11 -0
  164. package/dist-types/ts3.4/pagination/ListAccessGrantsLocationsPaginator.d.ts +11 -0
  165. package/dist-types/ts3.4/pagination/ListAccessGrantsPaginator.d.ts +11 -0
  166. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  167. package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +240 -0
  168. package/package.json +3 -3
@@ -0,0 +1,775 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { BucketVersioningStatus, JobStatus, LifecycleRule, MultiRegionAccessPointRoute, ObjectLambdaConfiguration, PublicAccessBlockConfiguration, PutMultiRegionAccessPointPolicyInput, ReplicationConfiguration, S3Tag, StorageLensConfiguration, StorageLensGroup, StorageLensTag, Tag } from "./models_0";
3
+ import { S3ControlServiceException as __BaseException } from "./S3ControlServiceException";
4
+ /**
5
+ * @public
6
+ * <p>
7
+ * Each entry contains a Storage Lens group that exists in the specified home Region.
8
+ * </p>
9
+ */
10
+ export interface ListStorageLensGroupEntry {
11
+ /**
12
+ * @public
13
+ * <p>
14
+ * Contains the name of the Storage Lens group that exists in the specified home Region.
15
+ * </p>
16
+ */
17
+ Name: string | undefined;
18
+ /**
19
+ * @public
20
+ * <p>
21
+ * Contains the Amazon Resource Name (ARN) of the Storage Lens group. This property is read-only.
22
+ * </p>
23
+ */
24
+ StorageLensGroupArn: string | undefined;
25
+ /**
26
+ * @public
27
+ * <p>
28
+ * Contains the Amazon Web Services Region where the Storage Lens group was created.
29
+ * </p>
30
+ */
31
+ HomeRegion: string | undefined;
32
+ }
33
+ /**
34
+ * @public
35
+ */
36
+ export interface ListStorageLensGroupsResult {
37
+ /**
38
+ * @public
39
+ * <p>
40
+ * If <code>NextToken</code> is returned, there are more Storage Lens groups results available. The value of <code>NextToken</code> is a
41
+ * unique pagination token for each page. Make the call again using the returned token to
42
+ * retrieve the next page. Keep all other arguments unchanged. Each pagination token expires
43
+ * after 24 hours.
44
+ * </p>
45
+ */
46
+ NextToken?: string;
47
+ /**
48
+ * @public
49
+ * <p>
50
+ * The list of Storage Lens groups that exist in the specified home Region.
51
+ * </p>
52
+ */
53
+ StorageLensGroupList?: ListStorageLensGroupEntry[];
54
+ }
55
+ /**
56
+ * @public
57
+ */
58
+ export interface ListTagsForResourceRequest {
59
+ /**
60
+ * @public
61
+ * <p>
62
+ * The Amazon Web Services account ID of the resource owner.
63
+ * </p>
64
+ */
65
+ AccountId?: string;
66
+ /**
67
+ * @public
68
+ * <p>
69
+ * The Amazon Resource Name (ARN) of the S3 resource that you want to list the tags for. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
70
+ * </p>
71
+ */
72
+ ResourceArn: string | undefined;
73
+ }
74
+ /**
75
+ * @public
76
+ */
77
+ export interface ListTagsForResourceResult {
78
+ /**
79
+ * @public
80
+ * <p>
81
+ * The Amazon Web Services resource tags that are associated with the resource.
82
+ * </p>
83
+ */
84
+ Tags?: Tag[];
85
+ }
86
+ /**
87
+ * @public
88
+ */
89
+ export interface PutAccessGrantsInstanceResourcePolicyRequest {
90
+ /**
91
+ * @public
92
+ * <p>The ID of the Amazon Web Services account that is making this request.</p>
93
+ */
94
+ AccountId?: string;
95
+ /**
96
+ * @public
97
+ * <p>The resource policy of the S3 Access Grants instance that you are updating.</p>
98
+ */
99
+ Policy: string | undefined;
100
+ /**
101
+ * @public
102
+ * <p>The Organization of the resource policy of the S3 Access Grants instance.</p>
103
+ */
104
+ Organization?: string;
105
+ }
106
+ /**
107
+ * @public
108
+ */
109
+ export interface PutAccessGrantsInstanceResourcePolicyResult {
110
+ /**
111
+ * @public
112
+ * <p>The updated resource policy of the S3 Access Grants instance.</p>
113
+ */
114
+ Policy?: string;
115
+ /**
116
+ * @public
117
+ * <p>The Organization of the resource policy of the S3 Access Grants instance.</p>
118
+ */
119
+ Organization?: string;
120
+ /**
121
+ * @public
122
+ * <p>The date and time when you created the S3 Access Grants instance resource policy. </p>
123
+ */
124
+ CreatedAt?: Date;
125
+ }
126
+ /**
127
+ * @public
128
+ */
129
+ export interface PutAccessPointConfigurationForObjectLambdaRequest {
130
+ /**
131
+ * @public
132
+ * <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
133
+ */
134
+ AccountId?: string;
135
+ /**
136
+ * @public
137
+ * <p>The name of the Object Lambda Access Point.</p>
138
+ */
139
+ Name: string | undefined;
140
+ /**
141
+ * @public
142
+ * <p>Object Lambda Access Point configuration document.</p>
143
+ */
144
+ Configuration: ObjectLambdaConfiguration | undefined;
145
+ }
146
+ /**
147
+ * @public
148
+ */
149
+ export interface PutAccessPointPolicyRequest {
150
+ /**
151
+ * @public
152
+ * <p>The Amazon Web Services account ID for owner of the bucket associated with the specified access point.</p>
153
+ */
154
+ AccountId?: string;
155
+ /**
156
+ * @public
157
+ * <p>The name of the access point that you want to associate with the specified policy.</p>
158
+ * <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
159
+ * <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded. </p>
160
+ */
161
+ Name: string | undefined;
162
+ /**
163
+ * @public
164
+ * <p>The policy that you want to apply to the specified access point. For more information about access point
165
+ * policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">Managing data access with Amazon S3
166
+ * access points</a> in the <i>Amazon S3 User Guide</i>.</p>
167
+ */
168
+ Policy: string | undefined;
169
+ }
170
+ /**
171
+ * @public
172
+ */
173
+ export interface PutAccessPointPolicyForObjectLambdaRequest {
174
+ /**
175
+ * @public
176
+ * <p>The account ID for the account that owns the specified Object Lambda Access Point.</p>
177
+ */
178
+ AccountId?: string;
179
+ /**
180
+ * @public
181
+ * <p>The name of the Object Lambda Access Point.</p>
182
+ */
183
+ Name: string | undefined;
184
+ /**
185
+ * @public
186
+ * <p>Object Lambda Access Point resource policy document.</p>
187
+ */
188
+ Policy: string | undefined;
189
+ }
190
+ /**
191
+ * @public
192
+ * <p>The container for the Outposts bucket lifecycle configuration.</p>
193
+ */
194
+ export interface LifecycleConfiguration {
195
+ /**
196
+ * @public
197
+ * <p>A lifecycle rule for individual objects in an Outposts bucket. </p>
198
+ */
199
+ Rules?: LifecycleRule[];
200
+ }
201
+ /**
202
+ * @public
203
+ */
204
+ export interface PutBucketLifecycleConfigurationRequest {
205
+ /**
206
+ * @public
207
+ * <p>The Amazon Web Services account ID of the Outposts bucket.</p>
208
+ */
209
+ AccountId?: string;
210
+ /**
211
+ * @public
212
+ * <p>The name of the bucket for which to set the configuration.</p>
213
+ */
214
+ Bucket: string | undefined;
215
+ /**
216
+ * @public
217
+ * <p>Container for lifecycle rules. You can add as many as 1,000 rules.</p>
218
+ */
219
+ LifecycleConfiguration?: LifecycleConfiguration;
220
+ }
221
+ /**
222
+ * @public
223
+ */
224
+ export interface PutBucketPolicyRequest {
225
+ /**
226
+ * @public
227
+ * <p>The Amazon Web Services account ID of the Outposts bucket.</p>
228
+ */
229
+ AccountId?: string;
230
+ /**
231
+ * @public
232
+ * <p>Specifies the bucket.</p>
233
+ * <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
234
+ * <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
235
+ */
236
+ Bucket: string | undefined;
237
+ /**
238
+ * @public
239
+ * <p>Set this parameter to true to confirm that you want to remove your permissions to change
240
+ * this bucket policy in the future.</p>
241
+ * <note>
242
+ * <p>This is not supported by Amazon S3 on Outposts buckets.</p>
243
+ * </note>
244
+ */
245
+ ConfirmRemoveSelfBucketAccess?: boolean;
246
+ /**
247
+ * @public
248
+ * <p>The bucket policy as a JSON document.</p>
249
+ */
250
+ Policy: string | undefined;
251
+ }
252
+ /**
253
+ * @public
254
+ */
255
+ export interface PutBucketReplicationRequest {
256
+ /**
257
+ * @public
258
+ * <p>The Amazon Web Services account ID of the Outposts bucket.</p>
259
+ */
260
+ AccountId?: string;
261
+ /**
262
+ * @public
263
+ * <p>Specifies the S3 on Outposts bucket to set the configuration for.</p>
264
+ * <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
265
+ * <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
266
+ */
267
+ Bucket: string | undefined;
268
+ /**
269
+ * @public
270
+ * <p></p>
271
+ */
272
+ ReplicationConfiguration: ReplicationConfiguration | undefined;
273
+ }
274
+ /**
275
+ * @public
276
+ * <p></p>
277
+ */
278
+ export interface Tagging {
279
+ /**
280
+ * @public
281
+ * <p>A collection for a set of tags.</p>
282
+ */
283
+ TagSet: S3Tag[] | undefined;
284
+ }
285
+ /**
286
+ * @public
287
+ */
288
+ export interface PutBucketTaggingRequest {
289
+ /**
290
+ * @public
291
+ * <p>The Amazon Web Services account ID of the Outposts bucket.</p>
292
+ */
293
+ AccountId?: string;
294
+ /**
295
+ * @public
296
+ * <p>The Amazon Resource Name (ARN) of the bucket.</p>
297
+ * <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
298
+ * <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name></code>. For example, to access the bucket <code>reports</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports</code>. The value must be URL encoded. </p>
299
+ */
300
+ Bucket: string | undefined;
301
+ /**
302
+ * @public
303
+ * <p></p>
304
+ */
305
+ Tagging: Tagging | undefined;
306
+ }
307
+ /**
308
+ * @public
309
+ * @enum
310
+ */
311
+ export declare const MFADelete: {
312
+ readonly Disabled: "Disabled";
313
+ readonly Enabled: "Enabled";
314
+ };
315
+ /**
316
+ * @public
317
+ */
318
+ export type MFADelete = (typeof MFADelete)[keyof typeof MFADelete];
319
+ /**
320
+ * @public
321
+ * <p>Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see
322
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketVersioning.html">PutBucketVersioning</a>.</p>
323
+ */
324
+ export interface VersioningConfiguration {
325
+ /**
326
+ * @public
327
+ * <p>Specifies whether MFA delete is enabled or disabled in the bucket versioning
328
+ * configuration for the S3 on Outposts bucket.</p>
329
+ */
330
+ MFADelete?: MFADelete;
331
+ /**
332
+ * @public
333
+ * <p>Sets the versioning state of the S3 on Outposts bucket.</p>
334
+ */
335
+ Status?: BucketVersioningStatus;
336
+ }
337
+ /**
338
+ * @public
339
+ */
340
+ export interface PutBucketVersioningRequest {
341
+ /**
342
+ * @public
343
+ * <p>The Amazon Web Services account ID of the S3 on Outposts bucket.</p>
344
+ */
345
+ AccountId?: string;
346
+ /**
347
+ * @public
348
+ * <p>The S3 on Outposts bucket to set the versioning state for.</p>
349
+ */
350
+ Bucket: string | undefined;
351
+ /**
352
+ * @public
353
+ * <p>The concatenation of the authentication device's serial number, a space, and the value
354
+ * that is displayed on your authentication device.</p>
355
+ */
356
+ MFA?: string;
357
+ /**
358
+ * @public
359
+ * <p>The root-level tag for the <code>VersioningConfiguration</code> parameters.</p>
360
+ */
361
+ VersioningConfiguration: VersioningConfiguration | undefined;
362
+ }
363
+ /**
364
+ * @public
365
+ */
366
+ export interface PutJobTaggingRequest {
367
+ /**
368
+ * @public
369
+ * <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
370
+ */
371
+ AccountId?: string;
372
+ /**
373
+ * @public
374
+ * <p>The ID for the S3 Batch Operations job whose tags you want to replace.</p>
375
+ */
376
+ JobId: string | undefined;
377
+ /**
378
+ * @public
379
+ * <p>The set of tags to associate with the S3 Batch Operations job.</p>
380
+ */
381
+ Tags: S3Tag[] | undefined;
382
+ }
383
+ /**
384
+ * @public
385
+ */
386
+ export interface PutJobTaggingResult {
387
+ }
388
+ /**
389
+ * @public
390
+ * <p>Amazon S3 throws this exception if you have too many tags in your tag set.</p>
391
+ */
392
+ export declare class TooManyTagsException extends __BaseException {
393
+ readonly name: "TooManyTagsException";
394
+ readonly $fault: "client";
395
+ Message?: string;
396
+ /**
397
+ * @internal
398
+ */
399
+ constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
400
+ }
401
+ /**
402
+ * @public
403
+ */
404
+ export interface PutMultiRegionAccessPointPolicyRequest {
405
+ /**
406
+ * @public
407
+ * <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
408
+ */
409
+ AccountId?: string;
410
+ /**
411
+ * @public
412
+ * <p>An idempotency token used to identify the request and guarantee that requests are
413
+ * unique.</p>
414
+ */
415
+ ClientToken?: string;
416
+ /**
417
+ * @public
418
+ * <p>A container element containing the details of the policy for the Multi-Region Access Point.</p>
419
+ */
420
+ Details: PutMultiRegionAccessPointPolicyInput | undefined;
421
+ }
422
+ /**
423
+ * @public
424
+ */
425
+ export interface PutMultiRegionAccessPointPolicyResult {
426
+ /**
427
+ * @public
428
+ * <p>The request token associated with the request. You can use this token with <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a> to determine the status of asynchronous
429
+ * requests.</p>
430
+ */
431
+ RequestTokenARN?: string;
432
+ }
433
+ /**
434
+ * @public
435
+ */
436
+ export interface PutPublicAccessBlockRequest {
437
+ /**
438
+ * @public
439
+ * <p>The <code>PublicAccessBlock</code> configuration that you want to apply to the specified
440
+ * Amazon Web Services account.</p>
441
+ */
442
+ PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
443
+ /**
444
+ * @public
445
+ * <p>The account ID for the Amazon Web Services account whose <code>PublicAccessBlock</code> configuration
446
+ * you want to set.</p>
447
+ */
448
+ AccountId?: string;
449
+ }
450
+ /**
451
+ * @public
452
+ */
453
+ export interface PutStorageLensConfigurationRequest {
454
+ /**
455
+ * @public
456
+ * <p>The ID of the S3 Storage Lens configuration.</p>
457
+ */
458
+ ConfigId: string | undefined;
459
+ /**
460
+ * @public
461
+ * <p>The account ID of the requester.</p>
462
+ */
463
+ AccountId?: string;
464
+ /**
465
+ * @public
466
+ * <p>The S3 Storage Lens configuration.</p>
467
+ */
468
+ StorageLensConfiguration: StorageLensConfiguration | undefined;
469
+ /**
470
+ * @public
471
+ * <p>The tag set of the S3 Storage Lens configuration.</p>
472
+ * <note>
473
+ * <p>You can set up to a maximum of 50 tags.</p>
474
+ * </note>
475
+ */
476
+ Tags?: StorageLensTag[];
477
+ }
478
+ /**
479
+ * @public
480
+ */
481
+ export interface PutStorageLensConfigurationTaggingRequest {
482
+ /**
483
+ * @public
484
+ * <p>The ID of the S3 Storage Lens configuration.</p>
485
+ */
486
+ ConfigId: string | undefined;
487
+ /**
488
+ * @public
489
+ * <p>The account ID of the requester.</p>
490
+ */
491
+ AccountId?: string;
492
+ /**
493
+ * @public
494
+ * <p>The tag set of the S3 Storage Lens configuration.</p>
495
+ * <note>
496
+ * <p>You can set up to a maximum of 50 tags.</p>
497
+ * </note>
498
+ */
499
+ Tags: StorageLensTag[] | undefined;
500
+ }
501
+ /**
502
+ * @public
503
+ */
504
+ export interface PutStorageLensConfigurationTaggingResult {
505
+ }
506
+ /**
507
+ * @public
508
+ */
509
+ export interface SubmitMultiRegionAccessPointRoutesRequest {
510
+ /**
511
+ * @public
512
+ * <p>The Amazon Web Services account ID for the owner of the Multi-Region Access Point.</p>
513
+ */
514
+ AccountId?: string;
515
+ /**
516
+ * @public
517
+ * <p>The Multi-Region Access Point ARN.</p>
518
+ */
519
+ Mrap: string | undefined;
520
+ /**
521
+ * @public
522
+ * <p>The different routes that make up the new route configuration. Active routes return a
523
+ * value of <code>100</code>, and passive routes return a value of <code>0</code>.</p>
524
+ */
525
+ RouteUpdates: MultiRegionAccessPointRoute[] | undefined;
526
+ }
527
+ /**
528
+ * @public
529
+ */
530
+ export interface SubmitMultiRegionAccessPointRoutesResult {
531
+ }
532
+ /**
533
+ * @public
534
+ */
535
+ export interface TagResourceRequest {
536
+ /**
537
+ * @public
538
+ * <p>
539
+ * The Amazon Web Services account ID that created the S3 resource that you're trying to add tags to or the requester's account ID.
540
+ * </p>
541
+ */
542
+ AccountId?: string;
543
+ /**
544
+ * @public
545
+ * <p>The Amazon Resource Name (ARN) of the S3 resource that you're trying to add tags to. The tagged resource can be an S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.</p>
546
+ */
547
+ ResourceArn: string | undefined;
548
+ /**
549
+ * @public
550
+ * <p>
551
+ * The Amazon Web Services resource tags that you want to add to the specified S3 resource.
552
+ * </p>
553
+ */
554
+ Tags: Tag[] | undefined;
555
+ }
556
+ /**
557
+ * @public
558
+ */
559
+ export interface TagResourceResult {
560
+ }
561
+ /**
562
+ * @public
563
+ */
564
+ export interface UntagResourceRequest {
565
+ /**
566
+ * @public
567
+ * <p>
568
+ * The Amazon Web Services account ID that owns the resource that you're trying to remove the tags from.
569
+ * </p>
570
+ */
571
+ AccountId?: string;
572
+ /**
573
+ * @public
574
+ * <p>
575
+ * The Amazon Resource Name (ARN) of the S3 resource that you're trying to remove the tags from.
576
+ * </p>
577
+ */
578
+ ResourceArn: string | undefined;
579
+ /**
580
+ * @public
581
+ * <p>
582
+ * The array of tag key-value pairs that you're trying to remove from of the S3 resource.
583
+ * </p>
584
+ */
585
+ TagKeys: string[] | undefined;
586
+ }
587
+ /**
588
+ * @public
589
+ */
590
+ export interface UntagResourceResult {
591
+ }
592
+ /**
593
+ * @public
594
+ */
595
+ export interface UpdateAccessGrantsLocationRequest {
596
+ /**
597
+ * @public
598
+ * <p>The ID of the Amazon Web Services account that is making this request.</p>
599
+ */
600
+ AccountId?: string;
601
+ /**
602
+ * @public
603
+ * <p>The ID of the registered location that you are updating. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register. </p>
604
+ * <p>The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register. </p>
605
+ * <p>If you are passing the <code>default</code> location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the <code>Subprefix</code> field. </p>
606
+ */
607
+ AccessGrantsLocationId: string | undefined;
608
+ /**
609
+ * @public
610
+ * <p>The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location. </p>
611
+ */
612
+ IAMRoleArn: string | undefined;
613
+ }
614
+ /**
615
+ * @public
616
+ */
617
+ export interface UpdateAccessGrantsLocationResult {
618
+ /**
619
+ * @public
620
+ * <p>The date and time when you registered the location. </p>
621
+ */
622
+ CreatedAt?: Date;
623
+ /**
624
+ * @public
625
+ * <p>The ID of the registered location to which you are granting access. S3 Access Grants assigned this ID when you registered the location. S3 Access Grants assigns the ID <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register. </p>
626
+ */
627
+ AccessGrantsLocationId?: string;
628
+ /**
629
+ * @public
630
+ * <p>The Amazon Resource Name (ARN) of the registered location that you are updating. </p>
631
+ */
632
+ AccessGrantsLocationArn?: string;
633
+ /**
634
+ * @public
635
+ * <p>The S3 URI path of the location that you are updating. You cannot update the scope of the registered location. The location scope can be the default S3 location <code>s3://</code>, the S3 path to a bucket <code>s3://<bucket></code>, or the S3 path to a bucket and prefix <code>s3://<bucket>/<prefix></code>. </p>
636
+ */
637
+ LocationScope?: string;
638
+ /**
639
+ * @public
640
+ * <p>The Amazon Resource Name (ARN) of the IAM role of the registered location. S3 Access Grants assumes this role to manage access to the registered location. </p>
641
+ */
642
+ IAMRoleArn?: string;
643
+ }
644
+ /**
645
+ * @public
646
+ */
647
+ export interface UpdateJobPriorityRequest {
648
+ /**
649
+ * @public
650
+ * <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
651
+ */
652
+ AccountId?: string;
653
+ /**
654
+ * @public
655
+ * <p>The ID for the job whose priority you want to update.</p>
656
+ */
657
+ JobId: string | undefined;
658
+ /**
659
+ * @public
660
+ * <p>The priority you want to assign to this job.</p>
661
+ */
662
+ Priority: number | undefined;
663
+ }
664
+ /**
665
+ * @public
666
+ */
667
+ export interface UpdateJobPriorityResult {
668
+ /**
669
+ * @public
670
+ * <p>The ID for the job whose priority Amazon S3 updated.</p>
671
+ */
672
+ JobId: string | undefined;
673
+ /**
674
+ * @public
675
+ * <p>The new priority assigned to the specified job.</p>
676
+ */
677
+ Priority: number | undefined;
678
+ }
679
+ /**
680
+ * @public
681
+ * <p></p>
682
+ */
683
+ export declare class JobStatusException extends __BaseException {
684
+ readonly name: "JobStatusException";
685
+ readonly $fault: "client";
686
+ Message?: string;
687
+ /**
688
+ * @internal
689
+ */
690
+ constructor(opts: __ExceptionOptionType<JobStatusException, __BaseException>);
691
+ }
692
+ /**
693
+ * @public
694
+ * @enum
695
+ */
696
+ export declare const RequestedJobStatus: {
697
+ readonly Cancelled: "Cancelled";
698
+ readonly Ready: "Ready";
699
+ };
700
+ /**
701
+ * @public
702
+ */
703
+ export type RequestedJobStatus = (typeof RequestedJobStatus)[keyof typeof RequestedJobStatus];
704
+ /**
705
+ * @public
706
+ */
707
+ export interface UpdateJobStatusRequest {
708
+ /**
709
+ * @public
710
+ * <p>The Amazon Web Services account ID associated with the S3 Batch Operations job.</p>
711
+ */
712
+ AccountId?: string;
713
+ /**
714
+ * @public
715
+ * <p>The ID of the job whose status you want to update.</p>
716
+ */
717
+ JobId: string | undefined;
718
+ /**
719
+ * @public
720
+ * <p>The status that you want to move the specified job to.</p>
721
+ */
722
+ RequestedJobStatus: RequestedJobStatus | undefined;
723
+ /**
724
+ * @public
725
+ * <p>A description of the reason why you want to change the specified job's status. This
726
+ * field can be any string up to the maximum length.</p>
727
+ */
728
+ StatusUpdateReason?: string;
729
+ }
730
+ /**
731
+ * @public
732
+ */
733
+ export interface UpdateJobStatusResult {
734
+ /**
735
+ * @public
736
+ * <p>The ID for the job whose status was updated.</p>
737
+ */
738
+ JobId?: string;
739
+ /**
740
+ * @public
741
+ * <p>The current status for the specified job.</p>
742
+ */
743
+ Status?: JobStatus;
744
+ /**
745
+ * @public
746
+ * <p>The reason that the specified job's status was updated.</p>
747
+ */
748
+ StatusUpdateReason?: string;
749
+ }
750
+ /**
751
+ * @public
752
+ */
753
+ export interface UpdateStorageLensGroupRequest {
754
+ /**
755
+ * @public
756
+ * <p>
757
+ * The name of the Storage Lens group that you want to update.
758
+ * </p>
759
+ */
760
+ Name: string | undefined;
761
+ /**
762
+ * @public
763
+ * <p>
764
+ * The Amazon Web Services account ID of the Storage Lens group owner.
765
+ * </p>
766
+ */
767
+ AccountId?: string;
768
+ /**
769
+ * @public
770
+ * <p>
771
+ * The JSON file that contains the Storage Lens group configuration.
772
+ * </p>
773
+ */
774
+ StorageLensGroup: StorageLensGroup | undefined;
775
+ }