aws-sdk-s3control 1.13.0 → 1.19.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 63c2e799313657facbad2dd52c76fea3be8c39f5
4
- data.tar.gz: 8c24ad8a37649e88ec1033a6cfc058898f6b778e
2
+ SHA256:
3
+ metadata.gz: ef14b068e46c65dcac89cc4f4f56fd33a88226a856748601e4bb8e552c47145d
4
+ data.tar.gz: de128a6e4522186a802c32832234ccb4df33ba848e2e4038c36df857221c8e08
5
5
  SHA512:
6
- metadata.gz: 52ac47e995e015c691a8ea5837e70798029cf516ad943d74d64cbaac9b8c895153c91b721bf306ec95d3a2600c1bcf991faab80f616a697be93fb2a084e9444d
7
- data.tar.gz: c2e5651c8e6e534ac062a72182cdc8e4fbabc4ed01b0bf2f3346cc4769a04058224e9281b1480c2dc715ba5307ab0dad5a939c9c54800fa3ce3ae1a5a9dab0b6
6
+ metadata.gz: 32f03550593b6849d99201cebb8946cb465752ac7aa60807b806659ff760b528318c1e8c87c8edaca3b6fe662f2861eec0d79a3b007402325ff6e57d8e64c6ed
7
+ data.tar.gz: b92f3f07bc811f044fe1a04ff9c52306d26ed49c9513ccabd8fa34df47ebe40eb9f44351248c4b1d8cfc158ee5d981d979d66243c678e460167922e9e75e44cb
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-s3control/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # s3_control = Aws::S3Control::Client.new
28
+ # resp = s3_control.create_access_point(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS S3 Control all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS S3 Control are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::S3Control::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS S3 Control API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-s3control/customizations'
42
45
  # @service
43
46
  module Aws::S3Control
44
47
 
45
- GEM_VERSION = '1.13.0'
48
+ GEM_VERSION = '1.19.0'
46
49
 
47
50
  end
@@ -33,6 +33,18 @@ require 'aws-sdk-s3control/plugins/s3_host_id.rb'
33
33
  Aws::Plugins::GlobalConfiguration.add_identifier(:s3control)
34
34
 
35
35
  module Aws::S3Control
36
+ # An API client for S3Control. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::S3Control::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
36
48
  class Client < Seahorse::Client::Base
37
49
 
38
50
  include Aws::ClientStubs
@@ -99,7 +111,7 @@ module Aws::S3Control
99
111
  # @option options [required, String] :region
100
112
  # The AWS region to connect to. The configured `:region` is
101
113
  # used to determine the service `:endpoint`. When not passed,
102
- # a default `:region` is search for in the following locations:
114
+ # a default `:region` is searched for in the following locations:
103
115
  #
104
116
  # * `Aws.config[:region]`
105
117
  # * `ENV['AWS_REGION']`
@@ -114,6 +126,12 @@ module Aws::S3Control
114
126
  # When set to `true`, a thread polling for endpoints will be running in
115
127
  # the background every 60 secs (default). Defaults to `false`.
116
128
  #
129
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
130
+ # Used only in `adaptive` retry mode. When true, the request will sleep
131
+ # until there is sufficent client side capacity to retry the request.
132
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
133
+ # not retry instead of sleeping.
134
+ #
117
135
  # @option options [Boolean] :client_side_monitoring (false)
118
136
  # When `true`, client-side metrics will be collected for all API requests from
119
137
  # this client.
@@ -138,6 +156,10 @@ module Aws::S3Control
138
156
  # When `true`, an attempt is made to coerce request parameters into
139
157
  # the required types.
140
158
  #
159
+ # @option options [Boolean] :correct_clock_skew (true)
160
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
161
+ # a clock skew correction and retry requests with skewed client clocks.
162
+ #
141
163
  # @option options [Boolean] :disable_host_prefix_injection (false)
142
164
  # Set to true to disable SDK automatically adding host prefix
143
165
  # to default service endpoint when available.
@@ -145,7 +167,7 @@ module Aws::S3Control
145
167
  # @option options [String] :endpoint
