Amazonka.BackupStorage.Types

Service Configuration

defaultService :: Service

API version 2018-04-10 of the Amazon Backup Storage SDK configuration.

Errors

_AccessDeniedException :: AsError a => Fold a ServiceError

Prism for AccessDeniedException' errors.

_DataAlreadyExistsException :: AsError a => Fold a ServiceError

Non-retryable exception. Attempted to create already existing object or chunk. This message contains a checksum of already presented data.

_IllegalArgumentException :: AsError a => Fold a ServiceError

Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for details.

_KMSInvalidKeyUsageException :: AsError a => Fold a ServiceError

Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.

_NotReadableInputStreamException :: AsError a => Fold a ServiceError

Retryalble exception. Indicated issues while reading an input stream due to the networking issues or connection drop on the client side.

_ResourceNotFoundException :: AsError a => Fold a ServiceError

Non-retryable exception. Attempted to make an operation on non-existing or expired resource.

_RetryableException :: AsError a => Fold a ServiceError

Retryable exception. In general indicates internal failure that can be fixed by retry.

_ServiceInternalException :: AsError a => Fold a ServiceError

Deprecated. To be removed from the model.

_ServiceUnavailableException :: AsError a => Fold a ServiceError

Retryable exception, indicates internal server error.

_ThrottlingException :: AsError a => Fold a ServiceError

Increased rate over throttling limits. Can be retried with exponential backoff.

DataChecksumAlgorithm

newtype DataChecksumAlgorithm

Constructors

DataChecksumAlgorithm'

Fields

• fromDataChecksumAlgorithm :: Text

Bundled Patterns

pattern DataChecksumAlgorithm_SHA256 :: DataChecksumAlgorithm

Instances

FromJSON DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

parseJSON :: Value -> Parser DataChecksumAlgorithm

parseJSONList :: Value -> Parser [DataChecksumAlgorithm]

FromJSONKey DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

fromJSONKey :: FromJSONKeyFunction DataChecksumAlgorithm

fromJSONKeyList :: FromJSONKeyFunction [DataChecksumAlgorithm]

ToJSON DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toJSON :: DataChecksumAlgorithm -> Value

toEncoding :: DataChecksumAlgorithm -> Encoding

toJSONList :: [DataChecksumAlgorithm] -> Value

toEncodingList :: [DataChecksumAlgorithm] -> Encoding

ToJSONKey DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toJSONKey :: ToJSONKeyFunction DataChecksumAlgorithm

toJSONKeyList :: ToJSONKeyFunction [DataChecksumAlgorithm]

ToByteString DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toBS :: DataChecksumAlgorithm -> ByteString

ToHeader DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toHeader :: HeaderName -> DataChecksumAlgorithm -> [Header]

ToLog DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

build :: DataChecksumAlgorithm -> ByteStringBuilder

ToQuery DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toQuery :: DataChecksumAlgorithm -> QueryString

FromText DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

fromText :: Text -> Either String DataChecksumAlgorithm

ToText DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toText :: DataChecksumAlgorithm -> Text

FromXML DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

parseXML :: [Node] -> Either String DataChecksumAlgorithm

ToXML DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

toXML :: DataChecksumAlgorithm -> XML

Generic DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Associated Types

type Rep DataChecksumAlgorithm :: Type -> Type

Methods

from :: DataChecksumAlgorithm -> Rep DataChecksumAlgorithm x

to :: Rep DataChecksumAlgorithm x -> DataChecksumAlgorithm

Read DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

readsPrec :: Int -> ReadS DataChecksumAlgorithm

readList :: ReadS [DataChecksumAlgorithm]

readPrec :: ReadPrec DataChecksumAlgorithm

readListPrec :: ReadPrec [DataChecksumAlgorithm]

Show DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

showsPrec :: Int -> DataChecksumAlgorithm -> ShowS

show :: DataChecksumAlgorithm -> String

showList :: [DataChecksumAlgorithm] -> ShowS

NFData DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

rnf :: DataChecksumAlgorithm -> ()

Eq DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

(==) :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Bool

(/=) :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Bool

Ord DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

compare :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Ordering

(<) :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Bool

(<=) :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Bool

(>) :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Bool

(>=) :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> Bool

max :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> DataChecksumAlgorithm

min :: DataChecksumAlgorithm -> DataChecksumAlgorithm -> DataChecksumAlgorithm

Hashable DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

Methods

hashWithSalt :: Int -> DataChecksumAlgorithm -> Int

hash :: DataChecksumAlgorithm -> Int

type Rep DataChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.DataChecksumAlgorithm

