aws-sdk 2.667.0 → 2.671.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.
@@ -21,11 +21,11 @@ declare class S3Control extends Service {
21
21
  */
22
22
  createAccessPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
23
23
  /**
24
- * Creates an Amazon S3 batch operations job.
24
+ * You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: DescribeJob ListJobs UpdateJobPriority UpdateJobStatus
25
25
  */
26
26
  createJob(params: S3Control.Types.CreateJobRequest, callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request<S3Control.Types.CreateJobResult, AWSError>;
27
27
  /**
28
- * Creates an Amazon S3 batch operations job.
28
+ * You can use Amazon S3 Batch Operations to perform large-scale Batch Operations on Amazon S3 objects. Amazon S3 Batch Operations can execute a single operation or action on lists of Amazon S3 objects that you specify. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: DescribeJob ListJobs UpdateJobPriority UpdateJobStatus
29
29
  */
30
30
  createJob(callback?: (err: AWSError, data: S3Control.Types.CreateJobResult) => void): Request<S3Control.Types.CreateJobResult, AWSError>;
31
31
  /**
@@ -45,11 +45,11 @@ declare class S3Control extends Service {
45
45
  */
46
46
  deleteAccessPointPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
47
47
  /**
48
- * Delete the tags on a Amazon S3 batch operations job, if any.
48
+ * Removes the entire tag set from the specified Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob GetJobTagging PutJobTagging
49
49
  */
50
50
  deleteJobTagging(params: S3Control.Types.DeleteJobTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.DeleteJobTaggingResult) => void): Request<S3Control.Types.DeleteJobTaggingResult, AWSError>;
51
51
  /**
52
- * Delete the tags on a Amazon S3 batch operations job, if any.
52
+ * Removes the entire tag set from the specified Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:DeleteJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob GetJobTagging PutJobTagging
53
53
  */
54
54
  deleteJobTagging(callback?: (err: AWSError, data: S3Control.Types.DeleteJobTaggingResult) => void): Request<S3Control.Types.DeleteJobTaggingResult, AWSError>;
55
55
  /**
@@ -61,11 +61,11 @@ declare class S3Control extends Service {
61
61
  */
62
62
  deletePublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
63
63
  /**
64
- * Retrieves the configuration parameters and status for a batch operations job.
64
+ * Retrieves the configuration parameters and status for a Batch Operations job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs UpdateJobPriority UpdateJobStatus
65
65
  */
66
66
  describeJob(params: S3Control.Types.DescribeJobRequest, callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request<S3Control.Types.DescribeJobResult, AWSError>;
67
67
  /**
68
- * Retrieves the configuration parameters and status for a batch operations job.
68
+ * Retrieves the configuration parameters and status for a Batch Operations job. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs UpdateJobPriority UpdateJobStatus
69
69
  */
70
70
  describeJob(callback?: (err: AWSError, data: S3Control.Types.DescribeJobResult) => void): Request<S3Control.Types.DescribeJobResult, AWSError>;
71
71
  /**
@@ -93,11 +93,11 @@ declare class S3Control extends Service {
93
93
  */
94
94
  getAccessPointPolicyStatus(callback?: (err: AWSError, data: S3Control.Types.GetAccessPointPolicyStatusResult) => void): Request<S3Control.Types.GetAccessPointPolicyStatusResult, AWSError>;
95
95
  /**
96
- * Retrieve the tags on a Amazon S3 batch operations job.
96
+ * Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob PutJobTagging DeleteJobTagging
97
97
  */
98
98
  getJobTagging(params: S3Control.Types.GetJobTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.GetJobTaggingResult) => void): Request<S3Control.Types.GetJobTaggingResult, AWSError>;
99
99
  /**
100
- * Retrieve the tags on a Amazon S3 batch operations job.
100
+ * Returns the tags on an Amazon S3 Batch Operations job. To use this operation, you must have permission to perform the s3:GetJobTagging action. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob PutJobTagging DeleteJobTagging
101
101
  */
102
102
  getJobTagging(callback?: (err: AWSError, data: S3Control.Types.GetJobTaggingResult) => void): Request<S3Control.Types.GetJobTaggingResult, AWSError>;
103
103
  /**
@@ -109,19 +109,19 @@ declare class S3Control extends Service {
109
109
  */
110
110
  getPublicAccessBlock(callback?: (err: AWSError, data: S3Control.Types.GetPublicAccessBlockOutput) => void): Request<S3Control.Types.GetPublicAccessBlockOutput, AWSError>;
111
111
  /**
112
- * 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.
112
+ * 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 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.
113
113
  */
114
114
  listAccessPoints(params: S3Control.Types.ListAccessPointsRequest, callback?: (err: AWSError, data: S3Control.Types.ListAccessPointsResult) => void): Request<S3Control.Types.ListAccessPointsResult, AWSError>;
115
115
  /**
116
- * 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.
116
+ * 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 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.
117
117
  */
118
118
  listAccessPoints(callback?: (err: AWSError, data: S3Control.Types.ListAccessPointsResult) => void): Request<S3Control.Types.ListAccessPointsResult, AWSError>;
119
119
  /**
120
- * Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
120
+ * Lists current Amazon S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus
121
121
  */
122
122
  listJobs(params: S3Control.Types.ListJobsRequest, callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request<S3Control.Types.ListJobsResult, AWSError>;
123
123
  /**
124
- * Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
124
+ * Lists current Amazon S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatus
125
125
  */
126
126
  listJobs(callback?: (err: AWSError, data: S3Control.Types.ListJobsResult) => void): Request<S3Control.Types.ListJobsResult, AWSError>;
127
127
  /**
@@ -133,11 +133,11 @@ declare class S3Control extends Service {
133
133
  */
134
134
  putAccessPointPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
135
135
  /**
136
- * Replace the set of tags on a Amazon S3 batch operations job.
136
+ * Set the supplied tag-set on an Amazon S3 Batch Operations job. A tag is a key-value pair. You can associate Amazon S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the tag set with the one you have modified.. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide. If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you will be charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing. For deleting existing tags for your batch operations job, DeleteJobTagging request is preferred because it achieves the same result without incurring charges. A few things to consider about using tags: Amazon S3 limits the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. The key and values are case sensitive. For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions. To use this operation, you must have permission to perform the s3:PutJobTagging action. Related actions include: CreateJob GetJobTagging DeleteJobTagging
137
137
  */
138
138
  putJobTagging(params: S3Control.Types.PutJobTaggingRequest, callback?: (err: AWSError, data: S3Control.Types.PutJobTaggingResult) => void): Request<S3Control.Types.PutJobTaggingResult, AWSError>;
139
139
  /**
140
- * Replace the set of tags on a Amazon S3 batch operations job.
140
+ * Set the supplied tag-set on an Amazon S3 Batch Operations job. A tag is a key-value pair. You can associate Amazon S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using GetJobTagging, modify that tag set, and use this API action to replace the tag set with the one you have modified.. For more information, see Using Job Tags in the Amazon Simple Storage Service Developer Guide. If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you will be charged for a Tier 1 Request (PUT). For more information, see Amazon S3 pricing. For deleting existing tags for your batch operations job, DeleteJobTagging request is preferred because it achieves the same result without incurring charges. A few things to consider about using tags: Amazon S3 limits the maximum number of tags to 50 tags per job. You can associate up to 50 tags with a job as long as they have unique tag keys. A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length. The key and values are case sensitive. For tagging-related restrictions related to characters and encodings, see User-Defined Tag Restrictions. To use this operation, you must have permission to perform the s3:PutJobTagging action. Related actions include: CreateJob GetJobTagging DeleteJobTagging
141
141
  */
142
142
  putJobTagging(callback?: (err: AWSError, data: S3Control.Types.PutJobTaggingResult) => void): Request<S3Control.Types.PutJobTaggingResult, AWSError>;
143
143
  /**
@@ -149,19 +149,19 @@ declare class S3Control extends Service {
149
149
  */
150
150
  putPublicAccessBlock(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
151
151
  /**
152
- * Updates an existing job's priority.
152
+ * Updates an existing Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
153
153
  */
154
154
  updateJobPriority(params: S3Control.Types.UpdateJobPriorityRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request<S3Control.Types.UpdateJobPriorityResult, AWSError>;
155
155
  /**
156
- * Updates an existing job's priority.
156
+ * Updates an existing Amazon S3 Batch Operations job's priority. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
157
157
  */
158
158
  updateJobPriority(callback?: (err: AWSError, data: S3Control.Types.UpdateJobPriorityResult) => void): Request<S3Control.Types.UpdateJobPriorityResult, AWSError>;
159
159
  /**
160
- * 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.
160
+ * 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. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
161
161
  */
162
162
  updateJobStatus(params: S3Control.Types.UpdateJobStatusRequest, callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request<S3Control.Types.UpdateJobStatusResult, AWSError>;
163
163
  /**
164
- * 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.
164
+ * 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. For more information, see Amazon S3 Batch Operations in the Amazon Simple Storage Service Developer Guide. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatus
165
165
  */
166
166
  updateJobStatus(callback?: (err: AWSError, data: S3Control.Types.UpdateJobStatusResult) => void): Request<S3Control.Types.UpdateJobStatusResult, AWSError>;
167
167
  }
@@ -172,11 +172,11 @@ declare namespace S3Control {
172
172
  */
173
173
  Name: AccessPointName;
174
174
  /**
175
- * 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.
175
+ * 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.
176
176
  */
177
177
  NetworkOrigin: NetworkOrigin;
178
178
  /**
179
- * The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
179
+ * The virtual private cloud (VPC) configuration for this access point, if one exists.
180
180
  */
181
181
  VpcConfiguration?: VpcConfiguration;
182
182
  /**
@@ -204,7 +204,7 @@ declare namespace S3Control {
204
204
  */
205
205
  Bucket: BucketName;
206
206
  /**
207
- * If you include this field, Amazon S3 restricts access to this access point to requests from the specified Virtual Private Cloud (VPC).
207
+ * If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
208
208
  */
209
209
  VpcConfiguration?: VpcConfiguration;
210
210
  PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
@@ -243,11 +243,11 @@ declare namespace S3Control {
243
243
  */
244
244
  Priority: JobPriority;
245
245
  /**
246
- * 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.
246
+ * The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to execute this job's operation on each object in the manifest.
247
247
  */
248
248
  RoleArn: IAMRoleArn;
249
249
  /**
250
- * An optional set of tags to associate with the job when it is created.
250
+ * A set of tags to associate with the Amazon S3 Batch Operations job. This is an optional parameter.
251
251
  */
252
252
  Tags?: S3TagSet;
253
253
  }
@@ -280,11 +280,11 @@ declare namespace S3Control {
280
280
  }
281
281
  export interface DeleteJobTaggingRequest {
282
282
  /**
283
- * The account ID for the Amazon Web Services account associated with the Amazon S3 batch operations job you want to remove tags from.
283
+ * The AWS account ID associated with the Amazon S3 Batch Operations job.
284
284
  */
285
285
  AccountId: AccountId;
286
286
  /**
287
- * The ID for the job whose tags you want to delete.
287
+ * The ID for the Amazon S3 Batch Operations job whose tags you want to delete.
288
288
  */
289
289
  JobId: JobId;
290
290
  }
@@ -312,6 +312,7 @@ declare namespace S3Control {
312
312
  */
313
313
  Job?: JobDescriptor;
314
314
  }
315
+ export type FunctionArnString = string;
315
316
  export interface GetAccessPointPolicyRequest {
316
317
  /**
317
318
  * The account ID for the account that owns the specified access point.
@@ -364,11 +365,11 @@ declare namespace S3Control {
364
365
  */
365
366
  Bucket?: BucketName;
366
367
  /**
367
- * 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.
368
+ * 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.
368
369
  */
369
370
  NetworkOrigin?: NetworkOrigin;
370
371
  /**
371
- * Contains the Virtual Private Cloud (VPC) configuration for the specified access point.
372
+ * Contains the virtual private cloud (VPC) configuration for the specified access point.
372
373
  */
373
374
  VpcConfiguration?: VpcConfiguration;
374
375
  PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration;
@@ -379,17 +380,17 @@ declare namespace S3Control {
379
380
  }
380
381
  export interface GetJobTaggingRequest {
381
382
  /**
382
- * The account ID for the Amazon Web Services account associated with the Amazon S3 batch operations job you want to retrieve tags for.
383
+ * The AWS account ID associated with the Amazon S3 Batch Operations job.
383
384
  */
384
385
  AccountId: AccountId;
385
386
  /**
386
- * The ID for the job whose tags you want to retrieve.
387
+ * The ID for the Amazon S3 Batch Operations job whose tags you want to retrieve.
387
388
  */
388
389
  JobId: JobId;
389
390
  }
390
391
  export interface GetJobTaggingResult {
391
392
  /**
392
- * The set of tags associated with the job.
393
+ * The set of tags associated with the Amazon S3 Batch Operations job.
393
394
  */
394
395
  Tags?: S3TagSet;
395
396
  }
@@ -467,7 +468,7 @@ declare namespace S3Control {
467
468
  */
468
469
  TerminationDate?: JobTerminationDate;
469
470
  /**
470
- * The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.
471
+ * The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role assigned to execute the tasks for this job.
471
472
  */
472
473
  RoleArn?: IAMRoleArn;
473
474
  /**
@@ -588,6 +589,8 @@ declare namespace S3Control {
588
589
  * Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.
589
590
  */
590
591
  S3InitiateRestoreObject?: S3InitiateRestoreObjectOperation;
592
+ S3PutObjectLegalHold?: S3SetObjectLegalHoldOperation;
593
+ S3PutObjectRetention?: S3SetObjectRetentionOperation;
591
594
  }
592
595
  export type JobPriority = number;
593
596
  export interface JobProgressSummary {
@@ -638,7 +641,7 @@ declare namespace S3Control {
638
641
  /**
639
642
  * The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.
640
643
  */
641
- FunctionArn?: NonEmptyMaxLength1024String;
644
+ FunctionArn?: FunctionArnString;
642
645
  }
643
646
  export interface ListAccessPointsRequest {
644
647
  /**
@@ -680,7 +683,7 @@ declare namespace S3Control {
680
683
  /**
681
684
  * 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.
682
685
  */
683
- NextToken?: NonEmptyMaxLength1024String;
686
+ NextToken?: StringForNextToken;
684
687
  /**
685
688
  * 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.
686
689
  */
@@ -690,7 +693,7 @@ declare namespace S3Control {
690
693
  /**
691
694
  * 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.
692
695
  */
693
- NextToken?: NonEmptyMaxLength1024String;
696
+ NextToken?: StringForNextToken;
694
697
  /**
695
698
  * The list of current jobs and jobs that have ended within the last 30 days.
696
699
  */
@@ -703,7 +706,7 @@ declare namespace S3Control {
703
706
  export type NonEmptyMaxLength2048String = string;
704
707
  export type NonEmptyMaxLength256String = string;
705
708
  export type NonEmptyMaxLength64String = string;
706
- export type OperationName = "LambdaInvoke"|"S3PutObjectCopy"|"S3PutObjectAcl"|"S3PutObjectTagging"|"S3InitiateRestoreObject"|string;
709
+ export type OperationName = "LambdaInvoke"|"S3PutObjectCopy"|"S3PutObjectAcl"|"S3PutObjectTagging"|"S3InitiateRestoreObject"|"S3PutObjectLegalHold"|"S3PutObjectRetention"|string;
707
710
  export type Policy = string;
708
711
  export interface PolicyStatus {
709
712
  /**
@@ -745,15 +748,15 @@ declare namespace S3Control {
745
748
  }
746
749
  export interface PutJobTaggingRequest {
747
750
  /**
748
- * The account ID for the Amazon Web Services account associated with the Amazon S3 batch operations job you want to replace tags on.
751
+ * The AWS account ID associated with the Amazon S3 Batch Operations job.
749
752
  */
750
753
  AccountId: AccountId;
751
754
  /**
752
- * The ID for the job whose tags you want to replace.
755
+ * The ID for the Amazon S3 Batch Operations job whose tags you want to replace.
753
756
  */
754
757
  JobId: JobId;
755
758
  /**
756
- * The set of tags to associate with the job.
759
+ * The set of tags to associate with the Amazon S3 Batch Operations job.
757
760
  */
758
761
  Tags: S3TagSet;
759
762
  }
@@ -848,15 +851,15 @@ declare namespace S3Control {
848
851
  */
849
852
  TargetKeyPrefix?: NonEmptyMaxLength1024String;
850
853
  /**
851
- *
854
+ * The Legal Hold status to be applied to all objects in the Batch Operations job.
852
855
  */
853
856
  ObjectLockLegalHoldStatus?: S3ObjectLockLegalHoldStatus;
854
857
  /**
855
- *
858
+ * The Retention mode to be applied to all objects in the Batch Operations job.
856
859
  */
857
860
  ObjectLockMode?: S3ObjectLockMode;
858
861
  /**
859
- *
862
+ * The date when the applied Object Retention configuration will expire on all objects in the Batch Operations job.
860
863
  */
861
864
  ObjectLockRetainUntilDate?: TimeStamp;
862
865
  }
@@ -900,8 +903,15 @@ declare namespace S3Control {
900
903
  }
901
904
  export type S3KeyArnString = string;
902
905
  export type S3MetadataDirective = "COPY"|"REPLACE"|string;
906
+ export interface S3ObjectLockLegalHold {
907
+ /**
908
+ * The Legal Hold status to be applied to all objects in the Batch Operations job.
909
+ */
910
+ Status: S3ObjectLockLegalHoldStatus;
911
+ }
903
912
  export type S3ObjectLockLegalHoldStatus = "OFF"|"ON"|string;
904
913
  export type S3ObjectLockMode = "COMPLIANCE"|"GOVERNANCE"|string;
914
+ export type S3ObjectLockRetentionMode = "COMPLIANCE"|"GOVERNANCE"|string;
905
915
  export interface S3ObjectMetadata {
906
916
  /**
907
917
  *
@@ -960,6 +970,16 @@ declare namespace S3Control {
960
970
  }
961
971
  export type S3ObjectVersionId = string;
962
972
  export type S3Permission = "FULL_CONTROL"|"READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"|string;
973
+ export interface S3Retention {
974
+ /**
975
+ * The date when the applied Object Retention will expire on all objects in the Batch Operations job.
976
+ */
977
+ RetainUntilDate?: TimeStamp;
978
+ /**
979
+ * The Retention mode to be applied to all objects in the Batch Operations job.
980
+ */
981
+ Mode?: S3ObjectLockRetentionMode;
982
+ }
963
983
  export type S3SSEAlgorithm = "AES256"|"KMS"|string;
964
984
  export interface S3SetObjectAclOperation {
965
985
  /**
@@ -967,6 +987,22 @@ declare namespace S3Control {
967
987
  */
968
988
  AccessControlPolicy?: S3AccessControlPolicy;
969
989
  }
990
+ export interface S3SetObjectLegalHoldOperation {
991
+ /**
992
+ * The Legal Hold contains the status to be applied to all objects in the Batch Operations job.
993
+ */
994
+ LegalHold: S3ObjectLockLegalHold;
995
+ }
996
+ export interface S3SetObjectRetentionOperation {
997
+ /**
998
+ * Indicates if the operation should be applied to objects in the Batch Operations job even if they have Governance-type Object Lock in place.
999
+ */
1000
+ BypassGovernanceRetention?: Boolean;
1001
+ /**
1002
+ * Amazon S3 object lock Retention contains the retention mode to be applied to all objects in the Batch Operations job.
1003
+ */
1004
+ Retention: S3Retention;
1005
+ }
970
1006
  export interface S3SetObjectTaggingOperation {
971
1007
  /**
972
1008
  *
@@ -978,17 +1014,20 @@ declare namespace S3Control {
978
1014
  /**
979
1015
  *
980
1016
  */
981
- Key: NonEmptyMaxLength1024String;
1017
+ Key: TagKeyString;
982
1018
  /**
983
1019
  *
984
1020
  */
985
- Value: MaxLength1024String;
1021
+ Value: TagValueString;
986
1022
  }
987
1023
  export type S3TagSet = S3Tag[];
988
1024
  export type S3UserMetadata = {[key: string]: MaxLength1024String};
989
1025
  export type Setting = boolean;
1026
+ export type StringForNextToken = string;
990
1027
  export type SuspendedCause = string;
991
1028
  export type SuspendedDate = Date;
1029
+ export type TagKeyString = string;
1030
+ export type TagValueString = string;
992
1031
  export type TimeStamp = Date;
993
1032
  export interface UpdateJobPriorityRequest {
994
1033
  /**
package/clients/ssm.d.ts CHANGED
@@ -1829,6 +1829,10 @@ declare namespace SSM {
1829
1829
  * CloudWatch Logs information where you want Systems Manager to send the command output.
1830
1830
  */
1831
1831
  CloudWatchOutputConfig?: CloudWatchOutputConfig;
1832
+ /**
1833
+ * The TimeoutSeconds value specified for a command.
1834
+ */
1835
+ TimeoutSeconds?: TimeoutSeconds;
1832
1836
  }
1833
1837
  export interface CommandFilter {
1834
1838
  /**
@@ -2275,7 +2279,7 @@ declare namespace SSM {
2275
2279
  }
2276
2280
  export interface CreateDocumentRequest {
2277
2281
  /**
2278
- * The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. For examples, see the following topics in the AWS Systems Manager User Guide. Create an SSM document (console) Create an SSM document (AWS CLI) Create an SSM document (API)
2282
+ * The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. For examples, see the following topics in the AWS Systems Manager User Guide. Create an SSM document (AWS API) Create an SSM document (AWS CLI) Create an SSM document (API)
2279
2283
  */
2280
2284
  Content: DocumentContent;
2281
2285
  /**
@@ -5374,7 +5378,7 @@ declare namespace SSM {
5374
5378
  */
5375
5379
  NextToken?: NextToken;
5376
5380
  /**
5377
- * (Optional) One or more filters. Use a filter to return a more specific list of results. Note that the DocumentName filter is not supported for ListCommandInvocations.
5381
+ * (Optional) One or more filters. Use a filter to return a more specific list of results.
5378
5382
  */
5379
5383
  Filters?: CommandFilterList;
5380
5384
  /**
@@ -5510,7 +5514,7 @@ declare namespace SSM {
5510
5514
  */
5511
5515
  DocumentFilterList?: DocumentFilterList;
5512
5516
  /**
5513
- * One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, and DocumentType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
5517
+ * One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
5514
5518
  */
5515
5519
  Filters?: DocumentKeyValuesFilterList;
5516
5520
  /**
@@ -6431,7 +6435,12 @@ declare namespace SSM {
6431
6435
  * The Amazon Resource Name (ARN) of the parameter.
6432
6436
  */
6433
6437
  ARN?: String;
6438
+ /**
6439
+ * The data type of the parameter, such as text or aws:ec2:image. The default is text.
6440
+ */
6441
+ DataType?: ParameterDataType;
6434
6442
  }
6443
+ export type ParameterDataType = string;
6435
6444
  export type ParameterDescription = string;
6436
6445
  export interface ParameterHistory {
6437
6446
  /**
@@ -6482,6 +6491,10 @@ declare namespace SSM {
6482
6491
  * Information about the policies assigned to a parameter. Assigning parameter policies in the AWS Systems Manager User Guide.
6483
6492
  */
6484
6493
  Policies?: ParameterPolicyList;
6494
+ /**
6495
+ * The data type of the parameter, such as text or aws:ec2:image. The default is text.
6496
+ */
6497
+ DataType?: ParameterDataType;
6485
6498
  }
6486
6499
  export type ParameterHistoryList = ParameterHistory[];
6487
6500
  export interface ParameterInlinePolicy {
@@ -6543,6 +6556,10 @@ declare namespace SSM {
6543
6556
  * A list of policies associated with a parameter.
6544
6557
  */
6545
6558
  Policies?: ParameterPolicyList;
6559
+ /**
6560
+ * The data type of the parameter, such as text or aws:ec2:image. The default is text.
6561
+ */
6562
+ DataType?: ParameterDataType;
6546
6563
  }
6547
6564
  export type ParameterMetadataList = ParameterMetadata[];
6548
6565
  export type ParameterName = string;
@@ -6926,7 +6943,7 @@ declare namespace SSM {
6926
6943
  /**
6927
6944
  * The type of parameter that you want to add to the system. Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type. SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.
6928
6945
  */
6929
- Type: ParameterType;
6946
+ Type?: ParameterType;
6930
6947
  /**
6931
6948
  * The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type. If you don't specify a key ID, the system uses the default key associated with your AWS account. To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key. To use a custom KMS key, choose the SecureString data type with the Key ID parameter.
6932
6949
  */
@@ -6951,6 +6968,10 @@ declare namespace SSM {
6951
6968
  * One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types: Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter. ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours. NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed. All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.
6952
6969
  */
6953
6970
  Policies?: ParameterPolicies;
6971
+ /**
6972
+ * The data type for a String parameter. Supported data types include plain text and Amazon Machine Image IDs. The following data type values are supported. text aws:ec2:image When you create a String parameter and specify aws:ec2:image, Systems Manager validates the parameter value you provide against that data type. The required format is ami-12345abcdeEXAMPLE. For more information, see Native parameter support for Amazon Machine Image IDs in the AWS Systems Manager User Guide.
6973
+ */
6974
+ DataType?: ParameterDataType;
6954
6975
  }
6955
6976
  export interface PutParameterResult {
6956
6977
  /**