146
168
  # The client endpoint is normally constructed from the `:region`
147
169
  # option. You should only configure an `:endpoint` when connecting
148
- # to test endpoints. This should be avalid HTTP(S) URI.
170
+ # to test endpoints. This should be a valid HTTP(S) URI.
149
171
  #
150
172
  # @option options [Integer] :endpoint_cache_max_entries (1000)
151
173
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -160,7 +182,7 @@ module Aws::S3Control
160
182
  # requests fetching endpoints information. Defaults to 60 sec.
161
183
  #
162
184
  # @option options [Boolean] :endpoint_discovery (false)
163
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
185
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
164
186
  #
165
187
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
166
188
  # The log formatter.
@@ -172,15 +194,29 @@ module Aws::S3Control
172
194
  # The Logger instance to send log messages to. If this option
173
195
  # is not set, logging will be disabled.
174
196
  #
197
+ # @option options [Integer] :max_attempts (3)
198
+ # An integer representing the maximum number attempts that will be made for
199
+ # a single request, including the initial attempt. For example,
200
+ # setting this value to 5 will result in a request being retried up to
201
+ # 4 times. Used in `standard` and `adaptive` retry modes.
202
+ #
175
203
  # @option options [String] :profile ("default")
176
204
  # Used when loading credentials from the shared credentials file
177
205
  # at HOME/.aws/credentials. When not specified, 'default' is used.
178
206
  #
207
+ # @option options [Proc] :retry_backoff
208
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
209
+ # This option is only used in the `legacy` retry mode.
210
+ #
179
211
  # @option options [Float] :retry_base_delay (0.3)
180
- # The base delay in seconds used by the default backoff function.
212
+ # The base delay in seconds used by the default backoff function. This option
213
+ # is only used in the `legacy` retry mode.
181
214
  #
182
215
  # @option options [Symbol] :retry_jitter (:none)
183
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
216
+ # A delay randomiser function used by the default backoff function.
217
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
218
+ # otherwise a Proc that takes and returns a number. This option is only used
219
+ # in the `legacy` retry mode.
184
220
  #
185
221
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
186
222
  #
@@ -188,11 +224,30 @@ module Aws::S3Control
188
224
  # The maximum number of times to retry failed requests. Only
189
225
  # ~ 500 level server errors and certain ~ 400 level client errors
190
226
  # are retried. Generally, these are throttling errors, data
191
- # checksum errors, networking errors, timeout errors and auth
192
- # errors from expired credentials.
227
+ # checksum errors, networking errors, timeout errors, auth errors,
228
+ # endpoint discovery, and errors from expired credentials.
229
+ # This option is only used in the `legacy` retry mode.
193
230
  #
194
231
  # @option options [Integer] :retry_max_delay (0)
195
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
232
+ # The maximum number of seconds to delay between retries (0 for no limit)
233
+ # used by the default backoff function. This option is only used in the
234
+ # `legacy` retry mode.
235
+ #
236
+ # @option options [String] :retry_mode ("legacy")
237
+ # Specifies which retry algorithm to use. Values are:
238
+ #
239
+ # * `legacy` - The pre-existing retry behavior. This is default value if
240
+ # no retry mode is provided.
241
+ #
242
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
243
+ # This includes support for retry quotas, which limit the number of
244
+ # unsuccessful retries a client can make.
245
+ #
246
+ # * `adaptive` - An experimental retry mode that includes all the
247
+ # functionality of `standard` mode along with automatic client side
248
+ # throttling. This is a provisional mode that may change behavior
249
+ # in the future.
250
+ #
196
251
  #
197
252
  # @option options [String] :secret_access_key
198
253
  #
@@ -219,16 +274,15 @@ module Aws::S3Control
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::S3Control
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -264,7 +318,81 @@ module Aws::S3Control
264
318
 
265
319
  # @!group API Operations
266
320
 
