amazonka-snowball-2.0: Amazon Import/Export Snowball SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Snowball.Types.KeyRange

Description

 
Synopsis

Documentation

data KeyRange Source #

Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

See: newKeyRange smart constructor.

Constructors

KeyRange' 

Fields

  • beginMarker :: Maybe Text

    The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

  • endMarker :: Maybe Text

    The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

Instances

Instances details
FromJSON KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

ToJSON KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

Generic KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

Associated Types

type Rep KeyRange :: Type -> Type #

Methods

from :: KeyRange -> Rep KeyRange x #

to :: Rep KeyRange x -> KeyRange #

Read KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

Show KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

NFData KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

Methods

rnf :: KeyRange -> () #

Eq KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

Hashable KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

Methods

hashWithSalt :: Int -> KeyRange -> Int #

hash :: KeyRange -> Int #

type Rep KeyRange Source # 
Instance details

Defined in Amazonka.Snowball.Types.KeyRange

type Rep KeyRange = D1 ('MetaData "KeyRange" "Amazonka.Snowball.Types.KeyRange" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "KeyRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newKeyRange :: KeyRange Source #

Create a value of KeyRange 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:beginMarker:KeyRange', keyRange_beginMarker - The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

$sel:endMarker:KeyRange', keyRange_endMarker - The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

keyRange_beginMarker :: Lens' KeyRange (Maybe Text) Source #

The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

keyRange_endMarker :: Lens' KeyRange (Maybe Text) Source #

The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.