amazonka-glacier-1.2.0.2: Amazon Glacier SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Glacier.Types

Contents

Description

 

Synopsis

Service Configuration

glacier :: Service Source

API version '2012-06-01' of the Amazon Glacier SDK configuration.

Errors

_PolicyEnforcedException :: AsError a => Getting (First ServiceError) 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,

_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if a parameter of the request is incorrectly specified.

_RequestTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if the service cannot complete the request.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if the request results in a vault or account limit being exceeded.

_MissingParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if a required header or parameter is missing from the request.

ActionCode

StatusCode

ArchiveCreationOutput

data ArchiveCreationOutput Source

Contains the Amazon Glacier response to your request.

For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier.

See: archiveCreationOutput smart constructor.

archiveCreationOutput :: ArchiveCreationOutput Source

Creates a value of ArchiveCreationOutput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

acoArchiveId :: Lens' ArchiveCreationOutput (Maybe Text) Source

The ID of the archive. This value is also included as part of the location.

acoChecksum :: Lens' ArchiveCreationOutput (Maybe Text) Source

The checksum of the archive computed by Amazon Glacier.

acoLocation :: Lens' ArchiveCreationOutput (Maybe Text) Source

The relative URI path of the newly added archive resource.

DataRetrievalPolicy

dataRetrievalPolicy :: DataRetrievalPolicy Source

Creates a value of DataRetrievalPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

drpRules :: Lens' DataRetrievalPolicy [DataRetrievalRule] Source

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

dataRetrievalRule :: DataRetrievalRule Source

Creates a value of DataRetrievalRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

drrStrategy :: Lens' DataRetrievalRule (Maybe Text) Source

The type of data retrieval policy to set.

Valid values: BytesPerHour|FreeTier|None

drrBytesPerHour :: Lens' DataRetrievalRule (Maybe Integer) Source

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.

DescribeVaultOutput

describeVaultOutput :: DescribeVaultOutput Source

Creates a value of DescribeVaultOutput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dvoSizeInBytes :: Lens' DescribeVaultOutput (Maybe Integer) Source

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.

dvoLastInventoryDate :: Lens' DescribeVaultOutput (Maybe Text) Source

The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

dvoVaultARN :: Lens' DescribeVaultOutput (Maybe Text) Source

The Amazon Resource Name (ARN) of the vault.

dvoCreationDate :: Lens' DescribeVaultOutput (Maybe Text) Source

The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

dvoNumberOfArchives :: Lens' DescribeVaultOutput (Maybe Integer) Source

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.

GlacierJobDescription

gjdArchiveId :: Lens' GlacierJobDescription (Maybe Text) Source

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

gjdSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) Source

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null in the following situations:

  • 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 and the job status is InProgress.
  • Inventory jobs.

gjdJobId :: Lens' GlacierJobDescription (Maybe Text) Source

An opaque string that identifies an Amazon Glacier job.

gjdRetrievalByteRange :: Lens' GlacierJobDescription (Maybe Text) Source

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 and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

gjdAction :: Lens' GlacierJobDescription (Maybe ActionCode) Source

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

gjdJobDescription :: Lens' GlacierJobDescription (Maybe Text) Source

The job description you provided when you initiated the job.

gjdSNSTopic :: Lens' GlacierJobDescription (Maybe Text) Source

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

gjdVaultARN :: Lens' GlacierJobDescription (Maybe Text) Source

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

gjdStatusMessage :: Lens' GlacierJobDescription (Maybe Text) Source

A friendly message that describes the job status.

gjdArchiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) Source

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

gjdCreationDate :: Lens' GlacierJobDescription (Maybe Text) Source

The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

gjdCompleted :: Lens' GlacierJobDescription (Maybe Bool) Source

The job status. When a job is completed, you get the job's output.

gjdCompletionDate :: Lens' GlacierJobDescription (Maybe Text) Source

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

gjdArchiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer) Source

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

gjdStatusCode :: Lens' GlacierJobDescription (Maybe StatusCode) Source

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

gjdInventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer) Source

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

InventoryRetrievalJobDescription

inventoryRetrievalJobDescription :: InventoryRetrievalJobDescription Source

Creates a value of InventoryRetrievalJobDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

irjdFormat :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source

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".

irjdEndDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

irjdStartDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source

The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

irjdMarker :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source

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.

irjdLimit :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source

Specifies 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.

InventoryRetrievalJobInput

inventoryRetrievalJobInput :: InventoryRetrievalJobInput Source

Creates a value of InventoryRetrievalJobInput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

irjiEndDate :: Lens' InventoryRetrievalJobInput (Maybe Text) Source

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

irjiStartDate :: Lens' InventoryRetrievalJobInput (Maybe Text) Source

The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z.

irjiMarker :: Lens' InventoryRetrievalJobInput (Maybe Text) Source

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.

irjiLimit :: Lens' InventoryRetrievalJobInput (Maybe Text) Source

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

JobParameters

jobParameters :: JobParameters Source

Creates a value of JobParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

jpArchiveId :: Lens' JobParameters (Maybe Text) Source

The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

jpRetrievalByteRange :: Lens' JobParameters (Maybe Text) Source

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.

jpFormat :: Lens' JobParameters (Maybe Text) Source

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".

jpInventoryRetrievalParameters :: Lens' JobParameters (Maybe InventoryRetrievalJobInput) Source

Input parameters used for range inventory retrieval.

jpSNSTopic :: Lens' JobParameters (Maybe Text) Source

The Amazon SNS topic ARN to which Amazon 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.

jpType :: Lens' JobParameters (Maybe Text) Source

The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval".

jpDescription :: Lens' JobParameters (Maybe Text) Source

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.

PartListElement

partListElement :: PartListElement Source

Creates a value of PartListElement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pleSHA256TreeHash :: Lens' PartListElement (Maybe Text) Source

The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.

pleRangeInBytes :: Lens' PartListElement (Maybe Text) Source

The byte range of a part, inclusive of the upper value of the range.

UploadListElement

uploadListElement :: UploadListElement Source

Creates a value of UploadListElement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

uleMultipartUploadId :: Lens' UploadListElement (Maybe Text) Source

The ID of a multipart upload.

uleArchiveDescription :: Lens' UploadListElement (Maybe Text) Source

The description of the archive that was specified in the Initiate Multipart Upload request.

ulePartSizeInBytes :: Lens' UploadListElement (Maybe Integer) Source

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.

uleVaultARN :: Lens' UploadListElement (Maybe Text) Source

The Amazon Resource Name (ARN) of the vault that contains the archive.

uleCreationDate :: Lens' UploadListElement (Maybe Text) Source

The UTC time at which the multipart upload was initiated.

VaultAccessPolicy

vaultAccessPolicy :: VaultAccessPolicy Source

Creates a value of VaultAccessPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vapPolicy :: Lens' VaultAccessPolicy (Maybe Text) Source

The vault access policy.

VaultLockPolicy

vaultLockPolicy :: VaultLockPolicy Source

Creates a value of VaultLockPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vlpPolicy :: Lens' VaultLockPolicy (Maybe Text) Source

The vault lock policy.

VaultNotificationConfig

vaultNotificationConfig :: VaultNotificationConfig Source

Creates a value of VaultNotificationConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vncSNSTopic :: Lens' VaultNotificationConfig (Maybe Text) Source

The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

vncEvents :: Lens' VaultNotificationConfig [Text] Source

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.