267
- # Creates an Amazon S3 batch operations job.
321
+ # Creates an access point and associates it with the specified bucket.
322
+ #
323
+ # @option params [required, String] :account_id
324
+ # The AWS account ID for the owner of the bucket for which you want to
325
+ # create an access point.
326
+ #
327
+ # @option params [required, String] :name
328
+ # The name you want to assign to this access point.
329
+ #
330
+ # @option params [required, String] :bucket
331
+ # The name of the bucket that you want to associate this access point
332
+ # with.
333
+ #
334
+ # @option params [Types::VpcConfiguration] :vpc_configuration
335
+ # If you include this field, Amazon S3 restricts access to this access
336
+ # point to requests from the specified virtual private cloud (VPC).
337
+ #
338
+ # @option params [Types::PublicAccessBlockConfiguration] :public_access_block_configuration
339
+ # The `PublicAccessBlock` configuration that you want to apply to this
340
+ # Amazon S3 bucket. You can enable the configuration options in any
341
+ # combination. For more information about when Amazon S3 considers a
342
+ # bucket or object public, see [The Meaning of "Public"][1] in the
343
+ # Amazon Simple Storage Service Developer Guide.
344
+ #
345
+ #
346
+ #
347
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
348
+ #
349
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
350
+ #
351
+ # @example Request syntax with placeholder values
352
+ #
353
+ # resp = client.create_access_point({
354
+ # account_id: "AccountId", # required
355
+ # name: "AccessPointName", # required
356
+ # bucket: "BucketName", # required
357
+ # vpc_configuration: {
358
+ # vpc_id: "VpcId", # required
359
+ # },
360
+ # public_access_block_configuration: {
361
+ # block_public_acls: false,
362
+ # ignore_public_acls: false,
363
+ # block_public_policy: false,
364
+ # restrict_public_buckets: false,
365
+ # },
366
+ # })
367
+ #
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateAccessPoint AWS API Documentation
369
+ #
370
+ # @overload create_access_point(params = {})
371
+ # @param [Hash] params ({})
372
+ def create_access_point(params = {}, options = {})
373
+ req = build_request(:create_access_point, params)
374
+ req.send_request(options)
375
+ end
376
+
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
268
396
  #
269
397
  # @option params [required, String] :account_id
270
398
  #
@@ -306,9 +434,13 @@ module Aws::S3Control
306
434
  # priority.
307
435
  #
308
436
  # @option params [required, String] :role_arn
309
- # The Amazon Resource Name (ARN) for the Identity and Access Management
310
- # (IAM) Role that batch operations will use to execute this job's
311
- # 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.
440
+ #
441
+ # @option params [Array<Types::S3Tag>] :tags
442
+ # A set of tags to associate with the Amazon S3 Batch Operations job.
443
+ # This is an optional parameter.
312
444
  #
313
445
  # @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
314
446
  #
@@ -321,7 +453,7 @@ module Aws::S3Control
321
453
  # confirmation_required: false,
322
454
  # operation: { # required
323
455
  # lambda_invoke: {
324
- # function_arn: "NonEmptyMaxLength1024String",
456
+ # function_arn: "FunctionArnString",
325
457
  # },
326
458
  # s3_put_object_copy: {
327
459
  # target_resource: "S3BucketArnString",
@@ -355,8 +487,8 @@ module Aws::S3Control
355
487
  # },
356
488
  # new_object_tagging: [
357
489
  # {
358
- # key: "NonEmptyMaxLength1024String", # required
359
- # value: "MaxLength1024String", # required
490
+ # key: "TagKeyString", # required
491
+ # value: "TagValueString", # required
360
492
  # },
361
493
  # ],
362
494
  # redirect_location: "NonEmptyMaxLength2048String",
@@ -393,8 +525,8 @@ module Aws::S3Control
393
525
  # s3_put_object_tagging: {
394
526
  # tag_set: [
395
527
  # {
396
- # key: "NonEmptyMaxLength1024String", # required
397
- # value: "MaxLength1024String", # required
528
+ # key: "TagKeyString", # required
529
+ # value: "TagValueString", # required
398
530
  # },
399
531
  # ],
400
532
  # },
