AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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 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.

Returns:

  • (String)


4226
4227
4228
4229
4230
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4226

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