| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.BackupStorage.PutObject
Description
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
Synopsis
- data PutObject = PutObject' {
- inlineChunkChecksum :: Maybe Text
- inlineChunkChecksumAlgorithm :: Maybe Text
- inlineChunkLength :: Maybe Integer
- metadataString :: Maybe Text
- objectChecksum :: Maybe Text
- objectChecksumAlgorithm :: Maybe SummaryChecksumAlgorithm
- throwOnDuplicate :: Maybe Bool
- backupJobId :: Text
- objectName :: Text
- inlineChunk :: HashedBody
- newPutObject :: Text -> Text -> HashedBody -> PutObject
- putObject_inlineChunkChecksum :: Lens' PutObject (Maybe Text)
- putObject_inlineChunkChecksumAlgorithm :: Lens' PutObject (Maybe Text)
- putObject_inlineChunkLength :: Lens' PutObject (Maybe Integer)
- putObject_metadataString :: Lens' PutObject (Maybe Text)
- putObject_objectChecksum :: Lens' PutObject (Maybe Text)
- putObject_objectChecksumAlgorithm :: Lens' PutObject (Maybe SummaryChecksumAlgorithm)
- putObject_throwOnDuplicate :: Lens' PutObject (Maybe Bool)
- putObject_backupJobId :: Lens' PutObject Text
- putObject_objectName :: Lens' PutObject Text
- putObject_inlineChunk :: Lens' PutObject HashedBody
- data PutObjectResponse = PutObjectResponse' {}
- newPutObjectResponse :: Int -> Text -> DataChecksumAlgorithm -> Text -> SummaryChecksumAlgorithm -> PutObjectResponse
- putObjectResponse_httpStatus :: Lens' PutObjectResponse Int
- putObjectResponse_inlineChunkChecksum :: Lens' PutObjectResponse Text
- putObjectResponse_inlineChunkChecksumAlgorithm :: Lens' PutObjectResponse DataChecksumAlgorithm
- putObjectResponse_objectChecksum :: Lens' PutObjectResponse Text
- putObjectResponse_objectChecksumAlgorithm :: Lens' PutObjectResponse SummaryChecksumAlgorithm
Creating a Request
See: newPutObject smart constructor.
Constructors
| PutObject' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> HashedBody | |
| -> PutObject |
Create a value of PutObject 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:
PutObject, putObject_inlineChunkChecksum - Inline chunk checksum
PutObject, putObject_inlineChunkChecksumAlgorithm - Inline chunk checksum algorithm
$sel:inlineChunkLength:PutObject', putObject_inlineChunkLength - Length of the inline chunk data.
PutObject, putObject_metadataString - Store user defined metadata like backup checksum, disk ids, restore
metadata etc.
PutObject, putObject_objectChecksum - object checksum
PutObject, putObject_objectChecksumAlgorithm - object checksum algorithm
$sel:throwOnDuplicate:PutObject', putObject_throwOnDuplicate - Throw an exception if Object name is already exist.
$sel:backupJobId:PutObject', putObject_backupJobId - Backup job Id for the in-progress backup.
$sel:objectName:PutObject', putObject_objectName - The name of the Object to be uploaded.
$sel:inlineChunk:PutObject', putObject_inlineChunk - Inline chunk data to be uploaded.
Request Lenses
putObject_inlineChunkChecksumAlgorithm :: Lens' PutObject (Maybe Text) Source #
Inline chunk checksum algorithm
putObject_inlineChunkLength :: Lens' PutObject (Maybe Integer) Source #
Length of the inline chunk data.
putObject_metadataString :: Lens' PutObject (Maybe Text) Source #
Store user defined metadata like backup checksum, disk ids, restore metadata etc.
putObject_objectChecksumAlgorithm :: Lens' PutObject (Maybe SummaryChecksumAlgorithm) Source #
object checksum algorithm
putObject_throwOnDuplicate :: Lens' PutObject (Maybe Bool) Source #
Throw an exception if Object name is already exist.
putObject_inlineChunk :: Lens' PutObject HashedBody Source #
Inline chunk data to be uploaded.
Destructuring the Response
data PutObjectResponse Source #
See: newPutObjectResponse smart constructor.
Constructors
| PutObjectResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> DataChecksumAlgorithm | |
| -> Text | |
| -> SummaryChecksumAlgorithm | |
| -> PutObjectResponse |
Create a value of PutObjectResponse 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:httpStatus:PutObjectResponse', putObjectResponse_httpStatus - The response's http status code.
PutObject, putObjectResponse_inlineChunkChecksum - Inline chunk checksum
PutObject, putObjectResponse_inlineChunkChecksumAlgorithm - Inline chunk checksum algorithm
PutObject, putObjectResponse_objectChecksum - object checksum
PutObject, putObjectResponse_objectChecksumAlgorithm - object checksum algorithm
Response Lenses
putObjectResponse_httpStatus :: Lens' PutObjectResponse Int Source #
The response's http status code.
putObjectResponse_inlineChunkChecksum :: Lens' PutObjectResponse Text Source #
Inline chunk checksum
putObjectResponse_inlineChunkChecksumAlgorithm :: Lens' PutObjectResponse DataChecksumAlgorithm Source #
Inline chunk checksum algorithm
putObjectResponse_objectChecksum :: Lens' PutObjectResponse Text Source #
object checksum
putObjectResponse_objectChecksumAlgorithm :: Lens' PutObjectResponse SummaryChecksumAlgorithm Source #
object checksum algorithm