@@ -402,6 +534,18 @@ module Aws::S3Control
402
534
  # expiration_in_days: 1,
403
535
  # glacier_job_tier: "BULK", # accepts BULK, STANDARD
404
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
+ # },
405
549
  # },
406
550
  # report: { # required
407
551
  # bucket: "S3BucketArnString",
@@ -425,6 +569,12 @@ module Aws::S3Control
425
569
  # description: "NonEmptyMaxLength256String",
426
570
  # priority: 1, # required
427
571
  # role_arn: "IAMRoleArn", # required
572
+ # tags: [
573
+ # {
574
+ # key: "TagKeyString", # required
575
+ # value: "TagValueString", # required
576
+ # },
577
+ # ],
428
578
  # })
429
579
  #
430
580
  # @example Response structure
@@ -440,12 +590,109 @@ module Aws::S3Control
440
590
  req.send_request(options)
441
591
  end
442
592
 
443
- # Deletes the block public access configuration for the specified
444
- # account.
593
+ # Deletes the specified access point.
594
+ #
595
+ # @option params [required, String] :account_id
596
+ # The account ID for the account that owns the specified access point.
597
+ #
598
+ # @option params [required, String] :name
599
+ # The name of the access point you want to delete.
600
+ #
601
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
602
+ #
603
+ # @example Request syntax with placeholder values
604
+ #
605
+ # resp = client.delete_access_point({
606
+ # account_id: "AccountId", # required
607
+ # name: "AccessPointName", # required
608
+ # })
609
+ #
610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPoint AWS API Documentation
611
+ #
612
+ # @overload delete_access_point(params = {})
613
+ # @param [Hash] params ({})
614
+ def delete_access_point(params = {}, options = {})
615
+ req = build_request(:delete_access_point, params)
616
+ req.send_request(options)
617
+ end
618
+
619
+ # Deletes the access point policy for the specified access point.
445
620
  #
446
621
  # @option params [required, String] :account_id
447
- # The account ID for the AWS account whose block public access
448
- # configuration you want to delete.
622
+ # The account ID for the account that owns the specified access point.
623
+ #
624
+ # @option params [required, String] :name
625
+ # The name of the access point whose policy you want to delete.
626
+ #
627
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
628
+ #
629
+ # @example Request syntax with placeholder values
630
+ #
631
+ # resp = client.delete_access_point_policy({
632
+ # account_id: "AccountId", # required
633
+ # name: "AccessPointName", # required
634
+ # })
635
+ #
636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteAccessPointPolicy AWS API Documentation
637
+ #
638
+ # @overload delete_access_point_policy(params = {})
639
+ # @param [Hash] params ({})
640
+ def delete_access_point_policy(params = {}, options = {})
641
+ req = build_request(:delete_access_point_policy, params)
642
+ req.send_request(options)
643
+ end
644
+
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
664
+ #
665
+ # @option params [required, String] :account_id
666
+ # The AWS account ID associated with the Amazon S3 Batch Operations job.
667
+ #
668
+ # @option params [required, String] :job_id
669
+ # The ID for the Amazon S3 Batch Operations job whose tags you want to
670
+ # delete.
671
+ #
672
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
673
+ #
674
+ # @example Request syntax with placeholder values
675
+ #
676
+ # resp = client.delete_job_tagging({
677
+ # account_id: "AccountId", # required
678
+ # job_id: "JobId", # required
679
+ # })
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeleteJobTagging AWS API Documentation
682
+ #
683
+ # @overload delete_job_tagging(params = {})
684
+ # @param [Hash] params ({})
685
+ def delete_job_tagging(params = {}, options = {})
686
+ req = build_request(:delete_job_tagging, params)
687
+ req.send_request(options)
688
+ end
689
+
690
+ # Removes the `PublicAccessBlock` configuration for an Amazon Web
691
+ # Services account.
692
+ #
693
+ # @option params [required, String] :account_id
694
+ # The account ID for the Amazon Web Services account whose
695
+ # `PublicAccessBlock` configuration you want to remove.
449
696
  #
450
697
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
451
698
  #
