@datafire/amazonaws_glacier
v5.0.0
Published
DataFire integration for Amazon Glacier
Downloads
13
Readme
@datafire/amazonaws_glacier
Client library for Amazon Glacier
Installation and Usage
npm install --save @datafire/amazonaws_glacier
let amazonaws_glacier = require('@datafire/amazonaws_glacier').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_glacier.GetDataRetrievalPolicy({
"accountId": ""
}).then(data => {
console.log(data);
});
Description
Actions
GetDataRetrievalPolicy
amazonaws_glacier.GetDataRetrievalPolicy({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
- accountId required
Output
- output GetDataRetrievalPolicyOutput
SetDataRetrievalPolicy
amazonaws_glacier.SetDataRetrievalPolicy({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
- Policy DataRetrievalPolicy
- accountId required
Output
Output schema unknown
ListProvisionedCapacity
amazonaws_glacier.ListProvisionedCapacity({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
- accountId required
Output
PurchaseProvisionedCapacity
amazonaws_glacier.PurchaseProvisionedCapacity({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
- accountId required
Output
Output schema unknown
ListVaults
amazonaws_glacier.ListVaults({
"accountId": ""
}, context)
Input
- input
object
- limit
string
- marker
string
- accountId required
string
- limit
Output
- output ListVaultsOutput
DeleteVault
amazonaws_glacier.DeleteVault({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
Output schema unknown
DescribeVault
amazonaws_glacier.DescribeVault({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
- output DescribeVaultOutput
CreateVault
amazonaws_glacier.CreateVault({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
Output schema unknown
DeleteVaultAccessPolicy
amazonaws_glacier.DeleteVaultAccessPolicy({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
Output schema unknown
GetVaultAccessPolicy
amazonaws_glacier.GetVaultAccessPolicy({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
- output GetVaultAccessPolicyOutput
SetVaultAccessPolicy
amazonaws_glacier.SetVaultAccessPolicy({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- policy VaultAccessPolicy
- accountId required
Output
Output schema unknown
UploadArchive
amazonaws_glacier.UploadArchive({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- body Stream
- accountId required
Output
Output schema unknown
DeleteArchive
amazonaws_glacier.DeleteArchive({
"accountId": "",
"vaultName": "",
"archiveId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- archiveId required
string
- accountId required
Output
Output schema unknown
ListJobs
amazonaws_glacier.ListJobs({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- limit
string
- marker
string
- accountId required
string
- vaultName required
string
- limit
Output
- output ListJobsOutput
InitiateJob
amazonaws_glacier.InitiateJob({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- jobParameters JobParameters
- accountId required
Output
Output schema unknown
DescribeJob
amazonaws_glacier.DescribeJob({
"accountId": "",
"vaultName": "",
"jobId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- jobId required
string
- accountId required
Output
- output GlacierJobDescription
GetJobOutput
amazonaws_glacier.GetJobOutput({
"accountId": "",
"vaultName": "",
"jobId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- jobId required
string
- accountId required
Output
- output GetJobOutputOutput
AbortVaultLock
amazonaws_glacier.AbortVaultLock({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
Output schema unknown
GetVaultLock
amazonaws_glacier.GetVaultLock({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
- output GetVaultLockOutput
InitiateVaultLock
amazonaws_glacier.InitiateVaultLock({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- policy VaultLockPolicy
- accountId required
Output
Output schema unknown
CompleteVaultLock
amazonaws_glacier.CompleteVaultLock({
"accountId": "",
"vaultName": "",
"lockId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- lockId required
string
- accountId required
Output
Output schema unknown
ListMultipartUploads
amazonaws_glacier.ListMultipartUploads({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- limit
string
- marker
string
- accountId required
string
- vaultName required
string
- limit
Output
- output ListMultipartUploadsOutput
InitiateMultipartUpload
amazonaws_glacier.InitiateMultipartUpload({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
Output schema unknown
AbortMultipartUpload
amazonaws_glacier.AbortMultipartUpload({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- uploadId required
string
- accountId required
Output
Output schema unknown
ListParts
amazonaws_glacier.ListParts({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
Input
- input
object
- limit
string
- marker
string
- accountId required
string
- vaultName required
string
- uploadId required
string
- limit
Output
- output ListPartsOutput
CompleteMultipartUpload
amazonaws_glacier.CompleteMultipartUpload({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- uploadId required
string
- accountId required
Output
Output schema unknown
UploadMultipartPart
amazonaws_glacier.UploadMultipartPart({
"accountId": "",
"vaultName": "",
"uploadId": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- uploadId required
string
- body Stream
- accountId required
Output
Output schema unknown
DeleteVaultNotifications
amazonaws_glacier.DeleteVaultNotifications({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
Output schema unknown
GetVaultNotifications
amazonaws_glacier.GetVaultNotifications({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
- output GetVaultNotificationsOutput
SetVaultNotifications
amazonaws_glacier.SetVaultNotifications({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- vaultNotificationConfig VaultNotificationConfig
- accountId required
Output
Output schema unknown
ListTagsForVault
amazonaws_glacier.ListTagsForVault({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- accountId required
Output
- output ListTagsForVaultOutput
AddTagsToVault
amazonaws_glacier.AddTagsToVault({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- Tags TagMap
- accountId required
Output
Output schema unknown
RemoveTagsFromVault
amazonaws_glacier.RemoveTagsFromVault({
"accountId": "",
"vaultName": ""
}, context)
Input
- input
object
- accountId required
string
- vaultName required
string
- TagKeys TagKeyList
- accountId required
Output
Output schema unknown
Definitions
AbortMultipartUploadInput
- 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.
AbortVaultLockInput
- AbortVaultLockInput
object
: The input values for AbortVaultLock.
AccessControlPolicyList
- AccessControlPolicyList
array
- items Grant
ActionCode
- ActionCode
string
(values: ArchiveRetrieval, InventoryRetrieval, Select)
AddTagsToVaultInput
- AddTagsToVaultInput
object
: The input values for AddTagsToVault.- Tags TagMap
ArchiveCreationOutput
- 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.
CSVInput
- CSVInput
object
: Contains information about the comma-separated value (CSV) file to select from.
CSVOutput
- 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
CannedACL
- CannedACL
string
(values: private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control)
CompleteMultipartUploadInput
- 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.
CompleteVaultLockInput
- CompleteVaultLockInput
object
: The input values for CompleteVaultLock.
CreateVaultInput
- CreateVaultInput
object
: Provides options to create a vault.
CreateVaultOutput
- CreateVaultOutput
object
: Contains the Amazon Glacier response to your request.
DataRetrievalPolicy
- DataRetrievalPolicy
object
: Data retrieval policy.- Rules DataRetrievalRulesList
DataRetrievalRule
- DataRetrievalRule
object
: Data retrieval policy rule.- BytesPerHour NullableLong
- Strategy string
DataRetrievalRulesList
- DataRetrievalRulesList
array
- items DataRetrievalRule
DateTime
- DateTime
string
DeleteArchiveInput
- DeleteArchiveInput
object
: Provides options for deleting an archive from an Amazon Glacier vault.
DeleteVaultAccessPolicyInput
- DeleteVaultAccessPolicyInput
object
: DeleteVaultAccessPolicy input.
DeleteVaultInput
- DeleteVaultInput
object
: Provides options for deleting a vault from Amazon Glacier.
DeleteVaultNotificationsInput
- DeleteVaultNotificationsInput
object
: Provides options for deleting a vault notification configuration from an Amazon Glacier vault.
DescribeJobInput
- DescribeJobInput
object
: Provides options for retrieving a job description.
DescribeVaultInput
- DescribeVaultInput
object
: Provides options for retrieving metadata for a specific vault in Amazon Glacier.
DescribeVaultOutput
- DescribeVaultOutput
object
: Contains the Amazon Glacier response to your request.
Encryption
- Encryption
object
: Contains information about the encryption used to store the job results in Amazon S3.- EncryptionType EncryptionType
- KMSContext string
- KMSKeyId string
EncryptionType
- EncryptionType
string
(values: aws:kms, AES256)
ExpressionType
- ExpressionType
string
(values: SQL)
FileHeaderInfo
- FileHeaderInfo
string
(values: USE, IGNORE, NONE)
GetDataRetrievalPolicyInput
- GetDataRetrievalPolicyInput
object
: Input for GetDataRetrievalPolicy.
GetDataRetrievalPolicyOutput
- GetDataRetrievalPolicyOutput
object
: Contains the Amazon Glacier response to the GetDataRetrievalPolicy request.- Policy DataRetrievalPolicy
GetJobOutputInput
- GetJobOutputInput
object
: Provides options for downloading output of an Amazon Glacier job.
GetJobOutputOutput
- GetJobOutputOutput
object
: Contains the Amazon Glacier response to your request.- body Stream
GetVaultAccessPolicyInput
- GetVaultAccessPolicyInput
object
: Input for GetVaultAccessPolicy.
GetVaultAccessPolicyOutput
- GetVaultAccessPolicyOutput
object
: Output for GetVaultAccessPolicy.- policy VaultAccessPolicy
GetVaultLockInput
- GetVaultLockInput
object
: The input values for GetVaultLock.
GetVaultLockOutput
- GetVaultLockOutput
object
: Contains the Amazon Glacier response to your request.
GetVaultNotificationsInput
- GetVaultNotificationsInput
object
: Provides options for retrieving the notification configuration set on an Amazon Glacier vault.
GetVaultNotificationsOutput
- GetVaultNotificationsOutput
object
: Contains the Amazon Glacier response to your request.- vaultNotificationConfig VaultNotificationConfig
GlacierJobDescription
- 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
Grant
- Grant
object
: Contains information about a grant.- Grantee Grantee
- Permission Permission
Grantee
- Grantee
object
: Contains information about the grantee.
InitiateJobInput
- InitiateJobInput
object
: Provides options for initiating an Amazon Glacier job.- jobParameters JobParameters
InitiateJobOutput
- InitiateJobOutput
object
: Contains the Amazon Glacier response to your request.
InitiateMultipartUploadInput
- InitiateMultipartUploadInput
object
: Provides options for initiating a multipart upload to an Amazon Glacier vault.
InitiateMultipartUploadOutput
- InitiateMultipartUploadOutput
object
: The Amazon Glacier response to your request.
InitiateVaultLockInput
- InitiateVaultLockInput
object
: The input values for InitiateVaultLock.- policy VaultLockPolicy
InitiateVaultLockOutput
- InitiateVaultLockOutput
object
: Contains the Amazon Glacier response to your request.
InputSerialization
- InputSerialization
object
: Describes how the archive is serialized.- csv CSVInput
InsufficientCapacityException
- 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.
InvalidParameterValueException
- InvalidParameterValueException
object
: Returned if a parameter of the request is incorrectly specified.
InventoryRetrievalJobDescription
- InventoryRetrievalJobDescription
object
: Describes the options for a range inventory retrieval job.
InventoryRetrievalJobInput
- InventoryRetrievalJobInput
object
: Provides options for specifying a range inventory retrieval job.
JobList
- JobList
array
- items GlacierJobDescription
JobParameters
- 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
LimitExceededException
- LimitExceededException
object
: Returned if the request results in a vault or account limit being exceeded.
ListJobsInput
- ListJobsInput
object
: Provides options for retrieving a job list for an Amazon Glacier vault.
ListJobsOutput
- ListJobsOutput
object
: Contains the Amazon Glacier response to your request.
ListMultipartUploadsInput
- ListMultipartUploadsInput
object
: Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.
ListMultipartUploadsOutput
- ListMultipartUploadsOutput
object
: Contains the Amazon Glacier response to your request.- Marker string
- UploadsList UploadsList
ListPartsInput
- ListPartsInput
object
: Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
ListPartsOutput
- ListPartsOutput
object
: Contains the Amazon Glacier response to your request.
ListProvisionedCapacityInput
- ListProvisionedCapacityInput
object
ListProvisionedCapacityOutput
- ListProvisionedCapacityOutput
object
- ProvisionedCapacityList ProvisionedCapacityList
ListTagsForVaultInput
- ListTagsForVaultInput
object
: The input value for ListTagsForVaultInput.
ListTagsForVaultOutput
- ListTagsForVaultOutput
object
: Contains the Amazon Glacier response to your request.- Tags TagMap
ListVaultsInput
- ListVaultsInput
object
: Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.
ListVaultsOutput
- ListVaultsOutput
object
: Contains the Amazon Glacier response to your request.
MissingParameterValueException
- MissingParameterValueException
object
: Returned if a required header or parameter is missing from the request.
NotificationEventList
- NotificationEventList
array
- items string
NullableLong
- NullableLong
integer
OutputLocation
- OutputLocation
object
: Contains information about the location where the select job results are stored.- S3 S3Location
OutputSerialization
- OutputSerialization
object
: Describes how the select output is serialized.- csv CSVOutput
PartList
- PartList
array
- items PartListElement
PartListElement
- PartListElement
object
: A list of the part sizes of the multipart upload.
Permission
- Permission
string
(values: FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP)
PolicyEnforcedException
- PolicyEnforcedException
object
: Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,
ProvisionedCapacityDescription
- ProvisionedCapacityDescription
object
: The definition for a provisioned capacity unit.
ProvisionedCapacityList
- ProvisionedCapacityList
array
PurchaseProvisionedCapacityInput
- PurchaseProvisionedCapacityInput
object
PurchaseProvisionedCapacityOutput
- PurchaseProvisionedCapacityOutput
object
QuoteFields
- QuoteFields
string
(values: ALWAYS, ASNEEDED)
RemoveTagsFromVaultInput
- RemoveTagsFromVaultInput
object
: The input value for RemoveTagsFromVaultInput.- TagKeys TagKeyList
RequestTimeoutException
- RequestTimeoutException
object
: Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.
ResourceNotFoundException
- ResourceNotFoundException
object
: Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.
S3Location
- 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
SelectParameters
- SelectParameters
object
: Contains information about the parameters used for a select.- Expression string
- ExpressionType ExpressionType
- InputSerialization InputSerialization
- OutputSerialization OutputSerialization
ServiceUnavailableException
- ServiceUnavailableException
object
: Returned if the service cannot complete the request.
SetDataRetrievalPolicyInput
- SetDataRetrievalPolicyInput
object
: SetDataRetrievalPolicy input.- Policy DataRetrievalPolicy
SetVaultAccessPolicyInput
- SetVaultAccessPolicyInput
object
: SetVaultAccessPolicy input.- policy VaultAccessPolicy
SetVaultNotificationsInput
- SetVaultNotificationsInput
object
: Provides options to configure notifications that will be sent when specific events happen to a vault.- vaultNotificationConfig VaultNotificationConfig
Size
- Size
integer
StatusCode
- StatusCode
string
(values: InProgress, Succeeded, Failed)
StorageClass
- StorageClass
string
(values: STANDARD, REDUCED_REDUNDANCY, STANDARD_IA)
Stream
- Stream
string
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items string
TagMap
TagValue
- TagValue
string
Type
- Type
string
(values: AmazonCustomerByEmail, CanonicalUser, Group)
UploadArchiveInput
- UploadArchiveInput
object
: Provides options to add an archive to a vault.- body Stream
UploadListElement
- UploadListElement
object
: A list of in-progress multipart uploads for a vault.
UploadMultipartPartInput
- UploadMultipartPartInput
object
: Provides options to upload a part of an archive in a multipart upload operation.- body Stream
UploadMultipartPartOutput
- UploadMultipartPartOutput
object
: Contains the Amazon Glacier response to your request.
UploadsList
- UploadsList
array
- items UploadListElement
VaultAccessPolicy
- VaultAccessPolicy
object
: Contains the vault access policy.- Policy string
VaultList
- VaultList
array
- items DescribeVaultOutput
VaultLockPolicy
- VaultLockPolicy
object
: Contains the vault lock policy.- Policy string
VaultNotificationConfig
- VaultNotificationConfig
object
: Represents a vault's notification configuration.- Events NotificationEventList
- SNSTopic string
boolean
- boolean
boolean
hashmap
httpstatus
- httpstatus
integer
long
- long
integer
string
- string
string