@datafire/amazonaws_glacier

Client library for Amazon Glacier

Installation and Usage

``bash
npm install --save @datafire/amazonaws_glacier
`
`js
let amazonaws_glacier = require('@datafire/amazonaws_glacier').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});

amazonaws_glacier.GetDataRetrievalPolicy({
"accountId": ""
}).then(data => {
console.log(data);
});
`

Description

Amazon Glacier is a storage solution for "cold data."

Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.

Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).

You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.

If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide:

• What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.

• Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.

Actions

$3

`js
amazonaws_glacier.GetDataRetrievalPolicy({
"accountId": ""
}, context)
`

#### Input
* input object
* accountId required string

#### Output
* output GetDataRetrievalPolicyOutput

$3

`js
amazonaws_glacier.SetDataRetrievalPolicy({
"accountId": ""
}, context)
`

#### Input
* input object
* accountId required string
* Policy DataRetrievalPolicy

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.ListProvisionedCapacity({
"accountId": ""
}, context)
`

#### Input
* input object
* accountId required string

#### Output
* output ListProvisionedCapacityOutput

$3

`js
amazonaws_glacier.PurchaseProvisionedCapacity({
"accountId": ""
}, context)
`

#### Input
* input object
* accountId required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.ListVaults({
"accountId": ""
}, context)
`

#### Input
* input object
* limit string
* marker string
* accountId required string

#### Output
* output ListVaultsOutput

$3

`js
amazonaws_glacier.DeleteVault({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.DescribeVault({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
* output DescribeVaultOutput

$3

`js
amazonaws_glacier.CreateVault({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.DeleteVaultAccessPolicy({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.GetVaultAccessPolicy({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
* output GetVaultAccessPolicyOutput

$3

`js
amazonaws_glacier.SetVaultAccessPolicy({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* policy VaultAccessPolicy

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.UploadArchive({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* body Stream

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.DeleteArchive({
"accountId": "",
"vaultName": "",
"archiveId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* archiveId required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.ListJobs({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* limit string
* marker string
* accountId required string
* vaultName required string

#### Output
* output ListJobsOutput

$3

`js
amazonaws_glacier.InitiateJob({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* jobParameters JobParameters

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.DescribeJob({
"accountId": "",
"vaultName": "",
"jobId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* jobId required string

#### Output
* output GlacierJobDescription

$3

`js
amazonaws_glacier.GetJobOutput({
"accountId": "",
"vaultName": "",
"jobId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* jobId required string

#### Output
* output GetJobOutputOutput

$3

`js
amazonaws_glacier.AbortVaultLock({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.GetVaultLock({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
* output GetVaultLockOutput

$3

`js
amazonaws_glacier.InitiateVaultLock({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* policy VaultLockPolicy

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.CompleteVaultLock({
"accountId": "",
"vaultName": "",
"lockId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* lockId required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.ListMultipartUploads({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* limit string
* marker string
* accountId required string
* vaultName required string

#### Output
* output ListMultipartUploadsOutput

$3

`js
amazonaws_glacier.InitiateMultipartUpload({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.AbortMultipartUpload({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* uploadId required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.ListParts({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
`

#### Input
* input object
* limit string
* marker string
* accountId required string
* vaultName required string
* uploadId required string

#### Output
* output ListPartsOutput

$3

`js
amazonaws_glacier.CompleteMultipartUpload({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* uploadId required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.UploadMultipartPart({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* uploadId required string
* body Stream

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.DeleteVaultNotifications({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.GetVaultNotifications({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
* output GetVaultNotificationsOutput

$3

`js
amazonaws_glacier.SetVaultNotifications({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* vaultNotificationConfig VaultNotificationConfig

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.ListTagsForVault({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string

#### Output
* output ListTagsForVaultOutput

$3

`js
amazonaws_glacier.AddTagsToVault({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* Tags TagMap

#### Output
Output schema unknown

$3

`js
amazonaws_glacier.RemoveTagsFromVault({
"accountId": "",
"vaultName": ""
}, context)
`

#### Input
* input object
* accountId required string
* vaultName required string
* TagKeys TagKeyList

#### Output
Output schema unknown

Definitions

$3


* AbortMultipartUploadInput object:

Provides options to abort a multipart upload identified by the upload ID.

For information about the underlying REST API, see Abort Multipart Upload. For conceptual information, see Working with Archives in Amazon Glacier.

$3

* AbortVaultLockInput object: The input values for AbortVaultLock.

$3

* AccessControlPolicyList array
* items Grant

$3

* ActionCode string (values: ArchiveRetrieval, InventoryRetrieval, Select)

$3

* AddTagsToVaultInput object: The input values for AddTagsToVault.
* Tags TagMap

$3

* ArchiveCreationOutput object:

Contains the Amazon Glacier response to your request.

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

$3

* CSVInput object: Contains information about the comma-separated value (CSV) file to select from.
* Comments string
* FieldDelimiter string
* FileHeaderInfo FileHeaderInfo
* QuoteCharacter string
* QuoteEscapeCharacter string
* RecordDelimiter string

$3

* CSVOutput object: Contains information about the comma-separated value (CSV) file that the job results are stored in.
* FieldDelimiter string
* QuoteCharacter string
* QuoteEscapeCharacter string
* QuoteFields QuoteFields
* RecordDelimiter string

$3

* CannedACL string (values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control)

$3

* CompleteMultipartUploadInput object: 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.

$3

* CompleteVaultLockInput object: The input values for CompleteVaultLock.

$3

* CreateVaultInput object: Provides options to create a vault.

$3

* CreateVaultOutput object: Contains the Amazon Glacier response to your request.

$3

* DataRetrievalPolicy object: Data retrieval policy.
* Rules DataRetrievalRulesList

$3

* DataRetrievalRule object: Data retrieval policy rule.
* BytesPerHour NullableLong
* Strategy string

$3

* DataRetrievalRulesList array
* items DataRetrievalRule

$3

* DateTime string

$3

* DeleteArchiveInput object: Provides options for deleting an archive from an Amazon Glacier vault.

$3

* DeleteVaultAccessPolicyInput object: DeleteVaultAccessPolicy input.

$3

* DeleteVaultInput object: Provides options for deleting a vault from Amazon Glacier.

$3

* DeleteVaultNotificationsInput object: Provides options for deleting a vault notification configuration from an Amazon Glacier vault.

$3

* DescribeJobInput object: Provides options for retrieving a job description.

$3

* DescribeVaultInput object: Provides options for retrieving metadata for a specific vault in Amazon Glacier.

$3

* DescribeVaultOutput object: Contains the Amazon Glacier response to your request.
* CreationDate string
* LastInventoryDate string
* NumberOfArchives long
* SizeInBytes long
* VaultARN string
* VaultName string

$3

* Encryption object: Contains information about the encryption used to store the job results in Amazon S3.
* EncryptionType EncryptionType
* KMSContext string
* KMSKeyId string

$3

* EncryptionType string (values: aws:kms, AES256)

$3

* ExpressionType string (values: SQL)

$3

* FileHeaderInfo string (values: USE, IGNORE, NONE)

$3

* GetDataRetrievalPolicyInput object: Input for GetDataRetrievalPolicy.

$3

* GetDataRetrievalPolicyOutput object: Contains the Amazon Glacier response to the GetDataRetrievalPolicy request.
* Policy DataRetrievalPolicy

$3

* GetJobOutputInput object: Provides options for downloading output of an Amazon Glacier job.

$3

* GetJobOutputOutput object: Contains the Amazon Glacier response to your request.
* body Stream

$3

* GetVaultAccessPolicyInput object: Input for GetVaultAccessPolicy.

$3

* GetVaultAccessPolicyOutput object: Output for GetVaultAccessPolicy.
* policy VaultAccessPolicy

$3

* GetVaultLockInput object: The input values for GetVaultLock.

$3

* GetVaultLockOutput object: Contains the Amazon Glacier response to your request.
* CreationDate string
* ExpirationDate string
* Policy string
* State string

$3

* GetVaultNotificationsInput object: Provides options for retrieving the notification configuration set on an Amazon Glacier vault.

$3

* GetVaultNotificationsOutput object: Contains the Amazon Glacier response to your request.
* vaultNotificationConfig VaultNotificationConfig

$3

* GlacierJobDescription object: Contains the description of an Amazon Glacier job.
* Action ActionCode
* ArchiveId string
* ArchiveSHA256TreeHash string
* ArchiveSizeInBytes Size
* Completed boolean
* CompletionDate string
* CreationDate string
* InventoryRetrievalParameters InventoryRetrievalJobDescription
* InventorySizeInBytes Size
* JobDescription string
* JobId string
* JobOutputPath string
* OutputLocation OutputLocation
* RetrievalByteRange string
* SHA256TreeHash string
* SNSTopic string
* SelectParameters SelectParameters
* StatusCode StatusCode
* StatusMessage string
* Tier string
* VaultARN string

$3

* Grant object: Contains information about a grant.
* Grantee Grantee
* Permission Permission

$3

* Grantee object: Contains information about the grantee.
* DisplayName string
* EmailAddress string
* ID string
* Type required Type
* URI string

$3

* InitiateJobInput object: Provides options for initiating an Amazon Glacier job.
* jobParameters JobParameters

$3

* InitiateJobOutput object: Contains the Amazon Glacier response to your request.

$3

* InitiateMultipartUploadInput object: Provides options for initiating a multipart upload to an Amazon Glacier vault.

$3

* InitiateMultipartUploadOutput object: The Amazon Glacier response to your request.

$3

* InitiateVaultLockInput object: The input values for InitiateVaultLock.
* policy VaultLockPolicy

$3

* InitiateVaultLockOutput object: Contains the Amazon Glacier response to your request.

$3

* InputSerialization object: Describes how the archive is serialized.
* csv CSVInput

$3

* InsufficientCapacityException object: 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.
* code string
* message string
* type string

$3

* InvalidParameterValueException object: Returned if a parameter of the request is incorrectly specified.
* code string
* message string
* type string

$3

* InventoryRetrievalJobDescription object: Describes the options for a range inventory retrieval job.
* EndDate DateTime
* Format string
* Limit string
* Marker string
* StartDate DateTime

$3

* InventoryRetrievalJobInput object: Provides options for specifying a range inventory retrieval job.
* EndDate string
* Limit string
* Marker string
* StartDate string

$3

* JobList array
* items GlacierJobDescription

$3

* JobParameters object: Provides options for defining a job.
* ArchiveId string
* Description string
* Format string
* InventoryRetrievalParameters InventoryRetrievalJobInput
* OutputLocation OutputLocation
* RetrievalByteRange string
* SNSTopic string
* SelectParameters SelectParameters
* Tier string
* Type string

$3

* LimitExceededException object: Returned if the request results in a vault or account limit being exceeded.
* code string
* message string
* type string

$3

* ListJobsInput object: Provides options for retrieving a job list for an Amazon Glacier vault.

$3

* ListJobsOutput object: Contains the Amazon Glacier response to your request.
* JobList JobList
* Marker string

$3

* ListMultipartUploadsInput object: Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.

$3

* ListMultipartUploadsOutput object: Contains the Amazon Glacier response to your request.
* Marker string
* UploadsList UploadsList

$3

* ListPartsInput object: Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

$3

* ListPartsOutput object: Contains the Amazon Glacier response to your request.
* ArchiveDescription string
* CreationDate string
* Marker string
* MultipartUploadId string
* PartSizeInBytes long
* Parts PartList
* VaultARN string

$3

* ListProvisionedCapacityInput object

$3

* ListProvisionedCapacityOutput object
* ProvisionedCapacityList ProvisionedCapacityList

$3

* ListTagsForVaultInput object: The input value for ListTagsForVaultInput.

$3

* ListTagsForVaultOutput object: Contains the Amazon Glacier response to your request.
* Tags TagMap

$3

* ListVaultsInput object: Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

$3

* ListVaultsOutput object: Contains the Amazon Glacier response to your request.
* Marker string
* VaultList VaultList

$3

* MissingParameterValueException object: Returned if a required header or parameter is missing from the request.
* code string
* message string
* type string

$3

* NotificationEventList array
* items string

$3

* NullableLong integer

$3

* OutputLocation object: Contains information about the location where the select job results are stored.
* S3 S3Location

$3

* OutputSerialization object: Describes how the select output is serialized.
* csv CSVOutput

$3

* PartList array
* items PartListElement

$3

* PartListElement object: A list of the part sizes of the multipart upload.
* RangeInBytes string
* SHA256TreeHash string

$3

* Permission string (values: FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP)

$3

* PolicyEnforcedException object: Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
* code string
* message string
* type string

$3

* ProvisionedCapacityDescription object: The definition for a provisioned capacity unit.
* CapacityId string
* ExpirationDate string
* StartDate string

$3

* ProvisionedCapacityList array
* items ProvisionedCapacityDescription

$3

* PurchaseProvisionedCapacityInput object

$3

* PurchaseProvisionedCapacityOutput object

$3

* QuoteFields string (values: ALWAYS, ASNEEDED)

$3

* RemoveTagsFromVaultInput object: The input value for RemoveTagsFromVaultInput.
* TagKeys TagKeyList

$3

* RequestTimeoutException object: Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
* code string
* message string
* type string

$3

* ResourceNotFoundException object: Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
* code string
* message string
* type string

$3

* S3Location object: Contains information about the location in Amazon S3 where the select job results are stored.
* AccessControlList AccessControlPolicyList
* BucketName string
* CannedACL CannedACL
* Encryption Encryption
* Prefix string
* StorageClass StorageClass
* Tagging hashmap
* UserMetadata hashmap

$3

* SelectParameters object: Contains information about the parameters used for a select.
* Expression string
* ExpressionType ExpressionType
* InputSerialization InputSerialization
* OutputSerialization OutputSerialization

$3

* ServiceUnavailableException object: Returned if the service cannot complete the request.
* code string
* message string
* type string

$3

* SetDataRetrievalPolicyInput object: SetDataRetrievalPolicy input.
* Policy DataRetrievalPolicy

$3

* SetVaultAccessPolicyInput object: SetVaultAccessPolicy input.
* policy VaultAccessPolicy

$3

* SetVaultNotificationsInput object: Provides options to configure notifications that will be sent when specific events happen to a vault.
* vaultNotificationConfig VaultNotificationConfig

$3

* Size integer

$3

* StatusCode string (values: InProgress, Succeeded, Failed)

$3

* StorageClass string (values: STANDARD, REDUCED_REDUNDANCY, STANDARD_IA)

$3

* Stream string

$3

* TagKey string

$3

* TagKeyList array
* items string

$3

* TagMap array
* items object
* key TagKey
* value TagValue

$3

* TagValue string

$3

* Type string (values: AmazonCustomerByEmail, CanonicalUser, Group)

$3

* UploadArchiveInput object: Provides options to add an archive to a vault.
* body Stream

$3

* UploadListElement object: A list of in-progress multipart uploads for a vault.
* ArchiveDescription string
* CreationDate string
* MultipartUploadId string
* PartSizeInBytes long
* VaultARN string

$3

* UploadMultipartPartInput object: Provides options to upload a part of an archive in a multipart upload operation.
* body Stream

$3

* UploadMultipartPartOutput object: Contains the Amazon Glacier response to your request.

$3

* UploadsList array
* items UploadListElement

$3

* VaultAccessPolicy object: Contains the vault access policy.
* Policy string

$3

* VaultList array
* items DescribeVaultOutput

$3

* VaultLockPolicy object: Contains the vault lock policy.
* Policy string

$3

* VaultNotificationConfig object: Represents a vault's notification configuration.
* Events NotificationEventList
* SNSTopic string

$3

* boolean boolean

$3

* hashmap array
* items object
* key string
* value string

$3

* httpstatus integer

$3

* long integer

$3

* string string`