You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::Types::Condition

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

Overview

Note:

When making an API call, you may pass Condition data as a hash:

{
  http_error_code_returned_equals: "HttpErrorCodeReturnedEquals",
  key_prefix_equals: "KeyPrefixEquals",
}

Instance Attribute Summary collapse

Instance Attribute Details

#http_error_code_returned_equalsString

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

Returns:

  • (String)


865
866
867
868
869
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 865

class Condition < Struct.new(
  :http_error_code_returned_equals,
  :key_prefix_equals)
  include Aws::Structure
end

#key_prefix_equalsString

The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

Returns:

  • (String)


865
866
867
868
869
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 865

class Condition < Struct.new(
  :http_error_code_returned_equals,
  :key_prefix_equals)
  include Aws::Structure
end