aws-sdk-s3control 1.4.0 → 1.5.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 +4 -4
- data/lib/aws-sdk-s3control.rb +1 -1
- data/lib/aws-sdk-s3control/client.rb +469 -15
- data/lib/aws-sdk-s3control/client_api.rb +364 -0
- data/lib/aws-sdk-s3control/types.rb +1356 -73
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5d54ea79d8d2fce8f24a340e0fc8fc7a0fcce367
|
4
|
+
data.tar.gz: 546edf59cb41a8899a6e00f54b6bdcddf2a4023e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e85f527c4372a97e72c8162c64e55d89bd903240de2d26452343f39fb82769eddad51271ac9f337cabec90e13aa7e5307ce80d8cefc2d41b44cb6c8f766434ef
|
7
|
+
data.tar.gz: 7d0b60f754176385b8e149e7dcd0bdabc9768cf1d68e1750993afe83662f30b49d2c764b21be49890361982ba772790eb948d541a1b2df12b102b52bc4977be8
|
data/lib/aws-sdk-s3control.rb
CHANGED
@@ -209,18 +209,237 @@ module Aws::S3Control
|
|
209
209
|
# When `true`, request parameters are validated before
|
210
210
|
# sending the request.
|
211
211
|
#
|
212
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
213
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
214
|
+
#
|
215
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
216
|
+
# seconds to wait when opening a HTTP session before rasing a
|
217
|
+
# `Timeout::Error`.
|
218
|
+
#
|
219
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
220
|
+
# number of seconds to wait for response data. This value can
|
221
|
+
# safely be set
|
222
|
+
# per-request on the session yeidled by {#session_for}.
|
223
|
+
#
|
224
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
225
|
+
# seconds a connection is allowed to sit idble before it is
|
226
|
+
# considered stale. Stale connections are closed and removed
|
227
|
+
# from the pool before making a request.
|
228
|
+
#
|
229
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
230
|
+
# seconds to wait for a 100-continue response before sending the
|
231
|
+
# request body. This option has no effect unless the request has
|
232
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
233
|
+
# disables this behaviour. This value can safely be set per
|
234
|
+
# request on the session yeidled by {#session_for}.
|
235
|
+
#
|
236
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
237
|
+
# HTTP debug output will be sent to the `:logger`.
|
238
|
+
#
|
239
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
240
|
+
# SSL peer certificates are verified when establishing a
|
241
|
+
# connection.
|
242
|
+
#
|
243
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
244
|
+
# certificate authority bundle file that should be used when
|
245
|
+
# verifying peer certificates. If you do not pass
|
246
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
247
|
+
# will be used if available.
|
248
|
+
#
|
249
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
250
|
+
# directory that contains the unbundled SSL certificate
|
251
|
+
# authority files for verifying peer certificates. If you do
|
252
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
253
|
+
# system default will be used if available.
|
254
|
+
#
|
212
255
|
def initialize(*args)
|
213
256
|
super
|
214
257
|
end
|
215
258
|
|
216
259
|
# @!group API Operations
|
217
260
|
|
218
|
-
#
|
219
|
-
# Services account.
|
261
|
+
# Creates an Amazon S3 batch operations job.
|
220
262
|
#
|
221
263
|
# @option params [required, String] :account_id
|
222
|
-
#
|
223
|
-
#
|
264
|
+
#
|
265
|
+
# @option params [Boolean] :confirmation_required
|
266
|
+
# Indicates whether confirmation is required before Amazon S3 runs the
|
267
|
+
# job. Confirmation is only required for jobs created through the Amazon
|
268
|
+
# S3 console.
|
269
|
+
#
|
270
|
+
# @option params [required, Types::JobOperation] :operation
|
271
|
+
# The operation that you want this job to perform on each object listed
|
272
|
+
# in the manifest. For more information about the available operations,
|
273
|
+
# see [Available Operations][1] in the *Amazon Simple Storage Service
|
274
|
+
# Developer Guide*.
|
275
|
+
#
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html
|
279
|
+
#
|
280
|
+
# @option params [required, Types::JobReport] :report
|
281
|
+
# Configuration parameters for the optional job-completion report.
|
282
|
+
#
|
283
|
+
# @option params [required, String] :client_request_token
|
284
|
+
# An idempotency token to ensure that you don't accidentally submit the
|
285
|
+
# same request twice. You can use any string up to the maximum length.
|
286
|
+
#
|
287
|
+
# **A suitable default value is auto-generated.** You should normally
|
288
|
+
# not need to pass this option.**
|
289
|
+
#
|
290
|
+
# @option params [required, Types::JobManifest] :manifest
|
291
|
+
# Configuration parameters for the manifest.
|
292
|
+
#
|
293
|
+
# @option params [String] :description
|
294
|
+
# A description for this job. You can use any string within the
|
295
|
+
# permitted length. Descriptions don't need to be unique and can be
|
296
|
+
# used for multiple jobs.
|
297
|
+
#
|
298
|
+
# @option params [required, Integer] :priority
|
299
|
+
# The numerical priority for this job. Higher numbers indicate higher
|
300
|
+
# priority.
|
301
|
+
#
|
302
|
+
# @option params [required, String] :role_arn
|
303
|
+
# The Amazon Resource Name (ARN) for the Identity and Access Management
|
304
|
+
# (IAM) Role that batch operations will use to execute this job's
|
305
|
+
# operation on each object in the manifest.
|
306
|
+
#
|
307
|
+
# @return [Types::CreateJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
308
|
+
#
|
309
|
+
# * {Types::CreateJobResult#job_id #job_id} => String
|
310
|
+
#
|
311
|
+
# @example Request syntax with placeholder values
|
312
|
+
#
|
313
|
+
# resp = client.create_job({
|
314
|
+
# account_id: "AccountId", # required
|
315
|
+
# confirmation_required: false,
|
316
|
+
# operation: { # required
|
317
|
+
# lambda_invoke: {
|
318
|
+
# function_arn: "NonEmptyMaxLength1024String",
|
319
|
+
# },
|
320
|
+
# s3_put_object_copy: {
|
321
|
+
# target_resource: "S3BucketArnString",
|
322
|
+
# canned_access_control_list: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
|
323
|
+
# access_control_grants: [
|
324
|
+
# {
|
325
|
+
# grantee: {
|
326
|
+
# type_identifier: "id", # accepts id, emailAddress, uri
|
327
|
+
# identifier: "NonEmptyMaxLength1024String",
|
328
|
+
# display_name: "NonEmptyMaxLength1024String",
|
329
|
+
# },
|
330
|
+
# permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP
|
331
|
+
# },
|
332
|
+
# ],
|
333
|
+
# metadata_directive: "COPY", # accepts COPY, REPLACE
|
334
|
+
# modified_since_constraint: Time.now,
|
335
|
+
# new_object_metadata: {
|
336
|
+
# cache_control: "NonEmptyMaxLength1024String",
|
337
|
+
# content_disposition: "NonEmptyMaxLength1024String",
|
338
|
+
# content_encoding: "NonEmptyMaxLength1024String",
|
339
|
+
# content_language: "NonEmptyMaxLength1024String",
|
340
|
+
# user_metadata: {
|
341
|
+
# "NonEmptyMaxLength1024String" => "MaxLength1024String",
|
342
|
+
# },
|
343
|
+
# content_length: 1,
|
344
|
+
# content_md5: "NonEmptyMaxLength1024String",
|
345
|
+
# content_type: "NonEmptyMaxLength1024String",
|
346
|
+
# http_expires_date: Time.now,
|
347
|
+
# requester_charged: false,
|
348
|
+
# sse_algorithm: "AES256", # accepts AES256, KMS
|
349
|
+
# },
|
350
|
+
# new_object_tagging: [
|
351
|
+
# {
|
352
|
+
# key: "NonEmptyMaxLength1024String", # required
|
353
|
+
# value: "MaxLength1024String", # required
|
354
|
+
# },
|
355
|
+
# ],
|
356
|
+
# redirect_location: "NonEmptyMaxLength2048String",
|
357
|
+
# requester_pays: false,
|
358
|
+
# storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE
|
359
|
+
# un_modified_since_constraint: Time.now,
|
360
|
+
# sse_aws_kms_key_id: "KmsKeyArnString",
|
361
|
+
# target_key_prefix: "NonEmptyMaxLength1024String",
|
362
|
+
# object_lock_legal_hold_status: "OFF", # accepts OFF, ON
|
363
|
+
# object_lock_mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
|
364
|
+
# object_lock_retain_until_date: Time.now,
|
365
|
+
# },
|
366
|
+
# s3_put_object_acl: {
|
367
|
+
# access_control_policy: {
|
368
|
+
# access_control_list: {
|
369
|
+
# owner: { # required
|
370
|
+
# id: "NonEmptyMaxLength1024String",
|
371
|
+
# display_name: "NonEmptyMaxLength1024String",
|
372
|
+
# },
|
373
|
+
# grants: [
|
374
|
+
# {
|
375
|
+
# grantee: {
|
376
|
+
# type_identifier: "id", # accepts id, emailAddress, uri
|
377
|
+
# identifier: "NonEmptyMaxLength1024String",
|
378
|
+
# display_name: "NonEmptyMaxLength1024String",
|
379
|
+
# },
|
380
|
+
# permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP
|
381
|
+
# },
|
382
|
+
# ],
|
383
|
+
# },
|
384
|
+
# canned_access_control_list: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
|
385
|
+
# },
|
386
|
+
# },
|
387
|
+
# s3_put_object_tagging: {
|
388
|
+
# tag_set: [
|
389
|
+
# {
|
390
|
+
# key: "NonEmptyMaxLength1024String", # required
|
391
|
+
# value: "MaxLength1024String", # required
|
392
|
+
# },
|
393
|
+
# ],
|
394
|
+
# },
|
395
|
+
# s3_initiate_restore_object: {
|
396
|
+
# expiration_in_days: 1,
|
397
|
+
# glacier_job_tier: "BULK", # accepts BULK, STANDARD
|
398
|
+
# },
|
399
|
+
# },
|
400
|
+
# report: { # required
|
401
|
+
# bucket: "S3BucketArnString",
|
402
|
+
# format: "Report_CSV_20180820", # accepts Report_CSV_20180820
|
403
|
+
# enabled: false, # required
|
404
|
+
# prefix: "ReportPrefixString",
|
405
|
+
# report_scope: "AllTasks", # accepts AllTasks, FailedTasksOnly
|
406
|
+
# },
|
407
|
+
# client_request_token: "NonEmptyMaxLength64String", # required
|
408
|
+
# manifest: { # required
|
409
|
+
# spec: { # required
|
410
|
+
# format: "S3BatchOperations_CSV_20180820", # required, accepts S3BatchOperations_CSV_20180820, S3InventoryReport_CSV_20161130
|
411
|
+
# fields: ["Ignore"], # accepts Ignore, Bucket, Key, VersionId
|
412
|
+
# },
|
413
|
+
# location: { # required
|
414
|
+
# object_arn: "S3KeyArnString", # required
|
415
|
+
# object_version_id: "S3ObjectVersionId",
|
416
|
+
# etag: "NonEmptyMaxLength1024String", # required
|
417
|
+
# },
|
418
|
+
# },
|
419
|
+
# description: "NonEmptyMaxLength256String",
|
420
|
+
# priority: 1, # required
|
421
|
+
# role_arn: "IAMRoleArn", # required
|
422
|
+
# })
|
423
|
+
#
|
424
|
+
# @example Response structure
|
425
|
+
#
|
426
|
+
# resp.job_id #=> String
|
427
|
+
#
|
428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/CreateJob AWS API Documentation
|
429
|
+
#
|
430
|
+
# @overload create_job(params = {})
|
431
|
+
# @param [Hash] params ({})
|
432
|
+
def create_job(params = {}, options = {})
|
433
|
+
req = build_request(:create_job, params)
|
434
|
+
req.send_request(options)
|
435
|
+
end
|
436
|
+
|
437
|
+
# Deletes the block public access configuration for the specified
|
438
|
+
# account.
|
439
|
+
#
|
440
|
+
# @option params [required, String] :account_id
|
441
|
+
# The account ID for the AWS account whose block public access
|
442
|
+
# configuration you want to delete.
|
224
443
|
#
|
225
444
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
226
445
|
#
|
@@ -239,12 +458,114 @@ module Aws::S3Control
|
|
239
458
|
req.send_request(options)
|
240
459
|
end
|
241
460
|
|
242
|
-
# Retrieves the
|
243
|
-
#
|
461
|
+
# Retrieves the configuration parameters and status for a batch
|
462
|
+
# operations job.
|
244
463
|
#
|
245
464
|
# @option params [required, String] :account_id
|
246
|
-
#
|
247
|
-
#
|
465
|
+
#
|
466
|
+
# @option params [required, String] :job_id
|
467
|
+
# The ID for the job whose information you want to retrieve.
|
468
|
+
#
|
469
|
+
# @return [Types::DescribeJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
470
|
+
#
|
471
|
+
# * {Types::DescribeJobResult#job #job} => Types::JobDescriptor
|
472
|
+
#
|
473
|
+
# @example Request syntax with placeholder values
|
474
|
+
#
|
475
|
+
# resp = client.describe_job({
|
476
|
+
# account_id: "AccountId", # required
|
477
|
+
# job_id: "JobId", # required
|
478
|
+
# })
|
479
|
+
#
|
480
|
+
# @example Response structure
|
481
|
+
#
|
482
|
+
# resp.job.job_id #=> String
|
483
|
+
# resp.job.confirmation_required #=> Boolean
|
484
|
+
# resp.job.description #=> String
|
485
|
+
# resp.job.job_arn #=> String
|
486
|
+
# resp.job.status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
|
487
|
+
# resp.job.manifest.spec.format #=> String, one of "S3BatchOperations_CSV_20180820", "S3InventoryReport_CSV_20161130"
|
488
|
+
# resp.job.manifest.spec.fields #=> Array
|
489
|
+
# resp.job.manifest.spec.fields[0] #=> String, one of "Ignore", "Bucket", "Key", "VersionId"
|
490
|
+
# resp.job.manifest.location.object_arn #=> String
|
491
|
+
# resp.job.manifest.location.object_version_id #=> String
|
492
|
+
# resp.job.manifest.location.etag #=> String
|
493
|
+
# resp.job.operation.lambda_invoke.function_arn #=> String
|
494
|
+
# resp.job.operation.s3_put_object_copy.target_resource #=> String
|
495
|
+
# resp.job.operation.s3_put_object_copy.canned_access_control_list #=> String, one of "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control"
|
496
|
+
# resp.job.operation.s3_put_object_copy.access_control_grants #=> Array
|
497
|
+
# resp.job.operation.s3_put_object_copy.access_control_grants[0].grantee.type_identifier #=> String, one of "id", "emailAddress", "uri"
|
498
|
+
# resp.job.operation.s3_put_object_copy.access_control_grants[0].grantee.identifier #=> String
|
499
|
+
# resp.job.operation.s3_put_object_copy.access_control_grants[0].grantee.display_name #=> String
|
500
|
+
# resp.job.operation.s3_put_object_copy.access_control_grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE", "READ_ACP", "WRITE_ACP"
|
501
|
+
# resp.job.operation.s3_put_object_copy.metadata_directive #=> String, one of "COPY", "REPLACE"
|
502
|
+
# resp.job.operation.s3_put_object_copy.modified_since_constraint #=> Time
|
503
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.cache_control #=> String
|
504
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.content_disposition #=> String
|
505
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.content_encoding #=> String
|
506
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.content_language #=> String
|
507
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.user_metadata #=> Hash
|
508
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.user_metadata["NonEmptyMaxLength1024String"] #=> String
|
509
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.content_length #=> Integer
|
510
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.content_md5 #=> String
|
511
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.content_type #=> String
|
512
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.http_expires_date #=> Time
|
513
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.requester_charged #=> Boolean
|
514
|
+
# resp.job.operation.s3_put_object_copy.new_object_metadata.sse_algorithm #=> String, one of "AES256", "KMS"
|
515
|
+
# resp.job.operation.s3_put_object_copy.new_object_tagging #=> Array
|
516
|
+
# resp.job.operation.s3_put_object_copy.new_object_tagging[0].key #=> String
|
517
|
+
# resp.job.operation.s3_put_object_copy.new_object_tagging[0].value #=> String
|
518
|
+
# resp.job.operation.s3_put_object_copy.redirect_location #=> String
|
519
|
+
# resp.job.operation.s3_put_object_copy.requester_pays #=> Boolean
|
520
|
+
# resp.job.operation.s3_put_object_copy.storage_class #=> String, one of "STANDARD", "STANDARD_IA", "ONEZONE_IA", "GLACIER", "INTELLIGENT_TIERING", "DEEP_ARCHIVE"
|
521
|
+
# resp.job.operation.s3_put_object_copy.un_modified_since_constraint #=> Time
|
522
|
+
# resp.job.operation.s3_put_object_copy.sse_aws_kms_key_id #=> String
|
523
|
+
# resp.job.operation.s3_put_object_copy.target_key_prefix #=> String
|
524
|
+
# resp.job.operation.s3_put_object_copy.object_lock_legal_hold_status #=> String, one of "OFF", "ON"
|
525
|
+
# resp.job.operation.s3_put_object_copy.object_lock_mode #=> String, one of "COMPLIANCE", "GOVERNANCE"
|
526
|
+
# resp.job.operation.s3_put_object_copy.object_lock_retain_until_date #=> Time
|
527
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner.id #=> String
|
528
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.owner.display_name #=> String
|
529
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants #=> Array
|
530
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].grantee.type_identifier #=> String, one of "id", "emailAddress", "uri"
|
531
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].grantee.identifier #=> String
|
532
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].grantee.display_name #=> String
|
533
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.access_control_list.grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE", "READ_ACP", "WRITE_ACP"
|
534
|
+
# resp.job.operation.s3_put_object_acl.access_control_policy.canned_access_control_list #=> String, one of "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control"
|
535
|
+
# resp.job.operation.s3_put_object_tagging.tag_set #=> Array
|
536
|
+
# resp.job.operation.s3_put_object_tagging.tag_set[0].key #=> String
|
537
|
+
# resp.job.operation.s3_put_object_tagging.tag_set[0].value #=> String
|
538
|
+
# resp.job.operation.s3_initiate_restore_object.expiration_in_days #=> Integer
|
539
|
+
# resp.job.operation.s3_initiate_restore_object.glacier_job_tier #=> String, one of "BULK", "STANDARD"
|
540
|
+
# resp.job.priority #=> Integer
|
541
|
+
# resp.job.progress_summary.total_number_of_tasks #=> Integer
|
542
|
+
# resp.job.progress_summary.number_of_tasks_succeeded #=> Integer
|
543
|
+
# resp.job.progress_summary.number_of_tasks_failed #=> Integer
|
544
|
+
# resp.job.status_update_reason #=> String
|
545
|
+
# resp.job.failure_reasons #=> Array
|
546
|
+
# resp.job.failure_reasons[0].failure_code #=> String
|
547
|
+
# resp.job.failure_reasons[0].failure_reason #=> String
|
548
|
+
# resp.job.report.bucket #=> String
|
549
|
+
# resp.job.report.format #=> String, one of "Report_CSV_20180820"
|
550
|
+
# resp.job.report.enabled #=> Boolean
|
551
|
+
# resp.job.report.prefix #=> String
|
552
|
+
# resp.job.report.report_scope #=> String, one of "AllTasks", "FailedTasksOnly"
|
553
|
+
# resp.job.creation_time #=> Time
|
554
|
+
# resp.job.termination_date #=> Time
|
555
|
+
# resp.job.role_arn #=> String
|
556
|
+
# resp.job.suspended_date #=> Time
|
557
|
+
# resp.job.suspended_cause #=> String
|
558
|
+
#
|
559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DescribeJob AWS API Documentation
|
560
|
+
#
|
561
|
+
# @overload describe_job(params = {})
|
562
|
+
# @param [Hash] params ({})
|
563
|
+
def describe_job(params = {}, options = {})
|
564
|
+
req = build_request(:describe_job, params)
|
565
|
+
req.send_request(options)
|
566
|
+
end
|
567
|
+
|
568
|
+
# @option params [required, String] :account_id
|
248
569
|
#
|
249
570
|
# @return [Types::GetPublicAccessBlockOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
250
571
|
#
|
@@ -272,16 +593,67 @@ module Aws::S3Control
|
|
272
593
|
req.send_request(options)
|
273
594
|
end
|
274
595
|
|
275
|
-
#
|
276
|
-
#
|
596
|
+
# Lists current jobs and jobs that have ended within the last 30 days
|
597
|
+
# for the AWS account making the request.
|
598
|
+
#
|
599
|
+
# @option params [required, String] :account_id
|
600
|
+
#
|
601
|
+
# @option params [Array<String>] :job_statuses
|
602
|
+
# The `List Jobs` request returns jobs that match the statuses listed in
|
603
|
+
# this element.
|
604
|
+
#
|
605
|
+
# @option params [String] :next_token
|
606
|
+
# A pagination token to request the next page of results. Use the token
|
607
|
+
# that Amazon S3 returned in the `NextToken` element of the
|
608
|
+
# `ListJobsResult` from the previous `List Jobs` request.
|
609
|
+
#
|
610
|
+
# @option params [Integer] :max_results
|
611
|
+
# The maximum number of jobs that Amazon S3 will include in the `List
|
612
|
+
# Jobs` response. If there are more jobs than this number, the response
|
613
|
+
# will include a pagination token in the `NextToken` field to enable you
|
614
|
+
# to retrieve the next page of results.
|
277
615
|
#
|
616
|
+
# @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
617
|
+
#
|
618
|
+
# * {Types::ListJobsResult#next_token #next_token} => String
|
619
|
+
# * {Types::ListJobsResult#jobs #jobs} => Array<Types::JobListDescriptor>
|
620
|
+
#
|
621
|
+
# @example Request syntax with placeholder values
|
622
|
+
#
|
623
|
+
# resp = client.list_jobs({
|
624
|
+
# account_id: "AccountId", # required
|
625
|
+
# job_statuses: ["Active"], # accepts Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended
|
626
|
+
# next_token: "NonEmptyMaxLength1024String",
|
627
|
+
# max_results: 1,
|
628
|
+
# })
|
629
|
+
#
|
630
|
+
# @example Response structure
|
631
|
+
#
|
632
|
+
# resp.next_token #=> String
|
633
|
+
# resp.jobs #=> Array
|
634
|
+
# resp.jobs[0].job_id #=> String
|
635
|
+
# resp.jobs[0].description #=> String
|
636
|
+
# resp.jobs[0].operation #=> String, one of "LambdaInvoke", "S3PutObjectCopy", "S3PutObjectAcl", "S3PutObjectTagging", "S3InitiateRestoreObject"
|
637
|
+
# resp.jobs[0].priority #=> Integer
|
638
|
+
# resp.jobs[0].status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
|
639
|
+
# resp.jobs[0].creation_time #=> Time
|
640
|
+
# resp.jobs[0].termination_date #=> Time
|
641
|
+
# resp.jobs[0].progress_summary.total_number_of_tasks #=> Integer
|
642
|
+
# resp.jobs[0].progress_summary.number_of_tasks_succeeded #=> Integer
|
643
|
+
# resp.jobs[0].progress_summary.number_of_tasks_failed #=> Integer
|
644
|
+
#
|
645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListJobs AWS API Documentation
|
646
|
+
#
|
647
|
+
# @overload list_jobs(params = {})
|
648
|
+
# @param [Hash] params ({})
|
649
|
+
def list_jobs(params = {}, options = {})
|
650
|
+
req = build_request(:list_jobs, params)
|
651
|
+
req.send_request(options)
|
652
|
+
end
|
653
|
+
|
278
654
|
# @option params [required, Types::PublicAccessBlockConfiguration] :public_access_block_configuration
|
279
|
-
# The Public Access Block configuration that you want to apply to this
|
280
|
-
# Amazon Web Services account.
|
281
655
|
#
|
282
656
|
# @option params [required, String] :account_id
|
283
|
-
# The Account ID for the Amazon Web Services account whose Public Access
|
284
|
-
# Block configuration you want to set.
|
285
657
|
#
|
286
658
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
287
659
|
#
|
@@ -306,6 +678,88 @@ module Aws::S3Control
|
|
306
678
|
req.send_request(options)
|
307
679
|
end
|
308
680
|
|
681
|
+
# Updates an existing job's priority.
|
682
|
+
#
|
683
|
+
# @option params [required, String] :account_id
|
684
|
+
#
|
685
|
+
# @option params [required, String] :job_id
|
686
|
+
# The ID for the job whose priority you want to update.
|
687
|
+
#
|
688
|
+
# @option params [required, Integer] :priority
|
689
|
+
# The priority you want to assign to this job.
|
690
|
+
#
|
691
|
+
# @return [Types::UpdateJobPriorityResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
692
|
+
#
|
693
|
+
# * {Types::UpdateJobPriorityResult#job_id #job_id} => String
|
694
|
+
# * {Types::UpdateJobPriorityResult#priority #priority} => Integer
|
695
|
+
#
|
696
|
+
# @example Request syntax with placeholder values
|
697
|
+
#
|
698
|
+
# resp = client.update_job_priority({
|
699
|
+
# account_id: "AccountId", # required
|
700
|
+
# job_id: "JobId", # required
|
701
|
+
# priority: 1, # required
|
702
|
+
# })
|
703
|
+
#
|
704
|
+
# @example Response structure
|
705
|
+
#
|
706
|
+
# resp.job_id #=> String
|
707
|
+
# resp.priority #=> Integer
|
708
|
+
#
|
709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobPriority AWS API Documentation
|
710
|
+
#
|
711
|
+
# @overload update_job_priority(params = {})
|
712
|
+
# @param [Hash] params ({})
|
713
|
+
def update_job_priority(params = {}, options = {})
|
714
|
+
req = build_request(:update_job_priority, params)
|
715
|
+
req.send_request(options)
|
716
|
+
end
|
717
|
+
|
718
|
+
# Updates the status for the specified job. Use this operation to
|
719
|
+
# confirm that you want to run a job or to cancel an existing job.
|
720
|
+
#
|
721
|
+
# @option params [required, String] :account_id
|
722
|
+
#
|
723
|
+
# @option params [required, String] :job_id
|
724
|
+
# The ID of the job whose status you want to update.
|
725
|
+
#
|
726
|
+
# @option params [required, String] :requested_job_status
|
727
|
+
# The status that you want to move the specified job to.
|
728
|
+
#
|
729
|
+
# @option params [String] :status_update_reason
|
730
|
+
# A description of the reason why you want to change the specified
|
731
|
+
# job's status. This field can be any string up to the maximum length.
|
732
|
+
#
|
733
|
+
# @return [Types::UpdateJobStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
734
|
+
#
|
735
|
+
# * {Types::UpdateJobStatusResult#job_id #job_id} => String
|
736
|
+
# * {Types::UpdateJobStatusResult#status #status} => String
|
737
|
+
# * {Types::UpdateJobStatusResult#status_update_reason #status_update_reason} => String
|
738
|
+
#
|
739
|
+
# @example Request syntax with placeholder values
|
740
|
+
#
|
741
|
+
# resp = client.update_job_status({
|
742
|
+
# account_id: "AccountId", # required
|
743
|
+
# job_id: "JobId", # required
|
744
|
+
# requested_job_status: "Cancelled", # required, accepts Cancelled, Ready
|
745
|
+
# status_update_reason: "JobStatusUpdateReason",
|
746
|
+
# })
|
747
|
+
#
|
748
|
+
# @example Response structure
|
749
|
+
#
|
750
|
+
# resp.job_id #=> String
|
751
|
+
# resp.status #=> String, one of "Active", "Cancelled", "Cancelling", "Complete", "Completing", "Failed", "Failing", "New", "Paused", "Pausing", "Preparing", "Ready", "Suspended"
|
752
|
+
# resp.status_update_reason #=> String
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/UpdateJobStatus AWS API Documentation
|
755
|
+
#
|
756
|
+
# @overload update_job_status(params = {})
|
757
|
+
# @param [Hash] params ({})
|
758
|
+
def update_job_status(params = {}, options = {})
|
759
|
+
req = build_request(:update_job_status, params)
|
760
|
+
req.send_request(options)
|
761
|
+
end
|
762
|
+
|
309
763
|
# @!endgroup
|
310
764
|
|
311
765
|
# @param params ({})
|
@@ -319,7 +773,7 @@ module Aws::S3Control
|
|
319
773
|
params: params,
|
320
774
|
config: config)
|
321
775
|
context[:gem_name] = 'aws-sdk-s3control'
|
322
|
-
context[:gem_version] = '1.
|
776
|
+
context[:gem_version] = '1.5.0'
|
323
777
|
Seahorse::Client::Request.new(handlers, context)
|
324
778
|
end
|
325
779
|
|