| 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.Types
Contents
- Service Configuration
- Errors
- 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
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
- 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' {}
- newArchiveCreationOutput :: ArchiveCreationOutput
- archiveCreationOutput_archiveId :: Lens' ArchiveCreationOutput (Maybe Text)
- archiveCreationOutput_checksum :: Lens' ArchiveCreationOutput (Maybe Text)
- archiveCreationOutput_location :: Lens' ArchiveCreationOutput (Maybe Text)
- data CSVInput = CSVInput' {}
- newCSVInput :: CSVInput
- cSVInput_comments :: Lens' CSVInput (Maybe Text)
- cSVInput_fieldDelimiter :: Lens' CSVInput (Maybe Text)
- cSVInput_fileHeaderInfo :: Lens' CSVInput (Maybe FileHeaderInfo)
- cSVInput_quoteCharacter :: Lens' CSVInput (Maybe Text)
- cSVInput_quoteEscapeCharacter :: Lens' CSVInput (Maybe Text)
- cSVInput_recordDelimiter :: Lens' CSVInput (Maybe Text)
- data CSVOutput = CSVOutput' {}
- newCSVOutput :: CSVOutput
- cSVOutput_fieldDelimiter :: Lens' CSVOutput (Maybe Text)
- cSVOutput_quoteCharacter :: Lens' CSVOutput (Maybe Text)
- cSVOutput_quoteEscapeCharacter :: Lens' CSVOutput (Maybe Text)
- cSVOutput_quoteFields :: Lens' CSVOutput (Maybe QuoteFields)
- cSVOutput_recordDelimiter :: Lens' CSVOutput (Maybe Text)
- data DataRetrievalPolicy = DataRetrievalPolicy' {
- rules :: Maybe [DataRetrievalRule]
- newDataRetrievalPolicy :: DataRetrievalPolicy
- dataRetrievalPolicy_rules :: Lens' DataRetrievalPolicy (Maybe [DataRetrievalRule])
- data DataRetrievalRule = DataRetrievalRule' {}
- newDataRetrievalRule :: DataRetrievalRule
- dataRetrievalRule_bytesPerHour :: Lens' DataRetrievalRule (Maybe Integer)
- dataRetrievalRule_strategy :: Lens' DataRetrievalRule (Maybe Text)
- data DescribeVaultOutput = DescribeVaultOutput' {}
- newDescribeVaultOutput :: DescribeVaultOutput
- describeVaultOutput_creationDate :: Lens' DescribeVaultOutput (Maybe Text)
- describeVaultOutput_lastInventoryDate :: Lens' DescribeVaultOutput (Maybe Text)
- describeVaultOutput_numberOfArchives :: Lens' DescribeVaultOutput (Maybe Integer)
- describeVaultOutput_sizeInBytes :: Lens' DescribeVaultOutput (Maybe Integer)
- describeVaultOutput_vaultARN :: Lens' DescribeVaultOutput (Maybe Text)
- describeVaultOutput_vaultName :: Lens' DescribeVaultOutput (Maybe Text)
- data Encryption = Encryption' {}
- newEncryption :: Encryption
- encryption_encryptionType :: Lens' Encryption (Maybe EncryptionType)
- encryption_kmsContext :: Lens' Encryption (Maybe Text)
- encryption_kmsKeyId :: Lens' Encryption (Maybe Text)
- data GlacierJobDescription = GlacierJobDescription' {
- action :: Maybe ActionCode
- archiveId :: Maybe Text
- archiveSHA256TreeHash :: Maybe Text
- archiveSizeInBytes :: Maybe Integer
- completed :: Maybe Bool
- completionDate :: Maybe Text
- creationDate :: Maybe Text
- inventoryRetrievalParameters :: Maybe InventoryRetrievalJobDescription
- inventorySizeInBytes :: Maybe Integer
- jobDescription :: Maybe Text
- jobId :: Maybe Text
- jobOutputPath :: Maybe Text
- outputLocation :: Maybe OutputLocation
- retrievalByteRange :: Maybe Text
- sHA256TreeHash :: Maybe Text
- sNSTopic :: Maybe Text
- selectParameters :: Maybe SelectParameters
- statusCode :: Maybe StatusCode
- statusMessage :: Maybe Text
- tier :: Maybe Text
- vaultARN :: Maybe Text
- newGlacierJobDescription :: GlacierJobDescription
- glacierJobDescription_action :: Lens' GlacierJobDescription (Maybe ActionCode)
- glacierJobDescription_archiveId :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_archiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_archiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)
- glacierJobDescription_completed :: Lens' GlacierJobDescription (Maybe Bool)
- glacierJobDescription_completionDate :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_creationDate :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_inventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription)
- glacierJobDescription_inventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer)
- glacierJobDescription_jobDescription :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_jobId :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_jobOutputPath :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_outputLocation :: Lens' GlacierJobDescription (Maybe OutputLocation)
- glacierJobDescription_retrievalByteRange :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_sHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_sNSTopic :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_selectParameters :: Lens' GlacierJobDescription (Maybe SelectParameters)
- glacierJobDescription_statusCode :: Lens' GlacierJobDescription (Maybe StatusCode)
- glacierJobDescription_statusMessage :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_tier :: Lens' GlacierJobDescription (Maybe Text)
- glacierJobDescription_vaultARN :: Lens' GlacierJobDescription (Maybe Text)
- data Grant = Grant' {}
- newGrant :: Grant
- grant_grantee :: Lens' Grant (Maybe Grantee)
- grant_permission :: Lens' Grant (Maybe Permission)
- data Grantee = Grantee' {}
- newGrantee :: Type -> Grantee
- grantee_displayName :: Lens' Grantee (Maybe Text)
- grantee_emailAddress :: Lens' Grantee (Maybe Text)
- grantee_id :: Lens' Grantee (Maybe Text)
- grantee_uri :: Lens' Grantee (Maybe Text)
- grantee_type :: Lens' Grantee Type
- data InputSerialization = InputSerialization' {}
- newInputSerialization :: InputSerialization
- inputSerialization_csv :: Lens' InputSerialization (Maybe CSVInput)
- data InventoryRetrievalJobDescription = InventoryRetrievalJobDescription' {}
- newInventoryRetrievalJobDescription :: InventoryRetrievalJobDescription
- inventoryRetrievalJobDescription_endDate :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- inventoryRetrievalJobDescription_format :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- inventoryRetrievalJobDescription_limit :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- inventoryRetrievalJobDescription_marker :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- inventoryRetrievalJobDescription_startDate :: Lens' InventoryRetrievalJobDescription (Maybe Text)
- data InventoryRetrievalJobInput = InventoryRetrievalJobInput' {}
- newInventoryRetrievalJobInput :: InventoryRetrievalJobInput
- inventoryRetrievalJobInput_endDate :: Lens' InventoryRetrievalJobInput (Maybe Text)
- inventoryRetrievalJobInput_limit :: Lens' InventoryRetrievalJobInput (Maybe Text)
- inventoryRetrievalJobInput_marker :: Lens' InventoryRetrievalJobInput (Maybe Text)
- inventoryRetrievalJobInput_startDate :: Lens' InventoryRetrievalJobInput (Maybe Text)
- data JobParameters = JobParameters' {
- archiveId :: Maybe Text
- description :: Maybe Text
- format :: Maybe Text
- inventoryRetrievalParameters :: Maybe InventoryRetrievalJobInput
- outputLocation :: Maybe OutputLocation
- retrievalByteRange :: Maybe Text
- sNSTopic :: Maybe Text
- selectParameters :: Maybe SelectParameters
- tier :: Maybe Text
- type' :: Maybe Text
- newJobParameters :: JobParameters
- jobParameters_archiveId :: Lens' JobParameters (Maybe Text)
- jobParameters_description :: Lens' JobParameters (Maybe Text)
- jobParameters_format :: Lens' JobParameters (Maybe Text)
- jobParameters_inventoryRetrievalParameters :: Lens' JobParameters (Maybe InventoryRetrievalJobInput)
- jobParameters_outputLocation :: Lens' JobParameters (Maybe OutputLocation)
- jobParameters_retrievalByteRange :: Lens' JobParameters (Maybe Text)
- jobParameters_sNSTopic :: Lens' JobParameters (Maybe Text)
- jobParameters_selectParameters :: Lens' JobParameters (Maybe SelectParameters)
- jobParameters_tier :: Lens' JobParameters (Maybe Text)
- jobParameters_type :: Lens' JobParameters (Maybe Text)
- data OutputLocation = OutputLocation' {
- s3 :: Maybe S3Location
- newOutputLocation :: OutputLocation
- outputLocation_s3 :: Lens' OutputLocation (Maybe S3Location)
- data OutputSerialization = OutputSerialization' {}
- newOutputSerialization :: OutputSerialization
- outputSerialization_csv :: Lens' OutputSerialization (Maybe CSVOutput)
- data PartListElement = PartListElement' {}
- newPartListElement :: PartListElement
- partListElement_rangeInBytes :: Lens' PartListElement (Maybe Text)
- partListElement_sHA256TreeHash :: Lens' PartListElement (Maybe Text)
- data ProvisionedCapacityDescription = ProvisionedCapacityDescription' {
- capacityId :: Maybe Text
- expirationDate :: Maybe Text
- startDate :: Maybe Text
- newProvisionedCapacityDescription :: ProvisionedCapacityDescription
- provisionedCapacityDescription_capacityId :: Lens' ProvisionedCapacityDescription (Maybe Text)
- provisionedCapacityDescription_expirationDate :: Lens' ProvisionedCapacityDescription (Maybe Text)
- provisionedCapacityDescription_startDate :: Lens' ProvisionedCapacityDescription (Maybe Text)
- data S3Location = S3Location' {
- accessControlList :: Maybe [Grant]
- bucketName :: Maybe Text
- cannedACL :: Maybe CannedACL
- encryption :: Maybe Encryption
- prefix :: Maybe Text
- storageClass :: Maybe StorageClass
- tagging :: Maybe (HashMap Text Text)
- userMetadata :: Maybe (HashMap Text Text)
- newS3Location :: S3Location
- s3Location_accessControlList :: Lens' S3Location (Maybe [Grant])
- s3Location_bucketName :: Lens' S3Location (Maybe Text)
- s3Location_cannedACL :: Lens' S3Location (Maybe CannedACL)
- s3Location_encryption :: Lens' S3Location (Maybe Encryption)
- s3Location_prefix :: Lens' S3Location (Maybe Text)
- s3Location_storageClass :: Lens' S3Location (Maybe StorageClass)
- s3Location_tagging :: Lens' S3Location (Maybe (HashMap Text Text))
- s3Location_userMetadata :: Lens' S3Location (Maybe (HashMap Text Text))
- data SelectParameters = SelectParameters' {}
- newSelectParameters :: SelectParameters
- selectParameters_expression :: Lens' SelectParameters (Maybe Text)
- selectParameters_expressionType :: Lens' SelectParameters (Maybe ExpressionType)
- selectParameters_inputSerialization :: Lens' SelectParameters (Maybe InputSerialization)
- selectParameters_outputSerialization :: Lens' SelectParameters (Maybe OutputSerialization)
- data UploadListElement = UploadListElement' {}
- newUploadListElement :: UploadListElement
- uploadListElement_archiveDescription :: Lens' UploadListElement (Maybe Text)
- uploadListElement_creationDate :: Lens' UploadListElement (Maybe Text)
- uploadListElement_multipartUploadId :: Lens' UploadListElement (Maybe Text)
- uploadListElement_partSizeInBytes :: Lens' UploadListElement (Maybe Integer)
- uploadListElement_vaultARN :: Lens' UploadListElement (Maybe Text)
- data VaultAccessPolicy = VaultAccessPolicy' {}
- newVaultAccessPolicy :: VaultAccessPolicy
- vaultAccessPolicy_policy :: Lens' VaultAccessPolicy (Maybe Text)
- data VaultLockPolicy = VaultLockPolicy' {}
- newVaultLockPolicy :: VaultLockPolicy
- vaultLockPolicy_policy :: Lens' VaultLockPolicy (Maybe Text)
- data VaultNotificationConfig = VaultNotificationConfig' {}
- newVaultNotificationConfig :: VaultNotificationConfig
- vaultNotificationConfig_events :: Lens' VaultNotificationConfig (Maybe [Text])
- vaultNotificationConfig_sNSTopic :: Lens' VaultNotificationConfig (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2012-06-01 of the Amazon Glacier SDK configuration.
Errors
_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 :: AsError a => Fold a ServiceError Source #
Returned if a parameter of the request is incorrectly specified.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
Returned if the request results in a vault or account limit being exceeded.
_MissingParameterValueException :: AsError a => Fold a ServiceError Source #
Returned if a required header or parameter is missing from the request.
_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 :: AsError a => Fold a ServiceError Source #
Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.
_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 :: AsError a => Fold a ServiceError Source #
Returned if the service cannot complete the request.
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.
Constructors
| ArchiveCreationOutput' | |
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.
archiveCreationOutput_archiveId :: Lens' ArchiveCreationOutput (Maybe Text) Source #
The ID of the archive. This value is also included as part of the location.
archiveCreationOutput_checksum :: Lens' ArchiveCreationOutput (Maybe Text) Source #
The checksum of the archive computed by Amazon S3 Glacier.
archiveCreationOutput_location :: Lens' ArchiveCreationOutput (Maybe Text) Source #
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' | |
Fields
| |
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.
cSVInput_comments :: Lens' CSVInput (Maybe Text) Source #
A single character used to indicate that a row should be ignored when the character is present at the start of that row.
cSVInput_fieldDelimiter :: Lens' CSVInput (Maybe Text) Source #
A value used to separate individual fields from each other within a record.
cSVInput_fileHeaderInfo :: Lens' CSVInput (Maybe FileHeaderInfo) Source #
Describes the first line of input. Valid values are None, Ignore,
and Use.
cSVInput_quoteCharacter :: Lens' CSVInput (Maybe Text) Source #
A value used as an escape character where the field delimiter is part of the value.
cSVInput_quoteEscapeCharacter :: Lens' CSVInput (Maybe Text) Source #
A single character used for escaping the quotation-mark character inside an already escaped value.
cSVInput_recordDelimiter :: Lens' CSVInput (Maybe Text) Source #
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.
Constructors
| CSVOutput' | |
Fields
| |
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.
cSVOutput_fieldDelimiter :: Lens' CSVOutput (Maybe Text) Source #
A value used to separate individual fields from each other within a record.
cSVOutput_quoteCharacter :: Lens' CSVOutput (Maybe Text) Source #
A value used as an escape character where the field delimiter is part of the value.
cSVOutput_quoteEscapeCharacter :: Lens' CSVOutput (Maybe Text) Source #
A single character used for escaping the quotation-mark character inside an already escaped value.
cSVOutput_quoteFields :: Lens' CSVOutput (Maybe QuoteFields) Source #
A value that indicates whether all output fields should be contained within quotation marks.
cSVOutput_recordDelimiter :: Lens' CSVOutput (Maybe Text) Source #
A value used to separate individual records from each other.
DataRetrievalPolicy
data DataRetrievalPolicy Source #
Data retrieval policy.
See: newDataRetrievalPolicy smart constructor.
Constructors
| DataRetrievalPolicy' | |
Fields
| |
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.
dataRetrievalPolicy_rules :: Lens' DataRetrievalPolicy (Maybe [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
data DataRetrievalRule Source #
Data retrieval policy rule.
See: newDataRetrievalRule smart constructor.
Constructors
| DataRetrievalRule' | |
Fields
| |
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
dataRetrievalRule_bytesPerHour :: 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.
dataRetrievalRule_strategy :: Lens' DataRetrievalRule (Maybe Text) Source #
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' | |
Fields
| |
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.
describeVaultOutput_creationDate :: Lens' DescribeVaultOutput (Maybe Text) Source #
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.
describeVaultOutput_lastInventoryDate :: Lens' DescribeVaultOutput (Maybe Text) Source #
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.
describeVaultOutput_numberOfArchives :: 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.
describeVaultOutput_sizeInBytes :: 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.
describeVaultOutput_vaultARN :: Lens' DescribeVaultOutput (Maybe Text) Source #
The Amazon Resource Name (ARN) of the vault.
describeVaultOutput_vaultName :: Lens' DescribeVaultOutput (Maybe Text) Source #
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' | |
Fields
| |
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.
encryption_encryptionType :: Lens' Encryption (Maybe EncryptionType) Source #
The server-side encryption algorithm used when storing job results in
Amazon S3, for example AES256 or aws:kms.
encryption_kmsContext :: Lens' Encryption (Maybe Text) Source #
Optional. If the encryption type is aws:kms, you can use this value to
specify the encryption context for the job results.
encryption_kmsKeyId :: Lens' Encryption (Maybe Text) Source #
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' | |
Fields
| |
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.
glacierJobDescription_action :: Lens' GlacierJobDescription (Maybe ActionCode) Source #
The job type. This value is either ArchiveRetrieval,
InventoryRetrieval, or Select.
glacierJobDescription_archiveId :: Lens' GlacierJobDescription (Maybe Text) Source #
The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
glacierJobDescription_archiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) Source #
The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.
glacierJobDescription_archiveSizeInBytes :: Lens' GlacierJobDescription (Maybe Integer) Source #
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.
glacierJobDescription_completed :: Lens' GlacierJobDescription (Maybe Bool) Source #
The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
glacierJobDescription_completionDate :: Lens' GlacierJobDescription (Maybe Text) Source #
The UTC time that the job request completed. While the job is in progress, the value is null.
glacierJobDescription_creationDate :: Lens' GlacierJobDescription (Maybe Text) Source #
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".
glacierJobDescription_inventoryRetrievalParameters :: Lens' GlacierJobDescription (Maybe InventoryRetrievalJobDescription) Source #
Parameters used for range inventory retrieval.
glacierJobDescription_inventorySizeInBytes :: Lens' GlacierJobDescription (Maybe Integer) Source #
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.
glacierJobDescription_jobDescription :: Lens' GlacierJobDescription (Maybe Text) Source #
The job description provided when initiating the job.
glacierJobDescription_jobId :: Lens' GlacierJobDescription (Maybe Text) Source #
An opaque string that identifies an Amazon S3 Glacier job.
glacierJobDescription_jobOutputPath :: Lens' GlacierJobDescription (Maybe Text) Source #
Contains the job output location.
glacierJobDescription_outputLocation :: Lens' GlacierJobDescription (Maybe OutputLocation) Source #
Contains the location where the data from the select job is stored.
glacierJobDescription_retrievalByteRange :: 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. 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.
glacierJobDescription_sHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) Source #
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
glacierJobDescription_sNSTopic :: Lens' GlacierJobDescription (Maybe Text) Source #
An Amazon SNS topic that receives notification.
glacierJobDescription_selectParameters :: Lens' GlacierJobDescription (Maybe SelectParameters) Source #
Contains the parameters used for a select.
glacierJobDescription_statusCode :: Lens' GlacierJobDescription (Maybe StatusCode) Source #
The status code can be InProgress, Succeeded, or Failed, and
indicates the status of the job.
glacierJobDescription_statusMessage :: Lens' GlacierJobDescription (Maybe Text) Source #
A friendly message that describes the job status.
glacierJobDescription_tier :: Lens' GlacierJobDescription (Maybe Text) Source #
The tier to use for a select or an archive retrieval. Valid values are
Expedited, Standard, or Bulk. Standard is the default.
glacierJobDescription_vaultARN :: Lens' GlacierJobDescription (Maybe Text) Source #
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' | |
Fields
| |
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.
grant_permission :: Lens' Grant (Maybe Permission) Source #
Specifies the permission given to the grantee.
Grantee
Contains information about the grantee.
See: newGrantee smart constructor.
Constructors
| Grantee' | |
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' | |
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.
inputSerialization_csv :: Lens' InputSerialization (Maybe CSVInput) Source #
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' | |
Fields
| |
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.
inventoryRetrievalJobDescription_endDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source #
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.
inventoryRetrievalJobDescription_format :: 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.
inventoryRetrievalJobDescription_limit :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source #
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.
inventoryRetrievalJobDescription_marker :: 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.
inventoryRetrievalJobDescription_startDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) Source #
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.
Constructors
| InventoryRetrievalJobInput' | |
Fields
| |
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.
inventoryRetrievalJobInput_endDate :: Lens' InventoryRetrievalJobInput (Maybe Text) Source #
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.
inventoryRetrievalJobInput_limit :: 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.
inventoryRetrievalJobInput_marker :: 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.
inventoryRetrievalJobInput_startDate :: 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. 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' | |
Fields
| |
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".
jobParameters_archiveId :: 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 select or archive-retrievalcode>. An error
occurs if you specify this request parameter for an inventory retrieval
job request.
jobParameters_description :: 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.
jobParameters_format :: 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".
jobParameters_inventoryRetrievalParameters :: Lens' JobParameters (Maybe InventoryRetrievalJobInput) Source #
Input parameters used for range inventory retrieval.
jobParameters_outputLocation :: Lens' JobParameters (Maybe OutputLocation) Source #
Contains information about the location where the select job results are stored.
jobParameters_retrievalByteRange :: 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.
jobParameters_sNSTopic :: Lens' JobParameters (Maybe Text) Source #
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.
jobParameters_selectParameters :: Lens' JobParameters (Maybe SelectParameters) Source #
Contains the parameters that define a job.
jobParameters_tier :: Lens' JobParameters (Maybe Text) Source #
The tier to use for a select or an archive retrieval job. Valid values
are Expedited, Standard, or Bulk. Standard is the default.
jobParameters_type :: Lens' JobParameters (Maybe Text) Source #
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' | |
Fields
| |
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.
outputLocation_s3 :: Lens' OutputLocation (Maybe S3Location) Source #
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' | |
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.
outputSerialization_csv :: Lens' OutputSerialization (Maybe CSVOutput) Source #
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' | |
Fields
| |
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.
partListElement_rangeInBytes :: Lens' PartListElement (Maybe Text) Source #
The byte range of a part, inclusive of the upper value of the range.
partListElement_sHA256TreeHash :: Lens' PartListElement (Maybe Text) Source #
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.
Constructors
| ProvisionedCapacityDescription' | |
Fields
| |
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).
provisionedCapacityDescription_capacityId :: Lens' ProvisionedCapacityDescription (Maybe Text) Source #
The ID that identifies the provisioned capacity unit.
provisionedCapacityDescription_expirationDate :: Lens' ProvisionedCapacityDescription (Maybe Text) Source #
The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).
provisionedCapacityDescription_startDate :: Lens' ProvisionedCapacityDescription (Maybe Text) Source #
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' | |
Fields
| |
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.
s3Location_accessControlList :: Lens' S3Location (Maybe [Grant]) Source #
A list of grants that control access to the staged results.
s3Location_bucketName :: Lens' S3Location (Maybe Text) Source #
The name of the Amazon S3 bucket where the job results are stored.
s3Location_cannedACL :: Lens' S3Location (Maybe CannedACL) Source #
The canned access control list (ACL) to apply to the job results.
s3Location_encryption :: Lens' S3Location (Maybe Encryption) Source #
Contains information about the encryption used to store the job results in Amazon S3.
s3Location_prefix :: Lens' S3Location (Maybe Text) Source #
The prefix that is prepended to the results for this request.
s3Location_storageClass :: Lens' S3Location (Maybe StorageClass) Source #
The storage class used to store the job results.
s3Location_tagging :: Lens' S3Location (Maybe (HashMap Text Text)) Source #
The tag-set that is applied to the job results.
s3Location_userMetadata :: Lens' S3Location (Maybe (HashMap Text Text)) Source #
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' | |
Fields
| |
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.
selectParameters_expression :: Lens' SelectParameters (Maybe Text) Source #
The expression that is used to select the object.
selectParameters_expressionType :: Lens' SelectParameters (Maybe ExpressionType) Source #
The type of the provided expression, for example SQL.
selectParameters_inputSerialization :: Lens' SelectParameters (Maybe InputSerialization) Source #
Describes the serialization format of the object.
selectParameters_outputSerialization :: Lens' SelectParameters (Maybe OutputSerialization) Source #
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.
Constructors
| UploadListElement' | |
Fields
| |
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.
uploadListElement_archiveDescription :: Lens' UploadListElement (Maybe Text) Source #
The description of the archive that was specified in the Initiate Multipart Upload request.
uploadListElement_creationDate :: Lens' UploadListElement (Maybe Text) Source #
The UTC time at which the multipart upload was initiated.
uploadListElement_multipartUploadId :: Lens' UploadListElement (Maybe Text) Source #
The ID of a multipart upload.
uploadListElement_partSizeInBytes :: 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.
uploadListElement_vaultARN :: Lens' UploadListElement (Maybe Text) Source #
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' | |
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.
vaultAccessPolicy_policy :: Lens' VaultAccessPolicy (Maybe Text) Source #
The vault access policy.
VaultLockPolicy
data VaultLockPolicy Source #
Contains the vault lock policy.
See: newVaultLockPolicy smart constructor.
Constructors
| VaultLockPolicy' | |
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.
vaultLockPolicy_policy :: Lens' VaultLockPolicy (Maybe Text) Source #
The vault lock policy.
VaultNotificationConfig
data VaultNotificationConfig Source #
Represents a vault's notification configuration.
See: newVaultNotificationConfig smart constructor.
Constructors
| VaultNotificationConfig' | |
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).
vaultNotificationConfig_events :: Lens' VaultNotificationConfig (Maybe [Text]) Source #
A list of one or more events for which Amazon S3 Glacier will send a notification to the specified Amazon SNS topic.
vaultNotificationConfig_sNSTopic :: Lens' VaultNotificationConfig (Maybe Text) Source #
The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).