@@ -464,8 +711,25 @@ module Aws::S3Control
464
711
  req.send_request(options)
465
712
  end
466
713
 
467
- # Retrieves the configuration parameters and status for a batch
468
- # operations job.
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
469
733
  #
470
734
  # @option params [required, String] :account_id
471
735
  #
@@ -543,6 +807,10 @@ module Aws::S3Control
543
807
  # resp.job.operation.s3_put_object_tagging.tag_set[0].value #=> String
544
808
  # resp.job.operation.s3_initiate_restore_object.expiration_in_days #=> Integer
545
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"
546
814
  # resp.job.priority #=> Integer
547
815
  # resp.job.progress_summary.total_number_of_tasks #=> Integer
548
816
  # resp.job.progress_summary.number_of_tasks_succeeded #=> Integer
@@ -571,7 +839,182 @@ module Aws::S3Control
571
839
  req.send_request(options)
572
840
  end
573
841
 
842
+ # Returns configuration information about the specified access point.
843
+ #
844
+ # @option params [required, String] :account_id
845
+ # The account ID for the account that owns the specified access point.
846
+ #
847
+ # @option params [required, String] :name
848
+ # The name of the access point whose configuration information you want
849
+ # to retrieve.
850
+ #
851
+ # @return [Types::GetAccessPointResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
852
+ #
853
+ # * {Types::GetAccessPointResult#name #name} => String
854
+ # * {Types::GetAccessPointResult#bucket #bucket} => String
855
+ # * {Types::GetAccessPointResult#network_origin #network_origin} => String
856
+ # * {Types::GetAccessPointResult#vpc_configuration #vpc_configuration} => Types::VpcConfiguration
857
+ # * {Types::GetAccessPointResult#public_access_block_configuration #public_access_block_configuration} => Types::PublicAccessBlockConfiguration
858
+ # * {Types::GetAccessPointResult#creation_date #creation_date} => Time
859
+ #
860
+ # @example Request syntax with placeholder values
861
+ #
862
+ # resp = client.get_access_point({
863
+ # account_id: "AccountId", # required
864
+ # name: "AccessPointName", # required
865
+ # })
866
+ #
867
+ # @example Response structure
868
+ #
869
+ # resp.name #=> String
870
+ # resp.bucket #=> String
871
+ # resp.network_origin #=> String, one of "Internet", "VPC"
872
+ # resp.vpc_configuration.vpc_id #=> String
873
+ # resp.public_access_block_configuration.block_public_acls #=> Boolean
874
+ # resp.public_access_block_configuration.ignore_public_acls #=> Boolean
875
+ # resp.public_access_block_configuration.block_public_policy #=> Boolean
876
+ # resp.public_access_block_configuration.restrict_public_buckets #=> Boolean
877
+ # resp.creation_date #=> Time
878
+ #
879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPoint AWS API Documentation
880
+ #
881
+ # @overload get_access_point(params = {})
882
+ # @param [Hash] params ({})
883
+ def get_access_point(params = {}, options = {})
884
+ req = build_request(:get_access_point, params)
885
+ req.send_request(options)
886
+ end
887
+
888
+ # Returns the access point policy associated with the specified access
889
+ # point.
890
+ #
891
+ # @option params [required, String] :account_id
892
+ # The account ID for the account that owns the specified access point.
893
+ #
894
+ # @option params [required, String] :name
895
+ # The name of the access point whose policy you want to retrieve.
896
+ #
897
+ # @return [Types::GetAccessPointPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
898
+ #
899
+ # * {Types::GetAccessPointPolicyResult#policy #policy} => String
900
+ #
901
+ # @example Request syntax with placeholder values
902
+ #
903
+ # resp = client.get_access_point_policy({
904
+ # account_id: "AccountId", # required
905
+ # name: "AccessPointName", # required
906
+ # })
907
+ #
908
+ # @example Response structure
909
+ #
910
+ # resp.policy #=> String
911
+ #
912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPointPolicy AWS API Documentation
913
+ #
914
+ # @overload get_access_point_policy(params = {})
915
+ # @param [Hash] params ({})
916
+ def get_access_point_policy(params = {}, options = {})
917
+ req = build_request(:get_access_point_policy, params)
918
+ req.send_request(options)
919
+ end
920
+
921
+ # Indicates whether the specified access point currently has a policy
922
+ # that allows public access. For more information about public access
923
+ # through access points, see [Managing Data Access with Amazon S3 Access
924
+ # Points][1] in the *Amazon Simple Storage Service Developer Guide*.
925
+ #
926
+ #
927
+ #
928
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html
929
+ #
574
930
  # @option params [required, String] :account_id
