Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.Types.ErrorDocument

Description

Synopsis

data ErrorDocument = ErrorDocument' {
- key :: ObjectKey
}
newErrorDocument :: ObjectKey -> ErrorDocument
errorDocument_key :: Lens' ErrorDocument ObjectKey

Documentation

data ErrorDocument Source #

The error information.

See: newErrorDocument smart constructor.

Constructors

ErrorDocument'
Fields key :: ObjectKey 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.

Instances

Instances details

FromXML ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods parseXML :: [Node] -> Either String ErrorDocument #
ToXML ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods toXML :: ErrorDocument -> XML #
Generic ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Associated Types type Rep ErrorDocument :: Type -> Type # Methods from :: ErrorDocument -> Rep ErrorDocument x # to :: Rep ErrorDocument x -> ErrorDocument #
Read ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods readsPrec :: Int -> ReadS ErrorDocument # readList :: ReadS [ErrorDocument] # readPrec :: ReadPrec ErrorDocument # readListPrec :: ReadPrec [ErrorDocument] #
Show ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods showsPrec :: Int -> ErrorDocument -> ShowS # show :: ErrorDocument -> String # showList :: [ErrorDocument] -> ShowS #
NFData ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods rnf :: ErrorDocument -> () #
Eq ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods (==) :: ErrorDocument -> ErrorDocument -> Bool # (/=) :: ErrorDocument -> ErrorDocument -> Bool #
Hashable ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument Methods hashWithSalt :: Int -> ErrorDocument -> Int # hash :: ErrorDocument -> Int #
type Rep ErrorDocument Source #
Instance details Defined in Amazonka.S3.Types.ErrorDocument type Rep ErrorDocument = D1 ('MetaData "ErrorDocument" "Amazonka.S3.Types.ErrorDocument" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "ErrorDocument'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey)))

newErrorDocument Source #

Arguments

:: ObjectKey	`$sel:key:ErrorDocument'`
-> ErrorDocument

Create a value of ErrorDocument with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:ErrorDocument', errorDocument_key - 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.

errorDocument_key :: Lens' ErrorDocument ObjectKey Source #

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.