Class: Aws::S3Control::Types::S3CopyObjectOperation

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

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
  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,
}

Contains the configuration parameters for a PUT Copy object operation. Amazon S3 Batch Operations passes each value through 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

Instance Attribute Details

#access_control_grantsArray<Types::S3Grant>

Returns:



1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#canned_access_control_listString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_directiveString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#modified_since_constraintTime

Returns:

  • (Time)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#new_object_metadataTypes::S3ObjectMetadata



1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#new_object_taggingArray<Types::S3Tag>

Returns:



1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

The Legal Hold status to be applied to all objects in the Batch Operations job.

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#object_lock_modeString

The Retention mode to be applied to all objects in the Batch Operations job.

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#object_lock_retain_until_dateTime

The date when the applied Object Retention configuration will expire on all objects in the Batch Operations job.

Returns:

  • (Time)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_locationString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#requester_paysBoolean

Returns:

  • (Boolean)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#sse_aws_kms_key_idString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#storage_classString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#target_key_prefixString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#target_resourceString

Returns:

  • (String)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end

#un_modified_since_constraintTime

Returns:

  • (Time)


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 1866

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)
  SENSITIVE = []
  include Aws::Structure
end