aws-sdk-s3control 1.16.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-s3control.rb +1 -1
- data/lib/aws-sdk-s3control/client.rb +245 -44
- data/lib/aws-sdk-s3control/client_api.rb +30 -5
- data/lib/aws-sdk-s3control/resource.rb +1 -7
- data/lib/aws-sdk-s3control/types.rb +226 -54
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3341450a53a2076bf332bc48183e3fbbbc5ba0b86b3d05ea7e21920fe66ea630
|
4
|
+
data.tar.gz: d108e420427abf5435c454067fc73ab1256e51ac5bf4b7f9fd934b7fa0643c08
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3aeccfd8123c58897bab3b365f14cf29f1e6a1303630439cf9984f9d1a370b71a8eb0725833455553c17ee7ff0475d5d51b3e221612c80af19d713a390f6d8bd
|
7
|
+
data.tar.gz: 4ef98bb0dc91940ad084167fa4dc99d29e70ae3d7c062e6c081915c3f6d98961d33dcfe6bf1b839b20d0c3d6ee0af987f4d9aa4c8da97ee2e3968c6254cf635b
|
data/lib/aws-sdk-s3control.rb
CHANGED
@@ -279,8 +279,7 @@ module Aws::S3Control
|
|
279
279
|
#
|
280
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
281
281
|
# number of seconds to wait for response data. This value can
|
282
|
-
# safely be set
|
283
|
-
# per-request on the session yielded by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
284
283
|
#
|
285
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
286
285
|
# seconds a connection is allowed to sit idle before it is
|
@@ -292,7 +291,7 @@ module Aws::S3Control
|
|
292
291
|
# request body. This option has no effect unless the request has
|
293
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
294
293
|
# disables this behaviour. This value can safely be set per
|
295
|
-
# request on the session
|
294
|
+
# request on the session.
|
296
295
|
#
|
297
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
298
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -334,7 +333,7 @@ module Aws::S3Control
|
|
334
333
|
#
|
335
334
|
# @option params [Types::VpcConfiguration] :vpc_configuration
|
336
335
|
# If you include this field, Amazon S3 restricts access to this access
|
337
|
-
# point to requests from the specified
|
336
|
+
# point to requests from the specified virtual private cloud (VPC).
|
338
337
|
#
|
339
338
|
# @option params [Types::PublicAccessBlockConfiguration] :public_access_block_configuration
|
340
339
|
# The `PublicAccessBlock` configuration that you want to apply to this
|
@@ -375,7 +374,25 @@ module Aws::S3Control
|
|
375
374
|
req.send_request(options)
|
376
375
|
end
|
377
376
|
|
378
|
-
#
|
377
|
+
# You can use Amazon S3 Batch Operations to perform large-scale Batch
|
378
|
+
# Operations on Amazon S3 objects. Amazon S3 Batch Operations can
|
379
|
+
# execute a single operation or action on lists of Amazon S3 objects
|
380
|
+
# that you specify. For more information, see [Amazon S3 Batch
|
381
|
+
# Operations][1] in the Amazon Simple Storage Service Developer Guide.
|
382
|
+
#
|
383
|
+
# Related actions include:
|
384
|
+
#
|
385
|
+
# * DescribeJob
|
386
|
+
#
|
387
|
+
# * ListJobs
|
388
|
+
#
|
389
|
+
# * UpdateJobPriority
|
390
|
+
#
|
391
|
+
# * UpdateJobStatus
|
392
|
+
#
|
393
|
+
#
|
394
|
+
#
|
395
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html
|
379
396
|
#
|
380
397
|
# @option params [required, String] :account_id
|
381
398
|
#
|
@@ -417,12 +434,13 @@ module Aws::S3Control
|
|
417
434
|
# priority.
|
418
435
|
#
|
419
436
|
# @option params [required, String] :role_arn
|
420
|
-
# The Amazon Resource Name (ARN) for the Identity and Access
|
421
|
-
# (IAM)
|
422
|
-
# operation on each object in the manifest.
|
437
|
+
# The Amazon Resource Name (ARN) for the AWS Identity and Access
|
438
|
+
# Management (IAM) role that Batch Operations will use to execute this
|
439
|
+
# job's operation on each object in the manifest.
|
423
440
|
#
|
424
441
|
# @option params [Array<Types::S3Tag>] :tags
|
425
|
-
#
|
442
|
+
# A set of tags to associate with the Amazon S3 Batch Operations job.
|
443
|
+
# This is an optional parameter.
|
426
444
|
#
|
427
445
|
# @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
446
|
#
|
@@ -435,7 +453,7 @@ module Aws::S3Control
|
|
435
453
|
# confirmation_required: false,
|
436
454
|
# operation: { # required
|
437
455
|
# lambda_invoke: {
|
438
|
-
# function_arn: "
|
456
|
+
# function_arn: "FunctionArnString",
|
439
457
|
# },
|
440
458
|
# s3_put_object_copy: {
|
441
459
|
# target_resource: "S3BucketArnString",
|
@@ -469,8 +487,8 @@ module Aws::S3Control
|
|
469
487
|
# },
|
470
488
|
# new_object_tagging: [
|
471
489
|
# {
|
472
|
-
# key: "
|
473
|
-
# value: "
|
490
|
+
# key: "TagKeyString", # required
|
491
|
+
# value: "TagValueString", # required
|
474
492
|
# },
|
475
493
|
# ],
|
476
494
|
# redirect_location: "NonEmptyMaxLength2048String",
|
@@ -507,8 +525,8 @@ module Aws::S3Control
|
|
507
525
|
# s3_put_object_tagging: {
|
508
526
|
# tag_set: [
|
509
527
|
# {
|
510
|
-
# key: "
|
511
|
-
# value: "
|
528
|
+
# key: "TagKeyString", # required
|
529
|
+
# value: "TagValueString", # required
|
512
530
|
# },
|
513
531
|
# ],
|
514
532
|
# },
|
@@ -516,6 +534,18 @@ module Aws::S3Control
|
|
516
534
|
# expiration_in_days: 1,
|
517
535
|
# glacier_job_tier: "BULK", # accepts BULK, STANDARD
|
518
536
|
# },
|
537
|
+
# s3_put_object_legal_hold: {
|
538
|
+
# legal_hold: { # required
|
539
|
+
# status: "OFF", # required, accepts OFF, ON
|
540
|
+
# },
|
541
|
+
# },
|
542
|
+
# s3_put_object_retention: {
|
543
|
+
# bypass_governance_retention: false,
|
544
|
+
# retention: { # required
|
545
|
+
# retain_until_date: Time.now,
|
546
|
+
# mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
|
547
|
+
# },
|
548
|
+
# },
|
519
549
|
# },
|
520
550
|
# report: { # required
|
521
551
|
# bucket: "S3BucketArnString",
|
@@ -541,8 +571,8 @@ module Aws::S3Control
|
|
541
571
|
# role_arn: "IAMRoleArn", # required
|
542
572
|
# tags: [
|
543
573
|
# {
|
544
|
-
# key: "
|
545
|
-
# value: "
|
574
|
+
# key: "TagKeyString", # required
|
575
|
+
# value: "TagValueString", # required
|
546
576
|
# },
|
547
577
|
# ],
|
548
578
|
# })
|
@@ -612,14 +642,32 @@ module Aws::S3Control
|
|
612
642
|
req.send_request(options)
|
613
643
|
end
|
614
644
|
|
615
|
-
#
|
645
|
+
# Removes the entire tag set from the specified Amazon S3 Batch
|
646
|
+
# Operations job. To use this operation, you must have permission to
|
647
|
+
# perform the `s3:DeleteJobTagging` action. For more information, see
|
648
|
+
# [Using Job Tags][1] in the Amazon Simple Storage Service Developer
|
649
|
+
# Guide.
|
650
|
+
#
|
651
|
+
#
|
652
|
+
#
|
653
|
+
# Related actions include:
|
654
|
+
#
|
655
|
+
# * CreateJob
|
656
|
+
#
|
657
|
+
# * GetJobTagging
|
658
|
+
#
|
659
|
+
# * PutJobTagging
|
660
|
+
#
|
661
|
+
#
|
662
|
+
#
|
663
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags
|
616
664
|
#
|
617
665
|
# @option params [required, String] :account_id
|
618
|
-
# The account ID
|
619
|
-
# Amazon S3 batch operations job you want to remove tags from.
|
666
|
+
# The AWS account ID associated with the Amazon S3 Batch Operations job.
|
620
667
|
#
|
621
668
|
# @option params [required, String] :job_id
|
622
|
-
# The ID for the job whose tags you want to
|
669
|
+
# The ID for the Amazon S3 Batch Operations job whose tags you want to
|
670
|
+
# delete.
|
623
671
|
#
|
624
672
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
625
673
|
#
|
@@ -663,8 +711,25 @@ module Aws::S3Control
|
|
663
711
|
req.send_request(options)
|
664
712
|
end
|
665
713
|
|
666
|
-
# Retrieves the configuration parameters and status for a
|
667
|
-
#
|
714
|
+
# Retrieves the configuration parameters and status for a Batch
|
715
|
+
# Operations job. For more information, see [Amazon S3 Batch
|
716
|
+
# Operations][1] in the Amazon Simple Storage Service Developer Guide.
|
717
|
+
#
|
718
|
+
#
|
719
|
+
#
|
720
|
+
# Related actions include:
|
721
|
+
#
|
722
|
+
# * CreateJob
|
723
|
+
#
|
724
|
+
# * ListJobs
|
725
|
+
#
|
726
|
+
# * UpdateJobPriority
|
727
|
+
#
|
728
|
+
# * UpdateJobStatus
|
729
|
+
#
|
730
|
+
#
|
731
|
+
#
|
732
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html
|
668
733
|
#
|
669
734
|
# @option params [required, String] :account_id
|
670
735
|
#
|
@@ -742,6 +807,10 @@ module Aws::S3Control
|
|
742
807
|
# resp.job.operation.s3_put_object_tagging.tag_set[0].value #=> String
|
743
808
|
# resp.job.operation.s3_initiate_restore_object.expiration_in_days #=> Integer
|
744
809
|
# resp.job.operation.s3_initiate_restore_object.glacier_job_tier #=> String, one of "BULK", "STANDARD"
|
810
|
+
# resp.job.operation.s3_put_object_legal_hold.legal_hold.status #=> String, one of "OFF", "ON"
|
811
|
+
# resp.job.operation.s3_put_object_retention.bypass_governance_retention #=> Boolean
|
812
|
+
# resp.job.operation.s3_put_object_retention.retention.retain_until_date #=> Time
|
813
|
+
# resp.job.operation.s3_put_object_retention.retention.mode #=> String, one of "COMPLIANCE", "GOVERNANCE"
|
745
814
|
# resp.job.priority #=> Integer
|
746
815
|
# resp.job.progress_summary.total_number_of_tasks #=> Integer
|
747
816
|
# resp.job.progress_summary.number_of_tasks_succeeded #=> Integer
|
@@ -888,14 +957,31 @@ module Aws::S3Control
|
|
888
957
|
req.send_request(options)
|
889
958
|
end
|
890
959
|
|
891
|
-
#
|
960
|
+
# Returns the tags on an Amazon S3 Batch Operations job. To use this
|
961
|
+
# operation, you must have permission to perform the `s3:GetJobTagging`
|
962
|
+
# action. For more information, see [Using Job Tags][1] in the *Amazon
|
963
|
+
# Simple Storage Service Developer Guide*.
|
964
|
+
#
|
965
|
+
#
|
966
|
+
#
|
967
|
+
# Related actions include:
|
968
|
+
#
|
969
|
+
# * CreateJob
|
970
|
+
#
|
971
|
+
# * PutJobTagging
|
972
|
+
#
|
973
|
+
# * DeleteJobTagging
|
974
|
+
#
|
975
|
+
#
|
976
|
+
#
|
977
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags
|
892
978
|
#
|
893
979
|
# @option params [required, String] :account_id
|
894
|
-
# The account ID
|
895
|
-
# Amazon S3 batch operations job you want to retrieve tags for.
|
980
|
+
# The AWS account ID associated with the Amazon S3 Batch Operations job.
|
896
981
|
#
|
897
982
|
# @option params [required, String] :job_id
|
898
|
-
# The ID for the job whose tags you want to
|
983
|
+
# The ID for the Amazon S3 Batch Operations job whose tags you want to
|
984
|
+
# retrieve.
|
899
985
|
#
|
900
986
|
# @return [Types::GetJobTaggingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
901
987
|
#
|
@@ -958,10 +1044,10 @@ module Aws::S3Control
|
|
958
1044
|
|
959
1045
|
# Returns a list of the access points currently associated with the
|
960
1046
|
# specified bucket. You can retrieve up to 1000 access points per call.
|
961
|
-
# If the specified bucket has more than
|
962
|
-
# number specified in `maxResults`, whichever is less),
|
963
|
-
#
|
964
|
-
#
|
1047
|
+
# If the specified bucket has more than 1,000 access points (or the
|
1048
|
+
# number specified in `maxResults`, whichever is less), the response
|
1049
|
+
# will include a continuation token that you can use to list the
|
1050
|
+
# additional access points.
|
965
1051
|
#
|
966
1052
|
# @option params [required, String] :account_id
|
967
1053
|
# The AWS account ID for owner of the bucket whose access points you
|
@@ -988,6 +1074,8 @@ module Aws::S3Control
|
|
988
1074
|
# * {Types::ListAccessPointsResult#access_point_list #access_point_list} => Array<Types::AccessPoint>
|
989
1075
|
# * {Types::ListAccessPointsResult#next_token #next_token} => String
|
990
1076
|
#
|
1077
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1078
|
+
#
|
991
1079
|
# @example Request syntax with placeholder values
|
992
1080
|
#
|
993
1081
|
# resp = client.list_access_points({
|
@@ -1015,8 +1103,26 @@ module Aws::S3Control
|
|
1015
1103
|
req.send_request(options)
|
1016
1104
|
end
|
1017
1105
|
|
1018
|
-
# Lists current jobs and jobs that have ended
|
1019
|
-
# for the AWS account making the request.
|
1106
|
+
# Lists current Amazon S3 Batch Operations jobs and jobs that have ended
|
1107
|
+
# within the last 30 days for the AWS account making the request. For
|
1108
|
+
# more information, see [Amazon S3 Batch Operations][1] in the *Amazon
|
1109
|
+
# Simple Storage Service Developer Guide*.
|
1110
|
+
#
|
1111
|
+
# Related actions include:
|
1112
|
+
#
|
1113
|
+
#
|
1114
|
+
#
|
1115
|
+
# * CreateJob
|
1116
|
+
#
|
1117
|
+
# * DescribeJob
|
1118
|
+
#
|
1119
|
+
# * UpdateJobPriority
|
1120
|
+
#
|
1121
|
+
# * UpdateJobStatus
|
1122
|
+
#
|
1123
|
+
#
|
1124
|
+
#
|
1125
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html
|
1020
1126
|
#
|
1021
1127
|
# @option params [required, String] :account_id
|
1022
1128
|
#
|
@@ -1040,12 +1146,14 @@ module Aws::S3Control
|
|
1040
1146
|
# * {Types::ListJobsResult#next_token #next_token} => String
|
1041
1147
|
# * {Types::ListJobsResult#jobs #jobs} => Array<Types::JobListDescriptor>
|
1042
1148
|
#
|
1149
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1150
|
+
#
|
1043
1151
|
# @example Request syntax with placeholder values
|
1044
1152
|
#
|
1045
1153
|
# resp = client.list_jobs({
|
1046
1154
|
# account_id: "AccountId", # required
|
1047
1155
|
# job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
|
1048
|
-
# next_token: "
|
1156
|
+
# next_token: "StringForNextToken",
|
1049
1157
|
# max_results: 1,
|
1050
1158
|
# })
|
1051
1159
|
#
|
@@ -1055,7 +1163,7 @@ module Aws::S3Control
|
|
1055
1163
|
# resp.jobs #=> Array
|
1056
1164
|
# resp.jobs[0].job_id #=> String
|
1057
1165
|
# resp.jobs[0].description #=> String
|
1058
|
-
# resp.jobs[0].operation #=> String, one of "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3InitiateRestoreObject"
|
1166
|
+
# resp.jobs[0].operation #=> String, one of "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3InitiateRestoreObject", "S3PutObjectLegalHold", "S3PutObjectRetention"
|
1059
1167
|
# resp.jobs[0].priority #=> Integer
|
1060
1168
|
# resp.jobs[0].status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
|
1061
1169
|
# resp.jobs[0].creation_time #=> Time
|
@@ -1115,17 +1223,74 @@ module Aws::S3Control
|
|
1115
1223
|
req.send_request(options)
|
1116
1224
|
end
|
1117
1225
|
|
1118
|
-
#
|
1226
|
+
# Set the supplied tag-set on an Amazon S3 Batch Operations job.
|
1227
|
+
#
|
1228
|
+
# A tag is a key-value pair. You can associate Amazon S3 Batch
|
1229
|
+
# Operations tags with any job by sending a PUT request against the
|
1230
|
+
# tagging subresource that is associated with the job. To modify the
|
1231
|
+
# existing tag set, you can either replace the existing tag set
|
1232
|
+
# entirely, or make changes within the existing tag set by retrieving
|
1233
|
+
# the existing tag set using GetJobTagging, modify that tag set, and use
|
1234
|
+
# this API action to replace the tag set with the one you have
|
1235
|
+
# modified.. For more information, see [Using Job Tags][1] in the Amazon
|
1236
|
+
# Simple Storage Service Developer Guide.
|
1237
|
+
#
|
1238
|
+
#
|
1239
|
+
#
|
1240
|
+
# <note markdown="1"> * If you send this request with an empty tag set, Amazon S3 deletes
|
1241
|
+
# the existing tag set on the Batch Operations job. If you use this
|
1242
|
+
# method, you will be charged for a Tier 1 Request (PUT). For more
|
1243
|
+
# information, see [Amazon S3 pricing][2].
|
1244
|
+
#
|
1245
|
+
# * For deleting existing tags for your batch operations job,
|
1246
|
+
# DeleteJobTagging request is preferred because it achieves the same
|
1247
|
+
# result without incurring charges.
|
1248
|
+
#
|
1249
|
+
# * A few things to consider about using tags:
|
1250
|
+
#
|
1251
|
+
# * Amazon S3 limits the maximum number of tags to 50 tags per job.
|
1252
|
+
#
|
1253
|
+
# * You can associate up to 50 tags with a job as long as they have
|
1254
|
+
# unique tag keys.
|
1255
|
+
#
|
1256
|
+
# * A tag key can be up to 128 Unicode characters in length, and tag
|
1257
|
+
# values can be up to 256 Unicode characters in length.
|
1258
|
+
#
|
1259
|
+
# * The key and values are case sensitive.
|
1260
|
+
#
|
1261
|
+
# * For tagging-related restrictions related to characters and
|
1262
|
+
# encodings, see [User-Defined Tag Restrictions][3].
|
1263
|
+
#
|
1264
|
+
# </note>
|
1265
|
+
#
|
1266
|
+
#
|
1267
|
+
#
|
1268
|
+
# To use this operation, you must have permission to perform the
|
1269
|
+
# `s3:PutJobTagging` action.
|
1270
|
+
#
|
1271
|
+
# Related actions include:
|
1272
|
+
#
|
1273
|
+
# * CreateJob
|
1274
|
+
#
|
1275
|
+
# * GetJobTagging
|
1276
|
+
#
|
1277
|
+
# * DeleteJobTagging
|
1278
|
+
#
|
1279
|
+
#
|
1280
|
+
#
|
1281
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags
|
1282
|
+
# [2]: http://aws.amazon.com/s3/pricing/
|
1283
|
+
# [3]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
1119
1284
|
#
|
1120
1285
|
# @option params [required, String] :account_id
|
1121
|
-
# The account ID
|
1122
|
-
# Amazon S3 batch operations job you want to replace tags on.
|
1286
|
+
# The AWS account ID associated with the Amazon S3 Batch Operations job.
|
1123
1287
|
#
|
1124
1288
|
# @option params [required, String] :job_id
|
1125
|
-
# The ID for the job whose tags you want to
|
1289
|
+
# The ID for the Amazon S3 Batch Operations job whose tags you want to
|
1290
|
+
# replace.
|
1126
1291
|
#
|
1127
1292
|
# @option params [required, Array<Types::S3Tag>] :tags
|
1128
|
-
# The set of tags to associate with the job.
|
1293
|
+
# The set of tags to associate with the Amazon S3 Batch Operations job.
|
1129
1294
|
#
|
1130
1295
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1131
1296
|
#
|
@@ -1136,8 +1301,8 @@ module Aws::S3Control
|
|
1136
1301
|
# job_id: "JobId", # required
|
1137
1302
|
# tags: [ # required
|
1138
1303
|
# {
|
1139
|
-
# key: "
|
1140
|
-
# value: "
|
1304
|
+
# key: "TagKeyString", # required
|
1305
|
+
# value: "TagValueString", # required
|
1141
1306
|
# },
|
1142
1307
|
# ],
|
1143
1308
|
# })
|
@@ -1185,7 +1350,25 @@ module Aws::S3Control
|
|
1185
1350
|
req.send_request(options)
|
1186
1351
|
end
|
1187
1352
|
|
1188
|
-
# Updates an existing job's priority.
|
1353
|
+
# Updates an existing Amazon S3 Batch Operations job's priority. For
|
1354
|
+
# more information, see [Amazon S3 Batch Operations][1] in the Amazon
|
1355
|
+
# Simple Storage Service Developer Guide.
|
1356
|
+
#
|
1357
|
+
#
|
1358
|
+
#
|
1359
|
+
# Related actions include:
|
1360
|
+
#
|
1361
|
+
# * CreateJob
|
1362
|
+
#
|
1363
|
+
# * ListJobs
|
1364
|
+
#
|
1365
|
+
# * DescribeJob
|
1366
|
+
#
|
1367
|
+
# * UpdateJobStatus
|
1368
|
+
#
|
1369
|
+
#
|
1370
|
+
#
|
1371
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html
|
1189
1372
|
#
|
1190
1373
|
# @option params [required, String] :account_id
|
1191
1374
|
#
|
@@ -1223,7 +1406,25 @@ module Aws::S3Control
|
|
1223
1406
|
end
|
1224
1407
|
|
1225
1408
|
# Updates the status for the specified job. Use this operation to
|
1226
|
-
# confirm that you want to run a job or to cancel an existing job.
|
1409
|
+
# confirm that you want to run a job or to cancel an existing job. For
|
1410
|
+
# more information, see [Amazon S3 Batch Operations][1] in the Amazon
|
1411
|
+
# Simple Storage Service Developer Guide.
|
1412
|
+
#
|
1413
|
+
#
|
1414
|
+
#
|
1415
|
+
# Related actions include:
|
1416
|
+
#
|
1417
|
+
# * CreateJob
|
1418
|
+
#
|
1419
|
+
# * ListJobs
|
1420
|
+
#
|
1421
|
+
# * DescribeJob
|
1422
|
+
#
|
1423
|
+
# * UpdateJobStatus
|
1424
|
+
#
|
1425
|
+
#
|
1426
|
+
#
|
1427
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html
|
1227
1428
|
#
|
1228
1429
|
# @option params [required, String] :account_id
|
1229
1430
|
#
|
@@ -1280,7 +1481,7 @@ module Aws::S3Control
|
|
1280
1481
|
params: params,
|
1281
1482
|
config: config)
|
1282
1483
|
context[:gem_name] = 'aws-sdk-s3control'
|
1283
|
-
context[:gem_version] = '1.
|
1484
|
+
context[:gem_version] = '1.17.0'
|
1284
1485
|
Seahorse::Client::Request.new(handlers, context)
|
1285
1486
|
end
|
1286
1487
|
|
@@ -31,6 +31,7 @@ module Aws::S3Control
|
|
31
31
|
DescribeJobRequest = Shapes::StructureShape.new(name: 'DescribeJobRequest')
|
32
32
|
DescribeJobResult = Shapes::StructureShape.new(name: 'DescribeJobResult')
|
33
33
|
ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
|
34
|
+
FunctionArnString = Shapes::StringShape.new(name: 'FunctionArnString')
|
34
35
|
GetAccessPointPolicyRequest = Shapes::StructureShape.new(name: 'GetAccessPointPolicyRequest')
|
35
36
|
GetAccessPointPolicyResult = Shapes::StructureShape.new(name: 'GetAccessPointPolicyResult')
|
36
37
|
GetAccessPointPolicyStatusRequest = Shapes::StructureShape.new(name: 'GetAccessPointPolicyStatusRequest')
|
@@ -118,22 +119,30 @@ module Aws::S3Control
|
|
118
119
|
S3InitiateRestoreObjectOperation = Shapes::StructureShape.new(name: 'S3InitiateRestoreObjectOperation')
|
119
120
|
S3KeyArnString = Shapes::StringShape.new(name: 'S3KeyArnString')
|
120
121
|
S3MetadataDirective = Shapes::StringShape.new(name: 'S3MetadataDirective')
|
122
|
+
S3ObjectLockLegalHold = Shapes::StructureShape.new(name: 'S3ObjectLockLegalHold')
|
121
123
|
S3ObjectLockLegalHoldStatus = Shapes::StringShape.new(name: 'S3ObjectLockLegalHoldStatus')
|
122
124
|
S3ObjectLockMode = Shapes::StringShape.new(name: 'S3ObjectLockMode')
|
125
|
+
S3ObjectLockRetentionMode = Shapes::StringShape.new(name: 'S3ObjectLockRetentionMode')
|
123
126
|
S3ObjectMetadata = Shapes::StructureShape.new(name: 'S3ObjectMetadata')
|
124
127
|
S3ObjectOwner = Shapes::StructureShape.new(name: 'S3ObjectOwner')
|
125
128
|
S3ObjectVersionId = Shapes::StringShape.new(name: 'S3ObjectVersionId')
|
126
129
|
S3Permission = Shapes::StringShape.new(name: 'S3Permission')
|
130
|
+
S3Retention = Shapes::StructureShape.new(name: 'S3Retention')
|
127
131
|
S3SSEAlgorithm = Shapes::StringShape.new(name: 'S3SSEAlgorithm')
|
128
132
|
S3SetObjectAclOperation = Shapes::StructureShape.new(name: 'S3SetObjectAclOperation')
|
133
|
+
S3SetObjectLegalHoldOperation = Shapes::StructureShape.new(name: 'S3SetObjectLegalHoldOperation')
|
134
|
+
S3SetObjectRetentionOperation = Shapes::StructureShape.new(name: 'S3SetObjectRetentionOperation')
|
129
135
|
S3SetObjectTaggingOperation = Shapes::StructureShape.new(name: 'S3SetObjectTaggingOperation')
|
130
136
|
S3StorageClass = Shapes::StringShape.new(name: 'S3StorageClass')
|
131
137
|
S3Tag = Shapes::StructureShape.new(name: 'S3Tag')
|
132
138
|
S3TagSet = Shapes::ListShape.new(name: 'S3TagSet')
|
133
139
|
S3UserMetadata = Shapes::MapShape.new(name: 'S3UserMetadata')
|
134
140
|
Setting = Shapes::BooleanShape.new(name: 'Setting')
|
141
|
+
StringForNextToken = Shapes::StringShape.new(name: 'StringForNextToken')
|
135
142
|
SuspendedCause = Shapes::StringShape.new(name: 'SuspendedCause')
|
136
143
|
SuspendedDate = Shapes::TimestampShape.new(name: 'SuspendedDate')
|
144
|
+
TagKeyString = Shapes::StringShape.new(name: 'TagKeyString')
|
145
|
+
TagValueString = Shapes::StringShape.new(name: 'TagValueString')
|
137
146
|
TimeStamp = Shapes::TimestampShape.new(name: 'TimeStamp')
|
138
147
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
139
148
|
TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
|
@@ -311,6 +320,8 @@ module Aws::S3Control
|
|
311
320
|
JobOperation.add_member(:s3_put_object_acl, Shapes::ShapeRef.new(shape: S3SetObjectAclOperation, location_name: "S3PutObjectAcl", metadata: {"box"=>true}))
|
312
321
|
JobOperation.add_member(:s3_put_object_tagging, Shapes::ShapeRef.new(shape: S3SetObjectTaggingOperation, location_name: "S3PutObjectTagging", metadata: {"box"=>true}))
|
313
322
|
JobOperation.add_member(:s3_initiate_restore_object, Shapes::ShapeRef.new(shape: S3InitiateRestoreObjectOperation, location_name: "S3InitiateRestoreObject", metadata: {"box"=>true}))
|
323
|
+
JobOperation.add_member(:s3_put_object_legal_hold, Shapes::ShapeRef.new(shape: S3SetObjectLegalHoldOperation, location_name: "S3PutObjectLegalHold", metadata: {"box"=>true}))
|
324
|
+
JobOperation.add_member(:s3_put_object_retention, Shapes::ShapeRef.new(shape: S3SetObjectRetentionOperation, location_name: "S3PutObjectRetention", metadata: {"box"=>true}))
|
314
325
|
JobOperation.struct_class = Types::JobOperation
|
315
326
|
|
316
327
|
JobProgressSummary.add_member(:total_number_of_tasks, Shapes::ShapeRef.new(shape: JobTotalNumberOfTasks, location_name: "TotalNumberOfTasks", metadata: {"box"=>true}))
|
@@ -330,7 +341,7 @@ module Aws::S3Control
|
|
330
341
|
|
331
342
|
JobStatusList.member = Shapes::ShapeRef.new(shape: JobStatus)
|
332
343
|
|
333
|
-
LambdaInvokeOperation.add_member(:function_arn, Shapes::ShapeRef.new(shape:
|
344
|
+
LambdaInvokeOperation.add_member(:function_arn, Shapes::ShapeRef.new(shape: FunctionArnString, location_name: "FunctionArn"))
|
334
345
|
LambdaInvokeOperation.struct_class = Types::LambdaInvokeOperation
|
335
346
|
|
336
347
|
ListAccessPointsRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location: "header", location_name: "x-amz-account-id"))
|
@@ -345,11 +356,11 @@ module Aws::S3Control
|
|
345
356
|
|
346
357
|
ListJobsRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location: "header", location_name: "x-amz-account-id"))
|
347
358
|
ListJobsRequest.add_member(:job_statuses, Shapes::ShapeRef.new(shape: JobStatusList, location: "querystring", location_name: "jobStatuses"))
|
348
|
-
ListJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape:
|
359
|
+
ListJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: StringForNextToken, location: "querystring", location_name: "nextToken"))
|
349
360
|
ListJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults", metadata: {"box"=>true}))
|
350
361
|
ListJobsRequest.struct_class = Types::ListJobsRequest
|
351
362
|
|
352
|
-
ListJobsResult.add_member(:next_token, Shapes::ShapeRef.new(shape:
|
363
|
+
ListJobsResult.add_member(:next_token, Shapes::ShapeRef.new(shape: StringForNextToken, location_name: "NextToken"))
|
353
364
|
ListJobsResult.add_member(:jobs, Shapes::ShapeRef.new(shape: JobListDescriptorList, location_name: "Jobs"))
|
354
365
|
ListJobsResult.struct_class = Types::ListJobsResult
|
355
366
|
|
@@ -427,6 +438,9 @@ module Aws::S3Control
|
|
427
438
|
S3InitiateRestoreObjectOperation.add_member(:glacier_job_tier, Shapes::ShapeRef.new(shape: S3GlacierJobTier, location_name: "GlacierJobTier"))
|
428
439
|
S3InitiateRestoreObjectOperation.struct_class = Types::S3InitiateRestoreObjectOperation
|
429
440
|
|
441
|
+
S3ObjectLockLegalHold.add_member(:status, Shapes::ShapeRef.new(shape: S3ObjectLockLegalHoldStatus, required: true, location_name: "Status"))
|
442
|
+
S3ObjectLockLegalHold.struct_class = Types::S3ObjectLockLegalHold
|
443
|
+
|
430
444
|
S3ObjectMetadata.add_member(:cache_control, Shapes::ShapeRef.new(shape: NonEmptyMaxLength1024String, location_name: "CacheControl"))
|
431
445
|
S3ObjectMetadata.add_member(:content_disposition, Shapes::ShapeRef.new(shape: NonEmptyMaxLength1024String, location_name: "ContentDisposition"))
|
432
446
|
S3ObjectMetadata.add_member(:content_encoding, Shapes::ShapeRef.new(shape: NonEmptyMaxLength1024String, location_name: "ContentEncoding"))
|
@@ -444,14 +458,25 @@ module Aws::S3Control
|
|
444
458
|
S3ObjectOwner.add_member(:display_name, Shapes::ShapeRef.new(shape: NonEmptyMaxLength1024String, location_name: "DisplayName"))
|
445
459
|
S3ObjectOwner.struct_class = Types::S3ObjectOwner
|
446
460
|
|
461
|
+
S3Retention.add_member(:retain_until_date, Shapes::ShapeRef.new(shape: TimeStamp, location_name: "RetainUntilDate"))
|
462
|
+
S3Retention.add_member(:mode, Shapes::ShapeRef.new(shape: S3ObjectLockRetentionMode, location_name: "Mode"))
|
463
|
+
S3Retention.struct_class = Types::S3Retention
|
464
|
+
|
447
465
|
S3SetObjectAclOperation.add_member(:access_control_policy, Shapes::ShapeRef.new(shape: S3AccessControlPolicy, location_name: "AccessControlPolicy"))
|
448
466
|
S3SetObjectAclOperation.struct_class = Types::S3SetObjectAclOperation
|
449
467
|
|
468
|
+
S3SetObjectLegalHoldOperation.add_member(:legal_hold, Shapes::ShapeRef.new(shape: S3ObjectLockLegalHold, required: true, location_name: "LegalHold"))
|
469
|
+
S3SetObjectLegalHoldOperation.struct_class = Types::S3SetObjectLegalHoldOperation
|
470
|
+
|
471
|
+
S3SetObjectRetentionOperation.add_member(:bypass_governance_retention, Shapes::ShapeRef.new(shape: Boolean, location_name: "BypassGovernanceRetention", metadata: {"box"=>true}))
|
472
|
+
S3SetObjectRetentionOperation.add_member(:retention, Shapes::ShapeRef.new(shape: S3Retention, required: true, location_name: "Retention"))
|
473
|
+
S3SetObjectRetentionOperation.struct_class = Types::S3SetObjectRetentionOperation
|
474
|
+
|
450
475
|
S3SetObjectTaggingOperation.add_member(:tag_set, Shapes::ShapeRef.new(shape: S3TagSet, location_name: "TagSet"))
|
451
476
|
S3SetObjectTaggingOperation.struct_class = Types::S3SetObjectTaggingOperation
|
452
477
|
|
453
|
-
S3Tag.add_member(:key, Shapes::ShapeRef.new(shape:
|
454
|
-
S3Tag.add_member(:value, Shapes::ShapeRef.new(shape:
|
478
|
+
S3Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKeyString, required: true, location_name: "Key"))
|
479
|
+
S3Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValueString, required: true, location_name: "Value"))
|
455
480
|
S3Tag.struct_class = Types::S3Tag
|
456
481
|
|
457
482
|
S3TagSet.member = Shapes::ShapeRef.new(shape: S3Tag)
|
@@ -6,13 +6,7 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::S3Control
|
9
|
-
|
10
|
-
# To create a resource object:
|
11
|
-
# resource = Aws::S3Control::Resource.new(region: 'us-west-2')
|
12
|
-
# You can supply a client object with custom configuration that will be used for all resource operations.
|
13
|
-
# If you do not pass +:client+, a default client will be constructed.
|
14
|
-
# client = Aws::S3Control::Client.new(region: 'us-west-2')
|
15
|
-
# resource = Aws::S3Control::Resource.new(client: client)
|
9
|
+
|
16
10
|
class Resource
|
17
11
|
|
18
12
|
# @param options ({})
|
@@ -16,15 +16,15 @@ module Aws::S3Control
|
|
16
16
|
#
|
17
17
|
# @!attribute [rw] network_origin
|
18
18
|
# Indicates whether this access point allows access from the public
|
19
|
-
#
|
19
|
+
# internet. If `VpcConfiguration` is specified for this access point,
|
20
20
|
# then `NetworkOrigin` is `VPC`, and the access point doesn't allow
|
21
|
-
# access from the public
|
21
|
+
# access from the public internet. Otherwise, `NetworkOrigin` is
|
22
22
|
# `Internet`, and the access point allows access from the public
|
23
|
-
#
|
23
|
+
# internet, subject to the access point and bucket access policies.
|
24
24
|
# @return [String]
|
25
25
|
#
|
26
26
|
# @!attribute [rw] vpc_configuration
|
27
|
-
# The
|
27
|
+
# The virtual private cloud (VPC) configuration for this access point,
|
28
28
|
# if one exists.
|
29
29
|
# @return [Types::VpcConfiguration]
|
30
30
|
#
|
@@ -86,7 +86,7 @@ module Aws::S3Control
|
|
86
86
|
#
|
87
87
|
# @!attribute [rw] vpc_configuration
|
88
88
|
# If you include this field, Amazon S3 restricts access to this access
|
89
|
-
# point to requests from the specified
|
89
|
+
# point to requests from the specified virtual private cloud (VPC).
|
90
90
|
# @return [Types::VpcConfiguration]
|
91
91
|
#
|
92
92
|
# @!attribute [rw] public_access_block_configuration
|
@@ -120,7 +120,7 @@ module Aws::S3Control
|
|
120
120
|
# confirmation_required: false,
|
121
121
|
# operation: { # required
|
122
122
|
# lambda_invoke: {
|
123
|
-
# function_arn: "
|
123
|
+
# function_arn: "FunctionArnString",
|
124
124
|
# },
|
125
125
|
# s3_put_object_copy: {
|
126
126
|
# target_resource: "S3BucketArnString",
|
@@ -154,8 +154,8 @@ module Aws::S3Control
|
|
154
154
|
# },
|
155
155
|
# new_object_tagging: [
|
156
156
|
# {
|
157
|
-
# key: "
|
158
|
-
# value: "
|
157
|
+
# key: "TagKeyString", # required
|
158
|
+
# value: "TagValueString", # required
|
159
159
|
# },
|
160
160
|
# ],
|
161
161
|
# redirect_location: "NonEmptyMaxLength2048String",
|
@@ -192,8 +192,8 @@ module Aws::S3Control
|
|
192
192
|
# s3_put_object_tagging: {
|
193
193
|
# tag_set: [
|
194
194
|
# {
|
195
|
-
# key: "
|
196
|
-
# value: "
|
195
|
+
# key: "TagKeyString", # required
|
196
|
+
# value: "TagValueString", # required
|
197
197
|
# },
|
198
198
|
# ],
|
199
199
|
# },
|
@@ -201,6 +201,18 @@ module Aws::S3Control
|
|
201
201
|
# expiration_in_days: 1,
|
202
202
|
# glacier_job_tier: "BULK", # accepts BULK, STANDARD
|
203
203
|
# },
|
204
|
+
# s3_put_object_legal_hold: {
|
205
|
+
# legal_hold: { # required
|
206
|
+
# status: "OFF", # required, accepts OFF, ON
|
207
|
+
# },
|
208
|
+
# },
|
209
|
+
# s3_put_object_retention: {
|
210
|
+
# bypass_governance_retention: false,
|
211
|
+
# retention: { # required
|
212
|
+
# retain_until_date: Time.now,
|
213
|
+
# mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
|
214
|
+
# },
|
215
|
+
# },
|
204
216
|
# },
|
205
217
|
# report: { # required
|
206
218
|
# bucket: "S3BucketArnString",
|
@@ -226,8 +238,8 @@ module Aws::S3Control
|
|
226
238
|
# role_arn: "IAMRoleArn", # required
|
227
239
|
# tags: [
|
228
240
|
# {
|
229
|
-
# key: "
|
230
|
-
# value: "
|
241
|
+
# key: "TagKeyString", # required
|
242
|
+
# value: "TagValueString", # required
|
231
243
|
# },
|
232
244
|
# ],
|
233
245
|
# }
|
@@ -281,14 +293,14 @@ module Aws::S3Control
|
|
281
293
|
# @return [Integer]
|
282
294
|
#
|
283
295
|
# @!attribute [rw] role_arn
|
284
|
-
# The Amazon Resource Name (ARN) for the Identity and Access
|
285
|
-
# Management (IAM)
|
296
|
+
# The Amazon Resource Name (ARN) for the AWS Identity and Access
|
297
|
+
# Management (IAM) role that Batch Operations will use to execute this
|
286
298
|
# job's operation on each object in the manifest.
|
287
299
|
# @return [String]
|
288
300
|
#
|
289
301
|
# @!attribute [rw] tags
|
290
|
-
#
|
291
|
-
#
|
302
|
+
# A set of tags to associate with the Amazon S3 Batch Operations job.
|
303
|
+
# This is an optional parameter.
|
292
304
|
# @return [Array<Types::S3Tag>]
|
293
305
|
#
|
294
306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJobRequest AWS API Documentation
|
@@ -376,12 +388,13 @@ module Aws::S3Control
|
|
376
388
|
# }
|
377
389
|
#
|
378
390
|
# @!attribute [rw] account_id
|
379
|
-
# The account ID
|
380
|
-
#
|
391
|
+
# The AWS account ID associated with the Amazon S3 Batch Operations
|
392
|
+
# job.
|
381
393
|
# @return [String]
|
382
394
|
#
|
383
395
|
# @!attribute [rw] job_id
|
384
|
-
# The ID for the job whose tags you want to
|
396
|
+
# The ID for the Amazon S3 Batch Operations job whose tags you want to
|
397
|
+
# delete.
|
385
398
|
# @return [String]
|
386
399
|
#
|
387
400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteJobTaggingRequest AWS API Documentation
|
@@ -556,15 +569,15 @@ module Aws::S3Control
|
|
556
569
|
#
|
557
570
|
# @!attribute [rw] network_origin
|
558
571
|
# Indicates whether this access point allows access from the public
|
559
|
-
#
|
572
|
+
# internet. If `VpcConfiguration` is specified for this access point,
|
560
573
|
# then `NetworkOrigin` is `VPC`, and the access point doesn't allow
|
561
|
-
# access from the public
|
574
|
+
# access from the public internet. Otherwise, `NetworkOrigin` is
|
562
575
|
# `Internet`, and the access point allows access from the public
|
563
|
-
#
|
576
|
+
# internet, subject to the access point and bucket access policies.
|
564
577
|
# @return [String]
|
565
578
|
#
|
566
579
|
# @!attribute [rw] vpc_configuration
|
567
|
-
# Contains the
|
580
|
+
# Contains the virtual private cloud (VPC) configuration for the
|
568
581
|
# specified access point.
|
569
582
|
# @return [Types::VpcConfiguration]
|
570
583
|
#
|
@@ -605,12 +618,13 @@ module Aws::S3Control
|
|
605
618
|
# }
|
606
619
|
#
|
607
620
|
# @!attribute [rw] account_id
|
608
|
-
# The account ID
|
609
|
-
#
|
621
|
+
# The AWS account ID associated with the Amazon S3 Batch Operations
|
622
|
+
# job.
|
610
623
|
# @return [String]
|
611
624
|
#
|
612
625
|
# @!attribute [rw] job_id
|
613
|
-
# The ID for the job whose tags you want to
|
626
|
+
# The ID for the Amazon S3 Batch Operations job whose tags you want to
|
627
|
+
# retrieve.
|
614
628
|
# @return [String]
|
615
629
|
#
|
616
630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetJobTaggingRequest AWS API Documentation
|
@@ -622,7 +636,7 @@ module Aws::S3Control
|
|
622
636
|
end
|
623
637
|
|
624
638
|
# @!attribute [rw] tags
|
625
|
-
# The set of tags associated with the job.
|
639
|
+
# The set of tags associated with the Amazon S3 Batch Operations job.
|
626
640
|
# @return [Array<Types::S3Tag>]
|
627
641
|
#
|
628
642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetJobTaggingResult AWS API Documentation
|
@@ -773,8 +787,8 @@ module Aws::S3Control
|
|
773
787
|
# @return [Time]
|
774
788
|
#
|
775
789
|
# @!attribute [rw] role_arn
|
776
|
-
# The Amazon Resource Name (ARN) for the Identity and Access
|
777
|
-
# Management (IAM)
|
790
|
+
# The Amazon Resource Name (ARN) for the AWS Identity and Access
|
791
|
+
# Management (IAM) role assigned to execute the tasks for this job.
|
778
792
|
# @return [String]
|
779
793
|
#
|
780
794
|
# @!attribute [rw] suspended_date
|
@@ -998,7 +1012,7 @@ module Aws::S3Control
|
|
998
1012
|
#
|
999
1013
|
# {
|
1000
1014
|
# lambda_invoke: {
|
1001
|
-
# function_arn: "
|
1015
|
+
# function_arn: "FunctionArnString",
|
1002
1016
|
# },
|
1003
1017
|
# s3_put_object_copy: {
|
1004
1018
|
# target_resource: "S3BucketArnString",
|
@@ -1032,8 +1046,8 @@ module Aws::S3Control
|
|
1032
1046
|
# },
|
1033
1047
|
# new_object_tagging: [
|
1034
1048
|
# {
|
1035
|
-
# key: "
|
1036
|
-
# value: "
|
1049
|
+
# key: "TagKeyString", # required
|
1050
|
+
# value: "TagValueString", # required
|
1037
1051
|
# },
|
1038
1052
|
# ],
|
1039
1053
|
# redirect_location: "NonEmptyMaxLength2048String",
|
@@ -1070,8 +1084,8 @@ module Aws::S3Control
|
|
1070
1084
|
# s3_put_object_tagging: {
|
1071
1085
|
# tag_set: [
|
1072
1086
|
# {
|
1073
|
-
# key: "
|
1074
|
-
# value: "
|
1087
|
+
# key: "TagKeyString", # required
|
1088
|
+
# value: "TagValueString", # required
|
1075
1089
|
# },
|
1076
1090
|
# ],
|
1077
1091
|
# },
|
@@ -1079,6 +1093,18 @@ module Aws::S3Control
|
|
1079
1093
|
# expiration_in_days: 1,
|
1080
1094
|
# glacier_job_tier: "BULK", # accepts BULK, STANDARD
|
1081
1095
|
# },
|
1096
|
+
# s3_put_object_legal_hold: {
|
1097
|
+
# legal_hold: { # required
|
1098
|
+
# status: "OFF", # required, accepts OFF, ON
|
1099
|
+
# },
|
1100
|
+
# },
|
1101
|
+
# s3_put_object_retention: {
|
1102
|
+
# bypass_governance_retention: false,
|
1103
|
+
# retention: { # required
|
1104
|
+
# retain_until_date: Time.now,
|
1105
|
+
# mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
|
1106
|
+
# },
|
1107
|
+
# },
|
1082
1108
|
# }
|
1083
1109
|
#
|
1084
1110
|
# @!attribute [rw] lambda_invoke
|
@@ -1106,6 +1132,28 @@ module Aws::S3Control
|
|
1106
1132
|
# call on each object in the manifest.
|
1107
1133
|
# @return [Types::S3InitiateRestoreObjectOperation]
|
1108
1134
|
#
|
1135
|
+
# @!attribute [rw] s3_put_object_legal_hold
|
1136
|
+
# Contains the configuration parameters for a Set Object Legal Hold
|
1137
|
+
# operation. Amazon S3 Batch Operations passes each value through to
|
1138
|
+
# the underlying PUT Object Legal Hold API. For more information about
|
1139
|
+
# the parameters for this operation, see [PUT Object Legal Hold][1].
|
1140
|
+
#
|
1141
|
+
#
|
1142
|
+
#
|
1143
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.htmll#object-lock-legal-holds
|
1144
|
+
# @return [Types::S3SetObjectLegalHoldOperation]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] s3_put_object_retention
|
1147
|
+
# Contains the configuration parameters for a Set Object Retention
|
1148
|
+
# operation. Amazon S3 Batch Operations passes each value through to
|
1149
|
+
# the underlying PUT Object Retention API. For more information about
|
1150
|
+
# the parameters for this operation, see [PUT Object Retention][1].
|
1151
|
+
#
|
1152
|
+
#
|
1153
|
+
#
|
1154
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes
|
1155
|
+
# @return [Types::S3SetObjectRetentionOperation]
|
1156
|
+
#
|
1109
1157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/JobOperation AWS API Documentation
|
1110
1158
|
#
|
1111
1159
|
class JobOperation < Struct.new(
|
@@ -1113,7 +1161,9 @@ module Aws::S3Control
|
|
1113
1161
|
:s3_put_object_copy,
|
1114
1162
|
:s3_put_object_acl,
|
1115
1163
|
:s3_put_object_tagging,
|
1116
|
-
:s3_initiate_restore_object
|
1164
|
+
:s3_initiate_restore_object,
|
1165
|
+
:s3_put_object_legal_hold,
|
1166
|
+
:s3_put_object_retention)
|
1117
1167
|
include Aws::Structure
|
1118
1168
|
end
|
1119
1169
|
|
@@ -1205,7 +1255,7 @@ module Aws::S3Control
|
|
1205
1255
|
# data as a hash:
|
1206
1256
|
#
|
1207
1257
|
# {
|
1208
|
-
# function_arn: "
|
1258
|
+
# function_arn: "FunctionArnString",
|
1209
1259
|
# }
|
1210
1260
|
#
|
1211
1261
|
# @!attribute [rw] function_arn
|
@@ -1291,7 +1341,7 @@ module Aws::S3Control
|
|
1291
1341
|
# {
|
1292
1342
|
# account_id: "AccountId", # required
|
1293
1343
|
# job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
|
1294
|
-
# next_token: "
|
1344
|
+
# next_token: "StringForNextToken",
|
1295
1345
|
# max_results: 1,
|
1296
1346
|
# }
|
1297
1347
|
#
|
@@ -1511,23 +1561,25 @@ module Aws::S3Control
|
|
1511
1561
|
# job_id: "JobId", # required
|
1512
1562
|
# tags: [ # required
|
1513
1563
|
# {
|
1514
|
-
# key: "
|
1515
|
-
# value: "
|
1564
|
+
# key: "TagKeyString", # required
|
1565
|
+
# value: "TagValueString", # required
|
1516
1566
|
# },
|
1517
1567
|
# ],
|
1518
1568
|
# }
|
1519
1569
|
#
|
1520
1570
|
# @!attribute [rw] account_id
|
1521
|
-
# The account ID
|
1522
|
-
#
|
1571
|
+
# The AWS account ID associated with the Amazon S3 Batch Operations
|
1572
|
+
# job.
|
1523
1573
|
# @return [String]
|
1524
1574
|
#
|
1525
1575
|
# @!attribute [rw] job_id
|
1526
|
-
# The ID for the job whose tags you want to
|
1576
|
+
# The ID for the Amazon S3 Batch Operations job whose tags you want to
|
1577
|
+
# replace.
|
1527
1578
|
# @return [String]
|
1528
1579
|
#
|
1529
1580
|
# @!attribute [rw] tags
|
1530
|
-
# The set of tags to associate with the
|
1581
|
+
# The set of tags to associate with the Amazon S3 Batch Operations
|
1582
|
+
# job.
|
1531
1583
|
# @return [Array<Types::S3Tag>]
|
1532
1584
|
#
|
1533
1585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutJobTaggingRequest AWS API Documentation
|
@@ -1646,7 +1698,7 @@ module Aws::S3Control
|
|
1646
1698
|
end
|
1647
1699
|
|
1648
1700
|
# Contains the configuration parameters for a PUT Copy object operation.
|
1649
|
-
# Amazon S3
|
1701
|
+
# Amazon S3 Batch Operations passes each value through to the underlying
|
1650
1702
|
# PUT Copy object API. For more information about the parameters for
|
1651
1703
|
# this operation, see [PUT Object - Copy][1].
|
1652
1704
|
#
|
@@ -1689,8 +1741,8 @@ module Aws::S3Control
|
|
1689
1741
|
# },
|
1690
1742
|
# new_object_tagging: [
|
1691
1743
|
# {
|
1692
|
-
# key: "
|
1693
|
-
# value: "
|
1744
|
+
# key: "TagKeyString", # required
|
1745
|
+
# value: "TagValueString", # required
|
1694
1746
|
# },
|
1695
1747
|
# ],
|
1696
1748
|
# redirect_location: "NonEmptyMaxLength2048String",
|
@@ -1744,12 +1796,18 @@ module Aws::S3Control
|
|
1744
1796
|
# @return [String]
|
1745
1797
|
#
|
1746
1798
|
# @!attribute [rw] object_lock_legal_hold_status
|
1799
|
+
# The Legal Hold status to be applied to all objects in the Batch
|
1800
|
+
# Operations job.
|
1747
1801
|
# @return [String]
|
1748
1802
|
#
|
1749
1803
|
# @!attribute [rw] object_lock_mode
|
1804
|
+
# The Retention mode to be applied to all objects in the Batch
|
1805
|
+
# Operations job.
|
1750
1806
|
# @return [String]
|
1751
1807
|
#
|
1752
1808
|
# @!attribute [rw] object_lock_retain_until_date
|
1809
|
+
# The date when the applied Object Retention configuration will expire
|
1810
|
+
# on all objects in the Batch Operations job.
|
1753
1811
|
# @return [Time]
|
1754
1812
|
#
|
1755
1813
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3CopyObjectOperation AWS API Documentation
|
@@ -1828,7 +1886,7 @@ module Aws::S3Control
|
|
1828
1886
|
end
|
1829
1887
|
|
1830
1888
|
# Contains the configuration parameters for an Initiate Glacier Restore
|
1831
|
-
# job. Amazon S3
|
1889
|
+
# job. Amazon S3 Batch Operations passes each value through to the
|
1832
1890
|
# underlying POST Object restore API. For more information about the
|
1833
1891
|
# parameters for this operation, see [Restoring Archives][1].
|
1834
1892
|
#
|
@@ -1858,6 +1916,25 @@ module Aws::S3Control
|
|
1858
1916
|
include Aws::Structure
|
1859
1917
|
end
|
1860
1918
|
|
1919
|
+
# @note When making an API call, you may pass S3ObjectLockLegalHold
|
1920
|
+
# data as a hash:
|
1921
|
+
#
|
1922
|
+
# {
|
1923
|
+
# status: "OFF", # required, accepts OFF, ON
|
1924
|
+
# }
|
1925
|
+
#
|
1926
|
+
# @!attribute [rw] status
|
1927
|
+
# The Legal Hold status to be applied to all objects in the Batch
|
1928
|
+
# Operations job.
|
1929
|
+
# @return [String]
|
1930
|
+
#
|
1931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3ObjectLockLegalHold AWS API Documentation
|
1932
|
+
#
|
1933
|
+
class S3ObjectLockLegalHold < Struct.new(
|
1934
|
+
:status)
|
1935
|
+
include Aws::Structure
|
1936
|
+
end
|
1937
|
+
|
1861
1938
|
# @note When making an API call, you may pass S3ObjectMetadata
|
1862
1939
|
# data as a hash:
|
1863
1940
|
#
|
@@ -1949,8 +2026,34 @@ module Aws::S3Control
|
|
1949
2026
|
include Aws::Structure
|
1950
2027
|
end
|
1951
2028
|
|
2029
|
+
# @note When making an API call, you may pass S3Retention
|
2030
|
+
# data as a hash:
|
2031
|
+
#
|
2032
|
+
# {
|
2033
|
+
# retain_until_date: Time.now,
|
2034
|
+
# mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
|
2035
|
+
# }
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] retain_until_date
|
2038
|
+
# The date when the applied Object Retention will expire on all
|
2039
|
+
# objects in the Batch Operations job.
|
2040
|
+
# @return [Time]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] mode
|
2043
|
+
# The Retention mode to be applied to all objects in the Batch
|
2044
|
+
# Operations job.
|
2045
|
+
# @return [String]
|
2046
|
+
#
|
2047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3Retention AWS API Documentation
|
2048
|
+
#
|
2049
|
+
class S3Retention < Struct.new(
|
2050
|
+
:retain_until_date,
|
2051
|
+
:mode)
|
2052
|
+
include Aws::Structure
|
2053
|
+
end
|
2054
|
+
|
1952
2055
|
# Contains the configuration parameters for a Set Object ACL operation.
|
1953
|
-
# Amazon S3
|
2056
|
+
# Amazon S3 Batch Operations passes each value through to the underlying
|
1954
2057
|
# PUT Object acl API. For more information about the parameters for this
|
1955
2058
|
# operation, see [PUT Object acl][1].
|
1956
2059
|
#
|
@@ -1993,8 +2096,77 @@ module Aws::S3Control
|
|
1993
2096
|
include Aws::Structure
|
1994
2097
|
end
|
1995
2098
|
|
2099
|
+
# Contains the configuration parameters for a Set Object Legal Hold
|
2100
|
+
# operation. Amazon S3 Batch Operations passes each value through to the
|
2101
|
+
# underlying PUT Object Legal Hold API. For more information about the
|
2102
|
+
# parameters for this operation, see [PUT Object Legal Hold][1].
|
2103
|
+
#
|
2104
|
+
#
|
2105
|
+
#
|
2106
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.htmll#object-lock-legal-holds
|
2107
|
+
#
|
2108
|
+
# @note When making an API call, you may pass S3SetObjectLegalHoldOperation
|
2109
|
+
# data as a hash:
|
2110
|
+
#
|
2111
|
+
# {
|
2112
|
+
# legal_hold: { # required
|
2113
|
+
# status: "OFF", # required, accepts OFF, ON
|
2114
|
+
# },
|
2115
|
+
# }
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] legal_hold
|
2118
|
+
# The Legal Hold contains the status to be applied to all objects in
|
2119
|
+
# the Batch Operations job.
|
2120
|
+
# @return [Types::S3ObjectLockLegalHold]
|
2121
|
+
#
|
2122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3SetObjectLegalHoldOperation AWS API Documentation
|
2123
|
+
#
|
2124
|
+
class S3SetObjectLegalHoldOperation < Struct.new(
|
2125
|
+
:legal_hold)
|
2126
|
+
include Aws::Structure
|
2127
|
+
end
|
2128
|
+
|
2129
|
+
# Contains the configuration parameters for a Set Object Retention
|
2130
|
+
# operation. Amazon S3 Batch Operations passes each value through to the
|
2131
|
+
# underlying PUT Object Retention API. For more information about the
|
2132
|
+
# parameters for this operation, see [PUT Object Retention][1].
|
2133
|
+
#
|
2134
|
+
#
|
2135
|
+
#
|
2136
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes
|
2137
|
+
#
|
2138
|
+
# @note When making an API call, you may pass S3SetObjectRetentionOperation
|
2139
|
+
# data as a hash:
|
2140
|
+
#
|
2141
|
+
# {
|
2142
|
+
# bypass_governance_retention: false,
|
2143
|
+
# retention: { # required
|
2144
|
+
# retain_until_date: Time.now,
|
2145
|
+
# mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
|
2146
|
+
# },
|
2147
|
+
# }
|
2148
|
+
#
|
2149
|
+
# @!attribute [rw] bypass_governance_retention
|
2150
|
+
# Indicates if the operation should be applied to objects in the Batch
|
2151
|
+
# Operations job even if they have Governance-type Object Lock in
|
2152
|
+
# place.
|
2153
|
+
# @return [Boolean]
|
2154
|
+
#
|
2155
|
+
# @!attribute [rw] retention
|
2156
|
+
# Amazon S3 object lock Retention contains the retention mode to be
|
2157
|
+
# applied to all objects in the Batch Operations job.
|
2158
|
+
# @return [Types::S3Retention]
|
2159
|
+
#
|
2160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3SetObjectRetentionOperation AWS API Documentation
|
2161
|
+
#
|
2162
|
+
class S3SetObjectRetentionOperation < Struct.new(
|
2163
|
+
:bypass_governance_retention,
|
2164
|
+
:retention)
|
2165
|
+
include Aws::Structure
|
2166
|
+
end
|
2167
|
+
|
1996
2168
|
# Contains the configuration parameters for a Set Object Tagging
|
1997
|
-
# operation. Amazon S3
|
2169
|
+
# operation. Amazon S3 Batch Operations passes each value through to the
|
1998
2170
|
# underlying PUT Object tagging API. For more information about the
|
1999
2171
|
# parameters for this operation, see [PUT Object tagging][1].
|
2000
2172
|
#
|
@@ -2008,8 +2180,8 @@ module Aws::S3Control
|
|
2008
2180
|
# {
|
2009
2181
|
# tag_set: [
|
2010
2182
|
# {
|
2011
|
-
# key: "
|
2012
|
-
# value: "
|
2183
|
+
# key: "TagKeyString", # required
|
2184
|
+
# value: "TagValueString", # required
|
2013
2185
|
# },
|
2014
2186
|
# ],
|
2015
2187
|
# }
|
@@ -2028,8 +2200,8 @@ module Aws::S3Control
|
|
2028
2200
|
# data as a hash:
|
2029
2201
|
#
|
2030
2202
|
# {
|
2031
|
-
# key: "
|
2032
|
-
# value: "
|
2203
|
+
# key: "TagKeyString", # required
|
2204
|
+
# value: "TagValueString", # required
|
2033
2205
|
# }
|
2034
2206
|
#
|
2035
2207
|
# @!attribute [rw] key
|
@@ -2169,7 +2341,7 @@ module Aws::S3Control
|
|
2169
2341
|
include Aws::Structure
|
2170
2342
|
end
|
2171
2343
|
|
2172
|
-
# The
|
2344
|
+
# The virtual private cloud (VPC) configuration for an access point.
|
2173
2345
|
#
|
2174
2346
|
# @note When making an API call, you may pass VpcConfiguration
|
2175
2347
|
# data as a hash:
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-s3control
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.17.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-05-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sigv4
|
@@ -84,7 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
84
84
|
- !ruby/object:Gem::Version
|
85
85
|
version: '0'
|
86
86
|
requirements: []
|
87
|
-
|
87
|
+
rubyforge_project:
|
88
|
+
rubygems_version: 2.7.6.2
|
88
89
|
signing_key:
|
89
90
|
specification_version: 4
|
90
91
|
summary: AWS SDK for Ruby - AWS S3 Control
|