Class: Aws::S3::Types::RenameObjectRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::RenameObjectRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

  The bucket name of the directory bucket containing the object.

• #client_token ⇒ String

  A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.

• #destination_if_match ⇒ String

  Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3.

• #destination_if_modified_since ⇒ Time

  Renames the object if the destination exists and if it has been modified since the specified time.

• #destination_if_none_match ⇒ String

  Renames the object only if the destination does not already exist in the specified directory bucket.

• #destination_if_unmodified_since ⇒ Time

  Renames the object if it hasn’t been modified since the specified time.

• #key ⇒ String

  Key name of the object to rename.

• #rename_source ⇒ String

  Specifies the source for the rename operation.

• #source_if_match ⇒ String

  Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.

• #source_if_modified_since ⇒ Time

  Renames the object if the source exists and if it has been modified since the specified time.

• #source_if_none_match ⇒ String

  Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag.

• #source_if_unmodified_since ⇒ Time

  Renames the object if the source exists and hasn’t been modified since the specified time.

Instance Attribute Details

#bucket ⇒ String

The bucket name of the directory bucket containing the object.

You must use virtual-hosted-style requests in the format ‘Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format `bucket-base-name–zone-id–x-s3 ` (for example, `amzn-s3-demo-bucket–usw2-az1–x-s3`). For information about bucket naming restrictions, see [Directory bucket naming rules] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.

<note markdown=“1”> ‘RenameObject` supports idempotency using a client token. To make an idempotent API request using `RenameObject`, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an `IdempotentParameterMismatch` error is returned.

</note>

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#destination_if_match ⇒ String

Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3. The ‘If-Match` header field makes the request method conditional on ETags. If the ETag values do not match, the operation returns a `412 Precondition Failed` error.

Expects the ETag value as a string.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#destination_if_modified_since ⇒ Time

Renames the object if the destination exists and if it has been modified since the specified time.

Returns:

• (Time)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#destination_if_none_match ⇒ String

Renames the object only if the destination does not already exist in the specified directory bucket. If the object does exist when you send a request with ‘If-None-Match:*`, the S3 API will return a `412 Precondition Failed` error, preventing an overwrite. The `If-None-Match` header prevents overwrites of existing data by validating that there’s not an object with the same key name already in your directory bucket.

Expects the ‘*` character (asterisk).

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#destination_if_unmodified_since ⇒ Time

Renames the object if it hasn’t been modified since the specified time.

Returns:

• (Time)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

Key name of the object to rename.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#rename_source ⇒ String

Specifies the source for the rename operation. The value must be URL encoded.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source_if_match ⇒ String

Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source_if_modified_since ⇒ Time

Renames the object if the source exists and if it has been modified since the specified time.

Returns:

• (Time)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source_if_none_match ⇒ String

Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag. If an asterisk (‘*`) character is provided, the operation will fail and return a `412 Precondition Failed` error.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source_if_unmodified_since ⇒ Time

Renames the object if the source exists and hasn’t been modified since the specified time.

Returns:

• (Time)

# File 'lib/aws-sdk-s3/types.rb', line 17405

class RenameObjectRequest < Struct.new(
  :bucket,
  :key,
  :rename_source,
  :destination_if_match,
  :destination_if_none_match,
  :destination_if_modified_since,
  :destination_if_unmodified_since,
  :source_if_match,
  :source_if_none_match,
  :source_if_modified_since,
  :source_if_unmodified_since,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end