931
+ # The account ID for the account that owns the specified access point.
932
+ #
933
+ # @option params [required, String] :name
934
+ # The name of the access point whose policy status you want to retrieve.
935
+ #
936
+ # @return [Types::GetAccessPointPolicyStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
937
+ #
938
+ # * {Types::GetAccessPointPolicyStatusResult#policy_status #policy_status} => Types::PolicyStatus
939
+ #
940
+ # @example Request syntax with placeholder values
941
+ #
942
+ # resp = client.get_access_point_policy_status({
943
+ # account_id: "AccountId", # required
944
+ # name: "AccessPointName", # required
945
+ # })
946
+ #
947
+ # @example Response structure
948
+ #
949
+ # resp.policy_status.is_public #=> Boolean
950
+ #
951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetAccessPointPolicyStatus AWS API Documentation
952
+ #
953
+ # @overload get_access_point_policy_status(params = {})
954
+ # @param [Hash] params ({})
955
+ def get_access_point_policy_status(params = {}, options = {})
956
+ req = build_request(:get_access_point_policy_status, params)
957
+ req.send_request(options)
958
+ end
959
+
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
978
+ #
979
+ # @option params [required, String] :account_id
980
+ # The AWS account ID associated with the Amazon S3 Batch Operations job.
981
+ #
982
+ # @option params [required, String] :job_id
983
+ # The ID for the Amazon S3 Batch Operations job whose tags you want to
984
+ # retrieve.
985
+ #
986
+ # @return [Types::GetJobTaggingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
987
+ #
988
+ # * {Types::GetJobTaggingResult#tags #tags} => Array&lt;Types::S3Tag&gt;
989
+ #
990
+ # @example Request syntax with placeholder values
991
+ #
992
+ # resp = client.get_job_tagging({
993
+ # account_id: "AccountId", # required
994
+ # job_id: "JobId", # required
995
+ # })
996
+ #
997
+ # @example Response structure
998
+ #
999
+ # resp.tags #=> Array
1000
+ # resp.tags[0].key #=> String
1001
+ # resp.tags[0].value #=> String
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetJobTagging AWS API Documentation
1004
+ #
1005
+ # @overload get_job_tagging(params = {})
1006
+ # @param [Hash] params ({})
1007
+ def get_job_tagging(params = {}, options = {})
1008
+ req = build_request(:get_job_tagging, params)
1009
+ req.send_request(options)
1010
+ end
1011
+
1012
+ # Retrieves the `PublicAccessBlock` configuration for an Amazon Web
1013
+ # Services account.
1014
+ #
1015
+ # @option params [required, String] :account_id
1016
+ # The account ID for the Amazon Web Services account whose
1017
+ # `PublicAccessBlock` configuration you want to retrieve.
575
1018
  #
576
1019
  # @return [Types::GetPublicAccessBlockOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
577
1020
  #
@@ -599,8 +1042,87 @@ module Aws::S3Control
599
1042
  req.send_request(options)
600
1043
  end
601
1044
 
