Class: Aws::S3Control::Types::S3CopyObjectOperation
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3Control::Types::S3CopyObjectOperation
- Defined in:
- gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb
Overview
When making an API call, you may pass S3CopyObjectOperation data as a hash:
{
target_resource: "S3BucketArnString",
canned_access_control_list: "private", # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control
access_control_grants: [
{
grantee: {
type_identifier: "id", # accepts id, emailAddress, uri
identifier: "NonEmptyMaxLength1024String",
display_name: "NonEmptyMaxLength1024String",
},
permission: "FULL_CONTROL", # accepts FULL_CONTROL, READ, WRITE, READ_ACP, WRITE_ACP
},
],
metadata_directive: "COPY", # accepts COPY, REPLACE
modified_since_constraint: Time.now,
new_object_metadata: {
cache_control: "NonEmptyMaxLength1024String",
content_disposition: "NonEmptyMaxLength1024String",
content_encoding: "NonEmptyMaxLength1024String",
content_language: "NonEmptyMaxLength1024String",
user_metadata: {
"NonEmptyMaxLength1024String" => "MaxLength1024String",
},
content_length: 1,
content_md5: "NonEmptyMaxLength1024String",
content_type: "NonEmptyMaxLength1024String",
http_expires_date: Time.now,
requester_charged: false,
sse_algorithm: "AES256", # accepts AES256, KMS
},
new_object_tagging: [
{
key: "TagKeyString", # required
value: "TagValueString", # required
},
],
redirect_location: "NonEmptyMaxLength2048String",
requester_pays: false,
storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE, GLACIER_IR
un_modified_since_constraint: Time.now,
sse_aws_kms_key_id: "KmsKeyArnString",
target_key_prefix: "NonEmptyMaxLength1024String",
object_lock_legal_hold_status: "OFF", # accepts OFF, ON
object_lock_mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
object_lock_retain_until_date: Time.now,
bucket_key_enabled: false,
checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
}
Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_control_grants ⇒ Array<Types::S3Grant>
-
#bucket_key_enabled ⇒ Boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS).
-
#canned_access_control_list ⇒ String
-
#checksum_algorithm ⇒ String
Indicates the algorithm you want Amazon S3 to use to create the checksum.
-
#metadata_directive ⇒ String
-
#modified_since_constraint ⇒ Time
-
#new_object_metadata ⇒ Types::S3ObjectMetadata
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.
-
#new_object_tagging ⇒ Array<Types::S3Tag>
-
#object_lock_legal_hold_status ⇒ String
The legal hold status to be applied to all objects in the Batch Operations job.
-
#object_lock_mode ⇒ String
The retention mode to be applied to all objects in the Batch Operations job.
-
#object_lock_retain_until_date ⇒ Time
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
-
#redirect_location ⇒ String
Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location
. -
#requester_pays ⇒ Boolean
-
#sse_aws_kms_key_id ⇒ String
-
#storage_class ⇒ String
-
#target_key_prefix ⇒ String
Specifies the folder prefix into which you would like the objects to be copied.
-
#target_resource ⇒ String
Specifies the destination bucket ARN for the batch copy operation.
-
#un_modified_since_constraint ⇒ Time
Instance Attribute Details
#access_control_grants ⇒ Array<Types::S3Grant>
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#bucket_key_enabled ⇒ Boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object
encryption with server-side encryption using Amazon Web Services KMS
(SSE-KMS). Setting this header to true
causes Amazon S3 to use an
S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#canned_access_control_list ⇒ String
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#checksum_algorithm ⇒ String
Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#metadata_directive ⇒ String
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#modified_since_constraint ⇒ Time
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#new_object_metadata ⇒ Types::S3ObjectMetadata
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#new_object_tagging ⇒ Array<Types::S3Tag>
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#object_lock_legal_hold_status ⇒ String
The legal hold status to be applied to all objects in the Batch Operations job.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#object_lock_mode ⇒ String
The retention mode to be applied to all objects in the Batch Operations job.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#object_lock_retain_until_date ⇒ Time
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#redirect_location ⇒ String
Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location
. Allows webpage redirects if the
object is accessed through a website endpoint.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#requester_pays ⇒ Boolean
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#sse_aws_kms_key_id ⇒ String
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#storage_class ⇒ String
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#target_key_prefix ⇒ String
Specifies the folder prefix into which you would like the objects to
be copied. For example, to copy objects into a folder named
Folder1
in the destination bucket, set the TargetKeyPrefix to
Folder1
.
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#target_resource ⇒ String
Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |
#un_modified_since_constraint ⇒ Time
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 |
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 5614 class S3CopyObjectOperation < Struct.new( :target_resource, :canned_access_control_list, :access_control_grants, :metadata_directive, :modified_since_constraint, :new_object_metadata, :new_object_tagging, :redirect_location, :requester_pays, :storage_class, :un_modified_since_constraint, :sse_aws_kms_key_id, :target_key_prefix, :object_lock_legal_hold_status, :object_lock_mode, :object_lock_retain_until_date, :bucket_key_enabled, :checksum_algorithm) SENSITIVE = [] include Aws::Structure end |