s3control.d.ts
38.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
import {UseDualstackConfigOptions} from '../lib/config_use_dualstack';
interface Blob {}
declare class S3Control extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: S3Control.Types.ClientConfiguration)
config: Config & S3Control.Types.ClientConfiguration;
/**
* Creates an access point and associates it with the specified bucket.
*/
createAccessPoint(params: S3Control.Types.CreateAccessPointRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an access point and associates it with the specified bucket.
*/
createAccessPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an Amazon S3 batch operations job.
*/
createJob(params: S3Control.Types.CreateJobRequest, callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request<S3Control.Types.CreateJobResult, AWSError>;
/**
* Creates an Amazon S3 batch operations job.
*/
createJob(callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request<S3Control.Types.CreateJobResult, AWSError>;
/**
* Deletes the specified access point.
*/
deleteAccessPoint(params: S3Control.Types.DeleteAccessPointRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified access point.
*/
deleteAccessPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the access point policy for the specified access point.
*/
deleteAccessPointPolicy(params: S3Control.Types.DeleteAccessPointPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the access point policy for the specified access point.
*/
deleteAccessPointPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the PublicAccessBlock configuration for an Amazon Web Services account.
*/
deletePublicAccessBlock(params: S3Control.Types.DeletePublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the PublicAccessBlock configuration for an Amazon Web Services account.
*/
deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves the configuration parameters and status for a batch operations job.
*/
describeJob(params: S3Control.Types.DescribeJobRequest, callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request<S3Control.Types.DescribeJobResult, AWSError>;
/**
* Retrieves the configuration parameters and status for a batch operations job.
*/
describeJob(callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request<S3Control.Types.DescribeJobResult, AWSError>;
/**
* Returns configuration information about the specified access point.
*/
getAccessPoint(params: S3Control.Types.GetAccessPointRequest, callback?: (err: AWSError, data: S3Control.Types.GetAccessPointResult) => void): Request<S3Control.Types.GetAccessPointResult, AWSError>;
/**
* Returns configuration information about the specified access point.
*/
getAccessPoint(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointResult) => void): Request<S3Control.Types.GetAccessPointResult, AWSError>;
/**
* Returns the access point policy associated with the specified access point.
*/
getAccessPointPolicy(params: S3Control.Types.GetAccessPointPolicyRequest, callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyResult) => void): Request<S3Control.Types.GetAccessPointPolicyResult, AWSError>;
/**
* Returns the access point policy associated with the specified access point.
*/
getAccessPointPolicy(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyResult) => void): Request<S3Control.Types.GetAccessPointPolicyResult, AWSError>;
/**
* Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
*/
getAccessPointPolicyStatus(params: S3Control.Types.GetAccessPointPolicyStatusRequest, callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyStatusResult) => void): Request<S3Control.Types.GetAccessPointPolicyStatusResult, AWSError>;
/**
* Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
*/
getAccessPointPolicyStatus(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyStatusResult) => void): Request<S3Control.Types.GetAccessPointPolicyStatusResult, AWSError>;
/**
* Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
*/
getPublicAccessBlock(params: S3Control.Types.GetPublicAccessBlockRequest, callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request<S3Control.Types.GetPublicAccessBlockOutput, AWSError>;
/**
* Retrieves the PublicAccessBlock configuration for an Amazon Web Services account.
*/
getPublicAccessBlock(callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request<S3Control.Types.GetPublicAccessBlockOutput, AWSError>;
/**
* Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1000 access points (or the number specified in maxResults, whichever is less), then the response will include a continuation token that you can use to list the additional access points.
*/
listAccessPoints(params: S3Control.Types.ListAccessPointsRequest, callback?: (err: AWSError, data: S3Control.Types.ListAccessPointsResult) => void): Request<S3Control.Types.ListAccessPointsResult, AWSError>;
/**
* Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1000 access points (or the number specified in maxResults, whichever is less), then the response will include a continuation token that you can use to list the additional access points.
*/
listAccessPoints(callback?: (err: AWSError, data: S3Control.Types.ListAccessPointsResult) => void): Request<S3Control.Types.ListAccessPointsResult, AWSError>;
/**
* Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
*/
listJobs(params: S3Control.Types.ListJobsRequest, callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request<S3Control.Types.ListJobsResult, AWSError>;
/**
* Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
*/
listJobs(callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request<S3Control.Types.ListJobsResult, AWSError>;
/**
* Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
*/
putAccessPointPolicy(params: S3Control.Types.PutAccessPointPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.
*/
putAccessPointPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
*/
putPublicAccessBlock(params: S3Control.Types.PutPublicAccessBlockRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account.
*/
putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates an existing job's priority.
*/
updateJobPriority(params: S3Control.Types.UpdateJobPriorityRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request<S3Control.Types.UpdateJobPriorityResult, AWSError>;
/**
* Updates an existing job's priority.
*/
updateJobPriority(callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request<S3Control.Types.UpdateJobPriorityResult, AWSError>;
/**
* Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.
*/
updateJobStatus(params: S3Control.Types.UpdateJobStatusRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request<S3Control.Types.UpdateJobStatusResult, AWSError>;
/**
* Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.
*/
updateJobStatus(callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request<S3Control.Types.UpdateJobStatusResult, AWSError>;
}
declare namespace S3Control {
export interface AccessPoint {
/**
* The name of this access point.
*/
Name: AccessPointName;
/**
* Indicates whether this access point allows access from the public Internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public Internet, subject to the access point and bucket access policies.
*/
NetworkOrigin: NetworkOrigin;
/**
* The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
*/
VpcConfiguration?: VpcConfiguration;
/**
* The name of the bucket associated with this access point.
*/
Bucket: BucketName;
}
export type AccessPointList = AccessPoint[];
export type AccessPointName = string;
export type AccountId = string;
export type Boolean = boolean;
export type BucketName = string;
export type ConfirmationRequired = boolean;
export interface CreateAccessPointRequest {
/**
* The AWS account ID for the owner of the bucket for which you want to create an access point.
*/
AccountId: AccountId;
/**
* The name you want to assign to this access point.
*/
Name: AccessPointName;
/**
* The name of the bucket that you want to associate this access point with.
*/
Bucket: BucketName;
/**
* If you include this field, Amazon S3 restricts access to this access point to requests from the specified Virtual Private Cloud (VPC).
*/
VpcConfiguration?: VpcConfiguration;
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
}
export interface CreateJobRequest {
/**
*
*/
AccountId: AccountId;
/**
* Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
*/
ConfirmationRequired?: ConfirmationRequired;
/**
* The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide.
*/
Operation: JobOperation;
/**
* Configuration parameters for the optional job-completion report.
*/
Report: JobReport;
/**
* An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
*/
ClientRequestToken: NonEmptyMaxLength64String;
/**
* Configuration parameters for the manifest.
*/
Manifest: JobManifest;
/**
* A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
*/
Description?: NonEmptyMaxLength256String;
/**
* The numerical priority for this job. Higher numbers indicate higher priority.
*/
Priority: JobPriority;
/**
* The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.
*/
RoleArn: IAMRoleArn;
}
export interface CreateJobResult {
/**
* The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.
*/
JobId?: JobId;
}
export type CreationDate = Date;
export interface DeleteAccessPointPolicyRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose policy you want to delete.
*/
Name: AccessPointName;
}
export interface DeleteAccessPointRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point you want to delete.
*/
Name: AccessPointName;
}
export interface DeletePublicAccessBlockRequest {
/**
* The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to remove.
*/
AccountId: AccountId;
}
export interface DescribeJobRequest {
/**
*
*/
AccountId: AccountId;
/**
* The ID for the job whose information you want to retrieve.
*/
JobId: JobId;
}
export interface DescribeJobResult {
/**
* Contains the configuration parameters and status for the job specified in the Describe Job request.
*/
Job?: JobDescriptor;
}
export interface GetAccessPointPolicyRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose policy you want to retrieve.
*/
Name: AccessPointName;
}
export interface GetAccessPointPolicyResult {
/**
* The access point policy associated with the specified access point.
*/
Policy?: Policy;
}
export interface GetAccessPointPolicyStatusRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose policy status you want to retrieve.
*/
Name: AccessPointName;
}
export interface GetAccessPointPolicyStatusResult {
/**
* Indicates the current policy status of the specified access point.
*/
PolicyStatus?: PolicyStatus;
}
export interface GetAccessPointRequest {
/**
* The account ID for the account that owns the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point whose configuration information you want to retrieve.
*/
Name: AccessPointName;
}
export interface GetAccessPointResult {
/**
* The name of the specified access point.
*/
Name?: AccessPointName;
/**
* The name of the bucket associated with the specified access point.
*/
Bucket?: BucketName;
/**
* Indicates whether this access point allows access from the public Internet. If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC, and the access point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the access point allows access from the public Internet, subject to the access point and bucket access policies.
*/
NetworkOrigin?: NetworkOrigin;
/**
* Contains the Virtual Private Cloud (VPC) configuration for the specified access point.
*/
VpcConfiguration?: VpcConfiguration;
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
/**
* The date and time when the specified access point was created.
*/
CreationDate?: CreationDate;
}
export interface GetPublicAccessBlockOutput {
/**
* The PublicAccessBlock configuration currently in effect for this Amazon Web Services account.
*/
PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
}
export interface GetPublicAccessBlockRequest {
/**
* The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to retrieve.
*/
AccountId: AccountId;
}
export type IAMRoleArn = string;
export type IsPublic = boolean;
export type JobArn = string;
export type JobCreationTime = Date;
export interface JobDescriptor {
/**
* The ID for the specified job.
*/
JobId?: JobId;
/**
* Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.
*/
ConfirmationRequired?: ConfirmationRequired;
/**
* The description for this job, if one was provided in this job's Create Job request.
*/
Description?: NonEmptyMaxLength256String;
/**
* The Amazon Resource Name (ARN) for this job.
*/
JobArn?: JobArn;
/**
* The current status of the specified job.
*/
Status?: JobStatus;
/**
* The configuration information for the specified job's manifest object.
*/
Manifest?: JobManifest;
/**
* The operation that the specified job is configured to execute on the objects listed in the manifest.
*/
Operation?: JobOperation;
/**
* The priority of the specified job.
*/
Priority?: JobPriority;
/**
* Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
*/
ProgressSummary?: JobProgressSummary;
/**
*
*/
StatusUpdateReason?: JobStatusUpdateReason;
/**
* If the specified job failed, this field contains information describing the failure.
*/
FailureReasons?: JobFailureList;
/**
* Contains the configuration information for the job-completion report if you requested one in the Create Job request.
*/
Report?: JobReport;
/**
* A timestamp indicating when this job was created.
*/
CreationTime?: JobCreationTime;
/**
* A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
*/
TerminationDate?: JobTerminationDate;
/**
* The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.
*/
RoleArn?: IAMRoleArn;
/**
* The timestamp when this job was suspended, if it has been suspended.
*/
SuspendedDate?: SuspendedDate;
/**
* The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.
*/
SuspendedCause?: SuspendedCause;
}
export interface JobFailure {
/**
* The failure code, if any, for the specified job.
*/
FailureCode?: JobFailureCode;
/**
* The failure reason, if any, for the specified job.
*/
FailureReason?: JobFailureReason;
}
export type JobFailureCode = string;
export type JobFailureList = JobFailure[];
export type JobFailureReason = string;
export type JobId = string;
export interface JobListDescriptor {
/**
* The ID for the specified job.
*/
JobId?: JobId;
/**
* The user-specified description that was included in the specified job's Create Job request.
*/
Description?: NonEmptyMaxLength256String;
/**
* The operation that the specified job is configured to run on each object listed in the manifest.
*/
Operation?: OperationName;
/**
* The current priority for the specified job.
*/
Priority?: JobPriority;
/**
* The specified job's current status.
*/
Status?: JobStatus;
/**
* A timestamp indicating when the specified job was created.
*/
CreationTime?: JobCreationTime;
/**
* A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
*/
TerminationDate?: JobTerminationDate;
/**
* Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
*/
ProgressSummary?: JobProgressSummary;
}
export type JobListDescriptorList = JobListDescriptor[];
export interface JobManifest {
/**
* Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.
*/
Spec: JobManifestSpec;
/**
* Contains the information required to locate the specified job's manifest.
*/
Location: JobManifestLocation;
}
export type JobManifestFieldList = JobManifestFieldName[];
export type JobManifestFieldName = "Ignore"|"Bucket"|"Key"|"VersionId"|string;
export type JobManifestFormat = "S3BatchOperations_CSV_20180820"|"S3InventoryReport_CSV_20161130"|string;
export interface JobManifestLocation {
/**
* The Amazon Resource Name (ARN) for a manifest object.
*/
ObjectArn: S3KeyArnString;
/**
* The optional version ID to identify a specific version of the manifest object.
*/
ObjectVersionId?: S3ObjectVersionId;
/**
* The ETag for the specified manifest object.
*/
ETag: NonEmptyMaxLength1024String;
}
export interface JobManifestSpec {
/**
* Indicates which of the available formats the specified manifest uses.
*/
Format: JobManifestFormat;
/**
* If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.
*/
Fields?: JobManifestFieldList;
}
export type JobNumberOfTasksFailed = number;
export type JobNumberOfTasksSucceeded = number;
export interface JobOperation {
/**
* Directs the specified job to invoke an AWS Lambda function on each object in the manifest.
*/
LambdaInvoke?: LambdaInvokeOperation;
/**
* Directs the specified job to execute a PUT Copy object call on each object in the manifest.
*/
S3PutObjectCopy?: S3CopyObjectOperation;
/**
* Directs the specified job to execute a PUT Object acl call on each object in the manifest.
*/
S3PutObjectAcl?: S3SetObjectAclOperation;
/**
* Directs the specified job to execute a PUT Object tagging call on each object in the manifest.
*/
S3PutObjectTagging?: S3SetObjectTaggingOperation;
/**
* Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.
*/
S3InitiateRestoreObject?: S3InitiateRestoreObjectOperation;
}
export type JobPriority = number;
export interface JobProgressSummary {
/**
*
*/
TotalNumberOfTasks?: JobTotalNumberOfTasks;
/**
*
*/
NumberOfTasksSucceeded?: JobNumberOfTasksSucceeded;
/**
*
*/
NumberOfTasksFailed?: JobNumberOfTasksFailed;
}
export interface JobReport {
/**
* The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
*/
Bucket?: S3BucketArnString;
/**
* The format of the specified job-completion report.
*/
Format?: JobReportFormat;
/**
* Indicates whether the specified job will generate a job-completion report.
*/
Enabled: Boolean;
/**
* An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 will store the job-completion report at <prefix>/job-<job-id>/report.json.
*/
Prefix?: ReportPrefixString;
/**
* Indicates whether the job-completion report will include details of all tasks or only failed tasks.
*/
ReportScope?: JobReportScope;
}
export type JobReportFormat = "Report_CSV_20180820"|string;
export type JobReportScope = "AllTasks"|"FailedTasksOnly"|string;
export type JobStatus = "Active"|"Cancelled"|"Cancelling"|"Complete"|"Completing"|"Failed"|"Failing"|"New"|"Paused"|"Pausing"|"Preparing"|"Ready"|"Suspended"|string;
export type JobStatusList = JobStatus[];
export type JobStatusUpdateReason = string;
export type JobTerminationDate = Date;
export type JobTotalNumberOfTasks = number;
export type KmsKeyArnString = string;
export interface LambdaInvokeOperation {
/**
* The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.
*/
FunctionArn?: NonEmptyMaxLength1024String;
}
export interface ListAccessPointsRequest {
/**
* The AWS account ID for owner of the bucket whose access points you want to list.
*/
AccountId: AccountId;
/**
* The name of the bucket whose associated access points you want to list.
*/
Bucket?: BucketName;
/**
* A continuation token. If a previous call to ListAccessPoints returned a continuation token in the NextToken field, then providing that value here causes Amazon S3 to retrieve the next page of results.
*/
NextToken?: NonEmptyMaxLength1024String;
/**
* The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken field that you can use to retrieve the next page of access points.
*/
MaxResults?: MaxResults;
}
export interface ListAccessPointsResult {
/**
* Contains identification and configuration information for one or more access points associated with the specified bucket.
*/
AccessPointList?: AccessPointList;
/**
* If the specified bucket has more access points than can be returned in one call to this API, then this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
*/
NextToken?: NonEmptyMaxLength1024String;
}
export interface ListJobsRequest {
/**
*
*/
AccountId: AccountId;
/**
* The List Jobs request returns jobs that match the statuses listed in this element.
*/
JobStatuses?: JobStatusList;
/**
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.
*/
NextToken?: NonEmptyMaxLength1024String;
/**
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.
*/
MaxResults?: MaxResults;
}
export interface ListJobsResult {
/**
* If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.
*/
NextToken?: NonEmptyMaxLength1024String;
/**
* The list of current jobs and jobs that have ended within the last 30 days.
*/
Jobs?: JobListDescriptorList;
}
export type MaxLength1024String = string;
export type MaxResults = number;
export type NetworkOrigin = "Internet"|"VPC"|string;
export type NonEmptyMaxLength1024String = string;
export type NonEmptyMaxLength2048String = string;
export type NonEmptyMaxLength256String = string;
export type NonEmptyMaxLength64String = string;
export type OperationName = "LambdaInvoke"|"S3PutObjectCopy"|"S3PutObjectAcl"|"S3PutObjectTagging"|"S3InitiateRestoreObject"|string;
export type Policy = string;
export interface PolicyStatus {
/**
*
*/
IsPublic?: IsPublic;
}
export interface PublicAccessBlockConfiguration {
/**
* Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior: PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. PUT Object calls fail if the request includes a public ACL. PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
*/
BlockPublicAcls?: Setting;
/**
* Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
*/
IgnorePublicAcls?: Setting;
/**
* Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.
*/
BlockPublicPolicy?: Setting;
/**
* Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS services and authorized users within this account. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
*/
RestrictPublicBuckets?: Setting;
}
export interface PutAccessPointPolicyRequest {
/**
* The AWS account ID for owner of the bucket associated with the specified access point.
*/
AccountId: AccountId;
/**
* The name of the access point that you want to associate with the specified policy.
*/
Name: AccessPointName;
/**
* The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
*/
Policy: Policy;
}
export interface PutPublicAccessBlockRequest {
/**
* The PublicAccessBlock configuration that you want to apply to the specified Amazon Web Services account.
*/
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration;
/**
* The account ID for the Amazon Web Services account whose PublicAccessBlock configuration you want to set.
*/
AccountId: AccountId;
}
export type ReportPrefixString = string;
export type RequestedJobStatus = "Cancelled"|"Ready"|string;
export interface S3AccessControlList {
/**
*
*/
Owner: S3ObjectOwner;
/**
*
*/
Grants?: S3GrantList;
}
export interface S3AccessControlPolicy {
/**
*
*/
AccessControlList?: S3AccessControlList;
/**
*
*/
CannedAccessControlList?: S3CannedAccessControlList;
}
export type S3BucketArnString = string;
export type S3CannedAccessControlList = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|string;
export type S3ContentLength = number;
export interface S3CopyObjectOperation {
/**
*
*/
TargetResource?: S3BucketArnString;
/**
*
*/
CannedAccessControlList?: S3CannedAccessControlList;
/**
*
*/
AccessControlGrants?: S3GrantList;
/**
*
*/
MetadataDirective?: S3MetadataDirective;
/**
*
*/
ModifiedSinceConstraint?: TimeStamp;
/**
*
*/
NewObjectMetadata?: S3ObjectMetadata;
/**
*
*/
NewObjectTagging?: S3TagSet;
/**
*
*/
RedirectLocation?: NonEmptyMaxLength2048String;
/**
*
*/
RequesterPays?: Boolean;
/**
*
*/
StorageClass?: S3StorageClass;
/**
*
*/
UnModifiedSinceConstraint?: TimeStamp;
/**
*
*/
SSEAwsKmsKeyId?: KmsKeyArnString;
/**
*
*/
TargetKeyPrefix?: NonEmptyMaxLength1024String;
/**
*
*/
ObjectLockLegalHoldStatus?: S3ObjectLockLegalHoldStatus;
/**
*
*/
ObjectLockMode?: S3ObjectLockMode;
/**
*
*/
ObjectLockRetainUntilDate?: TimeStamp;
}
export type S3ExpirationInDays = number;
export type S3GlacierJobTier = "BULK"|"STANDARD"|string;
export interface S3Grant {
/**
*
*/
Grantee?: S3Grantee;
/**
*
*/
Permission?: S3Permission;
}
export type S3GrantList = S3Grant[];
export interface S3Grantee {
/**
*
*/
TypeIdentifier?: S3GranteeTypeIdentifier;
/**
*
*/
Identifier?: NonEmptyMaxLength1024String;
/**
*
*/
DisplayName?: NonEmptyMaxLength1024String;
}
export type S3GranteeTypeIdentifier = "id"|"emailAddress"|"uri"|string;
export interface S3InitiateRestoreObjectOperation {
/**
*
*/
ExpirationInDays?: S3ExpirationInDays;
/**
*
*/
GlacierJobTier?: S3GlacierJobTier;
}
export type S3KeyArnString = string;
export type S3MetadataDirective = "COPY"|"REPLACE"|string;
export type S3ObjectLockLegalHoldStatus = "OFF"|"ON"|string;
export type S3ObjectLockMode = "COMPLIANCE"|"GOVERNANCE"|string;
export interface S3ObjectMetadata {
/**
*
*/
CacheControl?: NonEmptyMaxLength1024String;
/**
*
*/
ContentDisposition?: NonEmptyMaxLength1024String;
/**
*
*/
ContentEncoding?: NonEmptyMaxLength1024String;
/**
*
*/
ContentLanguage?: NonEmptyMaxLength1024String;
/**
*
*/
UserMetadata?: S3UserMetadata;
/**
*
*/
ContentLength?: S3ContentLength;
/**
*
*/
ContentMD5?: NonEmptyMaxLength1024String;
/**
*
*/
ContentType?: NonEmptyMaxLength1024String;
/**
*
*/
HttpExpiresDate?: TimeStamp;
/**
*
*/
RequesterCharged?: Boolean;
/**
*
*/
SSEAlgorithm?: S3SSEAlgorithm;
}
export interface S3ObjectOwner {
/**
*
*/
ID?: NonEmptyMaxLength1024String;
/**
*
*/
DisplayName?: NonEmptyMaxLength1024String;
}
export type S3ObjectVersionId = string;
export type S3Permission = "FULL_CONTROL"|"READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"|string;
export type S3SSEAlgorithm = "AES256"|"KMS"|string;
export interface S3SetObjectAclOperation {
/**
*
*/
AccessControlPolicy?: S3AccessControlPolicy;
}
export interface S3SetObjectTaggingOperation {
/**
*
*/
TagSet?: S3TagSet;
}
export type S3StorageClass = "STANDARD"|"STANDARD_IA"|"ONEZONE_IA"|"GLACIER"|"INTELLIGENT_TIERING"|"DEEP_ARCHIVE"|string;
export interface S3Tag {
/**
*
*/
Key: NonEmptyMaxLength1024String;
/**
*
*/
Value: MaxLength1024String;
}
export type S3TagSet = S3Tag[];
export type S3UserMetadata = {[key: string]: MaxLength1024String};
export type Setting = boolean;
export type SuspendedCause = string;
export type SuspendedDate = Date;
export type TimeStamp = Date;
export interface UpdateJobPriorityRequest {
/**
*
*/
AccountId: AccountId;
/**
* The ID for the job whose priority you want to update.
*/
JobId: JobId;
/**
* The priority you want to assign to this job.
*/
Priority: JobPriority;
}
export interface UpdateJobPriorityResult {
/**
* The ID for the job whose priority Amazon S3 updated.
*/
JobId: JobId;
/**
* The new priority assigned to the specified job.
*/
Priority: JobPriority;
}
export interface UpdateJobStatusRequest {
/**
*
*/
AccountId: AccountId;
/**
* The ID of the job whose status you want to update.
*/
JobId: JobId;
/**
* The status that you want to move the specified job to.
*/
RequestedJobStatus: RequestedJobStatus;
/**
* A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.
*/
StatusUpdateReason?: JobStatusUpdateReason;
}
export interface UpdateJobStatusResult {
/**
* The ID for the job whose status was updated.
*/
JobId?: JobId;
/**
* The current status for the specified job.
*/
Status?: JobStatus;
/**
* The reason that the specified job's status was updated.
*/
StatusUpdateReason?: JobStatusUpdateReason;
}
export interface VpcConfiguration {
/**
* If this field is specified, this access point will only allow connections from the specified VPC ID.
*/
VpcId: VpcId;
}
export type VpcId = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-08-20"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & UseDualstackConfigOptions & ClientApiVersions;
/**
* Contains interfaces for use with the S3Control client.
*/
export import Types = S3Control;
}
export = S3Control;