602
- # Lists current jobs and jobs that have ended within the last 30 days
603
- # for the AWS account making the request.
1045
+ # Returns a list of the access points currently associated with the
1046
+ # specified bucket. You can retrieve up to 1000 access points per call.
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.
1051
+ #
1052
+ # @option params [required, String] :account_id
1053
+ # The AWS account ID for owner of the bucket whose access points you
1054
+ # want to list.
1055
+ #
1056
+ # @option params [String] :bucket
1057
+ # The name of the bucket whose associated access points you want to
1058
+ # list.
1059
+ #
1060
+ # @option params [String] :next_token
1061
+ # A continuation token. If a previous call to `ListAccessPoints`
1062
+ # returned a continuation token in the `NextToken` field, then providing
1063
+ # that value here causes Amazon S3 to retrieve the next page of results.
1064
+ #
1065
+ # @option params [Integer] :max_results
1066
+ # The maximum number of access points that you want to include in the
1067
+ # list. If the specified bucket has more than this number of access
1068
+ # points, then the response will include a continuation token in the
1069
+ # `NextToken` field that you can use to retrieve the next page of access
1070
+ # points.
1071
+ #
1072
+ # @return [Types::ListAccessPointsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1073
+ #
1074
+ # * {Types::ListAccessPointsResult#access_point_list #access_point_list} => Array&lt;Types::AccessPoint&gt;
1075
+ # * {Types::ListAccessPointsResult#next_token #next_token} => String
1076
+ #
1077
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1078
+ #
1079
+ # @example Request syntax with placeholder values
1080
+ #
1081
+ # resp = client.list_access_points({
1082
+ # account_id: "AccountId", # required
1083
+ # bucket: "BucketName",
1084
+ # next_token: "NonEmptyMaxLength1024String",
1085
+ # max_results: 1,
1086
+ # })
1087
+ #
1088
+ # @example Response structure
1089
+ #
1090
+ # resp.access_point_list #=> Array
1091
+ # resp.access_point_list[0].name #=> String
1092
+ # resp.access_point_list[0].network_origin #=> String, one of "Internet", "VPC"
1093
+ # resp.access_point_list[0].vpc_configuration.vpc_id #=> String
1094
+ # resp.access_point_list[0].bucket #=> String
1095
+ # resp.next_token #=> String
1096
+ #
1097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListAccessPoints AWS API Documentation
1098
+ #
1099
+ # @overload list_access_points(params = {})
1100
+ # @param [Hash] params ({})
1101
+ def list_access_points(params = {}, options = {})
1102
+ req = build_request(:list_access_points, params)
1103
+ req.send_request(options)
1104
+ end
1105
+
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
604
1126
  #
605
1127
  # @option params [required, String] :account_id
606
1128
  #
@@ -624,12 +1146,14 @@ module Aws::S3Control
624
1146
  # * {Types::ListJobsResult#next_token #next_token} => String
625
1147
  # * {Types::ListJobsResult#jobs #jobs} => Array&lt;Types::JobListDescriptor&gt;
626
1148
  #
1149
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1150
+ #
627
1151
  # @example Request syntax with placeholder values
628
1152
  #
629
1153
  # resp = client.list_jobs({
630
1154
  # account_id: "AccountId", # required
631
1155
  # job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
632
- # next_token: "NonEmptyMaxLength1024String",
1156
+ # next_token: "StringForNextToken",
633
1157
  # max_results: 1,
634
1158
  # })
635
1159
  #
@@ -639,7 +1163,7 @@ module Aws::S3Control
639
1163
  # resp.jobs #=> Array
640
1164
  # resp.jobs[0].job_id #=> String
641
1165
  # resp.jobs[0].description #=> String
642
- # 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"
643
1167
  # resp.jobs[0].priority #=> Integer
644
1168
  # resp.jobs[0].status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
645
1169
  # resp.jobs[0].creation_time #=> Time
@@ -657,9 +1181,151 @@ module Aws::S3Control
657
1181
  req.send_request(options)
658
1182
  end
659
1183
 
