diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,36 +8,27 @@ ## Version -`1.4.4` +`1.4.5` ## 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, go to . - -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/: - -- - 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. - -- - 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. - Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-glacier) and the [AWS API Reference](https://aws.amazon.com/documentation/). The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka), -which provides mechanisms for specifying AuthN/AuthZ information and sending requests. +which provides mechanisms for specifying AuthN/AuthZ information, sending requests, +and receiving responses. -Use of lenses is required for constructing and manipulating types. -This is due to the amount of nesting of AWS types and transparency regarding +Lenses are used for constructing and manipulating types, +due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries [lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core). + +See [Network.AWS.Glacier](http://hackage.haskell.org/package/amazonka-glacier/docs/Network-AWS-Glacier.html) +or [the AWS documentation](https://aws.amazon.com/documentation/) to get started. + ## Contribute diff --git a/amazonka-glacier.cabal b/amazonka-glacier.cabal --- a/amazonka-glacier.cabal +++ b/amazonka-glacier.cabal @@ -1,5 +1,5 @@ name: amazonka-glacier -version: 1.4.4 +version: 1.4.5 synopsis: Amazon Glacier SDK. homepage: https://github.com/brendanhay/amazonka bug-reports: https://github.com/brendanhay/amazonka/issues @@ -13,32 +13,19 @@ cabal-version: >= 1.10 extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep 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, go to . - - 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/: - - - - 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. - - - - 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. - . The types from this library are intended to be used with , which provides - mechanisms for specifying AuthN/AuthZ information and sending requests. + mechanisms for specifying AuthN/AuthZ information, sending requests, + and receiving responses. . - Use of lenses is required for constructing and manipulating types. - This is due to the amount of nesting of AWS types and transparency regarding + Lenses are used for constructing and manipulating types, + due to the depth of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries such as or . . - See "Network.AWS.Glacier" or + See "Network.AWS.Glacier" or to get started. source-repository head @@ -76,8 +63,10 @@ , Network.AWS.Glacier.ListJobs , Network.AWS.Glacier.ListMultipartUploads , Network.AWS.Glacier.ListParts + , Network.AWS.Glacier.ListProvisionedCapacity , Network.AWS.Glacier.ListTagsForVault , Network.AWS.Glacier.ListVaults + , Network.AWS.Glacier.PurchaseProvisionedCapacity , Network.AWS.Glacier.RemoveTagsFromVault , Network.AWS.Glacier.SetDataRetrievalPolicy , Network.AWS.Glacier.SetVaultAccessPolicy @@ -92,7 +81,7 @@ , Network.AWS.Glacier.Types.Sum build-depends: - amazonka-core == 1.4.4.* + amazonka-core == 1.4.5.* , base >= 4.7 && < 5 test-suite amazonka-glacier-test @@ -112,9 +101,9 @@ , Test.AWS.Glacier.Internal build-depends: - amazonka-core == 1.4.4.* - , amazonka-test == 1.4.4.* - , amazonka-glacier == 1.4.4.* + amazonka-core == 1.4.5.* + , amazonka-test == 1.4.5.* + , amazonka-glacier == 1.4.5.* , base , bytestring , tasty diff --git a/fixture/ListProvisionedCapacity.yaml b/fixture/ListProvisionedCapacity.yaml new file mode 100644 --- /dev/null +++ b/fixture/ListProvisionedCapacity.yaml diff --git a/fixture/ListProvisionedCapacityResponse.proto b/fixture/ListProvisionedCapacityResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/ListProvisionedCapacityResponse.proto diff --git a/fixture/PurchaseProvisionedCapacity.yaml b/fixture/PurchaseProvisionedCapacity.yaml new file mode 100644 --- /dev/null +++ b/fixture/PurchaseProvisionedCapacity.yaml diff --git a/fixture/PurchaseProvisionedCapacityResponse.proto b/fixture/PurchaseProvisionedCapacityResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/PurchaseProvisionedCapacityResponse.proto diff --git a/gen/Network/AWS/Glacier.hs b/gen/Network/AWS/Glacier.hs --- a/gen/Network/AWS/Glacier.hs +++ b/gen/Network/AWS/Glacier.hs @@ -11,20 +11,23 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- Amazon Glacier is a storage solution for \"cold data.\" +-- 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, go to . +-- 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 . +-- -- 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/: +-- 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/ : -- --- - - 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. +-- * - 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. -- --- - - 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. +-- * - 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. -- +-- +-- module Network.AWS.Glacier ( -- * Service Configuration @@ -45,6 +48,9 @@ -- ** ServiceUnavailableException , _ServiceUnavailableException + -- ** InsufficientCapacityException + , _InsufficientCapacityException + -- ** ResourceNotFoundException , _ResourceNotFoundException @@ -93,6 +99,9 @@ -- ** ListVaults (Paginated) , module Network.AWS.Glacier.ListVaults + -- ** ListProvisionedCapacity + , module Network.AWS.Glacier.ListProvisionedCapacity + -- ** ListJobs (Paginated) , module Network.AWS.Glacier.ListJobs @@ -111,6 +120,9 @@ -- ** AbortMultipartUpload , module Network.AWS.Glacier.AbortMultipartUpload + -- ** PurchaseProvisionedCapacity + , module Network.AWS.Glacier.PurchaseProvisionedCapacity + -- ** DescribeVault , module Network.AWS.Glacier.DescribeVault @@ -202,6 +214,7 @@ , gjdSNSTopic , gjdStatusMessage , gjdVaultARN + , gjdTier , gjdArchiveSHA256TreeHash , gjdCreationDate , gjdCompleted @@ -235,6 +248,7 @@ , jpRetrievalByteRange , jpInventoryRetrievalParameters , jpSNSTopic + , jpTier , jpType , jpDescription @@ -244,6 +258,13 @@ , pleSHA256TreeHash , pleRangeInBytes + -- ** ProvisionedCapacityDescription + , ProvisionedCapacityDescription + , provisionedCapacityDescription + , pcdCapacityId + , pcdStartDate + , pcdExpirationDate + -- ** UploadListElement , UploadListElement , uploadListElement @@ -293,8 +314,10 @@ import Network.AWS.Glacier.ListJobs import Network.AWS.Glacier.ListMultipartUploads import Network.AWS.Glacier.ListParts +import Network.AWS.Glacier.ListProvisionedCapacity import Network.AWS.Glacier.ListTagsForVault import Network.AWS.Glacier.ListVaults +import Network.AWS.Glacier.PurchaseProvisionedCapacity import Network.AWS.Glacier.RemoveTagsFromVault import Network.AWS.Glacier.SetDataRetrievalPolicy import Network.AWS.Glacier.SetVaultAccessPolicy diff --git a/gen/Network/AWS/Glacier/AbortMultipartUpload.hs b/gen/Network/AWS/Glacier/AbortMultipartUpload.hs --- a/gen/Network/AWS/Glacier/AbortMultipartUpload.hs +++ b/gen/Network/AWS/Glacier/AbortMultipartUpload.hs @@ -20,13 +20,15 @@ -- -- This operation aborts a multipart upload identified by the upload ID. -- --- After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see < UploadMultipartPart> and < CompleteMultipartUpload>. -- +-- After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see 'UploadMultipartPart' and 'CompleteMultipartUpload' . +-- -- This operation is idempotent. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.AbortMultipartUpload ( -- * Creating a Request @@ -51,8 +53,10 @@ -- | Provides options to abort a multipart upload identified by the upload ID. -- --- For information about the underlying REST API, go to . For conceptual information, go to . -- +-- For information about the underlying REST API, see . For conceptual information, see . +-- +-- -- /See:/ 'abortMultipartUpload' smart constructor. data AbortMultipartUpload = AbortMultipartUpload' { _amuAccountId :: !Text @@ -64,11 +68,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'amuAccountId' +-- * 'amuAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'amuVaultName' +-- * 'amuVaultName' - The name of the vault. -- --- * 'amuUploadId' +-- * 'amuUploadId' - The upload ID of the multipart upload to delete. abortMultipartUpload :: Text -- ^ 'amuAccountId' -> Text -- ^ 'amuVaultName' @@ -81,7 +85,7 @@ , _amuUploadId = pUploadId_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. amuAccountId :: Lens' AbortMultipartUpload Text amuAccountId = lens _amuAccountId (\ s a -> s{_amuAccountId = a}); diff --git a/gen/Network/AWS/Glacier/AbortVaultLock.hs b/gen/Network/AWS/Glacier/AbortVaultLock.hs --- a/gen/Network/AWS/Glacier/AbortVaultLock.hs +++ b/gen/Network/AWS/Glacier/AbortVaultLock.hs @@ -18,11 +18,13 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation aborts the vault locking process if the vault lock is not in the 'Locked' state. If the vault lock is in the 'Locked' state when this operation is requested, the operation returns an 'AccessDeniedException' error. Aborting the vault locking process removes the vault lock policy from the specified vault. +-- This operation aborts the vault locking process if the vault lock is not in the @Locked@ state. If the vault lock is in the @Locked@ state when this operation is requested, the operation returns an @AccessDeniedException@ error. Aborting the vault locking process removes the vault lock policy from the specified vault. -- --- A vault lock is put into the 'InProgress' state by calling < InitiateVaultLock>. A vault lock is put into the 'Locked' state by calling < CompleteVaultLock>. You can get the state of a vault lock by calling < GetVaultLock>. For more information about the vault locking process, see . For more information about vault lock policies, see . -- --- This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the 'InProgress' state or if there is no policy associated with the vault. +-- A vault lock is put into the @InProgress@ state by calling 'InitiateVaultLock' . A vault lock is put into the @Locked@ state by calling 'CompleteVaultLock' . You can get the state of a vault lock by calling 'GetVaultLock' . For more information about the vault locking process, see . For more information about vault lock policies, see . +-- +-- This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the @InProgress@ state or if there is no policy associated with the vault. +-- module Network.AWS.Glacier.AbortVaultLock ( -- * Creating a Request @@ -44,8 +46,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input values for 'AbortVaultLock'. +-- | The input values for @AbortVaultLock@ . -- +-- +-- -- /See:/ 'abortVaultLock' smart constructor. data AbortVaultLock = AbortVaultLock' { _avlAccountId :: !Text @@ -56,9 +60,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'avlAccountId' +-- * 'avlAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. -- --- * 'avlVaultName' +-- * 'avlVaultName' - The name of the vault. abortVaultLock :: Text -- ^ 'avlAccountId' -> Text -- ^ 'avlVaultName' @@ -69,7 +73,7 @@ , _avlVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. avlAccountId :: Lens' AbortVaultLock Text avlAccountId = lens _avlAccountId (\ s a -> s{_avlAccountId = a}); diff --git a/gen/Network/AWS/Glacier/AddTagsToVault.hs b/gen/Network/AWS/Glacier/AddTagsToVault.hs --- a/gen/Network/AWS/Glacier/AddTagsToVault.hs +++ b/gen/Network/AWS/Glacier/AddTagsToVault.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the 'LimitExceededException' error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see . +-- This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the @LimitExceededException@ error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see . +-- +-- module Network.AWS.Glacier.AddTagsToVault ( -- * Creating a Request @@ -41,8 +43,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input values for 'AddTagsToVault'. +-- | The input values for @AddTagsToVault@ . -- +-- +-- -- /See:/ 'addTagsToVault' smart constructor. data AddTagsToVault = AddTagsToVault' { _attvTags :: !(Maybe (Map Text Text)) @@ -54,11 +58,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'attvTags' +-- * 'attvTags' - The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string. -- --- * 'attvAccountId' +-- * 'attvAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'attvVaultName' +-- * 'attvVaultName' - The name of the vault. addTagsToVault :: Text -- ^ 'attvAccountId' -> Text -- ^ 'attvVaultName' @@ -74,7 +78,7 @@ attvTags :: Lens' AddTagsToVault (HashMap Text Text) attvTags = lens _attvTags (\ s a -> s{_attvTags = a}) . _Default . _Map; --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. attvAccountId :: Lens' AddTagsToVault Text attvAccountId = lens _attvAccountId (\ s a -> s{_attvAccountId = a}); diff --git a/gen/Network/AWS/Glacier/CompleteMultipartUpload.hs b/gen/Network/AWS/Glacier/CompleteMultipartUpload.hs --- a/gen/Network/AWS/Glacier/CompleteMultipartUpload.hs +++ b/gen/Network/AWS/Glacier/CompleteMultipartUpload.hs @@ -18,17 +18,19 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see < InitiateJob>. +-- You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see 'InitiateJob' . -- --- In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see . On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The < ListParts> operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. -- +-- In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see . On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The 'ListParts' operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue. +-- -- Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails. -- -- Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.CompleteMultipartUpload ( -- * Creating a Request @@ -59,6 +61,8 @@ -- | Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. -- +-- +-- -- /See:/ 'completeMultipartUpload' smart constructor. data CompleteMultipartUpload = CompleteMultipartUpload' { _cmuChecksum :: !(Maybe Text) @@ -72,15 +76,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cmuChecksum' +-- * 'cmuChecksum' - The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails. -- --- * 'cmuArchiveSize' +-- * 'cmuArchiveSize' - The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded. -- --- * 'cmuAccountId' +-- * 'cmuAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'cmuVaultName' +-- * 'cmuVaultName' - The name of the vault. -- --- * 'cmuUploadId' +-- * 'cmuUploadId' - The upload ID of the multipart upload. completeMultipartUpload :: Text -- ^ 'cmuAccountId' -> Text -- ^ 'cmuVaultName' @@ -103,7 +107,7 @@ cmuArchiveSize :: Lens' CompleteMultipartUpload (Maybe Text) cmuArchiveSize = lens _cmuArchiveSize (\ s a -> s{_cmuArchiveSize = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. cmuAccountId :: Lens' CompleteMultipartUpload Text cmuAccountId = lens _cmuAccountId (\ s a -> s{_cmuAccountId = a}); diff --git a/gen/Network/AWS/Glacier/CompleteVaultLock.hs b/gen/Network/AWS/Glacier/CompleteVaultLock.hs --- a/gen/Network/AWS/Glacier/CompleteVaultLock.hs +++ b/gen/Network/AWS/Glacier/CompleteVaultLock.hs @@ -18,11 +18,13 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation completes the vault locking process by transitioning the vault lock from the 'InProgress' state to the 'Locked' state, which causes the vault lock policy to become unchangeable. A vault lock is put into the 'InProgress' state by calling < InitiateVaultLock>. You can obtain the state of the vault lock by calling < GetVaultLock>. For more information about the vault locking process, . +-- This operation completes the vault locking process by transitioning the vault lock from the @InProgress@ state to the @Locked@ state, which causes the vault lock policy to become unchangeable. A vault lock is put into the @InProgress@ state by calling 'InitiateVaultLock' . You can obtain the state of the vault lock by calling 'GetVaultLock' . For more information about the vault locking process, . -- --- This operation is idempotent. This request is always successful if the vault lock is in the 'Locked' state and the provided lock ID matches the lock ID originally used to lock the vault. -- --- If an invalid lock ID is passed in the request when the vault lock is in the 'Locked' state, the operation returns an 'AccessDeniedException' error. If an invalid lock ID is passed in the request when the vault lock is in the 'InProgress' state, the operation throws an 'InvalidParameter' error. +-- This operation is idempotent. This request is always successful if the vault lock is in the @Locked@ state and the provided lock ID matches the lock ID originally used to lock the vault. +-- +-- If an invalid lock ID is passed in the request when the vault lock is in the @Locked@ state, the operation returns an @AccessDeniedException@ error. If an invalid lock ID is passed in the request when the vault lock is in the @InProgress@ state, the operation throws an @InvalidParameter@ error. +-- module Network.AWS.Glacier.CompleteVaultLock ( -- * Creating a Request @@ -45,8 +47,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input values for 'CompleteVaultLock'. +-- | The input values for @CompleteVaultLock@ . -- +-- +-- -- /See:/ 'completeVaultLock' smart constructor. data CompleteVaultLock = CompleteVaultLock' { _cvlAccountId :: !Text @@ -58,11 +62,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cvlAccountId' +-- * 'cvlAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. -- --- * 'cvlVaultName' +-- * 'cvlVaultName' - The name of the vault. -- --- * 'cvlLockId' +-- * 'cvlLockId' - The @lockId@ value is the lock ID obtained from a 'InitiateVaultLock' request. completeVaultLock :: Text -- ^ 'cvlAccountId' -> Text -- ^ 'cvlVaultName' @@ -75,7 +79,7 @@ , _cvlLockId = pLockId_ } --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. cvlAccountId :: Lens' CompleteVaultLock Text cvlAccountId = lens _cvlAccountId (\ s a -> s{_cvlAccountId = a}); @@ -83,7 +87,7 @@ cvlVaultName :: Lens' CompleteVaultLock Text cvlVaultName = lens _cvlVaultName (\ s a -> s{_cvlVaultName = a}); --- | The 'lockId' value is the lock ID obtained from a < InitiateVaultLock> request. +-- | The @lockId@ value is the lock ID obtained from a 'InitiateVaultLock' request. cvlLockId :: Lens' CompleteVaultLock Text cvlLockId = lens _cvlLockId (\ s a -> s{_cvlLockId = a}); diff --git a/gen/Network/AWS/Glacier/CreateVault.hs b/gen/Network/AWS/Glacier/CreateVault.hs --- a/gen/Network/AWS/Glacier/CreateVault.hs +++ b/gen/Network/AWS/Glacier/CreateVault.hs @@ -20,17 +20,21 @@ -- -- This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier. -- +-- -- You must use the following guidelines when naming a vault. -- --- - Names can be between 1 and 255 characters long. +-- * Names can be between 1 and 255 characters long. -- --- - Allowed characters are a-z, A-Z, 0-9, \'_\' (underscore), \'-\' (hyphen), and \'.\' (period). +-- * Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). -- +-- +-- -- This operation is idempotent. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.CreateVault ( -- * Creating a Request @@ -57,6 +61,8 @@ -- | Provides options to create a vault. -- +-- +-- -- /See:/ 'createVault' smart constructor. data CreateVault = CreateVault' { _cvAccountId :: !Text @@ -67,9 +73,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cvAccountId' +-- * 'cvAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. -- --- * 'cvVaultName' +-- * 'cvVaultName' - The name of the vault. createVault :: Text -- ^ 'cvAccountId' -> Text -- ^ 'cvVaultName' @@ -80,7 +86,7 @@ , _cvVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. cvAccountId :: Lens' CreateVault Text cvAccountId = lens _cvAccountId (\ s a -> s{_cvAccountId = a}); @@ -118,6 +124,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'createVaultResponse' smart constructor. data CreateVaultResponse = CreateVaultResponse' { _cvrsLocation :: !(Maybe Text) @@ -128,9 +136,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'cvrsLocation' +-- * 'cvrsLocation' - The URI of the vault that was created. -- --- * 'cvrsResponseStatus' +-- * 'cvrsResponseStatus' - -- | The response status code. createVaultResponse :: Int -- ^ 'cvrsResponseStatus' -> CreateVaultResponse @@ -144,7 +152,7 @@ cvrsLocation :: Lens' CreateVaultResponse (Maybe Text) cvrsLocation = lens _cvrsLocation (\ s a -> s{_cvrsLocation = a}); --- | The response status code. +-- | -- | The response status code. cvrsResponseStatus :: Lens' CreateVaultResponse Int cvrsResponseStatus = lens _cvrsResponseStatus (\ s a -> s{_cvrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/DeleteArchive.hs b/gen/Network/AWS/Glacier/DeleteArchive.hs --- a/gen/Network/AWS/Glacier/DeleteArchive.hs +++ b/gen/Network/AWS/Glacier/DeleteArchive.hs @@ -20,14 +20,19 @@ -- -- This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios: -- --- - If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail. --- - If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output. -- +-- * If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail. +-- +-- * If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output. +-- +-- +-- -- This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.DeleteArchive ( -- * Creating a Request @@ -52,6 +57,8 @@ -- | Provides options for deleting an archive from an Amazon Glacier vault. -- +-- +-- -- /See:/ 'deleteArchive' smart constructor. data DeleteArchive = DeleteArchive' { _daAccountId :: !Text @@ -63,11 +70,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'daAccountId' +-- * 'daAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'daVaultName' +-- * 'daVaultName' - The name of the vault. -- --- * 'daArchiveId' +-- * 'daArchiveId' - The ID of the archive to delete. deleteArchive :: Text -- ^ 'daAccountId' -> Text -- ^ 'daVaultName' @@ -80,7 +87,7 @@ , _daArchiveId = pArchiveId_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. daAccountId :: Lens' DeleteArchive Text daAccountId = lens _daAccountId (\ s a -> s{_daAccountId = a}); diff --git a/gen/Network/AWS/Glacier/DeleteVault.hs b/gen/Network/AWS/Glacier/DeleteVault.hs --- a/gen/Network/AWS/Glacier/DeleteVault.hs +++ b/gen/Network/AWS/Glacier/DeleteVault.hs @@ -18,13 +18,15 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use < DescribeVault> to return the number of archives in a vault, and you can use to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using . +-- This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use 'DescribeVault' to return the number of archives in a vault, and you can use to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using . -- +-- -- This operation is idempotent. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.DeleteVault ( -- * Creating a Request @@ -48,6 +50,8 @@ -- | Provides options for deleting a vault from Amazon Glacier. -- +-- +-- -- /See:/ 'deleteVault' smart constructor. data DeleteVault = DeleteVault' { _dAccountId :: !Text @@ -58,9 +62,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dAccountId' +-- * 'dAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'dVaultName' +-- * 'dVaultName' - The name of the vault. deleteVault :: Text -- ^ 'dAccountId' -> Text -- ^ 'dVaultName' @@ -71,7 +75,7 @@ , _dVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. dAccountId :: Lens' DeleteVault Text dAccountId = lens _dAccountId (\ s a -> s{_dAccountId = a}); diff --git a/gen/Network/AWS/Glacier/DeleteVaultAccessPolicy.hs b/gen/Network/AWS/Glacier/DeleteVaultAccessPolicy.hs --- a/gen/Network/AWS/Glacier/DeleteVaultAccessPolicy.hs +++ b/gen/Network/AWS/Glacier/DeleteVaultAccessPolicy.hs @@ -20,7 +20,9 @@ -- -- This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request. -- --- This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see . +-- +-- This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see . +-- module Network.AWS.Glacier.DeleteVaultAccessPolicy ( -- * Creating a Request @@ -44,6 +46,8 @@ -- | DeleteVaultAccessPolicy input. -- +-- +-- -- /See:/ 'deleteVaultAccessPolicy' smart constructor. data DeleteVaultAccessPolicy = DeleteVaultAccessPolicy' { _dvapAccountId :: !Text @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dvapAccountId' +-- * 'dvapAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'dvapVaultName' +-- * 'dvapVaultName' - The name of the vault. deleteVaultAccessPolicy :: Text -- ^ 'dvapAccountId' -> Text -- ^ 'dvapVaultName' @@ -67,7 +71,7 @@ , _dvapVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. dvapAccountId :: Lens' DeleteVaultAccessPolicy Text dvapAccountId = lens _dvapAccountId (\ s a -> s{_dvapAccountId = a}); diff --git a/gen/Network/AWS/Glacier/DeleteVaultNotifications.hs b/gen/Network/AWS/Glacier/DeleteVaultNotifications.hs --- a/gen/Network/AWS/Glacier/DeleteVaultNotifications.hs +++ b/gen/Network/AWS/Glacier/DeleteVaultNotifications.hs @@ -20,9 +20,11 @@ -- -- This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the Amazon Glacier Developer Guide. +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- +-- For conceptual information and underlying REST API, see and in the Amazon Glacier Developer Guide. +-- module Network.AWS.Glacier.DeleteVaultNotifications ( -- * Creating a Request @@ -46,6 +48,8 @@ -- | Provides options for deleting a vault notification configuration from an Amazon Glacier vault. -- +-- +-- -- /See:/ 'deleteVaultNotifications' smart constructor. data DeleteVaultNotifications = DeleteVaultNotifications' { _dvnAccountId :: !Text @@ -56,9 +60,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dvnAccountId' +-- * 'dvnAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'dvnVaultName' +-- * 'dvnVaultName' - The name of the vault. deleteVaultNotifications :: Text -- ^ 'dvnAccountId' -> Text -- ^ 'dvnVaultName' @@ -69,7 +73,7 @@ , _dvnVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. dvnAccountId :: Lens' DeleteVaultNotifications Text dvnAccountId = lens _dvnAccountId (\ s a -> s{_dvnAccountId = a}); diff --git a/gen/Network/AWS/Glacier/DescribeJob.hs b/gen/Network/AWS/Glacier/DescribeJob.hs --- a/gen/Network/AWS/Glacier/DescribeJob.hs +++ b/gen/Network/AWS/Glacier/DescribeJob.hs @@ -18,15 +18,15 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code\/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see < InitiateJob>. +-- This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see 'InitiateJob' . -- --- This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job. -- -- A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For information about the underlying REST API, go to in the /Amazon Glacier Developer Guide/. +-- For information about the underlying REST API, see in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.DescribeJob ( -- * Creating a Request @@ -51,6 +51,7 @@ , gjdSNSTopic , gjdStatusMessage , gjdVaultARN + , gjdTier , gjdArchiveSHA256TreeHash , gjdCreationDate , gjdCompleted @@ -69,6 +70,8 @@ -- | Provides options for retrieving a job description. -- +-- +-- -- /See:/ 'describeJob' smart constructor. data DescribeJob = DescribeJob' { _djAccountId :: !Text @@ -80,11 +83,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'djAccountId' +-- * 'djAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'djVaultName' +-- * 'djVaultName' - The name of the vault. -- --- * 'djJobId' +-- * 'djJobId' - The ID of the job to describe. describeJob :: Text -- ^ 'djAccountId' -> Text -- ^ 'djVaultName' @@ -97,7 +100,7 @@ , _djJobId = pJobId_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. djAccountId :: Lens' DescribeJob Text djAccountId = lens _djAccountId (\ s a -> s{_djAccountId = a}); diff --git a/gen/Network/AWS/Glacier/DescribeVault.hs b/gen/Network/AWS/Glacier/DescribeVault.hs --- a/gen/Network/AWS/Glacier/DescribeVault.hs +++ b/gen/Network/AWS/Glacier/DescribeVault.hs @@ -18,11 +18,13 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation returns information about a vault, including the vault\'s Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use < InitiateJob>. Amazon Glacier generates vault inventories approximately daily. For more information, see . +-- This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use 'InitiateJob' . Amazon Glacier generates vault inventories approximately daily. For more information, see . -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.DescribeVault ( -- * Creating a Request @@ -53,6 +55,8 @@ -- | Provides options for retrieving metadata for a specific vault in Amazon Glacier. -- +-- +-- -- /See:/ 'describeVault' smart constructor. data DescribeVault = DescribeVault' { _dvAccountId :: !Text @@ -63,9 +67,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dvAccountId' +-- * 'dvAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'dvVaultName' +-- * 'dvVaultName' - The name of the vault. describeVault :: Text -- ^ 'dvAccountId' -> Text -- ^ 'dvVaultName' @@ -76,7 +80,7 @@ , _dvVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. dvAccountId :: Lens' DescribeVault Text dvAccountId = lens _dvAccountId (\ s a -> s{_dvAccountId = a}); diff --git a/gen/Network/AWS/Glacier/GetDataRetrievalPolicy.hs b/gen/Network/AWS/Glacier/GetDataRetrievalPolicy.hs --- a/gen/Network/AWS/Glacier/GetDataRetrievalPolicy.hs +++ b/gen/Network/AWS/Glacier/GetDataRetrievalPolicy.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see . +-- This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see . +-- +-- module Network.AWS.Glacier.GetDataRetrievalPolicy ( -- * Creating a Request @@ -44,6 +46,8 @@ -- | Input for GetDataRetrievalPolicy. -- +-- +-- -- /See:/ 'getDataRetrievalPolicy' smart constructor. newtype GetDataRetrievalPolicy = GetDataRetrievalPolicy' { _gdrpAccountId :: Text @@ -53,7 +57,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gdrpAccountId' +-- * 'gdrpAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. getDataRetrievalPolicy :: Text -- ^ 'gdrpAccountId' -> GetDataRetrievalPolicy @@ -62,7 +66,7 @@ { _gdrpAccountId = pAccountId_ } --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. gdrpAccountId :: Lens' GetDataRetrievalPolicy Text gdrpAccountId = lens _gdrpAccountId (\ s a -> s{_gdrpAccountId = a}); @@ -92,8 +96,10 @@ instance ToQuery GetDataRetrievalPolicy where toQuery = const mempty --- | Contains the Amazon Glacier response to the 'GetDataRetrievalPolicy' request. +-- | Contains the Amazon Glacier response to the @GetDataRetrievalPolicy@ request. -- +-- +-- -- /See:/ 'getDataRetrievalPolicyResponse' smart constructor. data GetDataRetrievalPolicyResponse = GetDataRetrievalPolicyResponse' { _gdrprsPolicy :: !(Maybe DataRetrievalPolicy) @@ -104,9 +110,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gdrprsPolicy' +-- * 'gdrprsPolicy' - Contains the returned data retrieval policy in JSON format. -- --- * 'gdrprsResponseStatus' +-- * 'gdrprsResponseStatus' - -- | The response status code. getDataRetrievalPolicyResponse :: Int -- ^ 'gdrprsResponseStatus' -> GetDataRetrievalPolicyResponse @@ -120,7 +126,7 @@ gdrprsPolicy :: Lens' GetDataRetrievalPolicyResponse (Maybe DataRetrievalPolicy) gdrprsPolicy = lens _gdrprsPolicy (\ s a -> s{_gdrprsPolicy = a}); --- | The response status code. +-- | -- | The response status code. gdrprsResponseStatus :: Lens' GetDataRetrievalPolicyResponse Int gdrprsResponseStatus = lens _gdrprsResponseStatus (\ s a -> s{_gdrprsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/GetJobOutput.hs b/gen/Network/AWS/Glacier/GetJobOutput.hs --- a/gen/Network/AWS/Glacier/GetJobOutput.hs +++ b/gen/Network/AWS/Glacier/GetJobOutput.hs @@ -18,23 +18,23 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation downloads the output of the job you initiated using < InitiateJob>. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. +-- This operation downloads the output of the job you initiated using 'InitiateJob' . Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory. -- --- A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. -- --- If the job output is large, then you can use the 'Range' request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output: +-- You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data. -- --- 1. Download a 128 MB chunk of output by specifying the appropriate byte range using the 'Range' header. +-- A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the __Get Job Output__ response. -- --- 2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data. +-- For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of @bytes=0-1048575@ , you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the __Get Job Output__ response. -- --- 3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. +-- In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected. -- --- 4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the < DescribeJob> API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors. +-- A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and the underlying REST API, go to , , and +-- For conceptual information and the underlying REST API, see , , and +-- module Network.AWS.Glacier.GetJobOutput ( -- * Creating a Request @@ -68,6 +68,8 @@ -- | Provides options for downloading output of an Amazon Glacier job. -- +-- +-- -- /See:/ 'getJobOutput' smart constructor. data GetJobOutput = GetJobOutput' { _gjoRange :: !(Maybe Text) @@ -80,13 +82,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gjoRange' +-- * 'gjoRange' - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as @bytes=0-1048575@ . By default, this operation downloads the entire output. If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output: * Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received. * Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data. * Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. * After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the 'DescribeJob' API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors. -- --- * 'gjoAccountId' +-- * 'gjoAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'gjoVaultName' +-- * 'gjoVaultName' - The name of the vault. -- --- * 'gjoJobId' +-- * 'gjoJobId' - The job ID whose data is downloaded. getJobOutput :: Text -- ^ 'gjoAccountId' -> Text -- ^ 'gjoVaultName' @@ -100,11 +102,11 @@ , _gjoJobId = pJobId_ } --- | The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify \"Range: bytes=0-1048575\". By default, this operation downloads the entire output. +-- | The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as @bytes=0-1048575@ . By default, this operation downloads the entire output. If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output: * Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received. * Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data. * Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. * After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the 'DescribeJob' API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors. gjoRange :: Lens' GetJobOutput (Maybe Text) gjoRange = lens _gjoRange (\ s a -> s{_gjoRange = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. gjoAccountId :: Lens' GetJobOutput Text gjoAccountId = lens _gjoAccountId (\ s a -> s{_gjoAccountId = a}); @@ -151,6 +153,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'getJobOutputResponse' smart constructor. data GetJobOutputResponse = GetJobOutputResponse' { _gjorsChecksum :: !(Maybe Text) @@ -166,19 +170,19 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gjorsChecksum' +-- * 'gjorsChecksum' - The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions: * You get the entire range of the archive. * You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header. * You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header. -- --- * 'gjorsAcceptRanges' +-- * 'gjorsAcceptRanges' - Indicates the range units accepted. For more information, see . -- --- * 'gjorsArchiveDescription' +-- * 'gjorsArchiveDescription' - The description of an archive. -- --- * 'gjorsContentRange' +-- * 'gjorsContentRange' - The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB. -- --- * 'gjorsContentType' +-- * 'gjorsContentType' - The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json. -- --- * 'gjorsStatus' +-- * 'gjorsStatus' - The HTTP response code for a job output request. The value depends on whether a range was specified in the request. -- --- * 'gjorsBody' +-- * 'gjorsBody' - The job data, either archive data or inventory data. getJobOutputResponse :: Int -- ^ 'gjorsStatus' -> RsBody -- ^ 'gjorsBody' @@ -194,15 +198,11 @@ , _gjorsBody = pBody_ } --- | The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions: --- --- - You get the entire range of the archive. --- - You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header. --- - You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header. +-- | The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions: * You get the entire range of the archive. * You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header. * You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header. gjorsChecksum :: Lens' GetJobOutputResponse (Maybe Text) gjorsChecksum = lens _gjorsChecksum (\ s a -> s{_gjorsChecksum = a}); --- | Indicates the range units accepted. For more information, go to . +-- | Indicates the range units accepted. For more information, see . gjorsAcceptRanges :: Lens' GetJobOutputResponse (Maybe Text) gjorsAcceptRanges = lens _gjorsAcceptRanges (\ s a -> s{_gjorsAcceptRanges = a}); @@ -210,11 +210,11 @@ gjorsArchiveDescription :: Lens' GetJobOutputResponse (Maybe Text) gjorsArchiveDescription = lens _gjorsArchiveDescription (\ s a -> s{_gjorsArchiveDescription = a}); --- | The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575\/8388608 returns the first 1 MB from 8 MB. +-- | The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB. gjorsContentRange :: Lens' GetJobOutputResponse (Maybe Text) gjorsContentRange = lens _gjorsContentRange (\ s a -> s{_gjorsContentRange = a}); --- | The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application\/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text\/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application\/json. +-- | The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json. gjorsContentType :: Lens' GetJobOutputResponse (Maybe Text) gjorsContentType = lens _gjorsContentType (\ s a -> s{_gjorsContentType = a}); diff --git a/gen/Network/AWS/Glacier/GetVaultAccessPolicy.hs b/gen/Network/AWS/Glacier/GetVaultAccessPolicy.hs --- a/gen/Network/AWS/Glacier/GetVaultAccessPolicy.hs +++ b/gen/Network/AWS/Glacier/GetVaultAccessPolicy.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation retrieves the 'access-policy' subresource set on the vault; for more information on setting this subresource, see . If there is no access policy set on the vault, the operation returns a '404 Not found' error. For more information about vault access policies, see . +-- This operation retrieves the @access-policy@ subresource set on the vault; for more information on setting this subresource, see . If there is no access policy set on the vault, the operation returns a @404 Not found@ error. For more information about vault access policies, see . +-- +-- module Network.AWS.Glacier.GetVaultAccessPolicy ( -- * Creating a Request @@ -45,6 +47,8 @@ -- | Input for GetVaultAccessPolicy. -- +-- +-- -- /See:/ 'getVaultAccessPolicy' smart constructor. data GetVaultAccessPolicy = GetVaultAccessPolicy' { _gvapAccountId :: !Text @@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gvapAccountId' +-- * 'gvapAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'gvapVaultName' +-- * 'gvapVaultName' - The name of the vault. getVaultAccessPolicy :: Text -- ^ 'gvapAccountId' -> Text -- ^ 'gvapVaultName' @@ -68,7 +72,7 @@ , _gvapVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. gvapAccountId :: Lens' GetVaultAccessPolicy Text gvapAccountId = lens _gvapAccountId (\ s a -> s{_gvapAccountId = a}); @@ -104,6 +108,8 @@ -- | Output for GetVaultAccessPolicy. -- +-- +-- -- /See:/ 'getVaultAccessPolicyResponse' smart constructor. data GetVaultAccessPolicyResponse = GetVaultAccessPolicyResponse' { _gvaprsPolicy :: !(Maybe VaultAccessPolicy) @@ -114,9 +120,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gvaprsPolicy' +-- * 'gvaprsPolicy' - Contains the returned vault access policy as a JSON string. -- --- * 'gvaprsResponseStatus' +-- * 'gvaprsResponseStatus' - -- | The response status code. getVaultAccessPolicyResponse :: Int -- ^ 'gvaprsResponseStatus' -> GetVaultAccessPolicyResponse @@ -130,7 +136,7 @@ gvaprsPolicy :: Lens' GetVaultAccessPolicyResponse (Maybe VaultAccessPolicy) gvaprsPolicy = lens _gvaprsPolicy (\ s a -> s{_gvaprsPolicy = a}); --- | The response status code. +-- | -- | The response status code. gvaprsResponseStatus :: Lens' GetVaultAccessPolicyResponse Int gvaprsResponseStatus = lens _gvaprsResponseStatus (\ s a -> s{_gvaprsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/GetVaultLock.hs b/gen/Network/AWS/Glacier/GetVaultLock.hs --- a/gen/Network/AWS/Glacier/GetVaultLock.hs +++ b/gen/Network/AWS/Glacier/GetVaultLock.hs @@ -18,19 +18,23 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation retrieves the following attributes from the 'lock-policy' subresource set on the specified vault: +-- This operation retrieves the following attributes from the @lock-policy@ subresource set on the specified vault: -- --- - The vault lock policy set on the vault. -- --- - The state of the vault lock, which is either 'InProgess' or 'Locked'. +-- * The vault lock policy set on the vault. -- --- - When the lock ID expires. The lock ID is used to complete the vault locking process. +-- * The state of the vault lock, which is either @InProgess@ or @Locked@ . -- --- - When the vault lock was initiated and put into the 'InProgress' state. +-- * When the lock ID expires. The lock ID is used to complete the vault locking process. -- --- A vault lock is put into the 'InProgress' state by calling < InitiateVaultLock>. A vault lock is put into the 'Locked' state by calling < CompleteVaultLock>. You can abort the vault locking process by calling < AbortVaultLock>. For more information about the vault locking process, . +-- * When the vault lock was initiated and put into the @InProgress@ state. -- --- If there is no vault lock policy set on the vault, the operation returns a '404 Not found' error. For more information about vault lock policies, . +-- +-- +-- A vault lock is put into the @InProgress@ state by calling 'InitiateVaultLock' . A vault lock is put into the @Locked@ state by calling 'CompleteVaultLock' . You can abort the vault locking process by calling 'AbortVaultLock' . For more information about the vault locking process, . +-- +-- If there is no vault lock policy set on the vault, the operation returns a @404 Not found@ error. For more information about vault lock policies, . +-- module Network.AWS.Glacier.GetVaultLock ( -- * Creating a Request @@ -58,8 +62,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input values for 'GetVaultLock'. +-- | The input values for @GetVaultLock@ . -- +-- +-- -- /See:/ 'getVaultLock' smart constructor. data GetVaultLock = GetVaultLock' { _gvlAccountId :: !Text @@ -70,9 +76,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gvlAccountId' +-- * 'gvlAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'gvlVaultName' +-- * 'gvlVaultName' - The name of the vault. getVaultLock :: Text -- ^ 'gvlAccountId' -> Text -- ^ 'gvlVaultName' @@ -83,7 +89,7 @@ , _gvlVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. gvlAccountId :: Lens' GetVaultLock Text gvlAccountId = lens _gvlAccountId (\ s a -> s{_gvlAccountId = a}); @@ -121,6 +127,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'getVaultLockResponse' smart constructor. data GetVaultLockResponse = GetVaultLockResponse' { _gvlrsState :: !(Maybe Text) @@ -134,15 +142,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gvlrsState' +-- * 'gvlrsState' - The state of the vault lock. @InProgress@ or @Locked@ . -- --- * 'gvlrsExpirationDate' +-- * 'gvlrsExpirationDate' - The UTC date and time at which the lock ID expires. This value can be @null@ if the vault lock is in a @Locked@ state. -- --- * 'gvlrsCreationDate' +-- * 'gvlrsCreationDate' - The UTC date and time at which the vault lock was put into the @InProgress@ state. -- --- * 'gvlrsPolicy' +-- * 'gvlrsPolicy' - The vault lock policy as a JSON string, which uses "\" as an escape character. -- --- * 'gvlrsResponseStatus' +-- * 'gvlrsResponseStatus' - -- | The response status code. getVaultLockResponse :: Int -- ^ 'gvlrsResponseStatus' -> GetVaultLockResponse @@ -155,23 +163,23 @@ , _gvlrsResponseStatus = pResponseStatus_ } --- | The state of the vault lock. 'InProgress' or 'Locked'. +-- | The state of the vault lock. @InProgress@ or @Locked@ . gvlrsState :: Lens' GetVaultLockResponse (Maybe Text) gvlrsState = lens _gvlrsState (\ s a -> s{_gvlrsState = a}); --- | The UTC date and time at which the lock ID expires. This value can be 'null' if the vault lock is in a 'Locked' state. +-- | The UTC date and time at which the lock ID expires. This value can be @null@ if the vault lock is in a @Locked@ state. gvlrsExpirationDate :: Lens' GetVaultLockResponse (Maybe Text) gvlrsExpirationDate = lens _gvlrsExpirationDate (\ s a -> s{_gvlrsExpirationDate = a}); --- | The UTC date and time at which the vault lock was put into the 'InProgress' state. +-- | The UTC date and time at which the vault lock was put into the @InProgress@ state. gvlrsCreationDate :: Lens' GetVaultLockResponse (Maybe Text) gvlrsCreationDate = lens _gvlrsCreationDate (\ s a -> s{_gvlrsCreationDate = a}); --- | The vault lock policy as a JSON string, which uses \"\\\" as an escape character. +-- | The vault lock policy as a JSON string, which uses "\" as an escape character. gvlrsPolicy :: Lens' GetVaultLockResponse (Maybe Text) gvlrsPolicy = lens _gvlrsPolicy (\ s a -> s{_gvlrsPolicy = a}); --- | The response status code. +-- | -- | The response status code. gvlrsResponseStatus :: Lens' GetVaultLockResponse Int gvlrsResponseStatus = lens _gvlrsResponseStatus (\ s a -> s{_gvlrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/GetVaultNotifications.hs b/gen/Network/AWS/Glacier/GetVaultNotifications.hs --- a/gen/Network/AWS/Glacier/GetVaultNotifications.hs +++ b/gen/Network/AWS/Glacier/GetVaultNotifications.hs @@ -18,13 +18,15 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation retrieves the 'notification-configuration' subresource of the specified vault. +-- This operation retrieves the @notification-configuration@ subresource of the specified vault. -- --- For information about setting a notification configuration on a vault, see < SetVaultNotifications>. If a notification configuration for a vault is not set, the operation returns a '404 Not Found' error. For more information about vault notifications, see . -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- For information about setting a notification configuration on a vault, see 'SetVaultNotifications' . If a notification configuration for a vault is not set, the operation returns a @404 Not Found@ error. For more information about vault notifications, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.GetVaultNotifications ( -- * Creating a Request @@ -51,6 +53,8 @@ -- | Provides options for retrieving the notification configuration set on an Amazon Glacier vault. -- +-- +-- -- /See:/ 'getVaultNotifications' smart constructor. data GetVaultNotifications = GetVaultNotifications' { _gvnAccountId :: !Text @@ -61,9 +65,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gvnAccountId' +-- * 'gvnAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'gvnVaultName' +-- * 'gvnVaultName' - The name of the vault. getVaultNotifications :: Text -- ^ 'gvnAccountId' -> Text -- ^ 'gvnVaultName' @@ -74,7 +78,7 @@ , _gvnVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. gvnAccountId :: Lens' GetVaultNotifications Text gvnAccountId = lens _gvnAccountId (\ s a -> s{_gvnAccountId = a}); @@ -110,6 +114,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'getVaultNotificationsResponse' smart constructor. data GetVaultNotificationsResponse = GetVaultNotificationsResponse' { _gvnrsVaultNotificationConfig :: !(Maybe VaultNotificationConfig) @@ -120,9 +126,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gvnrsVaultNotificationConfig' +-- * 'gvnrsVaultNotificationConfig' - Returns the notification configuration set on the vault. -- --- * 'gvnrsResponseStatus' +-- * 'gvnrsResponseStatus' - -- | The response status code. getVaultNotificationsResponse :: Int -- ^ 'gvnrsResponseStatus' -> GetVaultNotificationsResponse @@ -136,7 +142,7 @@ gvnrsVaultNotificationConfig :: Lens' GetVaultNotificationsResponse (Maybe VaultNotificationConfig) gvnrsVaultNotificationConfig = lens _gvnrsVaultNotificationConfig (\ s a -> s{_gvnrsVaultNotificationConfig = a}); --- | The response status code. +-- | -- | The response status code. gvnrsResponseStatus :: Lens' GetVaultNotificationsResponse Int gvnrsResponseStatus = lens _gvnrsResponseStatus (\ s a -> s{_gvnrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/InitiateJob.hs b/gen/Network/AWS/Glacier/InitiateJob.hs --- a/gen/Network/AWS/Glacier/InitiateJob.hs +++ b/gen/Network/AWS/Glacier/InitiateJob.hs @@ -20,28 +20,29 @@ -- -- This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault). -- +-- -- Retrieving data from Amazon Glacier is a two-step process: -- --- 1. Initiate a retrieval job. +-- * Initiate a retrieval job. -- --- A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see . For more information about the PolicyEnforcedException exception, see . +-- * After the job completes, download the bytes. -- --- 2. After the job completes, download the bytes. -- --- The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see < GetJobOutput> operation. -- +-- The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see 'GetJobOutput' operation. +-- -- The job must complete before you can get its output. To determine when a job is complete, you have the following options: -- --- - __Use Amazon SNS Notification__ You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see < SetVaultNotifications>. +-- * __Use Amazon SNS Notification__ You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see 'SetVaultNotifications' . -- --- - __Get job details__ You can make a < DescribeJob> request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete. +-- * __Get job details__ You can make a 'DescribeJob' request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete. -- --- The information you get via notification is same that you get by calling < DescribeJob>. -- --- If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see < SetVaultNotifications>. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see 'SetVaultNotifications' . -- +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- -- __About the Vault Inventory__ -- -- Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory. @@ -52,21 +53,36 @@ -- -- /Filtering by Archive Creation Date/ -- --- You can retrieve inventory items for archives created between 'StartDate' and 'EndDate' by specifying values for these parameters in the __InitiateJob__ request. Archives created on or after the 'StartDate' and before the 'EndDate' will be returned. If you only provide the 'StartDate' without the 'EndDate', you will retrieve the inventory for all archives created on or after the 'StartDate'. If you only provide the 'EndDate' without the 'StartDate', you will get back the inventory for all archives created before the 'EndDate'. +-- You can retrieve inventory items for archives created between @StartDate@ and @EndDate@ by specifying values for these parameters in the __InitiateJob__ request. Archives created on or after the @StartDate@ and before the @EndDate@ will be returned. If you only provide the @StartDate@ without the @EndDate@ , you will retrieve the inventory for all archives created on or after the @StartDate@ . If you only provide the @EndDate@ without the @StartDate@ , you will get back the inventory for all archives created before the @EndDate@ . -- -- /Limiting Inventory Items per Retrieval/ -- --- You can limit the number of inventory items returned by setting the 'Limit' parameter in the __InitiateJob__ request. The inventory job output will contain inventory items up to the specified 'Limit'. If there are more inventory items available, the result is paginated. After a job is complete you can use the < DescribeJob> operation to get a marker that you use in a subsequent __InitiateJob__ request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making __InitiateJob__ requests with the marker from the previous __DescribeJob__ output, until you get a marker from __DescribeJob__ that returns null, indicating that there are no more inventory items available. +-- You can limit the number of inventory items returned by setting the @Limit@ parameter in the __InitiateJob__ request. The inventory job output will contain inventory items up to the specified @Limit@ . If there are more inventory items available, the result is paginated. After a job is complete you can use the 'DescribeJob' operation to get a marker that you use in a subsequent __InitiateJob__ request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making __InitiateJob__ requests with the marker from the previous __DescribeJob__ output, until you get a marker from __DescribeJob__ that returns null, indicating that there are no more inventory items available. -- --- You can use the 'Limit' parameter together with the date range parameters. +-- You can use the @Limit@ parameter together with the date range parameters. -- -- __About Ranged Archive Retrieval__ -- -- You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and the underlying REST API, go to and +-- For conceptual information and the underlying REST API, see and +-- +-- __Expedited and Bulk Archive Retrievals__ +-- +-- When retrieving an archive, you can specify one of the following options in the @Tier@ field of the request body: +-- +-- * __Standard__ The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours. +-- +-- * __Bulk__ Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours. +-- +-- * __Expedited__ Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes. +-- +-- +-- +-- For more information about expedited and bulk retrievals, see . +-- module Network.AWS.Glacier.InitiateJob ( -- * Creating a Request @@ -95,6 +111,8 @@ -- | Provides options for initiating an Amazon Glacier job. -- +-- +-- -- /See:/ 'initiateJob' smart constructor. data InitiateJob = InitiateJob' { _ijJobParameters :: !(Maybe JobParameters) @@ -106,11 +124,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ijJobParameters' +-- * 'ijJobParameters' - Provides options for specifying job information. -- --- * 'ijAccountId' +-- * 'ijAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'ijVaultName' +-- * 'ijVaultName' - The name of the vault. initiateJob :: Text -- ^ 'ijAccountId' -> Text -- ^ 'ijVaultName' @@ -126,7 +144,7 @@ ijJobParameters :: Lens' InitiateJob (Maybe JobParameters) ijJobParameters = lens _ijJobParameters (\ s a -> s{_ijJobParameters = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. ijAccountId :: Lens' InitiateJob Text ijAccountId = lens _ijAccountId (\ s a -> s{_ijAccountId = a}); @@ -168,6 +186,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'initiateJobResponse' smart constructor. data InitiateJobResponse = InitiateJobResponse' { _ijrsJobId :: !(Maybe Text) @@ -179,11 +199,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ijrsJobId' +-- * 'ijrsJobId' - The ID of the job. -- --- * 'ijrsLocation' +-- * 'ijrsLocation' - The relative URI path of the job. -- --- * 'ijrsResponseStatus' +-- * 'ijrsResponseStatus' - -- | The response status code. initiateJobResponse :: Int -- ^ 'ijrsResponseStatus' -> InitiateJobResponse @@ -202,7 +222,7 @@ ijrsLocation :: Lens' InitiateJobResponse (Maybe Text) ijrsLocation = lens _ijrsLocation (\ s a -> s{_ijrsLocation = a}); --- | The response status code. +-- | -- | The response status code. ijrsResponseStatus :: Lens' InitiateJobResponse Int ijrsResponseStatus = lens _ijrsResponseStatus (\ s a -> s{_ijrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/InitiateMultipartUpload.hs b/gen/Network/AWS/Glacier/InitiateMultipartUpload.hs --- a/gen/Network/AWS/Glacier/InitiateMultipartUpload.hs +++ b/gen/Network/AWS/Glacier/InitiateMultipartUpload.hs @@ -18,19 +18,19 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see < UploadMultipartPart>). +-- This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see 'UploadMultipartPart' ). -- --- When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. -- --- Every part you upload to this resource (see < UploadMultipartPart>), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. +-- When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB. -- --- You don\'t need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size. +-- Every part you upload to this resource (see 'UploadMultipartPart' ), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB. -- -- After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.InitiateMultipartUpload ( -- * Creating a Request @@ -60,6 +60,8 @@ -- | Provides options for initiating a multipart upload to an Amazon Glacier vault. -- +-- +-- -- /See:/ 'initiateMultipartUpload' smart constructor. data InitiateMultipartUpload = InitiateMultipartUpload' { _imuPartSize :: !(Maybe Text) @@ -72,13 +74,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'imuPartSize' +-- * 'imuPartSize' - The size of each part except the last, in bytes. The last part can be smaller than this part size. -- --- * 'imuArchiveDescription' +-- * 'imuArchiveDescription' - The archive description that you are uploading in parts. The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB). -- --- * 'imuAccountId' +-- * 'imuAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'imuVaultName' +-- * 'imuVaultName' - The name of the vault. initiateMultipartUpload :: Text -- ^ 'imuAccountId' -> Text -- ^ 'imuVaultName' @@ -95,13 +97,11 @@ imuPartSize :: Lens' InitiateMultipartUpload (Maybe Text) imuPartSize = lens _imuPartSize (\ s a -> s{_imuPartSize = a}); --- | The archive description that you are uploading in parts. --- --- The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB). +-- | The archive description that you are uploading in parts. The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB). imuArchiveDescription :: Lens' InitiateMultipartUpload (Maybe Text) imuArchiveDescription = lens _imuArchiveDescription (\ s a -> s{_imuArchiveDescription = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. imuAccountId :: Lens' InitiateMultipartUpload Text imuAccountId = lens _imuAccountId (\ s a -> s{_imuAccountId = a}); @@ -146,6 +146,8 @@ -- | The Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'initiateMultipartUploadResponse' smart constructor. data InitiateMultipartUploadResponse = InitiateMultipartUploadResponse' { _imursLocation :: !(Maybe Text) @@ -157,11 +159,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'imursLocation' +-- * 'imursLocation' - The relative URI path of the multipart upload ID Amazon Glacier created. -- --- * 'imursUploadId' +-- * 'imursUploadId' - The ID of the multipart upload. This value is also included as part of the location. -- --- * 'imursResponseStatus' +-- * 'imursResponseStatus' - -- | The response status code. initiateMultipartUploadResponse :: Int -- ^ 'imursResponseStatus' -> InitiateMultipartUploadResponse @@ -180,7 +182,7 @@ imursUploadId :: Lens' InitiateMultipartUploadResponse (Maybe Text) imursUploadId = lens _imursUploadId (\ s a -> s{_imursUploadId = a}); --- | The response status code. +-- | -- | The response status code. imursResponseStatus :: Lens' InitiateMultipartUploadResponse Int imursResponseStatus = lens _imursResponseStatus (\ s a -> s{_imursResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/InitiateVaultLock.hs b/gen/Network/AWS/Glacier/InitiateVaultLock.hs --- a/gen/Network/AWS/Glacier/InitiateVaultLock.hs +++ b/gen/Network/AWS/Glacier/InitiateVaultLock.hs @@ -20,21 +20,25 @@ -- -- This operation initiates the vault locking process by doing the following: -- --- - Installing a vault lock policy on the specified vault. -- --- - Setting the lock state of vault lock to 'InProgress'. +-- * Installing a vault lock policy on the specified vault. -- --- - Returning a lock ID, which is used to complete the vault locking process. +-- * Setting the lock state of vault lock to @InProgress@ . -- --- You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see . +-- * Returning a lock ID, which is used to complete the vault locking process. -- --- You must complete the vault locking process within 24 hours after the vault lock enters the 'InProgress' state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the 'InProgress' state, and the vault lock policy is removed from the vault. You call < CompleteVaultLock> to complete the vault locking process by setting the state of the vault lock to 'Locked'. -- --- After a vault lock is in the 'Locked' state, you cannot initiate a new vault lock for the vault. -- --- You can abort the vault locking process by calling < AbortVaultLock>. You can get the state of the vault lock by calling < GetVaultLock>. For more information about the vault locking process, . +-- You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see . -- --- If this operation is called when the vault lock is in the 'InProgress' state, the operation returns an 'AccessDeniedException' error. When the vault lock is in the 'InProgress' state you must call < AbortVaultLock> before you can initiate a new vault lock policy. +-- You must complete the vault locking process within 24 hours after the vault lock enters the @InProgress@ state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the @InProgress@ state, and the vault lock policy is removed from the vault. You call 'CompleteVaultLock' to complete the vault locking process by setting the state of the vault lock to @Locked@ . +-- +-- After a vault lock is in the @Locked@ state, you cannot initiate a new vault lock for the vault. +-- +-- You can abort the vault locking process by calling 'AbortVaultLock' . You can get the state of the vault lock by calling 'GetVaultLock' . For more information about the vault locking process, . +-- +-- If this operation is called when the vault lock is in the @InProgress@ state, the operation returns an @AccessDeniedException@ error. When the vault lock is in the @InProgress@ state you must call 'AbortVaultLock' before you can initiate a new vault lock policy. +-- module Network.AWS.Glacier.InitiateVaultLock ( -- * Creating a Request @@ -60,8 +64,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input values for 'InitiateVaultLock'. +-- | The input values for @InitiateVaultLock@ . -- +-- +-- -- /See:/ 'initiateVaultLock' smart constructor. data InitiateVaultLock = InitiateVaultLock' { _ivlPolicy :: !(Maybe VaultLockPolicy) @@ -73,11 +79,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ivlPolicy' +-- * 'ivlPolicy' - The vault lock policy as a JSON string, which uses "\" as an escape character. -- --- * 'ivlAccountId' +-- * 'ivlAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. -- --- * 'ivlVaultName' +-- * 'ivlVaultName' - The name of the vault. initiateVaultLock :: Text -- ^ 'ivlAccountId' -> Text -- ^ 'ivlVaultName' @@ -89,11 +95,11 @@ , _ivlVaultName = pVaultName_ } --- | The vault lock policy as a JSON string, which uses \"\\\" as an escape character. +-- | The vault lock policy as a JSON string, which uses "\" as an escape character. ivlPolicy :: Lens' InitiateVaultLock (Maybe VaultLockPolicy) ivlPolicy = lens _ivlPolicy (\ s a -> s{_ivlPolicy = a}); --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. ivlAccountId :: Lens' InitiateVaultLock Text ivlAccountId = lens _ivlAccountId (\ s a -> s{_ivlAccountId = a}); @@ -132,6 +138,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'initiateVaultLockResponse' smart constructor. data InitiateVaultLockResponse = InitiateVaultLockResponse' { _ivlrsLockId :: !(Maybe Text) @@ -142,9 +150,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ivlrsLockId' +-- * 'ivlrsLockId' - The lock ID, which is used to complete the vault locking process. -- --- * 'ivlrsResponseStatus' +-- * 'ivlrsResponseStatus' - -- | The response status code. initiateVaultLockResponse :: Int -- ^ 'ivlrsResponseStatus' -> InitiateVaultLockResponse @@ -158,7 +166,7 @@ ivlrsLockId :: Lens' InitiateVaultLockResponse (Maybe Text) ivlrsLockId = lens _ivlrsLockId (\ s a -> s{_ivlrsLockId = a}); --- | The response status code. +-- | -- | The response status code. ivlrsResponseStatus :: Lens' InitiateVaultLockResponse Int ivlrsResponseStatus = lens _ivlrsResponseStatus (\ s a -> s{_ivlrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/ListJobs.hs b/gen/Network/AWS/Glacier/ListJobs.hs --- a/gen/Network/AWS/Glacier/ListJobs.hs +++ b/gen/Network/AWS/Glacier/ListJobs.hs @@ -20,18 +20,18 @@ -- -- This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. -- --- Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists. -- --- To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time. +-- To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data. For an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time. -- --- This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a 'marker' at which to continue the list; if there are no more items the 'marker' is 'null'. To return a list of jobs that begins at a specific job, set the 'marker' request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the 'limit' parameter in the request. +-- The List Jobs operation supports pagination. You should always check the response @Marker@ field. If there are no more jobs to list, the @Marker@ field is set to @null@ . If there are more jobs to list, the @Marker@ field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the @Marker@ value for that job that you obtained from a previous List Jobs request. -- --- Additionally, you can filter the jobs list returned by specifying an optional 'statuscode' (InProgress, Succeeded, or Failed) and 'completed' (true, false) parameter. The 'statuscode' allows you to specify that only jobs that match a specified status are returned. The 'completed' parameter allows you to specify that only jobs in a specific completion state are returned. +-- You can set a maximum limit for the number of jobs returned in the response by specifying the @limit@ parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- Additionally, you can filter the jobs list returned by specifying the optional @statuscode@ parameter or @completed@ parameter, or both. Using the @statuscode@ parameter, you can specify to return only jobs that match either the @InProgress@ , @Succeeded@ , or @Failed@ status. Using the @completed@ parameter, you can specify to return only jobs that were completed (@true@ ) or jobs that were not completed (@false@ ). -- --- For the underlying REST API, go to +-- For the underlying REST API, see . -- +-- -- This operation returns paginated results. module Network.AWS.Glacier.ListJobs ( @@ -65,6 +65,8 @@ -- | Provides options for retrieving a job list for an Amazon Glacier vault. -- +-- +-- -- /See:/ 'listJobs' smart constructor. data ListJobs = ListJobs' { _ljMarker :: !(Maybe Text) @@ -79,17 +81,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ljMarker' +-- * 'ljMarker' - An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request. -- --- * 'ljCompleted' +-- * 'ljCompleted' - The state of the jobs to return. You can specify @true@ or @false@ . -- --- * 'ljLimit' +-- * 'ljLimit' - The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit. -- --- * 'ljStatuscode' +-- * 'ljStatuscode' - The type of job status to return. You can specify the following values: @InProgress@ , @Succeeded@ , or @Failed@ . -- --- * 'ljAccountId' +-- * 'ljAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'ljVaultName' +-- * 'ljVaultName' - The name of the vault. listJobs :: Text -- ^ 'ljAccountId' -> Text -- ^ 'ljVaultName' @@ -104,23 +106,23 @@ , _ljVaultName = pVaultName_ } --- | An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request. +-- | An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request. ljMarker :: Lens' ListJobs (Maybe Text) ljMarker = lens _ljMarker (\ s a -> s{_ljMarker = a}); --- | Specifies the state of the jobs to return. You can specify 'true' or 'false'. +-- | The state of the jobs to return. You can specify @true@ or @false@ . ljCompleted :: Lens' ListJobs (Maybe Text) ljCompleted = lens _ljCompleted (\ s a -> s{_ljCompleted = a}); --- | Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs. +-- | The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit. ljLimit :: Lens' ListJobs (Maybe Text) ljLimit = lens _ljLimit (\ s a -> s{_ljLimit = a}); --- | Specifies the type of job status to return. You can specify the following values: \"InProgress\", \"Succeeded\", or \"Failed\". +-- | The type of job status to return. You can specify the following values: @InProgress@ , @Succeeded@ , or @Failed@ . ljStatuscode :: Lens' ListJobs (Maybe Text) ljStatuscode = lens _ljStatuscode (\ s a -> s{_ljStatuscode = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. ljAccountId :: Lens' ListJobs Text ljAccountId = lens _ljAccountId (\ s a -> s{_ljAccountId = a}); @@ -166,6 +168,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'listJobsResponse' smart constructor. data ListJobsResponse = ListJobsResponse' { _ljrsMarker :: !(Maybe Text) @@ -177,11 +181,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ljrsMarker' +-- * 'ljrsMarker' - An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the @marker@ value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request. -- --- * 'ljrsJobList' +-- * 'ljrsJobList' - A list of job objects. Each job object contains metadata describing the job. -- --- * 'ljrsResponseStatus' +-- * 'ljrsResponseStatus' - -- | The response status code. listJobsResponse :: Int -- ^ 'ljrsResponseStatus' -> ListJobsResponse @@ -192,7 +196,7 @@ , _ljrsResponseStatus = pResponseStatus_ } --- | An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is 'null'. +-- | An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the @marker@ value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request. ljrsMarker :: Lens' ListJobsResponse (Maybe Text) ljrsMarker = lens _ljrsMarker (\ s a -> s{_ljrsMarker = a}); @@ -200,7 +204,7 @@ ljrsJobList :: Lens' ListJobsResponse [GlacierJobDescription] ljrsJobList = lens _ljrsJobList (\ s a -> s{_ljrsJobList = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. ljrsResponseStatus :: Lens' ListJobsResponse Int ljrsResponseStatus = lens _ljrsResponseStatus (\ s a -> s{_ljrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/ListMultipartUploads.hs b/gen/Network/AWS/Glacier/ListMultipartUploads.hs --- a/gen/Network/AWS/Glacier/ListMultipartUploads.hs +++ b/gen/Network/AWS/Glacier/ListMultipartUploads.hs @@ -18,16 +18,18 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an < InitiateMultipartUpload> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. +-- This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an 'InitiateMultipartUpload' request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. -- --- The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a 'marker' at which to continue the list; if there are no more items the 'marker' is 'null'. To return a list of multipart uploads that begins at a specific upload, set the 'marker' request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the 'limit' parameter in the request. -- --- Note the difference between this operation and listing parts (< ListParts>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. +-- The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a @marker@ at which to continue the list; if there are no more items the @marker@ is @null@ . To return a list of multipart uploads that begins at a specific upload, set the @marker@ request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the @limit@ parameter in the request. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- Note the difference between this operation and listing parts ('ListParts' ). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload. -- --- For conceptual information and the underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- +-- For conceptual information and the underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- +-- -- This operation returns paginated results. module Network.AWS.Glacier.ListMultipartUploads ( @@ -59,6 +61,8 @@ -- | Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault. -- +-- +-- -- /See:/ 'listMultipartUploads' smart constructor. data ListMultipartUploads = ListMultipartUploads' { _lmuMarker :: !(Maybe Text) @@ -71,13 +75,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lmuMarker' +-- * 'lmuMarker' - An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request. -- --- * 'lmuLimit' +-- * 'lmuLimit' - Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads. -- --- * 'lmuAccountId' +-- * 'lmuAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'lmuVaultName' +-- * 'lmuVaultName' - The name of the vault. listMultipartUploads :: Text -- ^ 'lmuAccountId' -> Text -- ^ 'lmuVaultName' @@ -98,7 +102,7 @@ lmuLimit :: Lens' ListMultipartUploads (Maybe Text) lmuLimit = lens _lmuLimit (\ s a -> s{_lmuLimit = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. lmuAccountId :: Lens' ListMultipartUploads Text lmuAccountId = lens _lmuAccountId (\ s a -> s{_lmuAccountId = a}); @@ -144,6 +148,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'listMultipartUploadsResponse' smart constructor. data ListMultipartUploadsResponse = ListMultipartUploadsResponse' { _lmursUploadsList :: !(Maybe [UploadListElement]) @@ -155,11 +161,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lmursUploadsList' +-- * 'lmursUploadsList' - A list of in-progress multipart uploads. -- --- * 'lmursMarker' +-- * 'lmursMarker' - An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is @null@ . -- --- * 'lmursResponseStatus' +-- * 'lmursResponseStatus' - -- | The response status code. listMultipartUploadsResponse :: Int -- ^ 'lmursResponseStatus' -> ListMultipartUploadsResponse @@ -174,11 +180,11 @@ lmursUploadsList :: Lens' ListMultipartUploadsResponse [UploadListElement] lmursUploadsList = lens _lmursUploadsList (\ s a -> s{_lmursUploadsList = a}) . _Default . _Coerce; --- | An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is 'null'. +-- | An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is @null@ . lmursMarker :: Lens' ListMultipartUploadsResponse (Maybe Text) lmursMarker = lens _lmursMarker (\ s a -> s{_lmursMarker = a}); --- | The response status code. +-- | -- | The response status code. lmursResponseStatus :: Lens' ListMultipartUploadsResponse Int lmursResponseStatus = lens _lmursResponseStatus (\ s a -> s{_lmursResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/ListParts.hs b/gen/Network/AWS/Glacier/ListParts.hs --- a/gen/Network/AWS/Glacier/ListParts.hs +++ b/gen/Network/AWS/Glacier/ListParts.hs @@ -18,14 +18,16 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see < CompleteMultipartUpload>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. +-- This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see 'CompleteMultipartUpload' . List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. -- --- The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a 'marker' at which to continue the list; if there are no more items the 'marker' is 'null'. To return a list of parts that begins at a specific part, set the 'marker' request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the 'limit' parameter in the request. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a @marker@ at which to continue the list; if there are no more items the @marker@ is @null@ . To return a list of parts that begins at a specific part, set the @marker@ request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the @limit@ parameter in the request. -- --- For conceptual information and the underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- +-- For conceptual information and the underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- +-- -- This operation returns paginated results. module Network.AWS.Glacier.ListParts ( @@ -63,6 +65,8 @@ -- | Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload. -- +-- +-- -- /See:/ 'listParts' smart constructor. data ListParts = ListParts' { _lpMarker :: !(Maybe Text) @@ -76,15 +80,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lpMarker' +-- * 'lpMarker' - An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request. -- --- * 'lpLimit' +-- * 'lpLimit' - The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit. -- --- * 'lpAccountId' +-- * 'lpAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'lpVaultName' +-- * 'lpVaultName' - The name of the vault. -- --- * 'lpUploadId' +-- * 'lpUploadId' - The upload ID of the multipart upload. listParts :: Text -- ^ 'lpAccountId' -> Text -- ^ 'lpVaultName' @@ -103,11 +107,11 @@ lpMarker :: Lens' ListParts (Maybe Text) lpMarker = lens _lpMarker (\ s a -> s{_lpMarker = a}); --- | Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads. +-- | The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit. lpLimit :: Lens' ListParts (Maybe Text) lpLimit = lens _lpLimit (\ s a -> s{_lpLimit = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. lpAccountId :: Lens' ListParts Text lpAccountId = lens _lpAccountId (\ s a -> s{_lpAccountId = a}); @@ -163,6 +167,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'listPartsResponse' smart constructor. data ListPartsResponse = ListPartsResponse' { _lprsParts :: !(Maybe [PartListElement]) @@ -179,21 +185,21 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lprsParts' +-- * 'lprsParts' - A list of the part sizes of the multipart upload. Each object in the array contains a @RangeBytes@ and @sha256-tree-hash@ name/value pair. -- --- * 'lprsMultipartUploadId' +-- * 'lprsMultipartUploadId' - The ID of the upload to which the parts are associated. -- --- * 'lprsPartSizeInBytes' +-- * 'lprsPartSizeInBytes' - The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request. -- --- * 'lprsArchiveDescription' +-- * 'lprsArchiveDescription' - The description of the archive that was specified in the Initiate Multipart Upload request. -- --- * 'lprsVaultARN' +-- * 'lprsVaultARN' - The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated. -- --- * 'lprsMarker' +-- * 'lprsMarker' - An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is @null@ . -- --- * 'lprsCreationDate' +-- * 'lprsCreationDate' - The UTC time at which the multipart upload was initiated. -- --- * 'lprsResponseStatus' +-- * 'lprsResponseStatus' - -- | The response status code. listPartsResponse :: Int -- ^ 'lprsResponseStatus' -> ListPartsResponse @@ -209,7 +215,7 @@ , _lprsResponseStatus = pResponseStatus_ } --- | A list of the part sizes of the multipart upload. +-- | A list of the part sizes of the multipart upload. Each object in the array contains a @RangeBytes@ and @sha256-tree-hash@ name/value pair. lprsParts :: Lens' ListPartsResponse [PartListElement] lprsParts = lens _lprsParts (\ s a -> s{_lprsParts = a}) . _Default . _Coerce; @@ -217,7 +223,7 @@ lprsMultipartUploadId :: Lens' ListPartsResponse (Maybe Text) lprsMultipartUploadId = lens _lprsMultipartUploadId (\ s a -> s{_lprsMultipartUploadId = a}); --- | The part size in bytes. +-- | The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request. lprsPartSizeInBytes :: Lens' ListPartsResponse (Maybe Integer) lprsPartSizeInBytes = lens _lprsPartSizeInBytes (\ s a -> s{_lprsPartSizeInBytes = a}); @@ -229,7 +235,7 @@ lprsVaultARN :: Lens' ListPartsResponse (Maybe Text) lprsVaultARN = lens _lprsVaultARN (\ s a -> s{_lprsVaultARN = a}); --- | An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is 'null'. +-- | An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is @null@ . lprsMarker :: Lens' ListPartsResponse (Maybe Text) lprsMarker = lens _lprsMarker (\ s a -> s{_lprsMarker = a}); @@ -237,7 +243,7 @@ lprsCreationDate :: Lens' ListPartsResponse (Maybe Text) lprsCreationDate = lens _lprsCreationDate (\ s a -> s{_lprsCreationDate = a}); --- | The response status code. +-- | -- | The response status code. lprsResponseStatus :: Lens' ListPartsResponse Int lprsResponseStatus = lens _lprsResponseStatus (\ s a -> s{_lprsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/ListProvisionedCapacity.hs b/gen/Network/AWS/Glacier/ListProvisionedCapacity.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/Glacier/ListProvisionedCapacity.hs @@ -0,0 +1,125 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.Glacier.ListProvisionedCapacity +-- Copyright : (c) 2013-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- This operation lists the provisioned capacity for the specified AWS account. +-- +-- +module Network.AWS.Glacier.ListProvisionedCapacity + ( + -- * Creating a Request + listProvisionedCapacity + , ListProvisionedCapacity + -- * Request Lenses + , lpcAccountId + + -- * Destructuring the Response + , listProvisionedCapacityResponse + , ListProvisionedCapacityResponse + -- * Response Lenses + , lpcrsProvisionedCapacityList + , lpcrsResponseStatus + ) where + +import Network.AWS.Glacier.Types +import Network.AWS.Glacier.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'listProvisionedCapacity' smart constructor. +newtype ListProvisionedCapacity = ListProvisionedCapacity' + { _lpcAccountId :: Text + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ListProvisionedCapacity' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lpcAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID. +listProvisionedCapacity + :: Text -- ^ 'lpcAccountId' + -> ListProvisionedCapacity +listProvisionedCapacity pAccountId_ = + ListProvisionedCapacity' + { _lpcAccountId = pAccountId_ + } + +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID. +lpcAccountId :: Lens' ListProvisionedCapacity Text +lpcAccountId = lens _lpcAccountId (\ s a -> s{_lpcAccountId = a}); + +instance AWSRequest ListProvisionedCapacity where + type Rs ListProvisionedCapacity = + ListProvisionedCapacityResponse + request = get glacier + response + = receiveJSON + (\ s h x -> + ListProvisionedCapacityResponse' <$> + (x .?> "ProvisionedCapacityList" .!@ mempty) <*> + (pure (fromEnum s))) + +instance Hashable ListProvisionedCapacity + +instance NFData ListProvisionedCapacity + +instance ToHeaders ListProvisionedCapacity where + toHeaders = const mempty + +instance ToPath ListProvisionedCapacity where + toPath ListProvisionedCapacity'{..} + = mconcat + ["/", toBS _lpcAccountId, "/provisioned-capacity"] + +instance ToQuery ListProvisionedCapacity where + toQuery = const mempty + +-- | /See:/ 'listProvisionedCapacityResponse' smart constructor. +data ListProvisionedCapacityResponse = ListProvisionedCapacityResponse' + { _lpcrsProvisionedCapacityList :: !(Maybe [ProvisionedCapacityDescription]) + , _lpcrsResponseStatus :: !Int + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'ListProvisionedCapacityResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lpcrsProvisionedCapacityList' - The response body contains the following JSON fields. +-- +-- * 'lpcrsResponseStatus' - -- | The response status code. +listProvisionedCapacityResponse + :: Int -- ^ 'lpcrsResponseStatus' + -> ListProvisionedCapacityResponse +listProvisionedCapacityResponse pResponseStatus_ = + ListProvisionedCapacityResponse' + { _lpcrsProvisionedCapacityList = Nothing + , _lpcrsResponseStatus = pResponseStatus_ + } + +-- | The response body contains the following JSON fields. +lpcrsProvisionedCapacityList :: Lens' ListProvisionedCapacityResponse [ProvisionedCapacityDescription] +lpcrsProvisionedCapacityList = lens _lpcrsProvisionedCapacityList (\ s a -> s{_lpcrsProvisionedCapacityList = a}) . _Default . _Coerce; + +-- | -- | The response status code. +lpcrsResponseStatus :: Lens' ListProvisionedCapacityResponse Int +lpcrsResponseStatus = lens _lpcrsResponseStatus (\ s a -> s{_lpcrsResponseStatus = a}); + +instance NFData ListProvisionedCapacityResponse diff --git a/gen/Network/AWS/Glacier/ListTagsForVault.hs b/gen/Network/AWS/Glacier/ListTagsForVault.hs --- a/gen/Network/AWS/Glacier/ListTagsForVault.hs +++ b/gen/Network/AWS/Glacier/ListTagsForVault.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see . +-- This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see . +-- +-- module Network.AWS.Glacier.ListTagsForVault ( -- * Creating a Request @@ -43,8 +45,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input value for 'ListTagsForVaultInput'. +-- | The input value for @ListTagsForVaultInput@ . -- +-- +-- -- /See:/ 'listTagsForVault' smart constructor. data ListTagsForVault = ListTagsForVault' { _ltfvAccountId :: !Text @@ -55,9 +59,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ltfvAccountId' +-- * 'ltfvAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'ltfvVaultName' +-- * 'ltfvVaultName' - The name of the vault. listTagsForVault :: Text -- ^ 'ltfvAccountId' -> Text -- ^ 'ltfvVaultName' @@ -68,7 +72,7 @@ , _ltfvVaultName = pVaultName_ } --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. ltfvAccountId :: Lens' ListTagsForVault Text ltfvAccountId = lens _ltfvAccountId (\ s a -> s{_ltfvAccountId = a}); @@ -103,6 +107,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'listTagsForVaultResponse' smart constructor. data ListTagsForVaultResponse = ListTagsForVaultResponse' { _ltfvrsTags :: !(Maybe (Map Text Text)) @@ -113,9 +119,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'ltfvrsTags' +-- * 'ltfvrsTags' - The tags attached to the vault. Each tag is composed of a key and a value. -- --- * 'ltfvrsResponseStatus' +-- * 'ltfvrsResponseStatus' - -- | The response status code. listTagsForVaultResponse :: Int -- ^ 'ltfvrsResponseStatus' -> ListTagsForVaultResponse @@ -129,7 +135,7 @@ ltfvrsTags :: Lens' ListTagsForVaultResponse (HashMap Text Text) ltfvrsTags = lens _ltfvrsTags (\ s a -> s{_ltfvrsTags = a}) . _Default . _Map; --- | The response status code. +-- | -- | The response status code. ltfvrsResponseStatus :: Lens' ListTagsForVaultResponse Int ltfvrsResponseStatus = lens _ltfvrsResponseStatus (\ s a -> s{_ltfvrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/ListVaults.hs b/gen/Network/AWS/Glacier/ListVaults.hs --- a/gen/Network/AWS/Glacier/ListVaults.hs +++ b/gen/Network/AWS/Glacier/ListVaults.hs @@ -18,14 +18,16 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation lists all vaults owned by the calling user\'s account. The list returned in the response is ASCII-sorted by vault name. +-- This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name. -- --- By default, this operation returns up to 1,000 items. If there are more vaults to list, the response 'marker' field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the 'marker' field is 'null'. To return a list of vaults that begins at a specific vault, set the 'marker' request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the 'limit' parameter in the request. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- By default, this operation returns up to 1,000 items. If there are more vaults to list, the response @marker@ field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the @marker@ field is @null@ . To return a list of vaults that begins at a specific vault, set the @marker@ request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the @limit@ parameter in the request. -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- +-- -- This operation returns paginated results. module Network.AWS.Glacier.ListVaults ( @@ -54,8 +56,10 @@ import Network.AWS.Request import Network.AWS.Response --- | Provides options to retrieve the vault list owned by the calling user\'s account. The list provides metadata information for each vault. +-- | Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault. -- +-- +-- -- /See:/ 'listVaults' smart constructor. data ListVaults = ListVaults' { _lvMarker :: !(Maybe Text) @@ -67,11 +71,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lvMarker' +-- * 'lvMarker' - A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin. -- --- * 'lvLimit' +-- * 'lvLimit' - The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit. -- --- * 'lvAccountId' +-- * 'lvAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. listVaults :: Text -- ^ 'lvAccountId' -> ListVaults @@ -86,11 +90,11 @@ lvMarker :: Lens' ListVaults (Maybe Text) lvMarker = lens _lvMarker (\ s a -> s{_lvMarker = a}); --- | The maximum number of items returned in the response. If you don\'t specify a value, the List Vaults operation returns up to 1,000 items. +-- | The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit. lvLimit :: Lens' ListVaults (Maybe Text) lvLimit = lens _lvLimit (\ s a -> s{_lvLimit = a}); --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. lvAccountId :: Lens' ListVaults Text lvAccountId = lens _lvAccountId (\ s a -> s{_lvAccountId = a}); @@ -129,6 +133,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'listVaultsResponse' smart constructor. data ListVaultsResponse = ListVaultsResponse' { _lvrsMarker :: !(Maybe Text) @@ -140,11 +146,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'lvrsMarker' +-- * 'lvrsMarker' - The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list. -- --- * 'lvrsVaultList' +-- * 'lvrsVaultList' - List of vaults. -- --- * 'lvrsResponseStatus' +-- * 'lvrsResponseStatus' - -- | The response status code. listVaultsResponse :: Int -- ^ 'lvrsResponseStatus' -> ListVaultsResponse @@ -163,7 +169,7 @@ lvrsVaultList :: Lens' ListVaultsResponse [DescribeVaultOutput] lvrsVaultList = lens _lvrsVaultList (\ s a -> s{_lvrsVaultList = a}) . _Default . _Coerce; --- | The response status code. +-- | -- | The response status code. lvrsResponseStatus :: Lens' ListVaultsResponse Int lvrsResponseStatus = lens _lvrsResponseStatus (\ s a -> s{_lvrsResponseStatus = a}); diff --git a/gen/Network/AWS/Glacier/PurchaseProvisionedCapacity.hs b/gen/Network/AWS/Glacier/PurchaseProvisionedCapacity.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/Glacier/PurchaseProvisionedCapacity.hs @@ -0,0 +1,127 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.Glacier.PurchaseProvisionedCapacity +-- Copyright : (c) 2013-2016 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- This operation purchases a provisioned capacity unit for an AWS account. +-- +-- +module Network.AWS.Glacier.PurchaseProvisionedCapacity + ( + -- * Creating a Request + purchaseProvisionedCapacity + , PurchaseProvisionedCapacity + -- * Request Lenses + , ppcAccountId + + -- * Destructuring the Response + , purchaseProvisionedCapacityResponse + , PurchaseProvisionedCapacityResponse + -- * Response Lenses + , ppcrsCapacityId + , ppcrsResponseStatus + ) where + +import Network.AWS.Glacier.Types +import Network.AWS.Glacier.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'purchaseProvisionedCapacity' smart constructor. +newtype PurchaseProvisionedCapacity = PurchaseProvisionedCapacity' + { _ppcAccountId :: Text + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'PurchaseProvisionedCapacity' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ppcAccountId' - The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID. +purchaseProvisionedCapacity + :: Text -- ^ 'ppcAccountId' + -> PurchaseProvisionedCapacity +purchaseProvisionedCapacity pAccountId_ = + PurchaseProvisionedCapacity' + { _ppcAccountId = pAccountId_ + } + +-- | The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID. +ppcAccountId :: Lens' PurchaseProvisionedCapacity Text +ppcAccountId = lens _ppcAccountId (\ s a -> s{_ppcAccountId = a}); + +instance AWSRequest PurchaseProvisionedCapacity where + type Rs PurchaseProvisionedCapacity = + PurchaseProvisionedCapacityResponse + request = postJSON glacier + response + = receiveEmpty + (\ s h x -> + PurchaseProvisionedCapacityResponse' <$> + (h .#? "x-amz-capacity-id") <*> (pure (fromEnum s))) + +instance Hashable PurchaseProvisionedCapacity + +instance NFData PurchaseProvisionedCapacity + +instance ToHeaders PurchaseProvisionedCapacity where + toHeaders = const mempty + +instance ToJSON PurchaseProvisionedCapacity where + toJSON = const (Object mempty) + +instance ToPath PurchaseProvisionedCapacity where + toPath PurchaseProvisionedCapacity'{..} + = mconcat + ["/", toBS _ppcAccountId, "/provisioned-capacity"] + +instance ToQuery PurchaseProvisionedCapacity where + toQuery = const mempty + +-- | /See:/ 'purchaseProvisionedCapacityResponse' smart constructor. +data PurchaseProvisionedCapacityResponse = PurchaseProvisionedCapacityResponse' + { _ppcrsCapacityId :: !(Maybe Text) + , _ppcrsResponseStatus :: !Int + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | Creates a value of 'PurchaseProvisionedCapacityResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ppcrsCapacityId' - The ID that identifies the provisioned capacity unit. +-- +-- * 'ppcrsResponseStatus' - -- | The response status code. +purchaseProvisionedCapacityResponse + :: Int -- ^ 'ppcrsResponseStatus' + -> PurchaseProvisionedCapacityResponse +purchaseProvisionedCapacityResponse pResponseStatus_ = + PurchaseProvisionedCapacityResponse' + { _ppcrsCapacityId = Nothing + , _ppcrsResponseStatus = pResponseStatus_ + } + +-- | The ID that identifies the provisioned capacity unit. +ppcrsCapacityId :: Lens' PurchaseProvisionedCapacityResponse (Maybe Text) +ppcrsCapacityId = lens _ppcrsCapacityId (\ s a -> s{_ppcrsCapacityId = a}); + +-- | -- | The response status code. +ppcrsResponseStatus :: Lens' PurchaseProvisionedCapacityResponse Int +ppcrsResponseStatus = lens _ppcrsResponseStatus (\ s a -> s{_ppcrsResponseStatus = a}); + +instance NFData PurchaseProvisionedCapacityResponse diff --git a/gen/Network/AWS/Glacier/RemoveTagsFromVault.hs b/gen/Network/AWS/Glacier/RemoveTagsFromVault.hs --- a/gen/Network/AWS/Glacier/RemoveTagsFromVault.hs +++ b/gen/Network/AWS/Glacier/RemoveTagsFromVault.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see . This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. +-- This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see . This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault. +-- +-- module Network.AWS.Glacier.RemoveTagsFromVault ( -- * Creating a Request @@ -41,8 +43,10 @@ import Network.AWS.Request import Network.AWS.Response --- | The input value for 'RemoveTagsFromVaultInput'. +-- | The input value for @RemoveTagsFromVaultInput@ . -- +-- +-- -- /See:/ 'removeTagsFromVault' smart constructor. data RemoveTagsFromVault = RemoveTagsFromVault' { _rtfvTagKeys :: !(Maybe [Text]) @@ -54,11 +58,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'rtfvTagKeys' +-- * 'rtfvTagKeys' - A list of tag keys. Each corresponding tag is removed from the vault. -- --- * 'rtfvAccountId' +-- * 'rtfvAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'rtfvVaultName' +-- * 'rtfvVaultName' - The name of the vault. removeTagsFromVault :: Text -- ^ 'rtfvAccountId' -> Text -- ^ 'rtfvVaultName' @@ -74,7 +78,7 @@ rtfvTagKeys :: Lens' RemoveTagsFromVault [Text] rtfvTagKeys = lens _rtfvTagKeys (\ s a -> s{_rtfvTagKeys = a}) . _Default . _Coerce; --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. rtfvAccountId :: Lens' RemoveTagsFromVault Text rtfvAccountId = lens _rtfvAccountId (\ s a -> s{_rtfvAccountId = a}); diff --git a/gen/Network/AWS/Glacier/SetDataRetrievalPolicy.hs b/gen/Network/AWS/Glacier/SetDataRetrievalPolicy.hs --- a/gen/Network/AWS/Glacier/SetDataRetrievalPolicy.hs +++ b/gen/Network/AWS/Glacier/SetDataRetrievalPolicy.hs @@ -20,7 +20,9 @@ -- -- This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation. -- --- The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see . +-- +-- The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see . +-- module Network.AWS.Glacier.SetDataRetrievalPolicy ( -- * Creating a Request @@ -44,6 +46,8 @@ -- | SetDataRetrievalPolicy input. -- +-- +-- -- /See:/ 'setDataRetrievalPolicy' smart constructor. data SetDataRetrievalPolicy = SetDataRetrievalPolicy' { _sdrpPolicy :: !(Maybe DataRetrievalPolicy) @@ -54,9 +58,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'sdrpPolicy' +-- * 'sdrpPolicy' - The data retrieval policy in JSON format. -- --- * 'sdrpAccountId' +-- * 'sdrpAccountId' - The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. setDataRetrievalPolicy :: Text -- ^ 'sdrpAccountId' -> SetDataRetrievalPolicy @@ -70,7 +74,7 @@ sdrpPolicy :: Lens' SetDataRetrievalPolicy (Maybe DataRetrievalPolicy) sdrpPolicy = lens _sdrpPolicy (\ s a -> s{_sdrpPolicy = a}); --- | The 'AccountId' value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID. sdrpAccountId :: Lens' SetDataRetrievalPolicy Text sdrpAccountId = lens _sdrpAccountId (\ s a -> s{_sdrpAccountId = a}); diff --git a/gen/Network/AWS/Glacier/SetVaultAccessPolicy.hs b/gen/Network/AWS/Glacier/SetVaultAccessPolicy.hs --- a/gen/Network/AWS/Glacier/SetVaultAccessPolicy.hs +++ b/gen/Network/AWS/Glacier/SetVaultAccessPolicy.hs @@ -18,7 +18,9 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the 'access-policy' subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see . +-- This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the @access-policy@ subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see . +-- +-- module Network.AWS.Glacier.SetVaultAccessPolicy ( -- * Creating a Request @@ -43,6 +45,8 @@ -- | SetVaultAccessPolicy input. -- +-- +-- -- /See:/ 'setVaultAccessPolicy' smart constructor. data SetVaultAccessPolicy = SetVaultAccessPolicy' { _svapPolicy :: !(Maybe VaultAccessPolicy) @@ -54,11 +58,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'svapPolicy' +-- * 'svapPolicy' - The vault access policy as a JSON string. -- --- * 'svapAccountId' +-- * 'svapAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'svapVaultName' +-- * 'svapVaultName' - The name of the vault. setVaultAccessPolicy :: Text -- ^ 'svapAccountId' -> Text -- ^ 'svapVaultName' @@ -74,7 +78,7 @@ svapPolicy :: Lens' SetVaultAccessPolicy (Maybe VaultAccessPolicy) svapPolicy = lens _svapPolicy (\ s a -> s{_svapPolicy = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. svapAccountId :: Lens' SetVaultAccessPolicy Text svapAccountId = lens _svapAccountId (\ s a -> s{_svapAccountId = a}); diff --git a/gen/Network/AWS/Glacier/SetVaultNotifications.hs b/gen/Network/AWS/Glacier/SetVaultNotifications.hs --- a/gen/Network/AWS/Glacier/SetVaultNotifications.hs +++ b/gen/Network/AWS/Glacier/SetVaultNotifications.hs @@ -18,18 +18,23 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation configures notifications that will be sent when specific events happen to a vault. By default, you don\'t get any notifications. +-- This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. -- --- To configure vault notifications, send a PUT request to the 'notification-configuration' subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic. -- +-- To configure vault notifications, send a PUT request to the @notification-configuration@ subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic. +-- -- Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events: -- --- - __ArchiveRetrievalCompleted__ This event occurs when a job that was initiated for an archive retrieval is completed (< InitiateJob>). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from < DescribeJob>. --- - __InventoryRetrievalCompleted__ This event occurs when a job that was initiated for an inventory retrieval is completed (< InitiateJob>). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from < DescribeJob>. +-- * __ArchiveRetrievalCompleted__ This event occurs when a job that was initiated for an archive retrieval is completed ('InitiateJob' ). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from 'DescribeJob' . -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- * __InventoryRetrievalCompleted__ This event occurs when a job that was initiated for an inventory retrieval is completed ('InitiateJob' ). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from 'DescribeJob' . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- +-- +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.SetVaultNotifications ( -- * Creating a Request @@ -54,6 +59,8 @@ -- | Provides options to configure notifications that will be sent when specific events happen to a vault. -- +-- +-- -- /See:/ 'setVaultNotifications' smart constructor. data SetVaultNotifications = SetVaultNotifications' { _svnVaultNotificationConfig :: !(Maybe VaultNotificationConfig) @@ -65,11 +72,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'svnVaultNotificationConfig' +-- * 'svnVaultNotificationConfig' - Provides options for specifying notification configuration. -- --- * 'svnAccountId' +-- * 'svnAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'svnVaultName' +-- * 'svnVaultName' - The name of the vault. setVaultNotifications :: Text -- ^ 'svnAccountId' -> Text -- ^ 'svnVaultName' @@ -85,7 +92,7 @@ svnVaultNotificationConfig :: Lens' SetVaultNotifications (Maybe VaultNotificationConfig) svnVaultNotificationConfig = lens _svnVaultNotificationConfig (\ s a -> s{_svnVaultNotificationConfig = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. svnAccountId :: Lens' SetVaultNotifications Text svnAccountId = lens _svnAccountId (\ s a -> s{_svnAccountId = a}); diff --git a/gen/Network/AWS/Glacier/Types.hs b/gen/Network/AWS/Glacier/Types.hs --- a/gen/Network/AWS/Glacier/Types.hs +++ b/gen/Network/AWS/Glacier/Types.hs @@ -20,6 +20,7 @@ , _InvalidParameterValueException , _RequestTimeoutException , _ServiceUnavailableException + , _InsufficientCapacityException , _ResourceNotFoundException , _LimitExceededException , _MissingParameterValueException @@ -71,6 +72,7 @@ , gjdSNSTopic , gjdStatusMessage , gjdVaultARN + , gjdTier , gjdArchiveSHA256TreeHash , gjdCreationDate , gjdCompleted @@ -104,6 +106,7 @@ , jpRetrievalByteRange , jpInventoryRetrievalParameters , jpSNSTopic + , jpTier , jpType , jpDescription @@ -113,6 +116,13 @@ , pleSHA256TreeHash , pleRangeInBytes + -- * ProvisionedCapacityDescription + , ProvisionedCapacityDescription + , provisionedCapacityDescription + , pcdCapacityId + , pcdStartDate + , pcdExpirationDate + -- * UploadListElement , UploadListElement , uploadListElement @@ -145,7 +155,7 @@ import Network.AWS.Prelude import Network.AWS.Sign.V4 --- | API version '2012-06-01' of the Amazon Glacier SDK configuration. +-- | API version @2012-06-01@ of the Amazon Glacier SDK configuration. glacier :: Service glacier = Service @@ -179,37 +189,58 @@ | has (hasStatus 509) e = Just "limit_exceeded" | otherwise = Nothing --- | Returned if a retrieval job would exceed the current data policy\'s retrieval rate limit. For more information about data retrieval policies, +-- | Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies, +-- +-- _PolicyEnforcedException :: AsError a => Getting (First ServiceError) a ServiceError _PolicyEnforcedException = _ServiceError . hasStatus 400 . hasCode "PolicyEnforcedException" -- | Returned if a parameter of the request is incorrectly specified. +-- +-- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError _InvalidParameterValueException = _ServiceError . hasStatus 400 . hasCode "InvalidParameterValueException" -- | Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload. +-- +-- _RequestTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError _RequestTimeoutException = _ServiceError . hasStatus 408 . hasCode "RequestTimeoutException" -- | Returned if the service cannot complete the request. +-- +-- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError _ServiceUnavailableException = _ServiceError . hasStatus 500 . hasCode "ServiceUnavailableException" --- | Returned if the specified resource, such as a vault, upload ID, or job ID, does not exist. +-- | 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. +-- +-- +_InsufficientCapacityException :: AsError a => Getting (First ServiceError) a ServiceError +_InsufficientCapacityException = + _ServiceError . hasStatus 400 . hasCode "InsufficientCapacityException" + +-- | Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist. +-- +-- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError _ResourceNotFoundException = _ServiceError . hasStatus 404 . hasCode "ResourceNotFoundException" -- | Returned if the request results in a vault or account limit being exceeded. +-- +-- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError _LimitExceededException = _ServiceError . hasStatus 400 . hasCode "LimitExceededException" -- | Returned if a required header or parameter is missing from the request. +-- +-- _MissingParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError _MissingParameterValueException = _ServiceError . hasStatus 400 . hasCode "MissingParameterValueException" diff --git a/gen/Network/AWS/Glacier/Types/Product.hs b/gen/Network/AWS/Glacier/Types/Product.hs --- a/gen/Network/AWS/Glacier/Types/Product.hs +++ b/gen/Network/AWS/Glacier/Types/Product.hs @@ -23,8 +23,10 @@ -- | Contains the Amazon Glacier response to your request. -- --- For information about the underlying REST API, go to . For conceptual information, go to . -- +-- For information about the underlying REST API, see . For conceptual information, see . +-- +-- -- /See:/ 'archiveCreationOutput' smart constructor. data ArchiveCreationOutput = ArchiveCreationOutput' { _acoArchiveId :: !(Maybe Text) @@ -36,11 +38,11 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'acoArchiveId' +-- * 'acoArchiveId' - The ID of the archive. This value is also included as part of the location. -- --- * 'acoChecksum' +-- * 'acoChecksum' - The checksum of the archive computed by Amazon Glacier. -- --- * 'acoLocation' +-- * 'acoLocation' - The relative URI path of the newly added archive resource. archiveCreationOutput :: ArchiveCreationOutput archiveCreationOutput = @@ -77,6 +79,8 @@ -- | Data retrieval policy. -- +-- +-- -- /See:/ 'dataRetrievalPolicy' smart constructor. newtype DataRetrievalPolicy = DataRetrievalPolicy' { _drpRules :: Maybe [DataRetrievalRule] @@ -86,7 +90,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'drpRules' +-- * '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. dataRetrievalPolicy :: DataRetrievalPolicy dataRetrievalPolicy = @@ -114,6 +118,8 @@ -- | Data retrieval policy rule. -- +-- +-- -- /See:/ 'dataRetrievalRule' smart constructor. data DataRetrievalRule = DataRetrievalRule' { _drrStrategy :: !(Maybe Text) @@ -124,9 +130,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'drrStrategy' +-- * 'drrStrategy' - The type of data retrieval policy to set. Valid values: BytesPerHour|FreeTier|None -- --- * 'drrBytesPerHour' +-- * 'drrBytesPerHour' - 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 :: DataRetrievalRule dataRetrievalRule = @@ -135,15 +141,11 @@ , _drrBytesPerHour = Nothing } --- | The type of data retrieval policy to set. --- --- Valid values: BytesPerHour|FreeTier|None +-- | The type of data retrieval policy to set. Valid values: BytesPerHour|FreeTier|None drrStrategy :: Lens' DataRetrievalRule (Maybe Text) drrStrategy = lens _drrStrategy (\ s a -> s{_drrStrategy = a}); --- | 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. +-- | 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. drrBytesPerHour :: Lens' DataRetrievalRule (Maybe Integer) drrBytesPerHour = lens _drrBytesPerHour (\ s a -> s{_drrBytesPerHour = a}); @@ -167,6 +169,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'describeVaultOutput' smart constructor. data DescribeVaultOutput = DescribeVaultOutput' { _dvoVaultName :: !(Maybe Text) @@ -181,17 +185,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'dvoVaultName' +-- * 'dvoVaultName' - The name of the vault. -- --- * 'dvoSizeInBytes' +-- * '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' +-- * '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 example @2012-03-20T17:03:43.221Z@ . -- --- * 'dvoVaultARN' +-- * 'dvoVaultARN' - The Amazon Resource Name (ARN) of the vault. -- --- * 'dvoCreationDate' +-- * '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 example @2012-03-20T17:03:43.221Z@ . -- --- * 'dvoNumberOfArchives' +-- * 'dvoNumberOfArchives' - 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 :: DescribeVaultOutput describeVaultOutput = @@ -208,11 +212,11 @@ dvoVaultName :: Lens' DescribeVaultOutput (Maybe Text) dvoVaultName = lens _dvoVaultName (\ s a -> s{_dvoVaultName = a}); --- | 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. +-- | 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. dvoSizeInBytes :: Lens' DescribeVaultOutput (Maybe Integer) dvoSizeInBytes = lens _dvoSizeInBytes (\ s a -> s{_dvoSizeInBytes = a}); --- | The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\". +-- | 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@ . dvoLastInventoryDate :: Lens' DescribeVaultOutput (Maybe Text) dvoLastInventoryDate = lens _dvoLastInventoryDate (\ s a -> s{_dvoLastInventoryDate = a}); @@ -220,11 +224,11 @@ dvoVaultARN :: Lens' DescribeVaultOutput (Maybe Text) dvoVaultARN = lens _dvoVaultARN (\ s a -> s{_dvoVaultARN = a}); --- | The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\". +-- | 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@ . dvoCreationDate :: Lens' DescribeVaultOutput (Maybe Text) dvoCreationDate = lens _dvoCreationDate (\ s a -> s{_dvoCreationDate = a}); --- | 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. +-- | 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. dvoNumberOfArchives :: Lens' DescribeVaultOutput (Maybe Integer) dvoNumberOfArchives = lens _dvoNumberOfArchives (\ s a -> s{_dvoNumberOfArchives = a}); @@ -245,6 +249,8 @@ -- | Describes an Amazon Glacier job. -- +-- +-- -- /See:/ 'glacierJobDescription' smart constructor. data GlacierJobDescription = GlacierJobDescription' { _gjdSHA256TreeHash :: !(Maybe Text) @@ -257,6 +263,7 @@ , _gjdSNSTopic :: !(Maybe Text) , _gjdStatusMessage :: !(Maybe Text) , _gjdVaultARN :: !(Maybe Text) + , _gjdTier :: !(Maybe Text) , _gjdArchiveSHA256TreeHash :: !(Maybe Text) , _gjdCreationDate :: !(Maybe Text) , _gjdCompleted :: !(Maybe Bool) @@ -270,39 +277,41 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'gjdSHA256TreeHash' +-- * 'gjdSHA256TreeHash' - For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null. The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value. For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This field is null in the following situations: * Archive retrieval jobs that specify a range that is not tree-hash aligned. * Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress. * Inventory jobs. -- --- * 'gjdArchiveId' +-- * 'gjdArchiveId' - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null. -- --- * 'gjdJobId' +-- * 'gjdJobId' - An opaque string that identifies an Amazon Glacier job. -- --- * 'gjdRetrievalByteRange' +-- * '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 and /StartByteValue/ equals 0 and /EndByteValue/ equals the size of the archive minus 1. For inventory retrieval jobs this field is null. -- --- * 'gjdInventoryRetrievalParameters' +-- * 'gjdInventoryRetrievalParameters' - Parameters used for range inventory retrieval. -- --- * 'gjdAction' +-- * 'gjdAction' - The job type. It is either ArchiveRetrieval or InventoryRetrieval. -- --- * 'gjdJobDescription' +-- * 'gjdJobDescription' - The job description you provided when you initiated the job. -- --- * 'gjdSNSTopic' +-- * 'gjdSNSTopic' - An Amazon Simple Notification Service (Amazon SNS) topic that receives notification. -- --- * 'gjdStatusMessage' +-- * 'gjdStatusMessage' - A friendly message that describes the job status. -- --- * 'gjdVaultARN' +-- * 'gjdVaultARN' - The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested. -- --- * 'gjdArchiveSHA256TreeHash' +-- * 'gjdTier' - The retrieval option to use for the archive retrieval. Valid values are @Expedited@ , @Standard@ , or @Bulk@ . @Standard@ is the default. -- --- * 'gjdCreationDate' +-- * 'gjdArchiveSHA256TreeHash' - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null. -- --- * 'gjdCompleted' +-- * 'gjdCreationDate' - The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". -- --- * 'gjdCompletionDate' +-- * 'gjdCompleted' - The job status. When a job is completed, you get the job's output. -- --- * 'gjdInventorySizeInBytes' +-- * 'gjdCompletionDate' - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null. -- --- * 'gjdArchiveSizeInBytes' +-- * 'gjdInventorySizeInBytes' - For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null. -- --- * 'gjdStatusCode' +-- * 'gjdArchiveSizeInBytes' - For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null. +-- +-- * 'gjdStatusCode' - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job. glacierJobDescription :: GlacierJobDescription glacierJobDescription = @@ -317,6 +326,7 @@ , _gjdSNSTopic = Nothing , _gjdStatusMessage = Nothing , _gjdVaultARN = Nothing + , _gjdTier = Nothing , _gjdArchiveSHA256TreeHash = Nothing , _gjdCreationDate = Nothing , _gjdCompleted = Nothing @@ -326,20 +336,7 @@ , _gjdStatusCode = Nothing } --- | For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null. --- --- The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value. --- --- For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. --- --- This field is null in the following situations: --- --- - Archive retrieval jobs that specify a range that is not tree-hash aligned. --- --- - Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress. --- --- - Inventory jobs. --- +-- | For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null. The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value. For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This field is null in the following situations: * Archive retrieval jobs that specify a range that is not tree-hash aligned. * Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress. * Inventory jobs. gjdSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) gjdSHA256TreeHash = lens _gjdSHA256TreeHash (\ s a -> s{_gjdSHA256TreeHash = a}); @@ -351,7 +348,7 @@ gjdJobId :: Lens' GlacierJobDescription (Maybe Text) gjdJobId = lens _gjdJobId (\ s a -> s{_gjdJobId = a}); --- | The retrieved byte range for archive retrieval jobs in the form \"/StartByteValue/-/EndByteValue/\" If no range was specified in the archive retrieval, then the whole archive is retrieved and /StartByteValue/ equals 0 and /EndByteValue/ equals the size of the archive minus 1. For inventory retrieval jobs this field is null. +-- | The retrieved byte range for archive retrieval jobs in the form "/StartByteValue/ -/EndByteValue/ " If no range was specified in the archive retrieval, then the whole archive is retrieved and /StartByteValue/ equals 0 and /EndByteValue/ equals the size of the archive minus 1. For inventory retrieval jobs this field is null. gjdRetrievalByteRange :: Lens' GlacierJobDescription (Maybe Text) gjdRetrievalByteRange = lens _gjdRetrievalByteRange (\ s a -> s{_gjdRetrievalByteRange = a}); @@ -379,15 +376,19 @@ gjdVaultARN :: Lens' GlacierJobDescription (Maybe Text) gjdVaultARN = lens _gjdVaultARN (\ s a -> s{_gjdVaultARN = a}); +-- | The retrieval option to use for the archive retrieval. Valid values are @Expedited@ , @Standard@ , or @Bulk@ . @Standard@ is the default. +gjdTier :: Lens' GlacierJobDescription (Maybe Text) +gjdTier = lens _gjdTier (\ s a -> s{_gjdTier = a}); + -- | The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null. gjdArchiveSHA256TreeHash :: Lens' GlacierJobDescription (Maybe Text) gjdArchiveSHA256TreeHash = lens _gjdArchiveSHA256TreeHash (\ s a -> s{_gjdArchiveSHA256TreeHash = a}); --- | The UTC date when the job was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\". +-- | The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". gjdCreationDate :: Lens' GlacierJobDescription (Maybe Text) gjdCreationDate = lens _gjdCreationDate (\ s a -> s{_gjdCreationDate = a}); --- | The job status. When a job is completed, you get the job\'s output. +-- | The job status. When a job is completed, you get the job's output. gjdCompleted :: Lens' GlacierJobDescription (Maybe Bool) gjdCompleted = lens _gjdCompleted (\ s a -> s{_gjdCompleted = a}); @@ -421,6 +422,7 @@ <*> (x .:? "SNSTopic") <*> (x .:? "StatusMessage") <*> (x .:? "VaultARN") + <*> (x .:? "Tier") <*> (x .:? "ArchiveSHA256TreeHash") <*> (x .:? "CreationDate") <*> (x .:? "Completed") @@ -435,6 +437,8 @@ -- | Describes the options for a range inventory retrieval job. -- +-- +-- -- /See:/ 'inventoryRetrievalJobDescription' smart constructor. data InventoryRetrievalJobDescription = InventoryRetrievalJobDescription' { _irjdFormat :: !(Maybe Text) @@ -448,15 +452,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'irjdFormat' +-- * '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 are @CSV@ and @JSON@ . -- --- * 'irjdEndDate' +-- * '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 example @2013-03-20T17:03:43Z@ . -- --- * 'irjdStartDate' +-- * '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 example @2013-03-20T17:03:43Z@ . -- --- * 'irjdMarker' +-- * '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 is @null@ . For more information, see . -- --- * 'irjdLimit' +-- * '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. inventoryRetrievalJobDescription :: InventoryRetrievalJobDescription inventoryRetrievalJobDescription = @@ -468,23 +472,23 @@ , _irjdLimit = Nothing } --- | 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\". +-- | 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@ . irjdFormat :: Lens' InventoryRetrievalJobDescription (Maybe Text) irjdFormat = lens _irjdFormat (\ s a -> s{_irjdFormat = a}); --- | The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. +-- | 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@ . irjdEndDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) irjdEndDate = lens _irjdEndDate (\ s a -> s{_irjdEndDate = a}); --- | The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. +-- | 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@ . irjdStartDate :: Lens' InventoryRetrievalJobDescription (Maybe Text) irjdStartDate = lens _irjdStartDate (\ s a -> s{_irjdStartDate = a}); --- | 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 . +-- | 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 . irjdMarker :: Lens' InventoryRetrievalJobDescription (Maybe Text) irjdMarker = lens _irjdMarker (\ s a -> s{_irjdMarker = a}); --- | Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a __InitiateJob__ request. +-- | 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. irjdLimit :: Lens' InventoryRetrievalJobDescription (Maybe Text) irjdLimit = lens _irjdLimit (\ s a -> s{_irjdLimit = a}); @@ -505,6 +509,8 @@ -- | Provides options for specifying a range inventory retrieval job. -- +-- +-- -- /See:/ 'inventoryRetrievalJobInput' smart constructor. data InventoryRetrievalJobInput = InventoryRetrievalJobInput' { _irjiEndDate :: !(Maybe Text) @@ -517,13 +523,13 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'irjiEndDate' +-- * '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 example @2013-03-20T17:03:43Z@ . -- --- * 'irjiStartDate' +-- * '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 example @2013-03-20T17:03:43Z@ . -- --- * 'irjiMarker' +-- * '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 is @null@ . -- --- * 'irjiLimit' +-- * 'irjiLimit' - Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1. inventoryRetrievalJobInput :: InventoryRetrievalJobInput inventoryRetrievalJobInput = @@ -534,15 +540,15 @@ , _irjiLimit = Nothing } --- | The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. +-- | 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@ . irjiEndDate :: Lens' InventoryRetrievalJobInput (Maybe Text) irjiEndDate = lens _irjiEndDate (\ s a -> s{_irjiEndDate = a}); --- | The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. +-- | 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@ . irjiStartDate :: Lens' InventoryRetrievalJobInput (Maybe Text) irjiStartDate = lens _irjiStartDate (\ s a -> s{_irjiStartDate = a}); --- | 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'. +-- | 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@ . irjiMarker :: Lens' InventoryRetrievalJobInput (Maybe Text) irjiMarker = lens _irjiMarker (\ s a -> s{_irjiMarker = a}); @@ -565,6 +571,8 @@ -- | Provides options for defining a job. -- +-- +-- -- /See:/ 'jobParameters' smart constructor. data JobParameters = JobParameters' { _jpArchiveId :: !(Maybe Text) @@ -572,6 +580,7 @@ , _jpRetrievalByteRange :: !(Maybe Text) , _jpInventoryRetrievalParameters :: !(Maybe InventoryRetrievalJobInput) , _jpSNSTopic :: !(Maybe Text) + , _jpTier :: !(Maybe Text) , _jpType :: !(Maybe Text) , _jpDescription :: !(Maybe Text) } deriving (Eq,Read,Show,Data,Typeable,Generic) @@ -580,19 +589,21 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'jpArchiveId' +-- * 'jpArchiveId' - The ID of the archive that you want to retrieve. This field is required only if @Type@ is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request. -- --- * 'jpFormat' +-- * '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' +-- * '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' +-- * 'jpInventoryRetrievalParameters' - Input parameters used for range inventory retrieval. -- --- * 'jpSNSTopic' +-- * '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. -- --- * 'jpType' +-- * 'jpTier' - The retrieval option to use for the archive retrieval. Valid values are @Expedited@ , @Standard@ , or @Bulk@ . @Standard@ is the default. -- --- * 'jpDescription' +-- * 'jpType' - The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval". +-- +-- * 'jpDescription' - 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 :: JobParameters jobParameters = @@ -602,21 +613,20 @@ , _jpRetrievalByteRange = Nothing , _jpInventoryRetrievalParameters = Nothing , _jpSNSTopic = Nothing + , _jpTier = Nothing , _jpType = Nothing , _jpDescription = Nothing } --- | The ID of the archive that you want to retrieve. This field is required only if 'Type' is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request. +-- | The ID of the archive that you want to retrieve. This field is required only if @Type@ is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request. jpArchiveId :: Lens' JobParameters (Maybe Text) jpArchiveId = lens _jpArchiveId (\ s a -> s{_jpArchiveId = a}); --- | 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\". +-- | 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". jpFormat :: Lens' JobParameters (Maybe Text) jpFormat = lens _jpFormat (\ s a -> s{_jpFormat = a}); --- | 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. +-- | 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. jpRetrievalByteRange :: Lens' JobParameters (Maybe Text) jpRetrievalByteRange = lens _jpRetrievalByteRange (\ s a -> s{_jpRetrievalByteRange = a}); @@ -628,7 +638,11 @@ jpSNSTopic :: Lens' JobParameters (Maybe Text) jpSNSTopic = lens _jpSNSTopic (\ s a -> s{_jpSNSTopic = a}); --- | The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are \"archive-retrieval\" and \"inventory-retrieval\". +-- | The retrieval option to use for the archive retrieval. Valid values are @Expedited@ , @Standard@ , or @Bulk@ . @Standard@ is the default. +jpTier :: Lens' JobParameters (Maybe Text) +jpTier = lens _jpTier (\ s a -> s{_jpTier = a}); + +-- | The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval". jpType :: Lens' JobParameters (Maybe Text) jpType = lens _jpType (\ s a -> s{_jpType = a}); @@ -650,11 +664,13 @@ ("InventoryRetrievalParameters" .=) <$> _jpInventoryRetrievalParameters, ("SNSTopic" .=) <$> _jpSNSTopic, - ("Type" .=) <$> _jpType, + ("Tier" .=) <$> _jpTier, ("Type" .=) <$> _jpType, ("Description" .=) <$> _jpDescription]) -- | A list of the part sizes of the multipart upload. -- +-- +-- -- /See:/ 'partListElement' smart constructor. data PartListElement = PartListElement' { _pleSHA256TreeHash :: !(Maybe Text) @@ -665,9 +681,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'pleSHA256TreeHash' +-- * 'pleSHA256TreeHash' - The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never @null@ . -- --- * 'pleRangeInBytes' +-- * 'pleRangeInBytes' - The byte range of a part, inclusive of the upper value of the range. partListElement :: PartListElement partListElement = @@ -676,7 +692,7 @@ , _pleRangeInBytes = Nothing } --- | The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never 'null'. +-- | The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never @null@ . pleSHA256TreeHash :: Lens' PartListElement (Maybe Text) pleSHA256TreeHash = lens _pleSHA256TreeHash (\ s a -> s{_pleSHA256TreeHash = a}); @@ -695,8 +711,64 @@ instance NFData PartListElement +-- | The definition for a provisioned capacity unit. +-- +-- +-- +-- /See:/ 'provisionedCapacityDescription' smart constructor. +data ProvisionedCapacityDescription = ProvisionedCapacityDescription' + { _pcdCapacityId :: !(Maybe Text) + , _pcdStartDate :: !(Maybe Text) + , _pcdExpirationDate :: !(Maybe Text) + } deriving (Eq,Read,Show,Data,Typeable,Generic) + +-- | 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). +provisionedCapacityDescription + :: ProvisionedCapacityDescription +provisionedCapacityDescription = + ProvisionedCapacityDescription' + { _pcdCapacityId = Nothing + , _pcdStartDate = Nothing + , _pcdExpirationDate = Nothing + } + +-- | The ID that identifies the provisioned capacity unit. +pcdCapacityId :: Lens' ProvisionedCapacityDescription (Maybe Text) +pcdCapacityId = lens _pcdCapacityId (\ s a -> s{_pcdCapacityId = a}); + +-- | The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC). +pcdStartDate :: Lens' ProvisionedCapacityDescription (Maybe Text) +pcdStartDate = lens _pcdStartDate (\ s a -> s{_pcdStartDate = a}); + +-- | The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC). +pcdExpirationDate :: Lens' ProvisionedCapacityDescription (Maybe Text) +pcdExpirationDate = lens _pcdExpirationDate (\ s a -> s{_pcdExpirationDate = a}); + +instance FromJSON ProvisionedCapacityDescription + where + parseJSON + = withObject "ProvisionedCapacityDescription" + (\ x -> + ProvisionedCapacityDescription' <$> + (x .:? "CapacityId") <*> (x .:? "StartDate") <*> + (x .:? "ExpirationDate")) + +instance Hashable ProvisionedCapacityDescription + +instance NFData ProvisionedCapacityDescription + -- | A list of in-progress multipart uploads for a vault. -- +-- +-- -- /See:/ 'uploadListElement' smart constructor. data UploadListElement = UploadListElement' { _uleMultipartUploadId :: !(Maybe Text) @@ -710,15 +782,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'uleMultipartUploadId' +-- * 'uleMultipartUploadId' - The ID of a multipart upload. -- --- * 'ulePartSizeInBytes' +-- * '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' +-- * 'uleArchiveDescription' - The description of the archive that was specified in the Initiate Multipart Upload request. -- --- * 'uleVaultARN' +-- * 'uleVaultARN' - The Amazon Resource Name (ARN) of the vault that contains the archive. -- --- * 'uleCreationDate' +-- * 'uleCreationDate' - The UTC time at which the multipart upload was initiated. uploadListElement :: UploadListElement uploadListElement = @@ -767,6 +839,8 @@ -- | Contains the vault access policy. -- +-- +-- -- /See:/ 'vaultAccessPolicy' smart constructor. newtype VaultAccessPolicy = VaultAccessPolicy' { _vapPolicy :: Maybe Text @@ -776,7 +850,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'vapPolicy' +-- * 'vapPolicy' - The vault access policy. vaultAccessPolicy :: VaultAccessPolicy vaultAccessPolicy = @@ -803,6 +877,8 @@ -- | Contains the vault lock policy. -- +-- +-- -- /See:/ 'vaultLockPolicy' smart constructor. newtype VaultLockPolicy = VaultLockPolicy' { _vlpPolicy :: Maybe Text @@ -812,7 +888,7 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'vlpPolicy' +-- * 'vlpPolicy' - The vault lock policy. vaultLockPolicy :: VaultLockPolicy vaultLockPolicy = @@ -832,8 +908,10 @@ toJSON VaultLockPolicy'{..} = object (catMaybes [("Policy" .=) <$> _vlpPolicy]) --- | Represents a vault\'s notification configuration. +-- | Represents a vault's notification configuration. -- +-- +-- -- /See:/ 'vaultNotificationConfig' smart constructor. data VaultNotificationConfig = VaultNotificationConfig' { _vncSNSTopic :: !(Maybe Text) @@ -844,9 +922,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'vncSNSTopic' +-- * 'vncSNSTopic' - The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN). -- --- * 'vncEvents' +-- * 'vncEvents' - A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic. vaultNotificationConfig :: VaultNotificationConfig vaultNotificationConfig = diff --git a/gen/Network/AWS/Glacier/UploadArchive.hs b/gen/Network/AWS/Glacier/UploadArchive.hs --- a/gen/Network/AWS/Glacier/UploadArchive.hs +++ b/gen/Network/AWS/Glacier/UploadArchive.hs @@ -18,19 +18,21 @@ -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- --- This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the 'x-amz-archive-id' header of the response. +-- This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the @x-amz-archive-id@ header of the response. -- --- You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see < InitiateJob>. -- --- You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see . +-- You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see 'InitiateJob' . -- --- You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see < InitiateJob>. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. +-- You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see . -- +-- You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see 'InitiateJob' . Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list. +-- -- Archives are immutable. After you upload an archive, you cannot edit the archive or its description. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.UploadArchive ( -- * Creating a Request @@ -61,6 +63,8 @@ -- | Provides options to add an archive to a vault. -- +-- +-- -- /See:/ 'uploadArchive' smart constructor. data UploadArchive = UploadArchive' { _uaChecksum :: !(Maybe Text) @@ -74,15 +78,15 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'uaChecksum' +-- * 'uaChecksum' - The SHA256 tree hash of the data being uploaded. -- --- * 'uaArchiveDescription' +-- * 'uaArchiveDescription' - The optional description of the archive you are uploading. -- --- * 'uaVaultName' +-- * 'uaVaultName' - The name of the vault. -- --- * 'uaAccountId' +-- * 'uaAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'uaBody' +-- * 'uaBody' - The data to upload. uploadArchive :: Text -- ^ 'uaVaultName' -> Text -- ^ 'uaAccountId' @@ -109,7 +113,7 @@ uaVaultName :: Lens' UploadArchive Text uaVaultName = lens _uaVaultName (\ s a -> s{_uaVaultName = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. uaAccountId :: Lens' UploadArchive Text uaAccountId = lens _uaAccountId (\ s a -> s{_uaAccountId = a}); diff --git a/gen/Network/AWS/Glacier/UploadMultipartPart.hs b/gen/Network/AWS/Glacier/UploadMultipartPart.hs --- a/gen/Network/AWS/Glacier/UploadMultipartPart.hs +++ b/gen/Network/AWS/Glacier/UploadMultipartPart.hs @@ -20,21 +20,23 @@ -- -- This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload. -- +-- -- Amazon Glacier rejects your upload part request if any of the following conditions is true: -- --- - __SHA256 tree hash does not match__To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don\'t match, the operation fails. For information about computing a SHA256 tree hash, see . +-- * __SHA256 tree hash does not match__ To ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see . -- --- - __Part size does not match__The size of each part except the last must match the size specified in the corresponding < InitiateMultipartUpload> request. The size of the last part must be the same size as, or smaller than, the specified size. +-- * __Part size does not match__ The size of each part except the last must match the size specified in the corresponding 'InitiateMultipartUpload' request. The size of the last part must be the same size as, or smaller than, the specified size. -- --- If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail. +-- * __Range does not align__ The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. -- --- - __Range does not align__The byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail. -- +-- -- This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data. -- --- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don\'t have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . +-- An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see . -- --- For conceptual information and underlying REST API, go to and in the /Amazon Glacier Developer Guide/. +-- For conceptual information and underlying REST API, see and in the /Amazon Glacier Developer Guide/ . +-- module Network.AWS.Glacier.UploadMultipartPart ( -- * Creating a Request @@ -65,6 +67,8 @@ -- | Provides options to upload a part of an archive in a multipart upload operation. -- +-- +-- -- /See:/ 'uploadMultipartPart' smart constructor. data UploadMultipartPart = UploadMultipartPart' { _umpChecksum :: !(Maybe Text) @@ -79,17 +83,17 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'umpChecksum' +-- * 'umpChecksum' - The SHA256 tree hash of the data being uploaded. -- --- * 'umpRange' +-- * 'umpRange' - Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*. -- --- * 'umpAccountId' +-- * 'umpAccountId' - The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. -- --- * 'umpVaultName' +-- * 'umpVaultName' - The name of the vault. -- --- * 'umpUploadId' +-- * 'umpUploadId' - The upload ID of the multipart upload. -- --- * 'umpBody' +-- * 'umpBody' - The data to upload. uploadMultipartPart :: Text -- ^ 'umpAccountId' -> Text -- ^ 'umpVaultName' @@ -110,11 +114,11 @@ umpChecksum :: Lens' UploadMultipartPart (Maybe Text) umpChecksum = lens _umpChecksum (\ s a -> s{_umpChecksum = a}); --- | Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303\/*. +-- | Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*. umpRange :: Lens' UploadMultipartPart (Maybe Text) umpRange = lens _umpRange (\ s a -> s{_umpRange = a}); --- | The 'AccountId' value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos'-'apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID. +-- | The @AccountId@ value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '@-@ ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID. umpAccountId :: Lens' UploadMultipartPart Text umpAccountId = lens _umpAccountId (\ s a -> s{_umpAccountId = a}); @@ -162,6 +166,8 @@ -- | Contains the Amazon Glacier response to your request. -- +-- +-- -- /See:/ 'uploadMultipartPartResponse' smart constructor. data UploadMultipartPartResponse = UploadMultipartPartResponse' { _umprsChecksum :: !(Maybe Text) @@ -172,9 +178,9 @@ -- -- Use one of the following lenses to modify other fields as desired: -- --- * 'umprsChecksum' +-- * 'umprsChecksum' - The SHA256 tree hash that Amazon Glacier computed for the uploaded part. -- --- * 'umprsResponseStatus' +-- * 'umprsResponseStatus' - -- | The response status code. uploadMultipartPartResponse :: Int -- ^ 'umprsResponseStatus' -> UploadMultipartPartResponse @@ -188,7 +194,7 @@ umprsChecksum :: Lens' UploadMultipartPartResponse (Maybe Text) umprsChecksum = lens _umprsChecksum (\ s a -> s{_umprsChecksum = a}); --- | The response status code. +-- | -- | The response status code. umprsResponseStatus :: Lens' UploadMultipartPartResponse Int umprsResponseStatus = lens _umprsResponseStatus (\ s a -> s{_umprsResponseStatus = a}); diff --git a/test/Test/AWS/Gen/Glacier.hs b/test/Test/AWS/Gen/Glacier.hs --- a/test/Test/AWS/Gen/Glacier.hs +++ b/test/Test/AWS/Gen/Glacier.hs @@ -61,6 +61,9 @@ -- , requestListVaults $ -- listVaults -- +-- , requestListProvisionedCapacity $ +-- listProvisionedCapacity +-- -- , requestListJobs $ -- listJobs -- @@ -79,6 +82,9 @@ -- , requestAbortMultipartUpload $ -- abortMultipartUpload -- +-- , requestPurchaseProvisionedCapacity $ +-- purchaseProvisionedCapacity +-- -- , requestDescribeVault $ -- describeVault -- @@ -157,6 +163,9 @@ -- , responseListVaults $ -- listVaultsResponse -- +-- , responseListProvisionedCapacity $ +-- listProvisionedCapacityResponse +-- -- , responseListJobs $ -- listJobsResponse -- @@ -175,6 +184,9 @@ -- , responseAbortMultipartUpload $ -- abortMultipartUploadResponse -- +-- , responsePurchaseProvisionedCapacity $ +-- purchaseProvisionedCapacityResponse +-- -- , responseDescribeVault $ -- describeVaultOutput -- @@ -272,6 +284,11 @@ "ListVaults" "fixture/ListVaults.yaml" +requestListProvisionedCapacity :: ListProvisionedCapacity -> TestTree +requestListProvisionedCapacity = req + "ListProvisionedCapacity" + "fixture/ListProvisionedCapacity.yaml" + requestListJobs :: ListJobs -> TestTree requestListJobs = req "ListJobs" @@ -302,6 +319,11 @@ "AbortMultipartUpload" "fixture/AbortMultipartUpload.yaml" +requestPurchaseProvisionedCapacity :: PurchaseProvisionedCapacity -> TestTree +requestPurchaseProvisionedCapacity = req + "PurchaseProvisionedCapacity" + "fixture/PurchaseProvisionedCapacity.yaml" + requestDescribeVault :: DescribeVault -> TestTree requestDescribeVault = req "DescribeVault" @@ -446,6 +468,13 @@ glacier (Proxy :: Proxy ListVaults) +responseListProvisionedCapacity :: ListProvisionedCapacityResponse -> TestTree +responseListProvisionedCapacity = res + "ListProvisionedCapacityResponse" + "fixture/ListProvisionedCapacityResponse.proto" + glacier + (Proxy :: Proxy ListProvisionedCapacity) + responseListJobs :: ListJobsResponse -> TestTree responseListJobs = res "ListJobsResponse" @@ -480,6 +509,13 @@ "fixture/AbortMultipartUploadResponse.proto" glacier (Proxy :: Proxy AbortMultipartUpload) + +responsePurchaseProvisionedCapacity :: PurchaseProvisionedCapacityResponse -> TestTree +responsePurchaseProvisionedCapacity = res + "PurchaseProvisionedCapacityResponse" + "fixture/PurchaseProvisionedCapacityResponse.proto" + glacier + (Proxy :: Proxy PurchaseProvisionedCapacity) responseDescribeVault :: DescribeVaultOutput -> TestTree responseDescribeVault = res