| 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.Glacier
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AbortMultipartUpload
- AbortVaultLock
- AddTagsToVault
- CompleteMultipartUpload
- CompleteVaultLock
- CreateVault
- DeleteArchive
- DeleteVault
- DeleteVaultAccessPolicy
- DeleteVaultNotifications
- DescribeJob
- DescribeVault
- GetDataRetrievalPolicy
- GetJobOutput
- GetVaultAccessPolicy
- GetVaultLock
- GetVaultNotifications
- InitiateJob
- InitiateMultipartUpload
- InitiateVaultLock
- ListJobs (Paginated)
- ListMultipartUploads (Paginated)
- ListParts (Paginated)
- ListProvisionedCapacity
- ListTagsForVault
- ListVaults (Paginated)
- PurchaseProvisionedCapacity
- RemoveTagsFromVault
- SetDataRetrievalPolicy
- SetVaultAccessPolicy
- SetVaultNotifications
- UploadArchive
- UploadMultipartPart
- Types
- ActionCode
- CannedACL
- EncryptionType
- ExpressionType
- FileHeaderInfo
- Permission
- QuoteFields
- StatusCode
- StorageClass
- Type
- ArchiveCreationOutput
- CSVInput
- CSVOutput
- DataRetrievalPolicy
- DataRetrievalRule
- DescribeVaultOutput
- Encryption
- GlacierJobDescription
- Grant
- Grantee
- InputSerialization
- InventoryRetrievalJobDescription
- InventoryRetrievalJobInput
- JobParameters
- OutputLocation
- OutputSerialization
- PartListElement
- ProvisionedCapacityDescription
- S3Location
- SelectParameters
- UploadListElement
- VaultAccessPolicy
- VaultLockPolicy
- VaultNotificationConfig
Description
Derived from API version 2012-06-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon S3 Glacier (Glacier) is a storage solution for "cold data."
Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.
Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).
You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Glacier.
If you are a first-time user of Glacier, we recommend that you begin by reading the following sections in the /Amazon S3 Glacier Developer Guide/:
- What is Amazon S3 Glacier
- This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.
- Getting Started with Amazon S3 Glacier
- The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.
Synopsis
- defaultService :: Service
- _InsufficientCapacityException :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MissingParameterValueException :: AsError a => Fold a ServiceError
- _PolicyEnforcedException :: AsError a => Fold a ServiceError
- _RequestTimeoutException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- newVaultExists :: Wait DescribeVault
- newVaultNotExists :: Wait DescribeVault
- data AbortMultipartUpload = AbortMultipartUpload' Text Text Text
- newAbortMultipartUpload :: Text -> Text -> Text -> AbortMultipartUpload
- data AbortMultipartUploadResponse = AbortMultipartUploadResponse' {
- newAbortMultipartUploadResponse :: AbortMultipartUploadResponse
- data AbortVaultLock = AbortVaultLock' Text Text
- newAbortVaultLock :: Text -> Text -> AbortVaultLock
- data AbortVaultLockResponse = AbortVaultLockResponse' {
- newAbortVaultLockResponse :: AbortVaultLockResponse
- data AddTagsToVault = AddTagsToVault' (Maybe (HashMap Text Text)) Text Text
- newAddTagsToVault :: Text -> Text -> AddTagsToVault
- data AddTagsToVaultResponse = AddTagsToVaultResponse' {
- newAddTagsToVaultResponse :: AddTagsToVaultResponse
- data CompleteMultipartUpload = CompleteMultipartUpload' Text Text Text Text Text
- newCompleteMultipartUpload :: Text -> Text -> Text -> Text -> Text -> CompleteMultipartUpload
- data ArchiveCreationOutput = ArchiveCreationOutput' (Maybe Text) (Maybe Text) (Maybe Text)
- newArchiveCreationOutput :: ArchiveCreationOutput
- data CompleteVaultLock = CompleteVaultLock' Text Text Text
- newCompleteVaultLock :: Text -> Text -> Text -> CompleteVaultLock
- data CompleteVaultLockResponse = CompleteVaultLockResponse' {
- newCompleteVaultLockResponse :: CompleteVaultLockResponse
- data CreateVault = CreateVault' Text Text
- newCreateVault :: Text -> Text -> CreateVault
- data CreateVaultResponse = CreateVaultResponse' (Maybe Text) Int
- newCreateVaultResponse :: Int -> CreateVaultResponse
- data DeleteArchive = DeleteArchive' Text Text Text
- newDeleteArchive :: Text -> Text -> Text -> DeleteArchive
- data DeleteArchiveResponse = DeleteArchiveResponse' {
- newDeleteArchiveResponse :: DeleteArchiveResponse
- data DeleteVault = DeleteVault' Text Text
- newDeleteVault :: Text -> Text -> DeleteVault
- data DeleteVaultResponse = DeleteVaultResponse' {
- newDeleteVaultResponse :: DeleteVaultResponse
- data DeleteVaultAccessPolicy = DeleteVaultAccessPolicy' Text Text
- newDeleteVaultAccessPolicy :: Text -> Text -> DeleteVaultAccessPolicy
- data DeleteVaultAccessPolicyResponse = DeleteVaultAccessPolicyResponse' {
- newDeleteVaultAccessPolicyResponse :: DeleteVaultAccessPolicyResponse
- data DeleteVaultNotifications = DeleteVaultNotifications' Text Text
- newDeleteVaultNotifications :: Text -> Text -> DeleteVaultNotifications
- data DeleteVaultNotificationsResponse = DeleteVaultNotificationsResponse' {
- newDeleteVaultNotificationsResponse :: DeleteVaultNotificationsResponse
- data DescribeJob = DescribeJob' Text Text Text
- newDescribeJob :: Text -> Text -> Text -> DescribeJob
- data GlacierJobDescription = GlacierJobDescription' (Maybe ActionCode) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe InventoryRetrievalJobDescription) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OutputLocation) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SelectParameters) (Maybe StatusCode) (Maybe Text) (Maybe Text) (Maybe Text)
- newGlacierJobDescription :: GlacierJobDescription
- data DescribeVault = DescribeVault' Text Text
- newDescribeVault :: Text -> Text -> DescribeVault
- data DescribeVaultOutput = DescribeVaultOutput' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text)
- newDescribeVaultOutput :: DescribeVaultOutput
- data GetDataRetrievalPolicy = GetDataRetrievalPolicy' Text
- newGetDataRetrievalPolicy :: Text -> GetDataRetrievalPolicy
- data GetDataRetrievalPolicyResponse = GetDataRetrievalPolicyResponse' (Maybe DataRetrievalPolicy) Int
- newGetDataRetrievalPolicyResponse :: Int -> GetDataRetrievalPolicyResponse
- data GetJobOutput = GetJobOutput' (Maybe Text) Text Text Text
- newGetJobOutput :: Text -> Text -> Text -> GetJobOutput
- data GetJobOutputResponse = GetJobOutputResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int ResponseBody
- newGetJobOutputResponse :: Int -> ResponseBody -> GetJobOutputResponse
- data GetVaultAccessPolicy = GetVaultAccessPolicy' Text Text
- newGetVaultAccessPolicy :: Text -> Text -> GetVaultAccessPolicy
- data GetVaultAccessPolicyResponse = GetVaultAccessPolicyResponse' (Maybe VaultAccessPolicy) Int
- newGetVaultAccessPolicyResponse :: Int -> GetVaultAccessPolicyResponse
- data GetVaultLock = GetVaultLock' Text Text
- newGetVaultLock :: Text -> Text -> GetVaultLock
- data GetVaultLockResponse = GetVaultLockResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetVaultLockResponse :: Int -> GetVaultLockResponse
- data GetVaultNotifications = GetVaultNotifications' Text Text
- newGetVaultNotifications :: Text -> Text -> GetVaultNotifications
- data GetVaultNotificationsResponse = GetVaultNotificationsResponse' (Maybe VaultNotificationConfig) Int
- newGetVaultNotificationsResponse :: Int -> GetVaultNotificationsResponse
- data InitiateJob = InitiateJob' (Maybe JobParameters) Text Text
- newInitiateJob :: Text -> Text -> InitiateJob
- data InitiateJobResponse = InitiateJobResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newInitiateJobResponse :: Int -> InitiateJobResponse
- data InitiateMultipartUpload = InitiateMultipartUpload' (Maybe Text) Text Text Text
- newInitiateMultipartUpload :: Text -> Text -> Text -> InitiateMultipartUpload
- data InitiateMultipartUploadResponse = InitiateMultipartUploadResponse' (Maybe Text) Int Text
- newInitiateMultipartUploadResponse :: Int -> Text -> InitiateMultipartUploadResponse
- data InitiateVaultLock = InitiateVaultLock' (Maybe VaultLockPolicy) Text Text
- newInitiateVaultLock :: Text -> Text -> InitiateVaultLock
- data InitiateVaultLockResponse = InitiateVaultLockResponse' (Maybe Text) Int
- newInitiateVaultLockResponse :: Int -> InitiateVaultLockResponse
- data ListJobs = ListJobs' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newListJobs :: Text -> Text -> ListJobs
- data ListJobsResponse = ListJobsResponse' (Maybe [GlacierJobDescription]) (Maybe Text) Int
- newListJobsResponse :: Int -> ListJobsResponse
- data ListMultipartUploads = ListMultipartUploads' (Maybe Text) (Maybe Text) Text Text
- newListMultipartUploads :: Text -> Text -> ListMultipartUploads
- data ListMultipartUploadsResponse = ListMultipartUploadsResponse' (Maybe Text) (Maybe [UploadListElement]) Int
- newListMultipartUploadsResponse :: Int -> ListMultipartUploadsResponse
- data ListParts = ListParts' (Maybe Text) (Maybe Text) Text Text Text
- newListParts :: Text -> Text -> Text -> ListParts
- data ListPartsResponse = ListPartsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe [PartListElement]) (Maybe Text) Int
- newListPartsResponse :: Int -> ListPartsResponse
- data ListProvisionedCapacity = ListProvisionedCapacity' Text
- newListProvisionedCapacity :: Text -> ListProvisionedCapacity
- data ListProvisionedCapacityResponse = ListProvisionedCapacityResponse' (Maybe [ProvisionedCapacityDescription]) Int
- newListProvisionedCapacityResponse :: Int -> ListProvisionedCapacityResponse
- data ListTagsForVault = ListTagsForVault' Text Text
- newListTagsForVault :: Text -> Text -> ListTagsForVault
- data ListTagsForVaultResponse = ListTagsForVaultResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForVaultResponse :: Int -> ListTagsForVaultResponse
- data ListVaults = ListVaults' (Maybe Text) (Maybe Text) Text
- newListVaults :: Text -> ListVaults
- data ListVaultsResponse = ListVaultsResponse' (Maybe Text) (Maybe [DescribeVaultOutput]) Int
- newListVaultsResponse :: Int -> ListVaultsResponse
- data PurchaseProvisionedCapacity = PurchaseProvisionedCapacity' Text
- newPurchaseProvisionedCapacity :: Text -> PurchaseProvisionedCapacity
- data PurchaseProvisionedCapacityResponse = PurchaseProvisionedCapacityResponse' (Maybe Text) Int
- newPurchaseProvisionedCapacityResponse :: Int -> PurchaseProvisionedCapacityResponse
- data RemoveTagsFromVault = RemoveTagsFromVault' (Maybe [Text]) Text Text
- newRemoveTagsFromVault :: Text -> Text -> RemoveTagsFromVault
- data RemoveTagsFromVaultResponse = RemoveTagsFromVaultResponse' {
- newRemoveTagsFromVaultResponse :: RemoveTagsFromVaultResponse
- data SetDataRetrievalPolicy = SetDataRetrievalPolicy' (Maybe DataRetrievalPolicy) Text
- newSetDataRetrievalPolicy :: Text -> SetDataRetrievalPolicy
- data SetDataRetrievalPolicyResponse = SetDataRetrievalPolicyResponse' {
- newSetDataRetrievalPolicyResponse :: SetDataRetrievalPolicyResponse
- data SetVaultAccessPolicy = SetVaultAccessPolicy' (Maybe VaultAccessPolicy) Text Text
- newSetVaultAccessPolicy :: Text -> Text -> SetVaultAccessPolicy
- data SetVaultAccessPolicyResponse = SetVaultAccessPolicyResponse' {
- newSetVaultAccessPolicyResponse :: SetVaultAccessPolicyResponse
- data SetVaultNotifications = SetVaultNotifications' (Maybe VaultNotificationConfig) Text Text
- newSetVaultNotifications :: Text -> Text -> SetVaultNotifications
- data SetVaultNotificationsResponse = SetVaultNotificationsResponse' {
- newSetVaultNotificationsResponse :: SetVaultNotificationsResponse
- data UploadArchive = UploadArchive' (Maybe Text) (Maybe Text) Text Text HashedBody
- newUploadArchive :: Text -> Text -> HashedBody -> UploadArchive
- data ArchiveCreationOutput = ArchiveCreationOutput' (Maybe Text) (Maybe Text) (Maybe Text)
- newArchiveCreationOutput :: ArchiveCreationOutput
- data UploadMultipartPart = UploadMultipartPart' Text Text Text Text Text HashedBody
- newUploadMultipartPart :: Text -> Text -> Text -> Text -> Text -> HashedBody -> UploadMultipartPart
- data UploadMultipartPartResponse = UploadMultipartPartResponse' (Maybe Text) Int
- newUploadMultipartPartResponse :: Int -> UploadMultipartPartResponse
- newtype ActionCode where
- ActionCode' { }
- pattern ActionCode_ArchiveRetrieval :: ActionCode
- pattern ActionCode_InventoryRetrieval :: ActionCode
- pattern ActionCode_Select :: ActionCode
- newtype CannedACL where
- CannedACL' { }
- pattern CannedACL_Authenticated_read :: CannedACL
- pattern CannedACL_Aws_exec_read :: CannedACL
- pattern CannedACL_Bucket_owner_full_control :: CannedACL
- pattern CannedACL_Bucket_owner_read :: CannedACL
- pattern CannedACL_Private :: CannedACL
- pattern CannedACL_Public_read :: CannedACL
- pattern CannedACL_Public_read_write :: CannedACL
- newtype EncryptionType where
- EncryptionType' { }
- pattern EncryptionType_AES256 :: EncryptionType
- pattern EncryptionType_Aws_kms :: EncryptionType
- newtype ExpressionType where
- ExpressionType' { }
- pattern ExpressionType_SQL :: ExpressionType
- newtype FileHeaderInfo where
- FileHeaderInfo' { }
- pattern FileHeaderInfo_IGNORE :: FileHeaderInfo
- pattern FileHeaderInfo_NONE :: FileHeaderInfo
- pattern FileHeaderInfo_USE :: FileHeaderInfo
- newtype Permission where
- Permission' { }
- pattern Permission_FULL_CONTROL :: Permission
- pattern Permission_READ :: Permission
- pattern Permission_READ_ACP :: Permission
- pattern Permission_WRITE :: Permission
- pattern Permission_WRITE_ACP :: Permission
- newtype QuoteFields where
- QuoteFields' { }
- pattern QuoteFields_ALWAYS :: QuoteFields
- pattern QuoteFields_ASNEEDED :: QuoteFields
- newtype StatusCode where
- StatusCode' { }
- pattern StatusCode_Failed :: StatusCode
- pattern StatusCode_InProgress :: StatusCode
- pattern StatusCode_Succeeded :: StatusCode
- newtype StorageClass where
- StorageClass' { }
- pattern StorageClass_REDUCED_REDUNDANCY :: StorageClass
- pattern StorageClass_STANDARD :: StorageClass
- pattern StorageClass_STANDARD_IA :: StorageClass
- newtype Type where
- Type' { }
- pattern Type_AmazonCustomerByEmail :: Type
- pattern Type_CanonicalUser :: Type
- pattern Type_Group :: Type
- data ArchiveCreationOutput = ArchiveCreationOutput' (Maybe Text) (Maybe Text) (Maybe Text)
- newArchiveCreationOutput :: ArchiveCreationOutput
- data CSVInput = CSVInput' (Maybe Text) (Maybe Text) (Maybe FileHeaderInfo) (Maybe Text) (Maybe Text) (Maybe Text)
- newCSVInput :: CSVInput
- data CSVOutput = CSVOutput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuoteFields) (Maybe Text)
- newCSVOutput :: CSVOutput
- data DataRetrievalPolicy = DataRetrievalPolicy' (Maybe [DataRetrievalRule])
- newDataRetrievalPolicy :: DataRetrievalPolicy
- data DataRetrievalRule = DataRetrievalRule' (Maybe Integer) (Maybe Text)
- newDataRetrievalRule :: DataRetrievalRule
- data DescribeVaultOutput = DescribeVaultOutput' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text)
- newDescribeVaultOutput :: DescribeVaultOutput
- data Encryption = Encryption' (Maybe EncryptionType) (Maybe Text) (Maybe Text)
- newEncryption :: Encryption
- data GlacierJobDescription = GlacierJobDescription' (Maybe ActionCode) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe InventoryRetrievalJobDescription) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OutputLocation) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SelectParameters) (Maybe StatusCode) (Maybe Text) (Maybe Text) (Maybe Text)
- newGlacierJobDescription :: GlacierJobDescription
- data Grant = Grant' (Maybe Grantee) (Maybe Permission)
- newGrant :: Grant
- data Grantee = Grantee' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Type
- newGrantee :: Type -> Grantee
- data InputSerialization = InputSerialization' (Maybe CSVInput)
- newInputSerialization :: InputSerialization
- data InventoryRetrievalJobDescription = InventoryRetrievalJobDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newInventoryRetrievalJobDescription :: InventoryRetrievalJobDescription
- data InventoryRetrievalJobInput = InventoryRetrievalJobInput' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newInventoryRetrievalJobInput :: InventoryRetrievalJobInput
- data JobParameters = JobParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InventoryRetrievalJobInput) (Maybe OutputLocation) (Maybe Text) (Maybe Text) (Maybe SelectParameters) (Maybe Text) (Maybe Text)
- newJobParameters :: JobParameters
- data OutputLocation = OutputLocation' (Maybe S3Location)
- newOutputLocation :: OutputLocation
- data OutputSerialization = OutputSerialization' (Maybe CSVOutput)
- newOutputSerialization :: OutputSerialization
- data PartListElement = PartListElement' (Maybe Text) (Maybe Text)
- newPartListElement :: PartListElement
- data ProvisionedCapacityDescription = ProvisionedCapacityDescription' (Maybe Text) (Maybe Text) (Maybe Text)
- newProvisionedCapacityDescription :: ProvisionedCapacityDescription
- data S3Location = S3Location' (Maybe [Grant]) (Maybe Text) (Maybe CannedACL) (Maybe Encryption) (Maybe Text) (Maybe StorageClass) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text))
- newS3Location :: S3Location
- data SelectParameters = SelectParameters' (Maybe Text) (Maybe ExpressionType) (Maybe InputSerialization) (Maybe OutputSerialization)
- newSelectParameters :: SelectParameters
- data UploadListElement = UploadListElement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text)
- newUploadListElement :: UploadListElement
- data VaultAccessPolicy = VaultAccessPolicy' (Maybe Text)
- newVaultAccessPolicy :: VaultAccessPolicy
- data VaultLockPolicy = VaultLockPolicy' (Maybe Text)
- newVaultLockPolicy :: VaultLockPolicy
- data VaultNotificationConfig = VaultNotificationConfig' (Maybe [Text]) (Maybe Text)
- newVaultNotificationConfig :: VaultNotificationConfig
Service Configuration
defaultService :: Service Source #
API version 2012-06-01 of the Amazon Glacier SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Glacier.
InsufficientCapacityException
_InsufficientCapacityException :: AsError a => Fold a ServiceError Source #
Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
Returned if a parameter of the request is incorrectly specified.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
Returned if the request results in a vault or account limit being exceeded.
MissingParameterValueException
_MissingParameterValueException :: AsError a => Fold a ServiceError Source #
Returned if a required header or parameter is missing from the request.
PolicyEnforcedException
_PolicyEnforcedException :: AsError a => Fold a ServiceError Source #
Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
RequestTimeoutException
_RequestTimeoutException :: AsError a => Fold a ServiceError Source #
Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
Returned if the service cannot complete the request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
VaultExists
newVaultExists :: Wait DescribeVault Source #
Polls DescribeVault every 3 seconds until a successful state is reached. An error is returned after 15 failed checks.
VaultNotExists
newVaultNotExists :: Wait DescribeVault Source #
Polls DescribeVault every 3 seconds until a successful state is reached. An error is returned after 15 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AbortMultipartUpload
data AbortMultipartUpload Source #
Provides options to abort a multipart upload identified by the upload ID.
For information about the underlying REST API, see Abort Multipart Upload. For conceptual information, see Working with Archives in Amazon S3 Glacier.
See: newAbortMultipartUpload smart constructor.
Constructors
| AbortMultipartUpload' Text Text Text |
Instances
newAbortMultipartUpload Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> AbortMultipartUpload |
Create a value of AbortMultipartUpload 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:accountId:AbortMultipartUpload', abortMultipartUpload_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
AbortMultipartUpload, abortMultipartUpload_vaultName - The name of the vault.
$sel:uploadId:AbortMultipartUpload', abortMultipartUpload_uploadId - The upload ID of the multipart upload to delete.
data AbortMultipartUploadResponse Source #
See: newAbortMultipartUploadResponse smart constructor.
Constructors
| AbortMultipartUploadResponse' | |
Instances
| Generic AbortMultipartUploadResponse Source # | |
Defined in Amazonka.Glacier.AbortMultipartUpload Associated Types type Rep AbortMultipartUploadResponse :: Type -> Type # | |
| Read AbortMultipartUploadResponse Source # | |
| Show AbortMultipartUploadResponse Source # | |
Defined in Amazonka.Glacier.AbortMultipartUpload Methods showsPrec :: Int -> AbortMultipartUploadResponse -> ShowS # show :: AbortMultipartUploadResponse -> String # showList :: [AbortMultipartUploadResponse] -> ShowS # | |
| NFData AbortMultipartUploadResponse Source # | |
Defined in Amazonka.Glacier.AbortMultipartUpload Methods rnf :: AbortMultipartUploadResponse -> () # | |
| Eq AbortMultipartUploadResponse Source # | |
Defined in Amazonka.Glacier.AbortMultipartUpload Methods (==) :: AbortMultipartUploadResponse -> AbortMultipartUploadResponse -> Bool # (/=) :: AbortMultipartUploadResponse -> AbortMultipartUploadResponse -> Bool # | |
| type Rep AbortMultipartUploadResponse Source # | |
Defined in Amazonka.Glacier.AbortMultipartUpload | |
newAbortMultipartUploadResponse :: AbortMultipartUploadResponse Source #
Create a value of AbortMultipartUploadResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AbortVaultLock
data AbortVaultLock Source #
The input values for AbortVaultLock.
See: newAbortVaultLock smart constructor.
Constructors
| AbortVaultLock' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AbortVaultLock |
Create a value of AbortVaultLock 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:accountId:AbortVaultLock', abortVaultLock_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
AbortVaultLock, abortVaultLock_vaultName - The name of the vault.
data AbortVaultLockResponse Source #
See: newAbortVaultLockResponse smart constructor.
Constructors
| AbortVaultLockResponse' | |
Instances
| Generic AbortVaultLockResponse Source # | |
Defined in Amazonka.Glacier.AbortVaultLock Associated Types type Rep AbortVaultLockResponse :: Type -> Type # Methods from :: AbortVaultLockResponse -> Rep AbortVaultLockResponse x # to :: Rep AbortVaultLockResponse x -> AbortVaultLockResponse # | |
| Read AbortVaultLockResponse Source # | |
Defined in Amazonka.Glacier.AbortVaultLock | |
| Show AbortVaultLockResponse Source # | |
Defined in Amazonka.Glacier.AbortVaultLock Methods showsPrec :: Int -> AbortVaultLockResponse -> ShowS # show :: AbortVaultLockResponse -> String # showList :: [AbortVaultLockResponse] -> ShowS # | |
| NFData AbortVaultLockResponse Source # | |
Defined in Amazonka.Glacier.AbortVaultLock Methods rnf :: AbortVaultLockResponse -> () # | |
| Eq AbortVaultLockResponse Source # | |
Defined in Amazonka.Glacier.AbortVaultLock Methods (==) :: AbortVaultLockResponse -> AbortVaultLockResponse -> Bool # (/=) :: AbortVaultLockResponse -> AbortVaultLockResponse -> Bool # | |
| type Rep AbortVaultLockResponse Source # | |
newAbortVaultLockResponse :: AbortVaultLockResponse Source #
Create a value of AbortVaultLockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AddTagsToVault
data AddTagsToVault Source #
The input values for AddTagsToVault.
See: newAddTagsToVault smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AddTagsToVault |
Create a value of AddTagsToVault 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:tags:AddTagsToVault', addTagsToVault_tags - The tags to add to the vault. Each tag is composed of a key and a value.
The value can be an empty string.
$sel:accountId:AddTagsToVault', addTagsToVault_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
AddTagsToVault, addTagsToVault_vaultName - The name of the vault.
data AddTagsToVaultResponse Source #
See: newAddTagsToVaultResponse smart constructor.
Constructors
| AddTagsToVaultResponse' | |
Instances
| Generic AddTagsToVaultResponse Source # | |
Defined in Amazonka.Glacier.AddTagsToVault Associated Types type Rep AddTagsToVaultResponse :: Type -> Type # Methods from :: AddTagsToVaultResponse -> Rep AddTagsToVaultResponse x # to :: Rep AddTagsToVaultResponse x -> AddTagsToVaultResponse # | |
| Read AddTagsToVaultResponse Source # | |
Defined in Amazonka.Glacier.AddTagsToVault | |
| Show AddTagsToVaultResponse Source # | |
Defined in Amazonka.Glacier.AddTagsToVault Methods showsPrec :: Int -> AddTagsToVaultResponse -> ShowS # show :: AddTagsToVaultResponse -> String # showList :: [AddTagsToVaultResponse] -> ShowS # | |
| NFData AddTagsToVaultResponse Source # | |
Defined in Amazonka.Glacier.AddTagsToVault Methods rnf :: AddTagsToVaultResponse -> () # | |
| Eq AddTagsToVaultResponse Source # | |
Defined in Amazonka.Glacier.AddTagsToVault Methods (==) :: AddTagsToVaultResponse -> AddTagsToVaultResponse -> Bool # (/=) :: AddTagsToVaultResponse -> AddTagsToVaultResponse -> Bool # | |
| type Rep AddTagsToVaultResponse Source # | |
newAddTagsToVaultResponse :: AddTagsToVaultResponse Source #
Create a value of AddTagsToVaultResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CompleteMultipartUpload
data CompleteMultipartUpload Source #
Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon S3 Glacier (Glacier) can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource.
See: newCompleteMultipartUpload smart constructor.
Instances
newCompleteMultipartUpload Source #
Create a value of CompleteMultipartUpload 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:accountId:CompleteMultipartUpload', completeMultipartUpload_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
CompleteMultipartUpload, completeMultipartUpload_vaultName - The name of the vault.
$sel:uploadId:CompleteMultipartUpload', completeMultipartUpload_uploadId - The upload ID of the multipart upload.
$sel:archiveSize:CompleteMultipartUpload', completeMultipartUpload_archiveSize - The total size, in bytes, of the entire archive. This value should be
the sum of all the sizes of the individual parts that you uploaded.
CompleteMultipartUpload, completeMultipartUpload_checksum - The SHA256 tree hash of the entire archive. It is the tree hash of
SHA256 tree hash of the individual parts. If the value you specify in
the request does not match the SHA256 tree hash of the final assembled
archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an
error and the request fails.
data ArchiveCreationOutput Source #
Contains the Amazon S3 Glacier response to your request.
For information about the underlying REST API, see Upload Archive. For conceptual information, see Working with Archives in Amazon S3 Glacier.
See: newArchiveCreationOutput smart constructor.
Instances
newArchiveCreationOutput :: ArchiveCreationOutput Source #
Create a value of ArchiveCreationOutput 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:archiveId:ArchiveCreationOutput', archiveCreationOutput_archiveId - The ID of the archive. This value is also included as part of the
location.
$sel:checksum:ArchiveCreationOutput', archiveCreationOutput_checksum - The checksum of the archive computed by Amazon S3 Glacier.
$sel:location:ArchiveCreationOutput', archiveCreationOutput_location - The relative URI path of the newly added archive resource.
CompleteVaultLock
data CompleteVaultLock Source #
The input values for CompleteVaultLock.
See: newCompleteVaultLock smart constructor.
Constructors
| CompleteVaultLock' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CompleteVaultLock |
Create a value of CompleteVaultLock 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:accountId:CompleteVaultLock', completeVaultLock_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
CompleteVaultLock, completeVaultLock_vaultName - The name of the vault.
$sel:lockId:CompleteVaultLock', completeVaultLock_lockId - The lockId value is the lock ID obtained from a InitiateVaultLock
request.
data CompleteVaultLockResponse Source #
See: newCompleteVaultLockResponse smart constructor.
Constructors
| CompleteVaultLockResponse' | |
Instances
newCompleteVaultLockResponse :: CompleteVaultLockResponse Source #
Create a value of CompleteVaultLockResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateVault
data CreateVault Source #
Provides options to create a vault.
See: newCreateVault smart constructor.
Constructors
| CreateVault' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateVault |
Create a value of CreateVault 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:accountId:CreateVault', createVault_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon S3 Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
CreateVault, createVault_vaultName - The name of the vault.
data CreateVaultResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newCreateVaultResponse smart constructor.
Constructors
| CreateVaultResponse' (Maybe Text) Int |
Instances
newCreateVaultResponse Source #
Arguments
| :: Int | |
| -> CreateVaultResponse |
Create a value of CreateVaultResponse 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:
CreateVaultResponse, createVaultResponse_location - The URI of the vault that was created.
$sel:httpStatus:CreateVaultResponse', createVaultResponse_httpStatus - The response's http status code.
DeleteArchive
data DeleteArchive Source #
Provides options for deleting an archive from an Amazon S3 Glacier vault.
See: newDeleteArchive smart constructor.
Constructors
| DeleteArchive' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DeleteArchive |
Create a value of DeleteArchive 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:accountId:DeleteArchive', deleteArchive_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
DeleteArchive, deleteArchive_vaultName - The name of the vault.
DeleteArchive, deleteArchive_archiveId - The ID of the archive to delete.
data DeleteArchiveResponse Source #
See: newDeleteArchiveResponse smart constructor.
Constructors
| DeleteArchiveResponse' | |
Instances
newDeleteArchiveResponse :: DeleteArchiveResponse Source #
Create a value of DeleteArchiveResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVault
data DeleteVault Source #
Provides options for deleting a vault from Amazon S3 Glacier.
See: newDeleteVault smart constructor.
Constructors
| DeleteVault' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteVault |
Create a value of DeleteVault 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:accountId:DeleteVault', deleteVault_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
DeleteVault, deleteVault_vaultName - The name of the vault.
data DeleteVaultResponse Source #
See: newDeleteVaultResponse smart constructor.
Constructors
| DeleteVaultResponse' | |
Instances
newDeleteVaultResponse :: DeleteVaultResponse Source #
Create a value of DeleteVaultResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVaultAccessPolicy
data DeleteVaultAccessPolicy Source #
DeleteVaultAccessPolicy input.
See: newDeleteVaultAccessPolicy smart constructor.
Constructors
| DeleteVaultAccessPolicy' Text Text |
Instances
newDeleteVaultAccessPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteVaultAccessPolicy |
Create a value of DeleteVaultAccessPolicy 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:accountId:DeleteVaultAccessPolicy', deleteVaultAccessPolicy_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
DeleteVaultAccessPolicy, deleteVaultAccessPolicy_vaultName - The name of the vault.
data DeleteVaultAccessPolicyResponse Source #
See: newDeleteVaultAccessPolicyResponse smart constructor.
Constructors
| DeleteVaultAccessPolicyResponse' | |
Instances
| Generic DeleteVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultAccessPolicy Associated Types type Rep DeleteVaultAccessPolicyResponse :: Type -> Type # | |
| Read DeleteVaultAccessPolicyResponse Source # | |
| Show DeleteVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultAccessPolicy Methods showsPrec :: Int -> DeleteVaultAccessPolicyResponse -> ShowS # | |
| NFData DeleteVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultAccessPolicy Methods rnf :: DeleteVaultAccessPolicyResponse -> () # | |
| Eq DeleteVaultAccessPolicyResponse Source # | |
| type Rep DeleteVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultAccessPolicy | |
newDeleteVaultAccessPolicyResponse :: DeleteVaultAccessPolicyResponse Source #
Create a value of DeleteVaultAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVaultNotifications
data DeleteVaultNotifications Source #
Provides options for deleting a vault notification configuration from an Amazon Glacier vault.
See: newDeleteVaultNotifications smart constructor.
Constructors
| DeleteVaultNotifications' Text Text |
Instances
newDeleteVaultNotifications Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteVaultNotifications |
Create a value of DeleteVaultNotifications 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:accountId:DeleteVaultNotifications', deleteVaultNotifications_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
DeleteVaultNotifications, deleteVaultNotifications_vaultName - The name of the vault.
data DeleteVaultNotificationsResponse Source #
See: newDeleteVaultNotificationsResponse smart constructor.
Constructors
| DeleteVaultNotificationsResponse' | |
Instances
| Generic DeleteVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultNotifications Associated Types type Rep DeleteVaultNotificationsResponse :: Type -> Type # | |
| Read DeleteVaultNotificationsResponse Source # | |
| Show DeleteVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultNotifications Methods showsPrec :: Int -> DeleteVaultNotificationsResponse -> ShowS # | |
| NFData DeleteVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultNotifications Methods rnf :: DeleteVaultNotificationsResponse -> () # | |
| Eq DeleteVaultNotificationsResponse Source # | |
| type Rep DeleteVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.DeleteVaultNotifications | |
newDeleteVaultNotificationsResponse :: DeleteVaultNotificationsResponse Source #
Create a value of DeleteVaultNotificationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeJob
data DescribeJob Source #
Provides options for retrieving a job description.
See: newDescribeJob smart constructor.
Constructors
| DescribeJob' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeJob |
Create a value of DescribeJob 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:accountId:DescribeJob', describeJob_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
DescribeJob, describeJob_vaultName - The name of the vault.
DescribeJob, describeJob_jobId - The ID of the job to describe.
data GlacierJobDescription Source #
Contains the description of an Amazon S3 Glacier job.
See: newGlacierJobDescription smart constructor.
Constructors
| GlacierJobDescription' (Maybe ActionCode) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe InventoryRetrievalJobDescription) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OutputLocation) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SelectParameters) (Maybe StatusCode) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newGlacierJobDescription :: GlacierJobDescription Source #
Create a value of GlacierJobDescription 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:action:GlacierJobDescription', glacierJobDescription_action - The job type. This value is either ArchiveRetrieval,
InventoryRetrieval, or Select.
$sel:archiveId:GlacierJobDescription', glacierJobDescription_archiveId - The archive ID requested for a select job or archive retrieval.
Otherwise, this field is null.
$sel:archiveSHA256TreeHash:GlacierJobDescription', glacierJobDescription_archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For
inventory retrieval or select jobs, this field is null.
$sel:archiveSizeInBytes:GlacierJobDescription', glacierJobDescription_archiveSizeInBytes - For an archive retrieval job, this value is the size in bytes of the
archive being requested for download. For an inventory retrieval or
select job, this value is null.
$sel:completed:GlacierJobDescription', glacierJobDescription_completed - The job status. When a job is completed, you get the job's output using
Get Job Output (GET output).
$sel:completionDate:GlacierJobDescription', glacierJobDescription_completionDate - The UTC time that the job request completed. While the job is in
progress, the value is null.
$sel:creationDate:GlacierJobDescription', glacierJobDescription_creationDate - The UTC date when the job was created. This value is a string
representation of ISO 8601 date format, for example
"2012-03-20T17:03:43.221Z".
$sel:inventoryRetrievalParameters:GlacierJobDescription', glacierJobDescription_inventoryRetrievalParameters - Parameters used for range inventory retrieval.
$sel:inventorySizeInBytes:GlacierJobDescription', glacierJobDescription_inventorySizeInBytes - For an inventory retrieval job, this value is the size in bytes of the
inventory requested for download. For an archive retrieval or select
job, this value is null.
$sel:jobDescription:GlacierJobDescription', glacierJobDescription_jobDescription - The job description provided when initiating the job.
$sel:jobId:GlacierJobDescription', glacierJobDescription_jobId - An opaque string that identifies an Amazon S3 Glacier job.
$sel:jobOutputPath:GlacierJobDescription', glacierJobDescription_jobOutputPath - Contains the job output location.
$sel:outputLocation:GlacierJobDescription', glacierJobDescription_outputLocation - Contains the location where the data from the select job is stored.
$sel:retrievalByteRange:GlacierJobDescription', glacierJobDescription_retrievalByteRange - The retrieved byte range for archive retrieval jobs in the form
StartByteValue-EndByteValue. If no range was specified in the
archive retrieval, then the whole archive is retrieved. In this case,
StartByteValue equals 0 and EndByteValue equals the size of the
archive minus 1. For inventory retrieval or select jobs, this field is
null.
$sel:sHA256TreeHash:GlacierJobDescription', glacierJobDescription_sHA256TreeHash - For an archive retrieval job, this value is the checksum of the archive.
Otherwise, this value is null.
The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.
If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null for the following:
- Archive retrieval jobs that specify a range that is not tree-hash aligned
- Archival jobs that specify a range that is equal to the whole
archive, when the job status is
InProgress - Inventory jobs
- Select jobs
$sel:sNSTopic:GlacierJobDescription', glacierJobDescription_sNSTopic - An Amazon SNS topic that receives notification.
$sel:selectParameters:GlacierJobDescription', glacierJobDescription_selectParameters - Contains the parameters used for a select.
$sel:statusCode:GlacierJobDescription', glacierJobDescription_statusCode - The status code can be InProgress, Succeeded, or Failed, and
indicates the status of the job.
$sel:statusMessage:GlacierJobDescription', glacierJobDescription_statusMessage - A friendly message that describes the job status.
$sel:tier:GlacierJobDescription', glacierJobDescription_tier - The tier to use for a select or an archive retrieval. Valid values are
Expedited, Standard, or Bulk. Standard is the default.
$sel:vaultARN:GlacierJobDescription', glacierJobDescription_vaultARN - The Amazon Resource Name (ARN) of the vault from which an archive
retrieval was requested.
DescribeVault
data DescribeVault Source #
Provides options for retrieving metadata for a specific vault in Amazon Glacier.
See: newDescribeVault smart constructor.
Constructors
| DescribeVault' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeVault |
Create a value of DescribeVault 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:accountId:DescribeVault', describeVault_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
DescribeVault, describeVault_vaultName - The name of the vault.
data DescribeVaultOutput Source #
Contains the Amazon S3 Glacier response to your request.
See: newDescribeVaultOutput smart constructor.
Constructors
| DescribeVaultOutput' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) |
Instances
newDescribeVaultOutput :: DescribeVaultOutput Source #
Create a value of DescribeVaultOutput 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:creationDate:DescribeVaultOutput', describeVaultOutput_creationDate - The Universal Coordinated Time (UTC) date when the vault was created.
This value should be a string in the ISO 8601 date format, for example
2012-03-20T17:03:43.221Z.
$sel:lastInventoryDate:DescribeVaultOutput', describeVaultOutput_lastInventoryDate - The Universal Coordinated Time (UTC) date when Amazon S3 Glacier
completed the last vault inventory. This value should be a string in the
ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.
$sel:numberOfArchives:DescribeVaultOutput', describeVaultOutput_numberOfArchives - The number of archives in the vault as of the last inventory date. This
field will return null if an inventory has not yet run on the vault,
for example if you just created the vault.
$sel:sizeInBytes:DescribeVaultOutput', describeVaultOutput_sizeInBytes - Total size, in bytes, of the archives in the vault as of the last
inventory date. This field will return null if an inventory has not yet
run on the vault, for example if you just created the vault.
$sel:vaultARN:DescribeVaultOutput', describeVaultOutput_vaultARN - The Amazon Resource Name (ARN) of the vault.
$sel:vaultName:DescribeVaultOutput', describeVaultOutput_vaultName - The name of the vault.
GetDataRetrievalPolicy
data GetDataRetrievalPolicy Source #
Input for GetDataRetrievalPolicy.
See: newGetDataRetrievalPolicy smart constructor.
Constructors
| GetDataRetrievalPolicy' Text |
Instances
newGetDataRetrievalPolicy Source #
Create a value of GetDataRetrievalPolicy 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:accountId:GetDataRetrievalPolicy', getDataRetrievalPolicy_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
data GetDataRetrievalPolicyResponse Source #
Contains the Amazon S3 Glacier response to the GetDataRetrievalPolicy
request.
See: newGetDataRetrievalPolicyResponse smart constructor.
Constructors
| GetDataRetrievalPolicyResponse' (Maybe DataRetrievalPolicy) Int |
Instances
newGetDataRetrievalPolicyResponse Source #
Create a value of GetDataRetrievalPolicyResponse 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:
GetDataRetrievalPolicyResponse, getDataRetrievalPolicyResponse_policy - Contains the returned data retrieval policy in JSON format.
$sel:httpStatus:GetDataRetrievalPolicyResponse', getDataRetrievalPolicyResponse_httpStatus - The response's http status code.
GetJobOutput
data GetJobOutput Source #
Provides options for downloading output of an Amazon S3 Glacier job.
See: newGetJobOutput smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetJobOutput |
Create a value of GetJobOutput 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:range:GetJobOutput', getJobOutput_range - The range of bytes to retrieve from the output. For example, if you want
to download the first 1,048,576 bytes, specify the range as
bytes=0-1048575. By default, this operation downloads the entire
output.
If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:
- Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.
- Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.
- Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.
- After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.
$sel:accountId:GetJobOutput', getJobOutput_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
GetJobOutput, getJobOutput_vaultName - The name of the vault.
GetJobOutput, getJobOutput_jobId - The job ID whose data is downloaded.
data GetJobOutputResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newGetJobOutputResponse smart constructor.
Constructors
| GetJobOutputResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int ResponseBody |
Instances
newGetJobOutputResponse Source #
Arguments
| :: Int | |
| -> ResponseBody | |
| -> GetJobOutputResponse |
Create a value of GetJobOutputResponse 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:acceptRanges:GetJobOutputResponse', getJobOutputResponse_acceptRanges - Indicates the range units accepted. For more information, see
RFC2616.
GetJobOutputResponse, getJobOutputResponse_archiveDescription - The description of an archive.
GetJobOutputResponse, getJobOutputResponse_checksum - The checksum of the data in the response. This header is returned only
when retrieving the output for an archive retrieval job. Furthermore,
this header appears only under the following conditions:
- You get the entire range of the archive.
- You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
- You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.
$sel:contentRange:GetJobOutputResponse', getJobOutputResponse_contentRange - The range of bytes returned by Amazon S3 Glacier. If only partial output
is downloaded, the response provides the range of bytes Amazon S3
Glacier returned. For example, bytes 0-1048575/8388608 returns the
first 1 MB from 8 MB.
$sel:contentType:GetJobOutputResponse', getJobOutputResponse_contentType - The Content-Type depends on whether the job output is an archive or a
vault inventory. For archive data, the Content-Type is
application/octet-stream. For vault inventory, if you requested CSV
format when you initiated the job, the Content-Type is text/csv.
Otherwise, by default, vault inventory is returned as JSON, and the
Content-Type is application/json.
$sel:status:GetJobOutputResponse', getJobOutputResponse_status - The HTTP response code for a job output request. The value depends on
whether a range was specified in the request.
$sel:body:GetJobOutputResponse', getJobOutputResponse_body - The job data, either archive data or inventory data.
GetVaultAccessPolicy
data GetVaultAccessPolicy Source #
Input for GetVaultAccessPolicy.
See: newGetVaultAccessPolicy smart constructor.
Constructors
| GetVaultAccessPolicy' Text Text |
Instances
newGetVaultAccessPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetVaultAccessPolicy |
Create a value of GetVaultAccessPolicy 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:accountId:GetVaultAccessPolicy', getVaultAccessPolicy_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
GetVaultAccessPolicy, getVaultAccessPolicy_vaultName - The name of the vault.
data GetVaultAccessPolicyResponse Source #
Output for GetVaultAccessPolicy.
See: newGetVaultAccessPolicyResponse smart constructor.
Constructors
| GetVaultAccessPolicyResponse' (Maybe VaultAccessPolicy) Int |
Instances
newGetVaultAccessPolicyResponse Source #
Create a value of GetVaultAccessPolicyResponse 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:
GetVaultAccessPolicyResponse, getVaultAccessPolicyResponse_policy - Contains the returned vault access policy as a JSON string.
$sel:httpStatus:GetVaultAccessPolicyResponse', getVaultAccessPolicyResponse_httpStatus - The response's http status code.
GetVaultLock
data GetVaultLock Source #
The input values for GetVaultLock.
See: newGetVaultLock smart constructor.
Constructors
| GetVaultLock' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetVaultLock |
Create a value of GetVaultLock 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:accountId:GetVaultLock', getVaultLock_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
GetVaultLock, getVaultLock_vaultName - The name of the vault.
data GetVaultLockResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newGetVaultLockResponse smart constructor.
Instances
newGetVaultLockResponse Source #
Arguments
| :: Int | |
| -> GetVaultLockResponse |
Create a value of GetVaultLockResponse 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:
GetVaultLockResponse, getVaultLockResponse_creationDate - The UTC date and time at which the vault lock was put into the
InProgress state.
GetVaultLockResponse, getVaultLockResponse_expirationDate - The UTC date and time at which the lock ID expires. This value can be
null if the vault lock is in a Locked state.
GetVaultLockResponse, getVaultLockResponse_policy - The vault lock policy as a JSON string, which uses "\" as an escape
character.
$sel:state:GetVaultLockResponse', getVaultLockResponse_state - The state of the vault lock. InProgress or Locked.
$sel:httpStatus:GetVaultLockResponse', getVaultLockResponse_httpStatus - The response's http status code.
GetVaultNotifications
data GetVaultNotifications Source #
Provides options for retrieving the notification configuration set on an Amazon Glacier vault.
See: newGetVaultNotifications smart constructor.
Constructors
| GetVaultNotifications' Text Text |
Instances
newGetVaultNotifications Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetVaultNotifications |
Create a value of GetVaultNotifications 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:accountId:GetVaultNotifications', getVaultNotifications_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
GetVaultNotifications, getVaultNotifications_vaultName - The name of the vault.
data GetVaultNotificationsResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newGetVaultNotificationsResponse smart constructor.
Constructors
| GetVaultNotificationsResponse' (Maybe VaultNotificationConfig) Int |
Instances
newGetVaultNotificationsResponse Source #
Create a value of GetVaultNotificationsResponse 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:vaultNotificationConfig:GetVaultNotificationsResponse', getVaultNotificationsResponse_vaultNotificationConfig - Returns the notification configuration set on the vault.
$sel:httpStatus:GetVaultNotificationsResponse', getVaultNotificationsResponse_httpStatus - The response's http status code.
InitiateJob
data InitiateJob Source #
Provides options for initiating an Amazon S3 Glacier job.
See: newInitiateJob smart constructor.
Constructors
| InitiateJob' (Maybe JobParameters) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> InitiateJob |
Create a value of InitiateJob 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:jobParameters:InitiateJob', initiateJob_jobParameters - Provides options for specifying job information.
$sel:accountId:InitiateJob', initiateJob_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
InitiateJob, initiateJob_vaultName - The name of the vault.
data InitiateJobResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newInitiateJobResponse smart constructor.
Instances
newInitiateJobResponse Source #
Arguments
| :: Int | |
| -> InitiateJobResponse |
Create a value of InitiateJobResponse 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:
InitiateJobResponse, initiateJobResponse_jobId - The ID of the job.
InitiateJobResponse, initiateJobResponse_jobOutputPath - The path to the location of where the select results are stored.
InitiateJobResponse, initiateJobResponse_location - The relative URI path of the job.
$sel:httpStatus:InitiateJobResponse', initiateJobResponse_httpStatus - The response's http status code.
InitiateMultipartUpload
data InitiateMultipartUpload Source #
Provides options for initiating a multipart upload to an Amazon S3 Glacier vault.
See: newInitiateMultipartUpload smart constructor.
Instances
newInitiateMultipartUpload Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> InitiateMultipartUpload |
Create a value of InitiateMultipartUpload 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:
InitiateMultipartUpload, initiateMultipartUpload_archiveDescription - The archive description that you are uploading in parts.
The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).
$sel:accountId:InitiateMultipartUpload', initiateMultipartUpload_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
InitiateMultipartUpload, initiateMultipartUpload_vaultName - The name of the vault.
$sel:partSize:InitiateMultipartUpload', initiateMultipartUpload_partSize - The size of each part except the last, in bytes. The last part can be
smaller than this part size.
data InitiateMultipartUploadResponse Source #
The Amazon S3 Glacier response to your request.
See: newInitiateMultipartUploadResponse smart constructor.
Constructors
| InitiateMultipartUploadResponse' (Maybe Text) Int Text |
Instances
newInitiateMultipartUploadResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> InitiateMultipartUploadResponse |
Create a value of InitiateMultipartUploadResponse 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:
InitiateMultipartUploadResponse, initiateMultipartUploadResponse_location - The relative URI path of the multipart upload ID Amazon S3 Glacier
created.
$sel:httpStatus:InitiateMultipartUploadResponse', initiateMultipartUploadResponse_httpStatus - The response's http status code.
$sel:uploadId:InitiateMultipartUploadResponse', initiateMultipartUploadResponse_uploadId - The ID of the multipart upload. This value is also included as part of
the location.
InitiateVaultLock
data InitiateVaultLock Source #
The input values for InitiateVaultLock.
See: newInitiateVaultLock smart constructor.
Constructors
| InitiateVaultLock' (Maybe VaultLockPolicy) Text Text |
Instances
Create a value of InitiateVaultLock 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:
InitiateVaultLock, initiateVaultLock_policy - The vault lock policy as a JSON string, which uses "\" as an escape
character.
$sel:accountId:InitiateVaultLock', initiateVaultLock_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
InitiateVaultLock, initiateVaultLock_vaultName - The name of the vault.
data InitiateVaultLockResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newInitiateVaultLockResponse smart constructor.
Constructors
| InitiateVaultLockResponse' (Maybe Text) Int |
Instances
newInitiateVaultLockResponse Source #
Create a value of InitiateVaultLockResponse 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:lockId:InitiateVaultLockResponse', initiateVaultLockResponse_lockId - The lock ID, which is used to complete the vault locking process.
$sel:httpStatus:InitiateVaultLockResponse', initiateVaultLockResponse_httpStatus - The response's http status code.
ListJobs (Paginated)
Provides options for retrieving a job list for an Amazon S3 Glacier vault.
See: newListJobs smart constructor.
Instances
Create a value of ListJobs 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:
ListJobs, listJobs_completed - The state of the jobs to return. You can specify true or false.
ListJobs, listJobs_limit - The maximum number of jobs to be returned. The default limit is 50. The
number of jobs returned might be fewer than the specified limit, but the
number of returned jobs never exceeds the limit.
ListJobs, listJobs_marker - An opaque string used for pagination. This value specifies the job at
which the listing of jobs should begin. Get the marker value from a
previous List Jobs response. You only need to include the marker if you
are continuing the pagination of results started in a previous List Jobs
request.
$sel:statuscode:ListJobs', listJobs_statuscode - The type of job status to return. You can specify the following values:
InProgress, Succeeded, or Failed.
$sel:accountId:ListJobs', listJobs_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
ListJobs, listJobs_vaultName - The name of the vault.
data ListJobsResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newListJobsResponse smart constructor.
Constructors
| ListJobsResponse' (Maybe [GlacierJobDescription]) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> ListJobsResponse |
Create a value of ListJobsResponse 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:jobList:ListJobsResponse', listJobsResponse_jobList - A list of job objects. Each job object contains metadata describing the
job.
ListJobs, listJobsResponse_marker - An opaque string used for pagination that specifies the job at which the
listing of jobs should begin. You get the marker value from a previous
List Jobs response. You only need to include the marker if you are
continuing the pagination of the results started in a previous List Jobs
request.
$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.
ListMultipartUploads (Paginated)
data ListMultipartUploads Source #
Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.
See: newListMultipartUploads smart constructor.
Instances
newListMultipartUploads Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListMultipartUploads |
Create a value of ListMultipartUploads 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:
ListMultipartUploads, listMultipartUploads_limit - Specifies the maximum number of uploads returned in the response body.
If this value is not specified, the List Uploads operation returns up to
50 uploads.
ListMultipartUploads, listMultipartUploads_marker - An opaque string used for pagination. This value specifies the upload at
which the listing of uploads should begin. Get the marker value from a
previous List Uploads response. You need only include the marker if you
are continuing the pagination of results started in a previous List
Uploads request.
$sel:accountId:ListMultipartUploads', listMultipartUploads_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
ListMultipartUploads, listMultipartUploads_vaultName - The name of the vault.
data ListMultipartUploadsResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newListMultipartUploadsResponse smart constructor.
Constructors
| ListMultipartUploadsResponse' (Maybe Text) (Maybe [UploadListElement]) Int |
Instances
newListMultipartUploadsResponse Source #
Create a value of ListMultipartUploadsResponse 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:
ListMultipartUploads, listMultipartUploadsResponse_marker - An opaque string that represents where to continue pagination of the
results. You use the marker in a new List Multipart Uploads request to
obtain more uploads in the list. If there are no more uploads, this
value is null.
$sel:uploadsList:ListMultipartUploadsResponse', listMultipartUploadsResponse_uploadsList - A list of in-progress multipart uploads.
$sel:httpStatus:ListMultipartUploadsResponse', listMultipartUploadsResponse_httpStatus - The response's http status code.
ListParts (Paginated)
Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
See: newListParts smart constructor.
Instances
Create a value of ListParts 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:
ListParts, listParts_limit - The maximum number of parts to be returned. The default limit is 50. The
number of parts returned might be fewer than the specified limit, but
the number of returned parts never exceeds the limit.
ListParts, listParts_marker - An opaque string used for pagination. This value specifies the part at
which the listing of parts should begin. Get the marker value from the
response of a previous List Parts response. You need only include the
marker if you are continuing the pagination of results started in a
previous List Parts request.
$sel:accountId:ListParts', listParts_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
ListParts, listParts_vaultName - The name of the vault.
$sel:uploadId:ListParts', listParts_uploadId - The upload ID of the multipart upload.
data ListPartsResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newListPartsResponse smart constructor.
Constructors
| ListPartsResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe [PartListElement]) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> ListPartsResponse |
Create a value of ListPartsResponse 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:
ListPartsResponse, listPartsResponse_archiveDescription - The description of the archive that was specified in the Initiate
Multipart Upload request.
ListPartsResponse, listPartsResponse_creationDate - The UTC time at which the multipart upload was initiated.
ListParts, listPartsResponse_marker - An opaque string that represents where to continue pagination of the
results. You use the marker in a new List Parts request to obtain more
jobs in the list. If there are no more parts, this value is null.
ListPartsResponse, listPartsResponse_multipartUploadId - The ID of the upload to which the parts are associated.
ListPartsResponse, listPartsResponse_partSizeInBytes - The part size in bytes. This is the same value that you specified in the
Initiate Multipart Upload request.
$sel:parts:ListPartsResponse', listPartsResponse_parts - A list of the part sizes of the multipart upload. Each object in the
array contains a RangeBytes and sha256-tree-hash name/value pair.
ListPartsResponse, listPartsResponse_vaultARN - The Amazon Resource Name (ARN) of the vault to which the multipart
upload was initiated.
$sel:httpStatus:ListPartsResponse', listPartsResponse_httpStatus - The response's http status code.
ListProvisionedCapacity
data ListProvisionedCapacity Source #
See: newListProvisionedCapacity smart constructor.
Constructors
| ListProvisionedCapacity' Text |
Instances
newListProvisionedCapacity Source #
Create a value of ListProvisionedCapacity 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:accountId:ListProvisionedCapacity', listProvisionedCapacity_accountId - The AWS account ID of the account that owns the vault. You can either
specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the
credentials used to sign the request. If you use an account ID, don't
include any hyphens ('-') in the ID.
data ListProvisionedCapacityResponse Source #
See: newListProvisionedCapacityResponse smart constructor.
Constructors
| ListProvisionedCapacityResponse' (Maybe [ProvisionedCapacityDescription]) Int |
Instances
newListProvisionedCapacityResponse Source #
Create a value of ListProvisionedCapacityResponse 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:provisionedCapacityList:ListProvisionedCapacityResponse', listProvisionedCapacityResponse_provisionedCapacityList - The response body contains the following JSON fields.
$sel:httpStatus:ListProvisionedCapacityResponse', listProvisionedCapacityResponse_httpStatus - The response's http status code.
ListTagsForVault
data ListTagsForVault Source #
The input value for ListTagsForVaultInput.
See: newListTagsForVault smart constructor.
Constructors
| ListTagsForVault' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListTagsForVault |
Create a value of ListTagsForVault 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:accountId:ListTagsForVault', listTagsForVault_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
ListTagsForVault, listTagsForVault_vaultName - The name of the vault.
data ListTagsForVaultResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newListTagsForVaultResponse smart constructor.
Instances
newListTagsForVaultResponse Source #
Create a value of ListTagsForVaultResponse 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:tags:ListTagsForVaultResponse', listTagsForVaultResponse_tags - The tags attached to the vault. Each tag is composed of a key and a
value.
$sel:httpStatus:ListTagsForVaultResponse', listTagsForVaultResponse_httpStatus - The response's http status code.
ListVaults (Paginated)
data ListVaults Source #
Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
See: newListVaults smart constructor.
Instances
Arguments
| :: Text | |
| -> ListVaults |
Create a value of ListVaults 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:
ListVaults, listVaults_limit - The maximum number of vaults to be returned. The default limit is 10.
The number of vaults returned might be fewer than the specified limit,
but the number of returned vaults never exceeds the limit.
ListVaults, listVaults_marker - A string used for pagination. The marker specifies the vault ARN after
which the listing of vaults should begin.
$sel:accountId:ListVaults', listVaults_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
data ListVaultsResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newListVaultsResponse smart constructor.
Constructors
| ListVaultsResponse' (Maybe Text) (Maybe [DescribeVaultOutput]) Int |
Instances
newListVaultsResponse Source #
Arguments
| :: Int | |
| -> ListVaultsResponse |
Create a value of ListVaultsResponse 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:
ListVaults, listVaultsResponse_marker - The vault ARN at which to continue pagination of the results. You use
the marker in another List Vaults request to obtain more vaults in the
list.
$sel:vaultList:ListVaultsResponse', listVaultsResponse_vaultList - List of vaults.
$sel:httpStatus:ListVaultsResponse', listVaultsResponse_httpStatus - The response's http status code.
PurchaseProvisionedCapacity
data PurchaseProvisionedCapacity Source #
See: newPurchaseProvisionedCapacity smart constructor.
Constructors
| PurchaseProvisionedCapacity' Text |
Instances
newPurchaseProvisionedCapacity Source #
Create a value of PurchaseProvisionedCapacity 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:accountId:PurchaseProvisionedCapacity', purchaseProvisionedCapacity_accountId - The AWS account ID of the account that owns the vault. You can either
specify an AWS account ID or optionally a single '-' (hyphen), in
which case Amazon S3 Glacier uses the AWS account ID associated with the
credentials used to sign the request. If you use an account ID, don't
include any hyphens ('-') in the ID.
data PurchaseProvisionedCapacityResponse Source #
See: newPurchaseProvisionedCapacityResponse smart constructor.
Constructors
| PurchaseProvisionedCapacityResponse' (Maybe Text) Int |
Instances
newPurchaseProvisionedCapacityResponse Source #
Arguments
| :: Int | |
| -> PurchaseProvisionedCapacityResponse |
Create a value of PurchaseProvisionedCapacityResponse 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:
PurchaseProvisionedCapacityResponse, purchaseProvisionedCapacityResponse_capacityId - The ID that identifies the provisioned capacity unit.
$sel:httpStatus:PurchaseProvisionedCapacityResponse', purchaseProvisionedCapacityResponse_httpStatus - The response's http status code.
RemoveTagsFromVault
data RemoveTagsFromVault Source #
The input value for RemoveTagsFromVaultInput.
See: newRemoveTagsFromVault smart constructor.
Constructors
| RemoveTagsFromVault' (Maybe [Text]) Text Text |
Instances
newRemoveTagsFromVault Source #
Create a value of RemoveTagsFromVault 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:tagKeys:RemoveTagsFromVault', removeTagsFromVault_tagKeys - A list of tag keys. Each corresponding tag is removed from the vault.
$sel:accountId:RemoveTagsFromVault', removeTagsFromVault_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
RemoveTagsFromVault, removeTagsFromVault_vaultName - The name of the vault.
data RemoveTagsFromVaultResponse Source #
See: newRemoveTagsFromVaultResponse smart constructor.
Constructors
| RemoveTagsFromVaultResponse' | |
Instances
newRemoveTagsFromVaultResponse :: RemoveTagsFromVaultResponse Source #
Create a value of RemoveTagsFromVaultResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetDataRetrievalPolicy
data SetDataRetrievalPolicy Source #
SetDataRetrievalPolicy input.
See: newSetDataRetrievalPolicy smart constructor.
Constructors
| SetDataRetrievalPolicy' (Maybe DataRetrievalPolicy) Text |
Instances
newSetDataRetrievalPolicy Source #
Create a value of SetDataRetrievalPolicy 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:
SetDataRetrievalPolicy, setDataRetrievalPolicy_policy - The data retrieval policy in JSON format.
$sel:accountId:SetDataRetrievalPolicy', setDataRetrievalPolicy_accountId - The AccountId value is the AWS account ID. This value must match the
AWS account ID associated with the credentials used to sign the request.
You can either specify an AWS account ID or optionally a single '-'
(hyphen), in which case Amazon Glacier uses the AWS account ID
associated with the credentials used to sign the request. If you specify
your account ID, do not include any hyphens ('-') in the ID.
data SetDataRetrievalPolicyResponse Source #
See: newSetDataRetrievalPolicyResponse smart constructor.
Constructors
| SetDataRetrievalPolicyResponse' | |
Instances
| Generic SetDataRetrievalPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetDataRetrievalPolicy Associated Types type Rep SetDataRetrievalPolicyResponse :: Type -> Type # | |
| Read SetDataRetrievalPolicyResponse Source # | |
| Show SetDataRetrievalPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetDataRetrievalPolicy Methods showsPrec :: Int -> SetDataRetrievalPolicyResponse -> ShowS # show :: SetDataRetrievalPolicyResponse -> String # showList :: [SetDataRetrievalPolicyResponse] -> ShowS # | |
| NFData SetDataRetrievalPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetDataRetrievalPolicy Methods rnf :: SetDataRetrievalPolicyResponse -> () # | |
| Eq SetDataRetrievalPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetDataRetrievalPolicy | |
| type Rep SetDataRetrievalPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetDataRetrievalPolicy | |
newSetDataRetrievalPolicyResponse :: SetDataRetrievalPolicyResponse Source #
Create a value of SetDataRetrievalPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetVaultAccessPolicy
data SetVaultAccessPolicy Source #
SetVaultAccessPolicy input.
See: newSetVaultAccessPolicy smart constructor.
Constructors
| SetVaultAccessPolicy' (Maybe VaultAccessPolicy) Text Text |
Instances
newSetVaultAccessPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> SetVaultAccessPolicy |
Create a value of SetVaultAccessPolicy 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:
SetVaultAccessPolicy, setVaultAccessPolicy_policy - The vault access policy as a JSON string.
$sel:accountId:SetVaultAccessPolicy', setVaultAccessPolicy_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
SetVaultAccessPolicy, setVaultAccessPolicy_vaultName - The name of the vault.
data SetVaultAccessPolicyResponse Source #
See: newSetVaultAccessPolicyResponse smart constructor.
Constructors
| SetVaultAccessPolicyResponse' | |
Instances
| Generic SetVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetVaultAccessPolicy Associated Types type Rep SetVaultAccessPolicyResponse :: Type -> Type # | |
| Read SetVaultAccessPolicyResponse Source # | |
| Show SetVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetVaultAccessPolicy Methods showsPrec :: Int -> SetVaultAccessPolicyResponse -> ShowS # show :: SetVaultAccessPolicyResponse -> String # showList :: [SetVaultAccessPolicyResponse] -> ShowS # | |
| NFData SetVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetVaultAccessPolicy Methods rnf :: SetVaultAccessPolicyResponse -> () # | |
| Eq SetVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetVaultAccessPolicy Methods (==) :: SetVaultAccessPolicyResponse -> SetVaultAccessPolicyResponse -> Bool # (/=) :: SetVaultAccessPolicyResponse -> SetVaultAccessPolicyResponse -> Bool # | |
| type Rep SetVaultAccessPolicyResponse Source # | |
Defined in Amazonka.Glacier.SetVaultAccessPolicy | |
newSetVaultAccessPolicyResponse :: SetVaultAccessPolicyResponse Source #
Create a value of SetVaultAccessPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetVaultNotifications
data SetVaultNotifications Source #
Provides options to configure notifications that will be sent when specific events happen to a vault.
See: newSetVaultNotifications smart constructor.
Constructors
| SetVaultNotifications' (Maybe VaultNotificationConfig) Text Text |
Instances
newSetVaultNotifications Source #
Arguments
| :: Text | |
| -> Text | |
| -> SetVaultNotifications |
Create a value of SetVaultNotifications 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:vaultNotificationConfig:SetVaultNotifications', setVaultNotifications_vaultNotificationConfig - Provides options for specifying notification configuration.
$sel:accountId:SetVaultNotifications', setVaultNotifications_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
SetVaultNotifications, setVaultNotifications_vaultName - The name of the vault.
data SetVaultNotificationsResponse Source #
See: newSetVaultNotificationsResponse smart constructor.
Constructors
| SetVaultNotificationsResponse' | |
Instances
| Generic SetVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.SetVaultNotifications Associated Types type Rep SetVaultNotificationsResponse :: Type -> Type # | |
| Read SetVaultNotificationsResponse Source # | |
| Show SetVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.SetVaultNotifications Methods showsPrec :: Int -> SetVaultNotificationsResponse -> ShowS # show :: SetVaultNotificationsResponse -> String # showList :: [SetVaultNotificationsResponse] -> ShowS # | |
| NFData SetVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.SetVaultNotifications Methods rnf :: SetVaultNotificationsResponse -> () # | |
| Eq SetVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.SetVaultNotifications | |
| type Rep SetVaultNotificationsResponse Source # | |
Defined in Amazonka.Glacier.SetVaultNotifications | |
newSetVaultNotificationsResponse :: SetVaultNotificationsResponse Source #
Create a value of SetVaultNotificationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UploadArchive
data UploadArchive Source #
Provides options to add an archive to a vault.
See: newUploadArchive smart constructor.
Constructors
| UploadArchive' (Maybe Text) (Maybe Text) Text Text HashedBody |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> HashedBody | |
| -> UploadArchive |
Create a value of UploadArchive 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:
UploadArchive, uploadArchive_archiveDescription - The optional description of the archive you are uploading.
UploadArchive, uploadArchive_checksum - The SHA256 tree hash of the data being uploaded.
UploadArchive, uploadArchive_vaultName - The name of the vault.
$sel:accountId:UploadArchive', uploadArchive_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
$sel:body:UploadArchive', uploadArchive_body - The data to upload.
data ArchiveCreationOutput Source #
Contains the Amazon S3 Glacier response to your request.
For information about the underlying REST API, see Upload Archive. For conceptual information, see Working with Archives in Amazon S3 Glacier.
See: newArchiveCreationOutput smart constructor.
Instances
newArchiveCreationOutput :: ArchiveCreationOutput Source #
Create a value of ArchiveCreationOutput 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:archiveId:ArchiveCreationOutput', archiveCreationOutput_archiveId - The ID of the archive. This value is also included as part of the
location.
$sel:checksum:ArchiveCreationOutput', archiveCreationOutput_checksum - The checksum of the archive computed by Amazon S3 Glacier.
$sel:location:ArchiveCreationOutput', archiveCreationOutput_location - The relative URI path of the newly added archive resource.
UploadMultipartPart
data UploadMultipartPart Source #
Provides options to upload a part of an archive in a multipart upload operation.
See: newUploadMultipartPart smart constructor.
Constructors
| UploadMultipartPart' Text Text Text Text Text HashedBody |
Instances
newUploadMultipartPart Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> HashedBody | |
| -> UploadMultipartPart |
Create a value of UploadMultipartPart 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:accountId:UploadMultipartPart', uploadMultipartPart_accountId - The AccountId value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
'-' (hyphen), in which case Amazon S3 Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens ('-') in the ID.
UploadMultipartPart, uploadMultipartPart_vaultName - The name of the vault.
$sel:uploadId:UploadMultipartPart', uploadMultipartPart_uploadId - The upload ID of the multipart upload.
$sel:range:UploadMultipartPart', uploadMultipartPart_range - Identifies the range of bytes in the assembled archive that will be
uploaded in this part. Amazon S3 Glacier uses this information to
assemble the archive in the proper sequence. The format of this header
follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.
UploadMultipartPart, uploadMultipartPart_checksum - The SHA256 tree hash of the data being uploaded.
$sel:body:UploadMultipartPart', uploadMultipartPart_body - The data to upload.
data UploadMultipartPartResponse Source #
Contains the Amazon S3 Glacier response to your request.
See: newUploadMultipartPartResponse smart constructor.
Constructors
| UploadMultipartPartResponse' (Maybe Text) Int |
Instances
newUploadMultipartPartResponse Source #
Create a value of UploadMultipartPartResponse 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:
UploadMultipartPart, uploadMultipartPartResponse_checksum - The SHA256 tree hash that Amazon S3 Glacier computed for the uploaded
part.
$sel:httpStatus:UploadMultipartPartResponse', uploadMultipartPartResponse_httpStatus - The response's http status code.
Types
ActionCode
newtype ActionCode Source #
Constructors
| ActionCode' | |
Fields | |
Bundled Patterns
| pattern ActionCode_ArchiveRetrieval :: ActionCode | |
| pattern ActionCode_InventoryRetrieval :: ActionCode | |
| pattern ActionCode_Select :: ActionCode |
Instances
CannedACL
Constructors
| CannedACL' | |
Fields | |
Bundled Patterns
| pattern CannedACL_Authenticated_read :: CannedACL | |
| pattern CannedACL_Aws_exec_read :: CannedACL | |
| pattern CannedACL_Bucket_owner_full_control :: CannedACL | |
| pattern CannedACL_Bucket_owner_read :: CannedACL | |
| pattern CannedACL_Private :: CannedACL | |
| pattern CannedACL_Public_read :: CannedACL | |
| pattern CannedACL_Public_read_write :: CannedACL |
Instances
EncryptionType
newtype EncryptionType Source #
Constructors
| EncryptionType' | |
Fields | |
Bundled Patterns
| pattern EncryptionType_AES256 :: EncryptionType | |
| pattern EncryptionType_Aws_kms :: EncryptionType |
Instances
ExpressionType
newtype ExpressionType Source #
Constructors
| ExpressionType' | |
Fields | |
Bundled Patterns
| pattern ExpressionType_SQL :: ExpressionType |
Instances
FileHeaderInfo
newtype FileHeaderInfo Source #
Constructors
| FileHeaderInfo' | |
Fields | |
Bundled Patterns
| pattern FileHeaderInfo_IGNORE :: FileHeaderInfo | |
| pattern FileHeaderInfo_NONE :: FileHeaderInfo | |
| pattern FileHeaderInfo_USE :: FileHeaderInfo |
Instances
Permission
newtype Permission Source #
Constructors
| Permission' | |
Fields | |
Bundled Patterns
| pattern Permission_FULL_CONTROL :: Permission | |
| pattern Permission_READ :: Permission | |
| pattern Permission_READ_ACP :: Permission | |
| pattern Permission_WRITE :: Permission | |
| pattern Permission_WRITE_ACP :: Permission |
Instances
QuoteFields
newtype QuoteFields Source #
Constructors
| QuoteFields' | |
Fields | |
Bundled Patterns
| pattern QuoteFields_ALWAYS :: QuoteFields | |
| pattern QuoteFields_ASNEEDED :: QuoteFields |
Instances
StatusCode
newtype StatusCode Source #
Constructors
| StatusCode' | |
Fields | |
Bundled Patterns
| pattern StatusCode_Failed :: StatusCode | |
| pattern StatusCode_InProgress :: StatusCode | |
| pattern StatusCode_Succeeded :: StatusCode |
Instances
StorageClass
newtype StorageClass Source #
Constructors
| StorageClass' | |
Fields | |
Bundled Patterns
| pattern StorageClass_REDUCED_REDUNDANCY :: StorageClass | |
| pattern StorageClass_STANDARD :: StorageClass | |
| pattern StorageClass_STANDARD_IA :: StorageClass |
Instances
Type
Bundled Patterns
| pattern Type_AmazonCustomerByEmail :: Type | |
| pattern Type_CanonicalUser :: Type | |
| pattern Type_Group :: Type |
Instances
ArchiveCreationOutput
data ArchiveCreationOutput Source #
Contains the Amazon S3 Glacier response to your request.
For information about the underlying REST API, see Upload Archive. For conceptual information, see Working with Archives in Amazon S3 Glacier.
See: newArchiveCreationOutput smart constructor.
Instances
newArchiveCreationOutput :: ArchiveCreationOutput Source #
Create a value of ArchiveCreationOutput 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:archiveId:ArchiveCreationOutput', archiveCreationOutput_archiveId - The ID of the archive. This value is also included as part of the
location.
$sel:checksum:ArchiveCreationOutput', archiveCreationOutput_checksum - The checksum of the archive computed by Amazon S3 Glacier.
$sel:location:ArchiveCreationOutput', archiveCreationOutput_location - The relative URI path of the newly added archive resource.
CSVInput
Contains information about the comma-separated value (CSV) file to select from.
See: newCSVInput smart constructor.
Constructors
| CSVInput' (Maybe Text) (Maybe Text) (Maybe FileHeaderInfo) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCSVInput :: CSVInput Source #
Create a value of CSVInput 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:comments:CSVInput', cSVInput_comments - A single character used to indicate that a row should be ignored when
the character is present at the start of that row.
$sel:fieldDelimiter:CSVInput', cSVInput_fieldDelimiter - A value used to separate individual fields from each other within a
record.
$sel:fileHeaderInfo:CSVInput', cSVInput_fileHeaderInfo - Describes the first line of input. Valid values are None, Ignore,
and Use.
$sel:quoteCharacter:CSVInput', cSVInput_quoteCharacter - A value used as an escape character where the field delimiter is part of
the value.
$sel:quoteEscapeCharacter:CSVInput', cSVInput_quoteEscapeCharacter - A single character used for escaping the quotation-mark character inside
an already escaped value.
$sel:recordDelimiter:CSVInput', cSVInput_recordDelimiter - A value used to separate individual records from each other.
CSVOutput
Contains information about the comma-separated value (CSV) file that the job results are stored in.
See: newCSVOutput smart constructor.
Instances
newCSVOutput :: CSVOutput Source #
Create a value of CSVOutput 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:fieldDelimiter:CSVOutput', cSVOutput_fieldDelimiter - A value used to separate individual fields from each other within a
record.
$sel:quoteCharacter:CSVOutput', cSVOutput_quoteCharacter - A value used as an escape character where the field delimiter is part of
the value.
$sel:quoteEscapeCharacter:CSVOutput', cSVOutput_quoteEscapeCharacter - A single character used for escaping the quotation-mark character inside
an already escaped value.
$sel:quoteFields:CSVOutput', cSVOutput_quoteFields - A value that indicates whether all output fields should be contained
within quotation marks.
$sel:recordDelimiter:CSVOutput', cSVOutput_recordDelimiter - A value used to separate individual records from each other.
DataRetrievalPolicy
data DataRetrievalPolicy Source #
Data retrieval policy.
See: newDataRetrievalPolicy smart constructor.
Constructors
| DataRetrievalPolicy' (Maybe [DataRetrievalRule]) |
Instances
newDataRetrievalPolicy :: DataRetrievalPolicy Source #
Create a value of DataRetrievalPolicy 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:rules:DataRetrievalPolicy', dataRetrievalPolicy_rules - The policy rule. Although this is a list type, currently there must be
only one rule, which contains a Strategy field and optionally a
BytesPerHour field.
DataRetrievalRule
data DataRetrievalRule Source #
Data retrieval policy rule.
See: newDataRetrievalRule smart constructor.
Constructors
| DataRetrievalRule' (Maybe Integer) (Maybe Text) |
Instances
newDataRetrievalRule :: DataRetrievalRule Source #
Create a value of DataRetrievalRule 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:bytesPerHour:DataRetrievalRule', dataRetrievalRule_bytesPerHour - The maximum number of bytes that can be retrieved in an hour.
This field is required only if the value of the Strategy field is
BytesPerHour. Your PUT operation will be rejected if the Strategy
field is not set to BytesPerHour and you set this field.
$sel:strategy:DataRetrievalRule', dataRetrievalRule_strategy - The type of data retrieval policy to set.
Valid values: BytesPerHour|FreeTier|None
DescribeVaultOutput
data DescribeVaultOutput Source #
Contains the Amazon S3 Glacier response to your request.
See: newDescribeVaultOutput smart constructor.
Constructors
| DescribeVaultOutput' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) |
Instances
newDescribeVaultOutput :: DescribeVaultOutput Source #
Create a value of DescribeVaultOutput 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:creationDate:DescribeVaultOutput', describeVaultOutput_creationDate - The Universal Coordinated Time (UTC) date when the vault was created.
This value should be a string in the ISO 8601 date format, for example
2012-03-20T17:03:43.221Z.
$sel:lastInventoryDate:DescribeVaultOutput', describeVaultOutput_lastInventoryDate - The Universal Coordinated Time (UTC) date when Amazon S3 Glacier
completed the last vault inventory. This value should be a string in the
ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.
$sel:numberOfArchives:DescribeVaultOutput', describeVaultOutput_numberOfArchives - The number of archives in the vault as of the last inventory date. This
field will return null if an inventory has not yet run on the vault,
for example if you just created the vault.
$sel:sizeInBytes:DescribeVaultOutput', describeVaultOutput_sizeInBytes - Total size, in bytes, of the archives in the vault as of the last
inventory date. This field will return null if an inventory has not yet
run on the vault, for example if you just created the vault.
$sel:vaultARN:DescribeVaultOutput', describeVaultOutput_vaultARN - The Amazon Resource Name (ARN) of the vault.
$sel:vaultName:DescribeVaultOutput', describeVaultOutput_vaultName - The name of the vault.
Encryption
data Encryption Source #
Contains information about the encryption used to store the job results in Amazon S3.
See: newEncryption smart constructor.
Constructors
| Encryption' (Maybe EncryptionType) (Maybe Text) (Maybe Text) |
Instances
newEncryption :: Encryption Source #
Create a value of Encryption 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:encryptionType:Encryption', encryption_encryptionType - The server-side encryption algorithm used when storing job results in
Amazon S3, for example AES256 or aws:kms.
$sel:kmsContext:Encryption', encryption_kmsContext - Optional. If the encryption type is aws:kms, you can use this value to
specify the encryption context for the job results.
$sel:kmsKeyId:Encryption', encryption_kmsKeyId - The AWS KMS key ID to use for object encryption. All GET and PUT
requests for an object protected by AWS KMS fail if not made by using
Secure Sockets Layer (SSL) or Signature Version 4.
GlacierJobDescription
data GlacierJobDescription Source #
Contains the description of an Amazon S3 Glacier job.
See: newGlacierJobDescription smart constructor.
Constructors
| GlacierJobDescription' (Maybe ActionCode) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe InventoryRetrievalJobDescription) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OutputLocation) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SelectParameters) (Maybe StatusCode) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newGlacierJobDescription :: GlacierJobDescription Source #
Create a value of GlacierJobDescription 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:action:GlacierJobDescription', glacierJobDescription_action - The job type. This value is either ArchiveRetrieval,
InventoryRetrieval, or Select.
$sel:archiveId:GlacierJobDescription', glacierJobDescription_archiveId - The archive ID requested for a select job or archive retrieval.
Otherwise, this field is null.
$sel:archiveSHA256TreeHash:GlacierJobDescription', glacierJobDescription_archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For
inventory retrieval or select jobs, this field is null.
$sel:archiveSizeInBytes:GlacierJobDescription', glacierJobDescription_archiveSizeInBytes - For an archive retrieval job, this value is the size in bytes of the
archive being requested for download. For an inventory retrieval or
select job, this value is null.
$sel:completed:GlacierJobDescription', glacierJobDescription_completed - The job status. When a job is completed, you get the job's output using
Get Job Output (GET output).
$sel:completionDate:GlacierJobDescription', glacierJobDescription_completionDate - The UTC time that the job request completed. While the job is in
progress, the value is null.
$sel:creationDate:GlacierJobDescription', glacierJobDescription_creationDate - The UTC date when the job was created. This value is a string
representation of ISO 8601 date format, for example
"2012-03-20T17:03:43.221Z".
$sel:inventoryRetrievalParameters:GlacierJobDescription', glacierJobDescription_inventoryRetrievalParameters - Parameters used for range inventory retrieval.
$sel:inventorySizeInBytes:GlacierJobDescription', glacierJobDescription_inventorySizeInBytes - For an inventory retrieval job, this value is the size in bytes of the
inventory requested for download. For an archive retrieval or select
job, this value is null.
$sel:jobDescription:GlacierJobDescription', glacierJobDescription_jobDescription - The job description provided when initiating the job.
$sel:jobId:GlacierJobDescription', glacierJobDescription_jobId - An opaque string that identifies an Amazon S3 Glacier job.
$sel:jobOutputPath:GlacierJobDescription', glacierJobDescription_jobOutputPath - Contains the job output location.
$sel:outputLocation:GlacierJobDescription', glacierJobDescription_outputLocation - Contains the location where the data from the select job is stored.
$sel:retrievalByteRange:GlacierJobDescription', glacierJobDescription_retrievalByteRange - The retrieved byte range for archive retrieval jobs in the form
StartByteValue-EndByteValue. If no range was specified in the
archive retrieval, then the whole archive is retrieved. In this case,
StartByteValue equals 0 and EndByteValue equals the size of the
archive minus 1. For inventory retrieval or select jobs, this field is
null.
$sel:sHA256TreeHash:GlacierJobDescription', glacierJobDescription_sHA256TreeHash - For an archive retrieval job, this value is the checksum of the archive.
Otherwise, this value is null.
The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.
If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null for the following:
- Archive retrieval jobs that specify a range that is not tree-hash aligned
- Archival jobs that specify a range that is equal to the whole
archive, when the job status is
InProgress - Inventory jobs
- Select jobs
$sel:sNSTopic:GlacierJobDescription', glacierJobDescription_sNSTopic - An Amazon SNS topic that receives notification.
$sel:selectParameters:GlacierJobDescription', glacierJobDescription_selectParameters - Contains the parameters used for a select.
$sel:statusCode:GlacierJobDescription', glacierJobDescription_statusCode - The status code can be InProgress, Succeeded, or Failed, and
indicates the status of the job.
$sel:statusMessage:GlacierJobDescription', glacierJobDescription_statusMessage - A friendly message that describes the job status.
$sel:tier:GlacierJobDescription', glacierJobDescription_tier - The tier to use for a select or an archive retrieval. Valid values are
Expedited, Standard, or Bulk. Standard is the default.
$sel:vaultARN:GlacierJobDescription', glacierJobDescription_vaultARN - The Amazon Resource Name (ARN) of the vault from which an archive
retrieval was requested.
Grant
Contains information about a grant.
See: newGrant smart constructor.
Constructors
| Grant' (Maybe Grantee) (Maybe Permission) |
Instances
| FromJSON Grant Source # | |
| ToJSON Grant Source # | |
Defined in Amazonka.Glacier.Types.Grant | |
| Generic Grant Source # | |
| Read Grant Source # | |
| Show Grant Source # | |
| NFData Grant Source # | |
Defined in Amazonka.Glacier.Types.Grant | |
| Eq Grant Source # | |
| Hashable Grant Source # | |
Defined in Amazonka.Glacier.Types.Grant | |
| type Rep Grant Source # | |
Defined in Amazonka.Glacier.Types.Grant type Rep Grant = D1 ('MetaData "Grant" "Amazonka.Glacier.Types.Grant" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "Grant'" 'PrefixI 'True) (S1 ('MetaSel ('Just "grantee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Grantee)) :*: S1 ('MetaSel ('Just "permission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Permission)))) | |
Create a value of Grant 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:grantee:Grant', grant_grantee - The grantee.
$sel:permission:Grant', grant_permission - Specifies the permission given to the grantee.
Grantee
Contains information about the grantee.
See: newGrantee smart constructor.
Instances
Create a value of Grantee 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:displayName:Grantee', grantee_displayName - Screen name of the grantee.
$sel:emailAddress:Grantee', grantee_emailAddress - Email address of the grantee.
$sel:id:Grantee', grantee_id - The canonical user ID of the grantee.
$sel:uri:Grantee', grantee_uri - URI of the grantee group.
$sel:type':Grantee', grantee_type - Type of grantee
InputSerialization
data InputSerialization Source #
Describes how the archive is serialized.
See: newInputSerialization smart constructor.
Constructors
| InputSerialization' (Maybe CSVInput) |
Instances
newInputSerialization :: InputSerialization Source #
Create a value of InputSerialization 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:csv:InputSerialization', inputSerialization_csv - Describes the serialization of a CSV-encoded object.
InventoryRetrievalJobDescription
data InventoryRetrievalJobDescription Source #
Describes the options for a range inventory retrieval job.
See: newInventoryRetrievalJobDescription smart constructor.
Constructors
| InventoryRetrievalJobDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newInventoryRetrievalJobDescription :: InventoryRetrievalJobDescription Source #
Create a value of InventoryRetrievalJobDescription 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:endDate:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_endDate - The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date. This value should be a
string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
$sel:format:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_format - The output format for the vault inventory list, which is set by the
InitiateJob request when initiating a job to retrieve a vault
inventory. Valid values are CSV and JSON.
$sel:limit:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_limit - The maximum number of inventory items returned per vault inventory
retrieval request. This limit is set when initiating the job with the a
InitiateJob request.
$sel:marker:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_marker - An opaque string that represents where to continue pagination of the
vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items. If there
are no more inventory items, this value is null. For more information,
see
Range Inventory Retrieval.
$sel:startDate:InventoryRetrievalJobDescription', inventoryRetrievalJobDescription_startDate - The start of the date range in Universal Coordinated Time (UTC) for
vault inventory retrieval that includes archives created on or after
this date. This value should be a string in the ISO 8601 date format,
for example 2013-03-20T17:03:43Z.
InventoryRetrievalJobInput
data InventoryRetrievalJobInput Source #
Provides options for specifying a range inventory retrieval job.
See: newInventoryRetrievalJobInput smart constructor.
Instances
newInventoryRetrievalJobInput :: InventoryRetrievalJobInput Source #
Create a value of InventoryRetrievalJobInput 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:endDate:InventoryRetrievalJobInput', inventoryRetrievalJobInput_endDate - The end of the date range in UTC for vault inventory retrieval that
includes archives created before this date. This value should be a
string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
$sel:limit:InventoryRetrievalJobInput', inventoryRetrievalJobInput_limit - Specifies the maximum number of inventory items returned per vault
inventory retrieval request. Valid values are greater than or equal to
1.
$sel:marker:InventoryRetrievalJobInput', inventoryRetrievalJobInput_marker - An opaque string that represents where to continue pagination of the
vault inventory retrieval results. You use the marker in a new
InitiateJob request to obtain additional inventory items. If there
are no more inventory items, this value is null.
$sel:startDate:InventoryRetrievalJobInput', inventoryRetrievalJobInput_startDate - The start of the date range in UTC for vault inventory retrieval that
includes archives created on or after this date. This value should be a
string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
JobParameters
data JobParameters Source #
Provides options for defining a job.
See: newJobParameters smart constructor.
Constructors
| JobParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe InventoryRetrievalJobInput) (Maybe OutputLocation) (Maybe Text) (Maybe Text) (Maybe SelectParameters) (Maybe Text) (Maybe Text) |
Instances
newJobParameters :: JobParameters Source #
Create a value of JobParameters 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:archiveId:JobParameters', jobParameters_archiveId - The ID of the archive that you want to retrieve. This field is required
only if Type is set to select or archive-retrievalcode>. An error
occurs if you specify this request parameter for an inventory retrieval
job request.
$sel:description:JobParameters', jobParameters_description - The optional description for the job. The description must be less than
or equal to 1,024 bytes. The allowable characters are 7-bit ASCII
without control codes-specifically, ASCII values 32-126 decimal or
0x20-0x7E hexadecimal.
$sel:format:JobParameters', jobParameters_format - When initiating a job to retrieve a vault inventory, you can optionally
add this parameter to your request to specify the output format. If you
are initiating an inventory job and do not specify a Format field, JSON
is the default format. Valid values are "CSV" and "JSON".
$sel:inventoryRetrievalParameters:JobParameters', jobParameters_inventoryRetrievalParameters - Input parameters used for range inventory retrieval.
$sel:outputLocation:JobParameters', jobParameters_outputLocation - Contains information about the location where the select job results are
stored.
$sel:retrievalByteRange:JobParameters', jobParameters_retrievalByteRange - The byte range to retrieve for an archive retrieval. in the form
"StartByteValue-EndByteValue" If not specified, the whole archive
is retrieved. If specified, the byte range must be megabyte (1024*1024)
aligned which means that StartByteValue must be divisible by 1 MB and
EndByteValue plus 1 must be divisible by 1 MB or be the end of the
archive specified as the archive byte size value minus 1. If
RetrievalByteRange is not megabyte aligned, this operation returns a 400
response.
An error occurs if you specify this field for an inventory retrieval job request.
$sel:sNSTopic:JobParameters', jobParameters_sNSTopic - The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification
when the job is completed and the output is ready for you to download.
The specified topic publishes the notification to its subscribers. The
SNS topic must exist.
$sel:selectParameters:JobParameters', jobParameters_selectParameters - Contains the parameters that define a job.
$sel:tier:JobParameters', jobParameters_tier - The tier to use for a select or an archive retrieval job. Valid values
are Expedited, Standard, or Bulk. Standard is the default.
$sel:type':JobParameters', jobParameters_type - The job type. You can initiate a job to perform a select query on an
archive, retrieve an archive, or get an inventory of a vault. Valid
values are "select", "archive-retrieval" and
"inventory-retrieval".
OutputLocation
data OutputLocation Source #
Contains information about the location where the select job results are stored.
See: newOutputLocation smart constructor.
Constructors
| OutputLocation' (Maybe S3Location) |
Instances
newOutputLocation :: OutputLocation Source #
Create a value of OutputLocation 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:s3:OutputLocation', outputLocation_s3 - Describes an S3 location that will receive the results of the job
request.
OutputSerialization
data OutputSerialization Source #
Describes how the select output is serialized.
See: newOutputSerialization smart constructor.
Constructors
| OutputSerialization' (Maybe CSVOutput) |
Instances
newOutputSerialization :: OutputSerialization Source #
Create a value of OutputSerialization 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:csv:OutputSerialization', outputSerialization_csv - Describes the serialization of CSV-encoded query results.
PartListElement
data PartListElement Source #
A list of the part sizes of the multipart upload.
See: newPartListElement smart constructor.
Constructors
| PartListElement' (Maybe Text) (Maybe Text) |
Instances
newPartListElement :: PartListElement Source #
Create a value of PartListElement 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:rangeInBytes:PartListElement', partListElement_rangeInBytes - The byte range of a part, inclusive of the upper value of the range.
$sel:sHA256TreeHash:PartListElement', partListElement_sHA256TreeHash - The SHA256 tree hash value that Amazon S3 Glacier calculated for the
part. This field is never null.
ProvisionedCapacityDescription
data ProvisionedCapacityDescription Source #
The definition for a provisioned capacity unit.
See: newProvisionedCapacityDescription smart constructor.
Instances
newProvisionedCapacityDescription :: ProvisionedCapacityDescription Source #
Create a value of ProvisionedCapacityDescription 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:capacityId:ProvisionedCapacityDescription', provisionedCapacityDescription_capacityId - The ID that identifies the provisioned capacity unit.
$sel:expirationDate:ProvisionedCapacityDescription', provisionedCapacityDescription_expirationDate - The date that the provisioned capacity unit expires, in Universal
Coordinated Time (UTC).
$sel:startDate:ProvisionedCapacityDescription', provisionedCapacityDescription_startDate - The date that the provisioned capacity unit was purchased, in Universal
Coordinated Time (UTC).
S3Location
data S3Location Source #
Contains information about the location in Amazon S3 where the select job results are stored.
See: newS3Location smart constructor.
Constructors
| S3Location' (Maybe [Grant]) (Maybe Text) (Maybe CannedACL) (Maybe Encryption) (Maybe Text) (Maybe StorageClass) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) |
Instances
newS3Location :: S3Location Source #
Create a value of S3Location 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:accessControlList:S3Location', s3Location_accessControlList - A list of grants that control access to the staged results.
$sel:bucketName:S3Location', s3Location_bucketName - The name of the Amazon S3 bucket where the job results are stored.
$sel:cannedACL:S3Location', s3Location_cannedACL - The canned access control list (ACL) to apply to the job results.
$sel:encryption:S3Location', s3Location_encryption - Contains information about the encryption used to store the job results
in Amazon S3.
$sel:prefix:S3Location', s3Location_prefix - The prefix that is prepended to the results for this request.
$sel:storageClass:S3Location', s3Location_storageClass - The storage class used to store the job results.
$sel:tagging:S3Location', s3Location_tagging - The tag-set that is applied to the job results.
$sel:userMetadata:S3Location', s3Location_userMetadata - A map of metadata to store with the job results in Amazon S3.
SelectParameters
data SelectParameters Source #
Contains information about the parameters used for a select.
See: newSelectParameters smart constructor.
Constructors
| SelectParameters' (Maybe Text) (Maybe ExpressionType) (Maybe InputSerialization) (Maybe OutputSerialization) |
Instances
newSelectParameters :: SelectParameters Source #
Create a value of SelectParameters 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:expression:SelectParameters', selectParameters_expression - The expression that is used to select the object.
$sel:expressionType:SelectParameters', selectParameters_expressionType - The type of the provided expression, for example SQL.
$sel:inputSerialization:SelectParameters', selectParameters_inputSerialization - Describes the serialization format of the object.
$sel:outputSerialization:SelectParameters', selectParameters_outputSerialization - Describes how the results of the select job are serialized.
UploadListElement
data UploadListElement Source #
A list of in-progress multipart uploads for a vault.
See: newUploadListElement smart constructor.
Instances
newUploadListElement :: UploadListElement Source #
Create a value of UploadListElement 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:archiveDescription:UploadListElement', uploadListElement_archiveDescription - The description of the archive that was specified in the Initiate
Multipart Upload request.
$sel:creationDate:UploadListElement', uploadListElement_creationDate - The UTC time at which the multipart upload was initiated.
$sel:multipartUploadId:UploadListElement', uploadListElement_multipartUploadId - The ID of a multipart upload.
$sel:partSizeInBytes:UploadListElement', uploadListElement_partSizeInBytes - The part size, in bytes, specified in the Initiate Multipart Upload
request. This is the size of all the parts in the upload except the last
part, which may be smaller than this size.
$sel:vaultARN:UploadListElement', uploadListElement_vaultARN - The Amazon Resource Name (ARN) of the vault that contains the archive.
VaultAccessPolicy
data VaultAccessPolicy Source #
Contains the vault access policy.
See: newVaultAccessPolicy smart constructor.
Constructors
| VaultAccessPolicy' (Maybe Text) |
Instances
newVaultAccessPolicy :: VaultAccessPolicy Source #
Create a value of VaultAccessPolicy 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:policy:VaultAccessPolicy', vaultAccessPolicy_policy - The vault access policy.
VaultLockPolicy
data VaultLockPolicy Source #
Contains the vault lock policy.
See: newVaultLockPolicy smart constructor.
Constructors
| VaultLockPolicy' (Maybe Text) |
Instances
newVaultLockPolicy :: VaultLockPolicy Source #
Create a value of VaultLockPolicy 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:policy:VaultLockPolicy', vaultLockPolicy_policy - The vault lock policy.
VaultNotificationConfig
data VaultNotificationConfig Source #
Represents a vault's notification configuration.
See: newVaultNotificationConfig smart constructor.
Constructors
| VaultNotificationConfig' (Maybe [Text]) (Maybe Text) |
Instances
newVaultNotificationConfig :: VaultNotificationConfig Source #
Create a value of VaultNotificationConfig 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:events:VaultNotificationConfig', vaultNotificationConfig_events - A list of one or more events for which Amazon S3 Glacier will send a
notification to the specified Amazon SNS topic.
$sel:sNSTopic:VaultNotificationConfig', vaultNotificationConfig_sNSTopic - The Amazon Simple Notification Service (Amazon SNS) topic Amazon
Resource Name (ARN).