type Rep DataChecksumAlgorithm = D1 ('MetaData "DataChecksumAlgorithm" "Amazonka.BackupStorage.Types.DataChecksumAlgorithm" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'True) (C1 ('MetaCons "DataChecksumAlgorithm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDataChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SummaryChecksumAlgorithm

newtype SummaryChecksumAlgorithm

Constructors

SummaryChecksumAlgorithm'

Fields

• fromSummaryChecksumAlgorithm :: Text

Bundled Patterns

pattern SummaryChecksumAlgorithm_SUMMARY :: SummaryChecksumAlgorithm

Instances

FromJSON SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

parseJSON :: Value -> Parser SummaryChecksumAlgorithm

parseJSONList :: Value -> Parser [SummaryChecksumAlgorithm]

FromJSONKey SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

fromJSONKey :: FromJSONKeyFunction SummaryChecksumAlgorithm

fromJSONKeyList :: FromJSONKeyFunction [SummaryChecksumAlgorithm]

ToJSON SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toJSON :: SummaryChecksumAlgorithm -> Value

toEncoding :: SummaryChecksumAlgorithm -> Encoding

toJSONList :: [SummaryChecksumAlgorithm] -> Value

toEncodingList :: [SummaryChecksumAlgorithm] -> Encoding

ToJSONKey SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toJSONKey :: ToJSONKeyFunction SummaryChecksumAlgorithm

toJSONKeyList :: ToJSONKeyFunction [SummaryChecksumAlgorithm]

ToByteString SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toBS :: SummaryChecksumAlgorithm -> ByteString

ToHeader SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toHeader :: HeaderName -> SummaryChecksumAlgorithm -> [Header]

ToLog SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

build :: SummaryChecksumAlgorithm -> ByteStringBuilder

ToQuery SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toQuery :: SummaryChecksumAlgorithm -> QueryString

FromText SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

fromText :: Text -> Either String SummaryChecksumAlgorithm

ToText SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toText :: SummaryChecksumAlgorithm -> Text

FromXML SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

parseXML :: [Node] -> Either String SummaryChecksumAlgorithm

ToXML SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

toXML :: SummaryChecksumAlgorithm -> XML

Generic SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Associated Types

type Rep SummaryChecksumAlgorithm :: Type -> Type

Methods

from :: SummaryChecksumAlgorithm -> Rep SummaryChecksumAlgorithm x

to :: Rep SummaryChecksumAlgorithm x -> SummaryChecksumAlgorithm

Read SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

readsPrec :: Int -> ReadS SummaryChecksumAlgorithm

readList :: ReadS [SummaryChecksumAlgorithm]

readPrec :: ReadPrec SummaryChecksumAlgorithm

readListPrec :: ReadPrec [SummaryChecksumAlgorithm]

Show SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

showsPrec :: Int -> SummaryChecksumAlgorithm -> ShowS

show :: SummaryChecksumAlgorithm -> String

showList :: [SummaryChecksumAlgorithm] -> ShowS

NFData SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

rnf :: SummaryChecksumAlgorithm -> ()

Eq SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

(==) :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Bool

(/=) :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Bool

Ord SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

compare :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Ordering

(<) :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Bool

(<=) :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Bool

(>) :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Bool

(>=) :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> Bool

max :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm

min :: SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm -> SummaryChecksumAlgorithm

Hashable SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

Methods

hashWithSalt :: Int -> SummaryChecksumAlgorithm -> Int

hash :: SummaryChecksumAlgorithm -> Int

type Rep SummaryChecksumAlgorithm

Defined in Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm

type Rep SummaryChecksumAlgorithm = D1 ('MetaData "SummaryChecksumAlgorithm" "Amazonka.BackupStorage.Types.SummaryChecksumAlgorithm" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'True) (C1 ('MetaCons "SummaryChecksumAlgorithm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSummaryChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

BackupObject

data BackupObject

Object

See: newBackupObject smart constructor.

Constructors

BackupObject'

Fields

• chunksCount :: Maybe Integer

  Number of chunks in object

• metadataString :: Maybe Text

  Metadata string associated with the Object

• name :: Text

  Object name

• objectChecksum :: Text

  Object checksum

• objectChecksumAlgorithm :: SummaryChecksumAlgorithm

  Checksum algorithm

• objectToken :: Text

  Object token

Instances

FromJSON BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Methods

parseJSON :: Value -> Parser BackupObject

parseJSONList :: Value -> Parser [BackupObject]

Generic BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Associated Types

type Rep BackupObject :: Type -> Type

Methods

from :: BackupObject -> Rep BackupObject x

to :: Rep BackupObject x -> BackupObject

Read BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Methods

readsPrec :: Int -> ReadS BackupObject

readList :: ReadS [BackupObject]

readPrec :: ReadPrec BackupObject

readListPrec :: ReadPrec [BackupObject]

Show BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Methods

showsPrec :: Int -> BackupObject -> ShowS

show :: BackupObject -> String

showList :: [BackupObject] -> ShowS

NFData BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Methods

rnf :: BackupObject -> ()

Eq BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Methods

(==) :: BackupObject -> BackupObject -> Bool

(/=) :: BackupObject -> BackupObject -> Bool

Hashable BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

Methods

hashWithSalt :: Int -> BackupObject -> Int

hash :: BackupObject -> Int

type Rep BackupObject

Defined in Amazonka.BackupStorage.Types.BackupObject

type Rep BackupObject = D1 ('MetaData "BackupObject" "Amazonka.BackupStorage.Types.BackupObject" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "BackupObject'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chunksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "metadataString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "objectChecksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "objectChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SummaryChecksumAlgorithm) :*: S1 ('MetaSel ('Just "objectToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newBackupObject

Arguments

:: Text

$sel:name:BackupObject'

-> Text

$sel:objectChecksum:BackupObject'

-> SummaryChecksumAlgorithm

$sel:objectChecksumAlgorithm:BackupObject'

-> Text

$sel:objectToken:BackupObject'

-> BackupObject

Create a value of BackupObject 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:chunksCount:BackupObject', backupObject_chunksCount - Number of chunks in object

$sel:metadataString:BackupObject', backupObject_metadataString - Metadata string associated with the Object

$sel:name:BackupObject', backupObject_name - Object name

$sel:objectChecksum:BackupObject', backupObject_objectChecksum - Object checksum

$sel:objectChecksumAlgorithm:BackupObject', backupObject_objectChecksumAlgorithm - Checksum algorithm

$sel:objectToken:BackupObject', backupObject_objectToken - Object token

backupObject_chunksCount :: Lens' BackupObject (Maybe Integer)

Number of chunks in object

backupObject_metadataString :: Lens' BackupObject (Maybe Text)

Metadata string associated with the Object

backupObject_name :: Lens' BackupObject Text

Object name

backupObject_objectChecksum :: Lens' BackupObject Text

Object checksum

backupObject_objectChecksumAlgorithm :: Lens' BackupObject SummaryChecksumAlgorithm

Checksum algorithm

backupObject_objectToken :: Lens' BackupObject Text

Object token

Chunk

data Chunk

Chunk

See: newChunk smart constructor.

Constructors

Chunk'

Fields

• index :: Integer

  Chunk index

• length :: Integer

  Chunk length

• checksum :: Text

  Chunk checksum

• checksumAlgorithm :: DataChecksumAlgorithm

  Checksum algorithm

• chunkToken :: Text

  Chunk token

Instances

FromJSON Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Methods

parseJSON :: Value -> Parser Chunk

parseJSONList :: Value -> Parser [Chunk]

Generic Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Associated Types

type Rep Chunk :: Type -> Type

Methods

from :: Chunk -> Rep Chunk x

to :: Rep Chunk x -> Chunk

Read Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Methods

readsPrec :: Int -> ReadS Chunk

readList :: ReadS [Chunk]

readPrec :: ReadPrec Chunk

readListPrec :: ReadPrec [Chunk]

Show Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Methods

showsPrec :: Int -> Chunk -> ShowS

show :: Chunk -> String

showList :: [Chunk] -> ShowS

NFData Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Methods

rnf :: Chunk -> ()

Eq Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Methods

(==) :: Chunk -> Chunk -> Bool

(/=) :: Chunk -> Chunk -> Bool

Hashable Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

Methods

hashWithSalt :: Int -> Chunk -> Int

hash :: Chunk -> Int

type Rep Chunk

Defined in Amazonka.BackupStorage.Types.Chunk

type Rep Chunk = D1 ('MetaData "Chunk" "Amazonka.BackupStorage.Types.Chunk" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "Chunk'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "length") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataChecksumAlgorithm) :*: S1 ('MetaSel ('Just "chunkToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newChunk

Arguments

:: Integer

$sel:index:Chunk'

-> Integer

$sel:length:Chunk'

-> Text

$sel:checksum:Chunk'

-> DataChecksumAlgorithm

$sel:checksumAlgorithm:Chunk'

-> Text

$sel:chunkToken:Chunk'

-> Chunk

Create a value of Chunk 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:index:Chunk', chunk_index - Chunk index

$sel:length:Chunk', chunk_length - Chunk length

$sel:checksum:Chunk', chunk_checksum - Chunk checksum

$sel:checksumAlgorithm:Chunk', chunk_checksumAlgorithm - Checksum algorithm

$sel:chunkToken:Chunk', chunk_chunkToken - Chunk token

chunk_index :: Lens' Chunk Integer

Chunk index

chunk_length :: Lens' Chunk Integer

Chunk length

chunk_checksum :: Lens' Chunk Text

Chunk checksum

chunk_checksumAlgorithm :: Lens' Chunk DataChecksumAlgorithm

Checksum algorithm

chunk_chunkToken :: Lens' Chunk Text

Chunk token