Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.Types.IndexDocument

Description

Synopsis

data IndexDocument = IndexDocument' {
- suffix :: Text
}
newIndexDocument :: Text -> IndexDocument
indexDocument_suffix :: Lens' IndexDocument Text

Documentation

data IndexDocument Source #

Container for the Suffix element.

See: newIndexDocument smart constructor.

Constructors

IndexDocument'

Fields

suffix :: Text
A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
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

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

newIndexDocument Source #

Arguments

:: Text	`$sel:suffix:IndexDocument'`
-> IndexDocument

Create a value of IndexDocument 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:suffix:IndexDocument', indexDocument_suffix - A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

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.

indexDocument_suffix :: Lens' IndexDocument Text Source #

A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

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.