Amazonka.StorageGateway.CreateTapeWithBarcode

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and cannot be reused if it has already been used on a tape. This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

Creating a Request

data CreateTapeWithBarcode

CreateTapeWithBarcodeInput

See: newCreateTapeWithBarcode smart constructor.

Constructors

CreateTapeWithBarcode'

Fields

• kmsEncrypted :: Maybe Bool

  Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

  Valid Values: true | false

• kmsKey :: Maybe Text

  The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

• poolId :: Maybe Text

  The ID of the pool that you want to add your tape to for archiving. The tape in this pool is 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 Deep Archive) that corresponds to the pool.

• tags :: Maybe [Tag]

  A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.

  Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

• worm :: Maybe Bool

  Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

• gatewayARN :: Text

  The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

• tapeSizeInBytes :: Integer

  The size, in bytes, of the virtual tape that you want to create.

  The size must be aligned by gigabyte (1024*1024*1024 bytes).

• tapeBarcode :: Text

  The barcode that you want to assign to the tape.

  Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Instances

ToJSON CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

toJSON :: CreateTapeWithBarcode -> Value

toEncoding :: CreateTapeWithBarcode -> Encoding

toJSONList :: [CreateTapeWithBarcode] -> Value

toEncodingList :: [CreateTapeWithBarcode] -> Encoding

ToHeaders CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

toHeaders :: CreateTapeWithBarcode -> [Header]

ToPath CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

toPath :: CreateTapeWithBarcode -> ByteString

ToQuery CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

toQuery :: CreateTapeWithBarcode -> QueryString

AWSRequest CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Associated Types

type AWSResponse CreateTapeWithBarcode

Methods

request :: (Service -> Service) -> CreateTapeWithBarcode -> Request CreateTapeWithBarcode

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTapeWithBarcode -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTapeWithBarcode)))

Generic CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Associated Types

type Rep CreateTapeWithBarcode :: Type -> Type

Methods

from :: CreateTapeWithBarcode -> Rep CreateTapeWithBarcode x

to :: Rep CreateTapeWithBarcode x -> CreateTapeWithBarcode

Read CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

readsPrec :: Int -> ReadS CreateTapeWithBarcode

readList :: ReadS [CreateTapeWithBarcode]

readPrec :: ReadPrec CreateTapeWithBarcode

readListPrec :: ReadPrec [CreateTapeWithBarcode]

Show CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

showsPrec :: Int -> CreateTapeWithBarcode -> ShowS

show :: CreateTapeWithBarcode -> String

showList :: [CreateTapeWithBarcode] -> ShowS

NFData CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

rnf :: CreateTapeWithBarcode -> ()

Eq CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

(==) :: CreateTapeWithBarcode -> CreateTapeWithBarcode -> Bool

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

Hashable CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

hashWithSalt :: Int -> CreateTapeWithBarcode -> Int

hash :: CreateTapeWithBarcode -> Int

type AWSResponse CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type AWSResponse CreateTapeWithBarcode = CreateTapeWithBarcodeResponse

type Rep CreateTapeWithBarcode

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type Rep CreateTapeWithBarcode = D1 ('MetaData "CreateTapeWithBarcode" "Amazonka.StorageGateway.CreateTapeWithBarcode" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CreateTapeWithBarcode'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "kmsEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "worm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tapeSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "tapeBarcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateTapeWithBarcode

Arguments

:: Text

CreateTapeWithBarcode

-> Integer

CreateTapeWithBarcode

-> Text

CreateTapeWithBarcode

-> CreateTapeWithBarcode

Create a value of CreateTapeWithBarcode 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:

CreateTapeWithBarcode, createTapeWithBarcode_kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

CreateTapeWithBarcode, createTapeWithBarcode_kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

CreateTapeWithBarcode, createTapeWithBarcode_poolId - The ID of the pool that you want to add your tape to for archiving. The tape in this pool is 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 Deep Archive) that corresponds to the pool.

CreateTapeWithBarcode, createTapeWithBarcode_tags - A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

CreateTapeWithBarcode, createTapeWithBarcode_worm - Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

CreateTapeWithBarcode, createTapeWithBarcode_gatewayARN - The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

