| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Glacier
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- SetVaultAccessPolicy
- InitiateJob
- SetDataRetrievalPolicy
- DeleteVaultAccessPolicy
- GetVaultNotifications
- ListTagsForVault
- UploadMultipartPart
- DeleteVaultNotifications
- CompleteVaultLock
- AbortVaultLock
- ListVaults (Paginated)
- ListProvisionedCapacity
- ListJobs (Paginated)
- SetVaultNotifications
- GetJobOutput
- CompleteMultipartUpload
- ListMultipartUploads (Paginated)
- AbortMultipartUpload
- PurchaseProvisionedCapacity
- DescribeVault
- GetVaultLock
- DescribeJob
- InitiateVaultLock
- GetVaultAccessPolicy
- GetDataRetrievalPolicy
- RemoveTagsFromVault
- DeleteVault
- DeleteArchive
- CreateVault
- InitiateMultipartUpload
- ListParts (Paginated)
- AddTagsToVault
- UploadArchive
- 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
Amazon Glacier is a storage solution for "cold data."
Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon 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.
Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. 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 Amazon Glacier.
If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide :
- What is Amazon 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 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
- glacier :: Service
- _PolicyEnforcedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientCapacityException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _MissingParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- vaultNotExists :: Wait DescribeVault
- vaultExists :: Wait DescribeVault
- module Network.AWS.Glacier.SetVaultAccessPolicy
- module Network.AWS.Glacier.InitiateJob
- module Network.AWS.Glacier.SetDataRetrievalPolicy
- module Network.AWS.Glacier.DeleteVaultAccessPolicy
- module Network.AWS.Glacier.GetVaultNotifications
- module Network.AWS.Glacier.ListTagsForVault
- module Network.AWS.Glacier.UploadMultipartPart
- module Network.AWS.Glacier.DeleteVaultNotifications
- module Network.AWS.Glacier.CompleteVaultLock
- module Network.AWS.Glacier.AbortVaultLock
- module Network.AWS.Glacier.ListVaults
- module Network.AWS.Glacier.ListProvisionedCapacity
- module Network.AWS.Glacier.ListJobs
- module Network.AWS.Glacier.SetVaultNotifications
- module Network.AWS.Glacier.GetJobOutput
- module Network.AWS.Glacier.CompleteMultipartUpload
- module Network.AWS.Glacier.ListMultipartUploads
- module Network.AWS.Glacier.AbortMultipartUpload
- module Network.AWS.Glacier.PurchaseProvisionedCapacity
- module Network.AWS.Glacier.DescribeVault
- module Network.AWS.Glacier.GetVaultLock
- module Network.AWS.Glacier.DescribeJob
- module Network.AWS.Glacier.InitiateVaultLock
- module Network.AWS.Glacier.GetVaultAccessPolicy
- module Network.AWS.Glacier.GetDataRetrievalPolicy
- module Network.AWS.Glacier.RemoveTagsFromVault
- module Network.AWS.Glacier.DeleteVault
- module Network.AWS.Glacier.DeleteArchive
- module Network.AWS.Glacier.CreateVault
- module Network.AWS.Glacier.InitiateMultipartUpload
- module Network.AWS.Glacier.ListParts
- module Network.AWS.Glacier.AddTagsToVault
- module Network.AWS.Glacier.UploadArchive
- data ActionCode
- data CannedACL
- data EncryptionType
- data ExpressionType = Sql
- data FileHeaderInfo
- data Permission
- = FullControl
- | Read
- | ReadAcp
- | Write
- | WriteAcp
- data QuoteFields
- data StatusCode
- data StorageClass
- data Type
- data ArchiveCreationOutput
- archiveCreationOutput :: ArchiveCreationOutput
- acoArchiveId :: Lens' ArchiveCreationOutput (Maybe Text)
- acoChecksum :: Lens' ArchiveCreationOutput (Maybe Text)
- acoLocation :: Lens' ArchiveCreationOutput (Maybe Text)
- data CSVInput
- csvInput :: CSVInput
- ciQuoteCharacter :: Lens' CSVInput (Maybe Text)
- ciRecordDelimiter :: Lens' CSVInput (Maybe Text)
- ciFileHeaderInfo :: Lens' CSVInput (Maybe FileHeaderInfo)
- ciQuoteEscapeCharacter :: Lens' CSVInput (Maybe Text)
- ciComments :: Lens' CSVInput (Maybe Text)
- ciFieldDelimiter :: Lens' CSVInput (Maybe Text)
- data CSVOutput
- csvOutput :: CSVOutput
- coQuoteCharacter :: Lens' CSVOutput (Maybe Text)
- coQuoteFields :: Lens' CSVOutput (Maybe QuoteFields)
- coRecordDelimiter :: Lens' CSVOutput (Maybe Text)
- coQuoteEscapeCharacter :: Lens' CSVOutput (Maybe Text)
- coFieldDelimiter :: Lens' CSVOutput (Maybe Text)
- data DataRetrievalPolicy
- dataRetrievalPolicy :: DataRetrievalPolicy
- drpRules :: Lens' DataRetrievalPolicy [DataRetrievalRule]
- data DataRetrievalRule
- dataRetrievalRule :: DataRetrievalRule
- drrStrategy :: Lens' DataRetrievalRule (Maybe Text)
- drrBytesPerHour :: Lens' DataRetrievalRule (Maybe Integer)
- data DescribeVaultOutput
- describeVaultOutput :: DescribeVaultOutput
- dvoVaultName :: Lens' DescribeVaultOutput (Maybe Text)
- dvoSizeInBytes :: Lens' DescribeVaultOutput (Maybe Integer)
- dvoLastInventoryDate :: Lens' DescribeVaultOutput (Maybe Text)
- dvoVaultARN :: Lens' DescribeVaultOutput (Maybe Text)
- dvoCreationDate :: Lens' DescribeVaultOutput (Maybe Text)
- dvoNumberOfArchives :: Lens' DescribeVaultOutput (Maybe Integer)
- data Encryption
- encryption :: Encryption
- eEncryptionType :: Lens' Encryption (Maybe EncryptionType)
- eKMSKeyId :: Lens' Encryption (Maybe Text)
- eKMSContext :: Lens' Encryption (Maybe Text)
- data GlacierJobDescription
- glacierJobDescription :: GlacierJobDescription
- gjdSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)
- gjdArchiveId :: Lens' GlacierJobDescription (Maybe Text)
- gjdSelectParameters :: Lens' GlacierJobDescription (Maybe SelectParameters)
- gjdJobId :: Lens' GlacierJobDescription (Maybe Text)
- gjdJobOutputPath :: Lens' GlacierJobDescription (Maybe Text)
- gjdRetrievalByteRange :: Lens' GlacierJobDescription (Maybe Text)
- gjdInventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription)
- gjdAction :: Lens' GlacierJobDescription (Maybe ActionCode)
- gjdJobDescription :: Lens' GlacierJobDescription (Maybe Text)
- gjdSNSTopic :: Lens' GlacierJobDescription (Maybe Text)
- gjdStatusMessage :: Lens' GlacierJobDescription (Maybe Text)
- gjdVaultARN :: Lens' GlacierJobDescription (Maybe Text)
- gjdOutputLocation :: Lens' GlacierJobDescription (Maybe OutputLocation)
- gjdTier :: Lens' GlacierJobDescription (Maybe Text)
- gjdArchiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)
- gjdCreationDate :: Lens' GlacierJobDescription (Maybe Text)
- gjdCompleted :: Lens' GlacierJobDescription (Maybe Bool)
- gjdCompletionDate :: Lens' GlacierJobDescription (Maybe Text)
- gjdInventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)
- gjdArchiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)
- gjdStatusCode :: Lens' GlacierJobDescription (Maybe StatusCode)
- data Grant
- grant :: Grant
- gPermission :: Lens' Grant (Maybe Permission)
- gGrantee :: Lens' Grant (Maybe Grantee)
- data Grantee
- grantee :: Type -> Grantee
- gURI :: Lens' Grantee (Maybe Text)
- gEmailAddress :: Lens' Grantee (Maybe Text)
- gDisplayName :: Lens' Grantee (Maybe Text)
- gId :: Lens' Grantee (Maybe Text)
- gType :: Lens' Grantee Type
- data InputSerialization
- inputSerialization :: InputSerialization
- isCsv :: Lens' InputSerialization (Maybe CSVInput)
- data InventoryRetrievalJobDescription
- inventoryRetrievalJobDescription :: InventoryRetrievalJobDescription
- irjdFormat :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- irjdEndDate :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- irjdStartDate :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- irjdMarker :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- irjdLimit :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- data InventoryRetrievalJobInput
- inventoryRetrievalJobInput :: InventoryRetrievalJobInput
- irjiEndDate :: Lens' InventoryRetrievalJobInput (Maybe Text)
- irjiStartDate :: Lens' InventoryRetrievalJobInput (Maybe Text)
- irjiMarker :: Lens' InventoryRetrievalJobInput (Maybe Text)
- irjiLimit :: Lens' InventoryRetrievalJobInput (Maybe Text)
- data JobParameters
- jobParameters :: JobParameters
- jpArchiveId :: Lens' JobParameters (Maybe Text)
- jpSelectParameters :: Lens' JobParameters (Maybe SelectParameters)
- jpFormat :: Lens' JobParameters (Maybe Text)
- jpRetrievalByteRange :: Lens' JobParameters (Maybe Text)
- jpInventoryRetrievalParameters :: Lens' JobParameters (Maybe InventoryRetrievalJobInput)
- jpSNSTopic :: Lens' JobParameters (Maybe Text)
- jpOutputLocation :: Lens' JobParameters (Maybe OutputLocation)
- jpTier :: Lens' JobParameters (Maybe Text)
- jpType :: Lens' JobParameters (Maybe Text)
- jpDescription :: Lens' JobParameters (Maybe Text)
- data OutputLocation
- outputLocation :: OutputLocation
- olS3 :: Lens' OutputLocation (Maybe S3Location)
- data OutputSerialization
- outputSerialization :: OutputSerialization
- osCsv :: Lens' OutputSerialization (Maybe CSVOutput)
- data PartListElement
- partListElement :: PartListElement
- pleSHA256TreeHash :: Lens' PartListElement (Maybe Text)
- pleRangeInBytes :: Lens' PartListElement (Maybe Text)
- data ProvisionedCapacityDescription
- provisionedCapacityDescription :: ProvisionedCapacityDescription
- pcdCapacityId :: Lens' ProvisionedCapacityDescription (Maybe Text)
- pcdStartDate :: Lens' ProvisionedCapacityDescription (Maybe Text)
- pcdExpirationDate :: Lens' ProvisionedCapacityDescription (Maybe Text)
- data S3Location
- s3Location :: S3Location
- slCannedACL :: Lens' S3Location (Maybe CannedACL)
- slPrefix :: Lens' S3Location (Maybe Text)
- slBucketName :: Lens' S3Location (Maybe Text)
- slAccessControlList :: Lens' S3Location [Grant]
- slUserMetadata :: Lens' S3Location (HashMap Text Text)
- slEncryption :: Lens' S3Location (Maybe Encryption)
- slStorageClass :: Lens' S3Location (Maybe StorageClass)
- slTagging :: Lens' S3Location (HashMap Text Text)
- data SelectParameters
- selectParameters :: SelectParameters
- spExpressionType :: Lens' SelectParameters (Maybe ExpressionType)
- spOutputSerialization :: Lens' SelectParameters (Maybe OutputSerialization)
- spExpression :: Lens' SelectParameters (Maybe Text)
- spInputSerialization :: Lens' SelectParameters (Maybe InputSerialization)
- data UploadListElement
- uploadListElement :: UploadListElement
- uleMultipartUploadId :: Lens' UploadListElement (Maybe Text)
- ulePartSizeInBytes :: Lens' UploadListElement (Maybe Integer)
- uleArchiveDescription :: Lens' UploadListElement (Maybe Text)
- uleVaultARN :: Lens' UploadListElement (Maybe Text)
- uleCreationDate :: Lens' UploadListElement (Maybe Text)
- data VaultAccessPolicy
- vaultAccessPolicy :: VaultAccessPolicy
- vapPolicy :: Lens' VaultAccessPolicy (Maybe Text)
- data VaultLockPolicy
- vaultLockPolicy :: VaultLockPolicy
- vlpPolicy :: Lens' VaultLockPolicy (Maybe Text)
- data VaultNotificationConfig
- vaultNotificationConfig :: VaultNotificationConfig
- vncSNSTopic :: Lens' VaultNotificationConfig (Maybe Text)
- vncEvents :: Lens' VaultNotificationConfig [Text]
Service 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.
PolicyEnforcedException
_PolicyEnforcedException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if a parameter of the request is incorrectly specified.
RequestTimeoutException
_RequestTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if the service cannot complete the request.
InsufficientCapacityException
_InsufficientCapacityException :: AsError a => Getting (First ServiceError) a ServiceError #
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.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if the request results in a vault or account limit being exceeded.
MissingParameterValueException
_MissingParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError #
Returned if a required header or parameter is missing from 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.
VaultNotExists
vaultNotExists :: Wait DescribeVault #
Polls DescribeVault every 3 seconds until a successful state is reached. An error is returned after 15 failed checks.
VaultExists
vaultExists :: Wait DescribeVault #
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.
SetVaultAccessPolicy
InitiateJob
SetDataRetrievalPolicy
DeleteVaultAccessPolicy
GetVaultNotifications
ListTagsForVault
UploadMultipartPart
DeleteVaultNotifications
CompleteVaultLock
AbortVaultLock
ListVaults (Paginated)
ListProvisionedCapacity
ListJobs (Paginated)
module Network.AWS.Glacier.ListJobs
SetVaultNotifications
GetJobOutput
CompleteMultipartUpload
ListMultipartUploads (Paginated)
AbortMultipartUpload
PurchaseProvisionedCapacity
DescribeVault
GetVaultLock
DescribeJob
InitiateVaultLock
GetVaultAccessPolicy
GetDataRetrievalPolicy
RemoveTagsFromVault
DeleteVault
DeleteArchive
CreateVault
InitiateMultipartUpload
ListParts (Paginated)
AddTagsToVault
UploadArchive
Types
ActionCode
data ActionCode #
Constructors
| ArchiveRetrieval | |
| InventoryRetrieval | |
| Select |
Instances
CannedACL
Constructors
| AWSExecRead | |
| AuthenticatedRead | |
| BucketOwnerFullControl | |
| BucketOwnerRead | |
| Private | |
| PublicRead | |
| PublicReadWrite |
Instances
EncryptionType
data EncryptionType #
Instances
ExpressionType
data ExpressionType #
Constructors
| Sql |
Instances
FileHeaderInfo
data FileHeaderInfo #
Instances
Permission
data Permission #
Constructors
| FullControl | |
| Read | |
| ReadAcp | |
| Write | |
| WriteAcp |
Instances
QuoteFields
data QuoteFields #
Instances
StatusCode
data StatusCode #
Constructors
| Failed | |
| InProgress | |
| Succeeded |
Instances
StorageClass
data StorageClass #
Constructors
| ReducedRedundancy | |
| Standard | |
| StandardIA |
Instances
Type
Constructors
| AmazonCustomerByEmail | |
| CanonicalUser | |
| Group |
Instances
| Bounded Type # | |
| Enum Type # | |
| Eq Type # | |
| Data Type # | |
Defined in Network.AWS.Glacier.Types.Sum Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Type -> c Type # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Type # dataTypeOf :: Type -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Type) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Type) # gmapT :: (forall b. Data b => b -> b) -> Type -> Type # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Type -> r # gmapQ :: (forall d. Data d => d -> u) -> Type -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Type -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Type -> m Type # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Type -> m Type # | |
| Ord Type # | |
| Read Type # | |
| Show Type # | |
| Generic Type # | |
| Hashable Type # | |
Defined in Network.AWS.Glacier.Types.Sum | |
| ToJSON Type # | |
Defined in Network.AWS.Glacier.Types.Sum | |
| FromJSON Type # | |
| ToHeader Type # | |
Defined in Network.AWS.Glacier.Types.Sum Methods toHeader :: HeaderName -> Type -> [Header] # | |
| ToQuery Type # | |
Defined in Network.AWS.Glacier.Types.Sum Methods toQuery :: Type -> QueryString # | |
| ToByteString Type # | |
Defined in Network.AWS.Glacier.Types.Sum Methods toBS :: Type -> ByteString # | |
| FromText Type # | |
Defined in Network.AWS.Glacier.Types.Sum | |
| ToText Type # | |
Defined in Network.AWS.Glacier.Types.Sum | |
| NFData Type # | |
Defined in Network.AWS.Glacier.Types.Sum | |
| type Rep Type # | |
Defined in Network.AWS.Glacier.Types.Sum type Rep Type = D1 (MetaData "Type" "Network.AWS.Glacier.Types.Sum" "amazonka-glacier-1.6.1-DKdHCKUvjITxCgj6hhopJ" False) (C1 (MetaCons "AmazonCustomerByEmail" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CanonicalUser" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Group" PrefixI False) (U1 :: Type -> Type))) | |
ArchiveCreationOutput
data ArchiveCreationOutput #
Contains the Amazon Glacier response to your request.
For information about the underlying REST API, see Upload Archive . For conceptual information, see Working with Archives in Amazon Glacier .
See: archiveCreationOutput smart constructor.
Instances
archiveCreationOutput :: ArchiveCreationOutput #
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- The ID of the archive. This value is also included as part of the location.acoChecksum- The checksum of the archive computed by Amazon Glacier.acoLocation- The relative URI path of the newly added archive resource.
acoArchiveId :: Lens' ArchiveCreationOutput (Maybe Text) #
The ID of the archive. This value is also included as part of the location.
acoChecksum :: Lens' ArchiveCreationOutput (Maybe Text) #
The checksum of the archive computed by Amazon Glacier.
acoLocation :: Lens' ArchiveCreationOutput (Maybe Text) #
The relative URI path of the newly added archive resource.
CSVInput
Contains information about the comma-separated value (CSV) file to select from.
See: csvInput smart constructor.
Instances
Creates a value of CSVInput with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciQuoteCharacter- A value used as an escape character where the field delimiter is part of the value.ciRecordDelimiter- A value used to separate individual records from each other.ciFileHeaderInfo- Describes the first line of input. Valid values areNone,Ignore, andUse.ciQuoteEscapeCharacter- A single character used for escaping the quotation-mark character inside an already escaped value.ciComments- A single character used to indicate that a row should be ignored when the character is present at the start of that row.ciFieldDelimiter- A value used to separate individual fields from each other within a record.
ciQuoteCharacter :: Lens' CSVInput (Maybe Text) #
A value used as an escape character where the field delimiter is part of the value.
ciRecordDelimiter :: Lens' CSVInput (Maybe Text) #
A value used to separate individual records from each other.
ciFileHeaderInfo :: Lens' CSVInput (Maybe FileHeaderInfo) #
Describes the first line of input. Valid values are None , Ignore , and Use .
ciQuoteEscapeCharacter :: Lens' CSVInput (Maybe Text) #
A single character used for escaping the quotation-mark character inside an already escaped value.
ciComments :: Lens' CSVInput (Maybe Text) #
A single character used to indicate that a row should be ignored when the character is present at the start of that row.
ciFieldDelimiter :: Lens' CSVInput (Maybe Text) #
A value used to separate individual fields from each other within a record.
CSVOutput
Contains information about the comma-separated value (CSV) file that the job results are stored in.
See: csvOutput smart constructor.
Instances
Creates a value of CSVOutput with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
coQuoteCharacter- A value used as an escape character where the field delimiter is part of the value.coQuoteFields- A value that indicates whether all output fields should be contained within quotation marks.coRecordDelimiter- A value used to separate individual records from each other.coQuoteEscapeCharacter- A single character used for escaping the quotation-mark character inside an already escaped value.coFieldDelimiter- A value used to separate individual fields from each other within a record.
coQuoteCharacter :: Lens' CSVOutput (Maybe Text) #
A value used as an escape character where the field delimiter is part of the value.
coQuoteFields :: Lens' CSVOutput (Maybe QuoteFields) #
A value that indicates whether all output fields should be contained within quotation marks.
coRecordDelimiter :: Lens' CSVOutput (Maybe Text) #
A value used to separate individual records from each other.
coQuoteEscapeCharacter :: Lens' CSVOutput (Maybe Text) #
A single character used for escaping the quotation-mark character inside an already escaped value.
coFieldDelimiter :: Lens' CSVOutput (Maybe Text) #
A value used to separate individual fields from each other within a record.
DataRetrievalPolicy
data DataRetrievalPolicy #
Data retrieval policy.
See: dataRetrievalPolicy smart constructor.
Instances
dataRetrievalPolicy :: DataRetrievalPolicy #
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- 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.
drpRules :: Lens' DataRetrievalPolicy [DataRetrievalRule] #
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 #
Data retrieval policy rule.
See: dataRetrievalRule smart constructor.
Instances
dataRetrievalRule :: DataRetrievalRule #
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- The type of data retrieval policy to set. Valid values: BytesPerHour|FreeTier|NonedrrBytesPerHour- The maximum number of bytes that can be retrieved in an hour. This field is required only if the value of the Strategy field isBytesPerHour. Your PUT operation will be rejected if the Strategy field is not set toBytesPerHourand you set this field.
drrStrategy :: Lens' DataRetrievalRule (Maybe Text) #
The type of data retrieval policy to set. Valid values: BytesPerHour|FreeTier|None
drrBytesPerHour :: Lens' DataRetrievalRule (Maybe Integer) #
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
data DescribeVaultOutput #
Contains the Amazon Glacier response to your request.
See: describeVaultOutput smart constructor.
Instances
describeVaultOutput :: DescribeVaultOutput #
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:
dvoVaultName- The name of the vault.dvoSizeInBytes- 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- The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example2012-03-20T17:03:43.221Z.dvoVaultARN- The Amazon Resource Name (ARN) of the vault.dvoCreationDate- The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example2012-03-20T17:03:43.221Z.dvoNumberOfArchives- The number of archives in the vault as of the last inventory date. This field will returnnullif an inventory has not yet run on the vault, for example if you just created the vault.
dvoVaultName :: Lens' DescribeVaultOutput (Maybe Text) #
The name of the vault.
dvoSizeInBytes :: Lens' DescribeVaultOutput (Maybe Integer) #
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) #
The Universal Coordinated Time (UTC) date when Amazon 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 .
dvoVaultARN :: Lens' DescribeVaultOutput (Maybe Text) #
The Amazon Resource Name (ARN) of the vault.
dvoCreationDate :: Lens' DescribeVaultOutput (Maybe Text) #
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 .
dvoNumberOfArchives :: Lens' DescribeVaultOutput (Maybe Integer) #
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.
Encryption
data Encryption #
Contains information about the encryption used to store the job results in Amazon S3.
See: encryption smart constructor.
Instances
Creates a value of Encryption with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eEncryptionType- The server-side encryption algorithm used when storing job results in Amazon S3, for exampleAES256oraws:kms.eKMSKeyId- 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.eKMSContext- Optional. If the encryption type isaws:kms, you can use this value to specify the encryption context for the job results.
eEncryptionType :: Lens' Encryption (Maybe EncryptionType) #
The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms .
eKMSKeyId :: Lens' Encryption (Maybe Text) #
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.
eKMSContext :: Lens' Encryption (Maybe Text) #
Optional. If the encryption type is aws:kms , you can use this value to specify the encryption context for the job results.
GlacierJobDescription
data GlacierJobDescription #
Contains the description of an Amazon Glacier job.
See: glacierJobDescription smart constructor.
Instances
glacierJobDescription :: GlacierJobDescription #
Creates a value of GlacierJobDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gjdSHA256TreeHash- 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 isInProgress* Inventory jobs * Select jobsgjdArchiveId- The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.gjdSelectParameters- Contains the parameters used for a select.gjdJobId- An opaque string that identifies an Amazon Glacier job.gjdJobOutputPath- Contains the job output location.gjdRetrievalByteRange- 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.gjdInventoryRetrievalParameters- Parameters used for range inventory retrieval.gjdAction- The job type. This value is eitherArchiveRetrieval,InventoryRetrieval, orSelect.gjdJobDescription- The job description provided when initiating the job.gjdSNSTopic- An Amazon SNS topic that receives notification.gjdStatusMessage- A friendly message that describes the job status.gjdVaultARN- The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.gjdOutputLocation- Contains the location where the data from the select job is stored.gjdTier- The tier to use for a select or an archive retrieval. Valid values areExpedited,Standard, orBulk.Standardis the default.gjdArchiveSHA256TreeHash- The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.gjdCreationDate- 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".gjdCompleted- The job status. When a job is completed, you get the job's output using Get Job Output (GET output).gjdCompletionDate- The UTC time that the job request completed. While the job is in progress, the value is null.gjdInventorySizeInBytes- 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.gjdArchiveSizeInBytes- 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.gjdStatusCode- The status code can beInProgress,Succeeded, orFailed, and indicates the status of the job.
gjdSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) #
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
gjdArchiveId :: Lens' GlacierJobDescription (Maybe Text) #
The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
gjdSelectParameters :: Lens' GlacierJobDescription (Maybe SelectParameters) #
Contains the parameters used for a select.
gjdJobId :: Lens' GlacierJobDescription (Maybe Text) #
An opaque string that identifies an Amazon Glacier job.
gjdJobOutputPath :: Lens' GlacierJobDescription (Maybe Text) #
Contains the job output location.
gjdRetrievalByteRange :: Lens' GlacierJobDescription (Maybe Text) #
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.
gjdInventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription) #
Parameters used for range inventory retrieval.
gjdAction :: Lens' GlacierJobDescription (Maybe ActionCode) #
The job type. This value is either ArchiveRetrieval , InventoryRetrieval , or Select .
gjdJobDescription :: Lens' GlacierJobDescription (Maybe Text) #
The job description provided when initiating the job.
gjdSNSTopic :: Lens' GlacierJobDescription (Maybe Text) #
An Amazon SNS topic that receives notification.
gjdStatusMessage :: Lens' GlacierJobDescription (Maybe Text) #
A friendly message that describes the job status.
gjdVaultARN :: Lens' GlacierJobDescription (Maybe Text) #
The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
gjdOutputLocation :: Lens' GlacierJobDescription (Maybe OutputLocation) #
Contains the location where the data from the select job is stored.
gjdTier :: Lens' GlacierJobDescription (Maybe Text) #
The tier to use for a select or an archive retrieval. Valid values are Expedited , Standard , or Bulk . Standard is the default.
gjdArchiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) #
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
gjdCreationDate :: Lens' GlacierJobDescription (Maybe Text) #
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" .
gjdCompleted :: Lens' GlacierJobDescription (Maybe Bool) #
The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
gjdCompletionDate :: Lens' GlacierJobDescription (Maybe Text) #
The UTC time that the job request completed. While the job is in progress, the value is null.
gjdInventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer) #
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.
gjdArchiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer) #
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.
gjdStatusCode :: Lens' GlacierJobDescription (Maybe StatusCode) #
The status code can be InProgress , Succeeded , or Failed , and indicates the status of the job.
Grant
Contains information about a grant.
See: grant smart constructor.
Instances
| Eq Grant # | |
| Data Grant # | |
Defined in Network.AWS.Glacier.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Grant -> c Grant # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Grant # dataTypeOf :: Grant -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Grant) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Grant) # gmapT :: (forall b. Data b => b -> b) -> Grant -> Grant # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Grant -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Grant -> r # gmapQ :: (forall d. Data d => d -> u) -> Grant -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Grant -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Grant -> m Grant # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Grant -> m Grant # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Grant -> m Grant # | |
| Read Grant # | |
| Show Grant # | |
| Generic Grant # | |
| Hashable Grant # | |
Defined in Network.AWS.Glacier.Types.Product | |
| ToJSON Grant # | |
Defined in Network.AWS.Glacier.Types.Product | |
| FromJSON Grant # | |
| NFData Grant # | |
Defined in Network.AWS.Glacier.Types.Product | |
| type Rep Grant # | |
Defined in Network.AWS.Glacier.Types.Product type Rep Grant = D1 (MetaData "Grant" "Network.AWS.Glacier.Types.Product" "amazonka-glacier-1.6.1-DKdHCKUvjITxCgj6hhopJ" False) (C1 (MetaCons "Grant'" PrefixI True) (S1 (MetaSel (Just "_gPermission") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Permission)) :*: S1 (MetaSel (Just "_gGrantee") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Grantee)))) | |
Creates a value of Grant with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gPermission- Specifies the permission given to the grantee.gGrantee- The grantee.
gPermission :: Lens' Grant (Maybe Permission) #
Specifies the permission given to the grantee.
Grantee
Contains information about the grantee.
See: grantee smart constructor.
Instances
Creates a value of Grantee with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gURI- URI of the grantee group.gEmailAddress- Email address of the grantee.gDisplayName- Screen name of the grantee.gId- The canonical user ID of the grantee.gType- Type of grantee
InputSerialization
data InputSerialization #
Describes how the archive is serialized.
See: inputSerialization smart constructor.
Instances
inputSerialization :: InputSerialization #
Creates a value of InputSerialization with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
isCsv- Describes the serialization of a CSV-encoded object.
isCsv :: Lens' InputSerialization (Maybe CSVInput) #
Describes the serialization of a CSV-encoded object.
InventoryRetrievalJobDescription
data InventoryRetrievalJobDescription #
Describes the options for a range inventory retrieval job.
See: inventoryRetrievalJobDescription smart constructor.
Instances
inventoryRetrievalJobDescription :: InventoryRetrievalJobDescription #
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- 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 areCSVandJSON.irjdEndDate- 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 example2013-03-20T17:03:43Z.irjdStartDate- 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 example2013-03-20T17:03:43Z.irjdMarker- 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 isnull. For more information, see Range Inventory Retrieval .irjdLimit- 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.
irjdFormat :: Lens' InventoryRetrievalJobDescription (Maybe Text) #
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) #
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 .
irjdStartDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) #
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 .
irjdMarker :: Lens' InventoryRetrievalJobDescription (Maybe Text) #
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) #
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
data InventoryRetrievalJobInput #
Provides options for specifying a range inventory retrieval job.
See: inventoryRetrievalJobInput smart constructor.
Instances
inventoryRetrievalJobInput :: InventoryRetrievalJobInput #
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- 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 example2013-03-20T17:03:43Z.irjiStartDate- 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 example2013-03-20T17:03:43Z.irjiMarker- 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 isnull.irjiLimit- Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.
irjiEndDate :: Lens' InventoryRetrievalJobInput (Maybe Text) #
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 .
irjiStartDate :: Lens' InventoryRetrievalJobInput (Maybe Text) #
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 .
irjiMarker :: Lens' InventoryRetrievalJobInput (Maybe Text) #
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) #
Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.
JobParameters
data JobParameters #
Provides options for defining a job.
See: jobParameters smart constructor.
Instances
jobParameters :: JobParameters #
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- The ID of the archive that you want to retrieve. This field is required only ifTypeis set toselectorarchive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.jpSelectParameters- Contains the parameters that define a job.jpFormat- 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.jpRetrievalByteRange- 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.jpInventoryRetrievalParameters- Input parameters used for range inventory retrieval.jpSNSTopic- 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.jpOutputLocation- Contains information about the location where the select job results are stored.jpTier- The tier to use for a select or an archive retrieval job. Valid values areExpedited,Standard, orBulk.Standardis the default.jpType- 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".jpDescription- 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.
jpArchiveId :: Lens' JobParameters (Maybe Text) #
The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrieval code>. An error occurs if you specify this request parameter for an inventory retrieval job request.
jpSelectParameters :: Lens' JobParameters (Maybe SelectParameters) #
Contains the parameters that define a job.
jpRetrievalByteRange :: Lens' JobParameters (Maybe Text) #
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.
jpInventoryRetrievalParameters :: Lens' JobParameters (Maybe InventoryRetrievalJobInput) #
Input parameters used for range inventory retrieval.
jpSNSTopic :: Lens' JobParameters (Maybe Text) #
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.
jpOutputLocation :: Lens' JobParameters (Maybe OutputLocation) #
Contains information about the location where the select job results are stored.
jpTier :: Lens' JobParameters (Maybe Text) #
The tier to use for a select or an archive retrieval job. Valid values are Expedited , Standard , or Bulk . Standard is the default.
jpType :: Lens' JobParameters (Maybe Text) #
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".
jpDescription :: Lens' JobParameters (Maybe Text) #
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.
OutputLocation
data OutputLocation #
Contains information about the location where the select job results are stored.
See: outputLocation smart constructor.
Instances
outputLocation :: OutputLocation #
Creates a value of OutputLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
olS3- Describes an S3 location that will receive the results of the job request.
olS3 :: Lens' OutputLocation (Maybe S3Location) #
Describes an S3 location that will receive the results of the job request.
OutputSerialization
data OutputSerialization #
Describes how the select output is serialized.
See: outputSerialization smart constructor.
Instances
outputSerialization :: OutputSerialization #
Creates a value of OutputSerialization with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osCsv- Describes the serialization of CSV-encoded query results.
osCsv :: Lens' OutputSerialization (Maybe CSVOutput) #
Describes the serialization of CSV-encoded query results.
PartListElement
data PartListElement #
A list of the part sizes of the multipart upload.
See: partListElement smart constructor.
Instances
partListElement :: PartListElement #
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- The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is nevernull.pleRangeInBytes- The byte range of a part, inclusive of the upper value of the range.
pleSHA256TreeHash :: Lens' PartListElement (Maybe Text) #
The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null .
pleRangeInBytes :: Lens' PartListElement (Maybe Text) #
The byte range of a part, inclusive of the upper value of the range.
ProvisionedCapacityDescription
data ProvisionedCapacityDescription #
The definition for a provisioned capacity unit.
See: provisionedCapacityDescription smart constructor.
Instances
provisionedCapacityDescription :: ProvisionedCapacityDescription #
Creates a value of ProvisionedCapacityDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcdCapacityId- The ID that identifies the provisioned capacity unit.pcdStartDate- The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).pcdExpirationDate- The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).
pcdCapacityId :: Lens' ProvisionedCapacityDescription (Maybe Text) #
The ID that identifies the provisioned capacity unit.
pcdStartDate :: Lens' ProvisionedCapacityDescription (Maybe Text) #
The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).
pcdExpirationDate :: Lens' ProvisionedCapacityDescription (Maybe Text) #
The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).
S3Location
data S3Location #
Contains information about the location in Amazon S3 where the select job results are stored.
See: s3Location smart constructor.
Instances
Creates a value of S3Location with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slCannedACL- The canned access control list (ACL) to apply to the job results.slPrefix- The prefix that is prepended to the results for this request.slBucketName- The name of the Amazon S3 bucket where the job results are stored.slAccessControlList- A list of grants that control access to the staged results.slUserMetadata- A map of metadata to store with the job results in Amazon S3.slEncryption- Contains information about the encryption used to store the job results in Amazon S3.slStorageClass- The storage class used to store the job results.slTagging- The tag-set that is applied to the job results.
slCannedACL :: Lens' S3Location (Maybe CannedACL) #
The canned access control list (ACL) to apply to the job results.
slPrefix :: Lens' S3Location (Maybe Text) #
The prefix that is prepended to the results for this request.
slBucketName :: Lens' S3Location (Maybe Text) #
The name of the Amazon S3 bucket where the job results are stored.
slAccessControlList :: Lens' S3Location [Grant] #
A list of grants that control access to the staged results.
slUserMetadata :: Lens' S3Location (HashMap Text Text) #
A map of metadata to store with the job results in Amazon S3.
slEncryption :: Lens' S3Location (Maybe Encryption) #
Contains information about the encryption used to store the job results in Amazon S3.
slStorageClass :: Lens' S3Location (Maybe StorageClass) #
The storage class used to store the job results.
SelectParameters
data SelectParameters #
Contains information about the parameters used for a select.
See: selectParameters smart constructor.
Instances
selectParameters :: SelectParameters #
Creates a value of SelectParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spExpressionType- The type of the provided expression, for exampleSQL.spOutputSerialization- Describes how the results of the select job are serialized.spExpression- The expression that is used to select the object.spInputSerialization- Describes the serialization format of the object.
spExpressionType :: Lens' SelectParameters (Maybe ExpressionType) #
The type of the provided expression, for example SQL .
spOutputSerialization :: Lens' SelectParameters (Maybe OutputSerialization) #
Describes how the results of the select job are serialized.
spExpression :: Lens' SelectParameters (Maybe Text) #
The expression that is used to select the object.
spInputSerialization :: Lens' SelectParameters (Maybe InputSerialization) #
Describes the serialization format of the object.
UploadListElement
data UploadListElement #
A list of in-progress multipart uploads for a vault.
See: uploadListElement smart constructor.
Instances
uploadListElement :: UploadListElement #
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- The ID of a multipart upload.ulePartSizeInBytes- 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.uleArchiveDescription- The description of the archive that was specified in the Initiate Multipart Upload request.uleVaultARN- The Amazon Resource Name (ARN) of the vault that contains the archive.uleCreationDate- The UTC time at which the multipart upload was initiated.
uleMultipartUploadId :: Lens' UploadListElement (Maybe Text) #
The ID of a multipart upload.
ulePartSizeInBytes :: Lens' UploadListElement (Maybe Integer) #
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.
uleArchiveDescription :: Lens' UploadListElement (Maybe Text) #
The description of the archive that was specified in the Initiate Multipart Upload request.
uleVaultARN :: Lens' UploadListElement (Maybe Text) #
The Amazon Resource Name (ARN) of the vault that contains the archive.
uleCreationDate :: Lens' UploadListElement (Maybe Text) #
The UTC time at which the multipart upload was initiated.
VaultAccessPolicy
data VaultAccessPolicy #
Contains the vault access policy.
See: vaultAccessPolicy smart constructor.
Instances
vaultAccessPolicy :: VaultAccessPolicy #
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- The vault access policy.
VaultLockPolicy
data VaultLockPolicy #
Contains the vault lock policy.
See: vaultLockPolicy smart constructor.
Instances
vaultLockPolicy :: VaultLockPolicy #
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- The vault lock policy.
VaultNotificationConfig
data VaultNotificationConfig #
Represents a vault's notification configuration.
See: vaultNotificationConfig smart constructor.
Instances
vaultNotificationConfig :: VaultNotificationConfig #
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- The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).vncEvents- A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.
vncSNSTopic :: Lens' VaultNotificationConfig (Maybe Text) #
The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).
vncEvents :: Lens' VaultNotificationConfig [Text] #
A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.