Class: Aws::S3::Types::ErrorDocument

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

Overview

Note:

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

{
  key: "ObjectKey", # required
}

The error information.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The object key name to use when a 4XX class error occurs.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints

Returns:

  • (String)

4196
4197
4198
4199
4200
# File 'lib/aws-sdk-s3/types.rb', line 4196

class ErrorDocument < Struct.new(
  :key)
  SENSITIVE = []
  include Aws::Structure
end