CreateTapeWithBarcode, createTapeWithBarcode_tapeSizeInBytes - The size, in bytes, of the virtual tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 bytes).

CreateTapeWithBarcode, createTapeWithBarcode_tapeBarcode - The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Request Lenses

createTapeWithBarcode_kmsEncrypted :: Lens' CreateTapeWithBarcode (Maybe Bool)

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

createTapeWithBarcode_kmsKey :: Lens' CreateTapeWithBarcode (Maybe Text)

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

createTapeWithBarcode_poolId :: Lens' CreateTapeWithBarcode (Maybe Text)

The ID of the pool that you want to add your tape to for archiving. The tape in this pool is 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 Deep Archive) that corresponds to the pool.

createTapeWithBarcode_tags :: Lens' CreateTapeWithBarcode (Maybe [Tag])

A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

createTapeWithBarcode_worm :: Lens' CreateTapeWithBarcode (Maybe Bool)

Set to TRUE if the tape you are creating is to be configured as a write-once-read-many (WORM) tape.

createTapeWithBarcode_gatewayARN :: Lens' CreateTapeWithBarcode Text

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

createTapeWithBarcode_tapeSizeInBytes :: Lens' CreateTapeWithBarcode Integer

The size, in bytes, of the virtual tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 bytes).

createTapeWithBarcode_tapeBarcode :: Lens' CreateTapeWithBarcode Text

The barcode that you want to assign to the tape.

Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

Destructuring the Response

data CreateTapeWithBarcodeResponse

CreateTapeOutput

See: newCreateTapeWithBarcodeResponse smart constructor.

Constructors

CreateTapeWithBarcodeResponse'

Fields

• tapeARN :: Maybe Text

  A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateTapeWithBarcodeResponse

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Associated Types

type Rep CreateTapeWithBarcodeResponse :: Type -> Type

Methods

from :: CreateTapeWithBarcodeResponse -> Rep CreateTapeWithBarcodeResponse x

to :: Rep CreateTapeWithBarcodeResponse x -> CreateTapeWithBarcodeResponse

Read CreateTapeWithBarcodeResponse

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

readsPrec :: Int -> ReadS CreateTapeWithBarcodeResponse

readList :: ReadS [CreateTapeWithBarcodeResponse]

readPrec :: ReadPrec CreateTapeWithBarcodeResponse

readListPrec :: ReadPrec [CreateTapeWithBarcodeResponse]

Show CreateTapeWithBarcodeResponse

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

showsPrec :: Int -> CreateTapeWithBarcodeResponse -> ShowS

show :: CreateTapeWithBarcodeResponse -> String

showList :: [CreateTapeWithBarcodeResponse] -> ShowS

NFData CreateTapeWithBarcodeResponse

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

rnf :: CreateTapeWithBarcodeResponse -> ()

Eq CreateTapeWithBarcodeResponse

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

Methods

(==) :: CreateTapeWithBarcodeResponse -> CreateTapeWithBarcodeResponse -> Bool

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

type Rep CreateTapeWithBarcodeResponse

Defined in Amazonka.StorageGateway.CreateTapeWithBarcode

type Rep CreateTapeWithBarcodeResponse = D1 ('MetaData "CreateTapeWithBarcodeResponse" "Amazonka.StorageGateway.CreateTapeWithBarcode" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CreateTapeWithBarcodeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateTapeWithBarcodeResponse

Arguments

:: Int

$sel:httpStatus:CreateTapeWithBarcodeResponse'

-> CreateTapeWithBarcodeResponse

Create a value of CreateTapeWithBarcodeResponse 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:

CreateTapeWithBarcodeResponse, createTapeWithBarcodeResponse_tapeARN - A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

$sel:httpStatus:CreateTapeWithBarcodeResponse', createTapeWithBarcodeResponse_httpStatus - The response's http status code.

Response Lenses

createTapeWithBarcodeResponse_tapeARN :: Lens' CreateTapeWithBarcodeResponse (Maybe Text)

A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

createTapeWithBarcodeResponse_httpStatus :: Lens' CreateTapeWithBarcodeResponse Int

The response's http status code.