1184
+ # Associates an access policy with the specified access point. Each
1185
+ # access point can have only one policy, so a request made to this API
1186
+ # replaces any existing policy associated with the specified access
1187
+ # point.
1188
+ #
1189
+ # @option params [required, String] :account_id
1190
+ # The AWS account ID for owner of the bucket associated with the
1191
+ # specified access point.
1192
+ #
1193
+ # @option params [required, String] :name
1194
+ # The name of the access point that you want to associate with the
1195
+ # specified policy.
1196
+ #
1197
+ # @option params [required, String] :policy
1198
+ # The policy that you want to apply to the specified access point. For
1199
+ # more information about access point policies, see [Managing Data
1200
+ # Access with Amazon S3 Access Points][1] in the *Amazon Simple Storage
1201
+ # Service Developer Guide*.
1202
+ #
1203
+ #
1204
+ #
1205
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html
1206
+ #
1207
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1208
+ #
1209
+ # @example Request syntax with placeholder values
1210
+ #
1211
+ # resp = client.put_access_point_policy({
1212
+ # account_id: "AccountId", # required
1213
+ # name: "AccessPointName", # required
1214
+ # policy: "Policy", # required
1215
+ # })
1216
+ #
1217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutAccessPointPolicy AWS API Documentation
1218
+ #
1219
+ # @overload put_access_point_policy(params = {})
1220
+ # @param [Hash] params ({})
1221
+ def put_access_point_policy(params = {}, options = {})
1222
+ req = build_request(:put_access_point_policy, params)
1223
+ req.send_request(options)
1224
+ end
1225
+
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
1284
+ #
1285
+ # @option params [required, String] :account_id
1286
+ # The AWS account ID associated with the Amazon S3 Batch Operations job.
1287
+ #
1288
+ # @option params [required, String] :job_id
1289
+ # The ID for the Amazon S3 Batch Operations job whose tags you want to
1290
+ # replace.
1291
+ #
1292
+ # @option params [required, Array<Types::S3Tag>] :tags
1293
+ # The set of tags to associate with the Amazon S3 Batch Operations job.
1294
+ #
1295
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1296
+ #
1297
+ # @example Request syntax with placeholder values
1298
+ #
1299
+ # resp = client.put_job_tagging({
1300
+ # account_id: "AccountId", # required
1301
+ # job_id: "JobId", # required
1302
+ # tags: [ # required
1303
+ # {
1304
+ # key: "TagKeyString", # required
1305
+ # value: "TagValueString", # required
1306
+ # },
1307
+ # ],
1308
+ # })
1309
+ #
1310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutJobTagging AWS API Documentation
1311
+ #
1312
+ # @overload put_job_tagging(params = {})
1313
+ # @param [Hash] params ({})
1314
+ def put_job_tagging(params = {}, options = {})
1315
+ req = build_request(:put_job_tagging, params)
1316
+ req.send_request(options)
1317
+ end
1318
+
1319
+ # Creates or modifies the `PublicAccessBlock` configuration for an
1320
+ # Amazon Web Services account.
1321
+ #
660
1322
  # @option params [required, Types::PublicAccessBlockConfiguration] :public_access_block_configuration
1323
+ # The `PublicAccessBlock` configuration that you want to apply to the
1324
+ # specified Amazon Web Services account.
661
1325
  #
662
1326
  # @option params [required, String] :account_id
1327
+ # The account ID for the Amazon Web Services account whose
1328
+ # `PublicAccessBlock` configuration you want to set.
663
1329
  #
664
1330
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
665
1331
  #
@@ -684,7 +1350,25 @@ module Aws::S3Control
684
1350
  req.send_request(options)
685
1351
  end
686
1352
 
687
- # 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
688
1372
  #
689
1373
  # @option params [required, String] :account_id
690
1374
  #
@@ -722,7 +1406,25 @@ module Aws::S3Control
722
1406
  end
723
1407
 
724
1408
  # Updates the status for the specified job. Use this operation to
725
- # 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
726
1428
  #
727
1429
  # @option params [required, String] :account_id
728
1430
  #
@@ -779,7 +1481,7 @@ module Aws::S3Control
779
1481
  params: params,
780
1482
  config: config)
781
1483
  context[:gem_name] = 'aws-sdk-s3control'
782
- context[:gem_version] = '1.13.0'
1484
+ context[:gem_version] = '1.19.0'
783
1485
  Seahorse::Client::Request.new(handlers, context)
784
1486
  end
785
1487