Amazonka.Snowball.Types.KeyRange

Documentation

data KeyRange

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

FromJSON KeyRange

Defined in Amazonka.Snowball.Types.KeyRange

Methods

parseJSON :: Value -> Parser KeyRange

parseJSONList :: Value -> Parser [KeyRange]

ToJSON KeyRange

Defined in Amazonka.Snowball.Types.KeyRange

Methods

toJSON :: KeyRange -> Value

toEncoding :: KeyRange -> Encoding

toJSONList :: [KeyRange] -> Value

toEncodingList :: [KeyRange] -> Encoding

Generic KeyRange

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

Defined in Amazonka.Snowball.Types.KeyRange

Methods

readsPrec :: Int -> ReadS KeyRange

readList :: ReadS [KeyRange]

readPrec :: ReadPrec KeyRange

readListPrec :: ReadPrec [KeyRange]

Show KeyRange

Defined in Amazonka.Snowball.Types.KeyRange

Methods

showsPrec :: Int -> KeyRange -> ShowS

show :: KeyRange -> String

showList :: [KeyRange] -> ShowS

NFData KeyRange

Defined in Amazonka.Snowball.Types.KeyRange

Methods

rnf :: KeyRange -> ()

Eq KeyRange

Defined in Amazonka.Snowball.Types.KeyRange

Methods

(==) :: KeyRange -> KeyRange -> Bool

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

Hashable KeyRange

Defined in Amazonka.Snowball.Types.KeyRange

Methods

hashWithSalt :: Int -> KeyRange -> Int

hash :: KeyRange -> Int

type Rep KeyRange

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

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)

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)

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