Amazonka.StorageGateway.Types.Tape

Documentation

data Tape

Describes a virtual tape object.

See: newTape smart constructor.

Constructors

Tape'

Fields

• kmsKey :: Maybe Text
• poolEntryDate :: Maybe POSIX

  The date that the tape enters a custom tape pool.

• poolId :: Maybe Text

  The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

• progress :: Maybe Double

  For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

  Range: 0 (not started) to 100 (complete).

• retentionStartDate :: Maybe POSIX

  The date that the tape is first archived with tape retention lock enabled.

• tapeARN :: Maybe Text

  The Amazon Resource Name (ARN) of the virtual tape.

• tapeBarcode :: Maybe Text

  The barcode that identifies a specific virtual tape.

• tapeCreatedDate :: Maybe POSIX

  The date the virtual tape was created.

• tapeSizeInBytes :: Maybe Integer

  The size, in bytes, of the virtual tape capacity.

• tapeStatus :: Maybe Text

  The current state of the virtual tape.

• tapeUsedInBytes :: Maybe Integer

  The size, in bytes, of data stored on the virtual tape.

  This value is not available for tapes created prior to May 13, 2015.

• vTLDevice :: Maybe Text

  The virtual tape library (VTL) device that the virtual tape is associated with.

• worm :: Maybe Bool

  If the tape is archived as write-once-read-many (WORM), this value is true.

Instances

FromJSON Tape

Defined in Amazonka.StorageGateway.Types.Tape

Methods

parseJSON :: Value -> Parser Tape

parseJSONList :: Value -> Parser [Tape]

Generic Tape

Defined in Amazonka.StorageGateway.Types.Tape

Associated Types

type Rep Tape :: Type -> Type

Methods

from :: Tape -> Rep Tape x

to :: Rep Tape x -> Tape

Read Tape

Defined in Amazonka.StorageGateway.Types.Tape

Methods

readsPrec :: Int -> ReadS Tape

readList :: ReadS [Tape]

readPrec :: ReadPrec Tape

readListPrec :: ReadPrec [Tape]

Show Tape

Defined in Amazonka.StorageGateway.Types.Tape

Methods

showsPrec :: Int -> Tape -> ShowS

show :: Tape -> String

showList :: [Tape] -> ShowS

NFData Tape

Defined in Amazonka.StorageGateway.Types.Tape

Methods

rnf :: Tape -> ()

Eq Tape

Defined in Amazonka.StorageGateway.Types.Tape

Methods

(==) :: Tape -> Tape -> Bool

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

Hashable Tape

Defined in Amazonka.StorageGateway.Types.Tape

Methods

hashWithSalt :: Int -> Tape -> Int

hash :: Tape -> Int

type Rep Tape

Defined in Amazonka.StorageGateway.Types.Tape

type Rep Tape = D1 ('MetaData "Tape" "Amazonka.StorageGateway.Types.Tape" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "Tape'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "poolEntryDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "progress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "retentionStartDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "tapeBarcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tapeCreatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "tapeSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "tapeStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tapeUsedInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "vTLDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "worm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newTape :: Tape

Create a value of Tape 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:kmsKey:Tape', tape_kmsKey - Undocumented member.

$sel:poolEntryDate:Tape', tape_poolEntryDate - The date that the tape enters a custom tape pool.

$sel:poolId:Tape', tape_poolId - The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

$sel:progress:Tape', tape_progress - For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

Range: 0 (not started) to 100 (complete).

$sel:retentionStartDate:Tape', tape_retentionStartDate - The date that the tape is first archived with tape retention lock enabled.

$sel:tapeARN:Tape', tape_tapeARN - The Amazon Resource Name (ARN) of the virtual tape.

$sel:tapeBarcode:Tape', tape_tapeBarcode - The barcode that identifies a specific virtual tape.

$sel:tapeCreatedDate:Tape', tape_tapeCreatedDate - The date the virtual tape was created.

$sel:tapeSizeInBytes:Tape', tape_tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.

$sel:tapeStatus:Tape', tape_tapeStatus - The current state of the virtual tape.

$sel:tapeUsedInBytes:Tape', tape_tapeUsedInBytes - The size, in bytes, of data stored on the virtual tape.

This value is not available for tapes created prior to May 13, 2015.

$sel:vTLDevice:Tape', tape_vTLDevice - The virtual tape library (VTL) device that the virtual tape is associated with.

$sel:worm:Tape', tape_worm - If the tape is archived as write-once-read-many (WORM), this value is true.

tape_kmsKey :: Lens' Tape (Maybe Text)

Undocumented member.

tape_poolEntryDate :: Lens' Tape (Maybe UTCTime)

The date that the tape enters a custom tape pool.

tape_poolId :: Lens' Tape (Maybe Text)

The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

tape_progress :: Lens' Tape (Maybe Double)

For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

Range: 0 (not started) to 100 (complete).

tape_retentionStartDate :: Lens' Tape (Maybe UTCTime)

The date that the tape is first archived with tape retention lock enabled.

tape_tapeARN :: Lens' Tape (Maybe Text)

The Amazon Resource Name (ARN) of the virtual tape.

tape_tapeBarcode :: Lens' Tape (Maybe Text)

The barcode that identifies a specific virtual tape.

tape_tapeCreatedDate :: Lens' Tape (Maybe UTCTime)

The date the virtual tape was created.

tape_tapeSizeInBytes :: Lens' Tape (Maybe Integer)

The size, in bytes, of the virtual tape capacity.

tape_tapeStatus :: Lens' Tape (Maybe Text)

The current state of the virtual tape.

tape_tapeUsedInBytes :: Lens' Tape (Maybe Integer)

The size, in bytes, of data stored on the virtual tape.

This value is not available for tapes created prior to May 13, 2015.

tape_vTLDevice :: Lens' Tape (Maybe Text)

The virtual tape library (VTL) device that the virtual tape is associated with.

tape_worm :: Lens' Tape (Maybe Bool)

If the tape is archived as write-once-read-many (WORM), this value is true.