Client

glacier

R Documentation

Amazon Glacier¶

Description¶

Amazon S3 Glacier (Glacier) is a storage solution for "cold data."

Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. 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.

Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. 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 Glacier.

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

What is Amazon S3 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 S3 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.

Usage¶

glacier(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- glacier(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

abort_multipart_upload: This operation aborts a multipart upload identified by the upload ID
abort_vault_lock: This operation aborts the vault locking process if the vault lock is not in the Locked state
add_tags_to_vault: This operation adds the specified tags to a vault
complete_multipart_upload: You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts
complete_vault_lock: 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
create_vault: This operation creates a new vault with the specified name
delete_archive: This operation deletes an archive from a vault
delete_vault: This operation deletes a vault
delete_vault_access_policy: This operation deletes the access policy associated with the specified vault
delete_vault_notifications: This operation deletes the notification configuration set for a vault
describe_job: 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 S3 Glacier (Glacier) completes the job
describe_vault: 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
get_data_retrieval_policy: This operation returns the current data retrieval policy for the account and region specified in the GET request
get_job_output: This operation downloads the output of the job you initiated using InitiateJob
get_vault_access_policy: This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy)
get_vault_lock: This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:
get_vault_notifications: This operation retrieves the notification-configuration subresource of the specified vault
initiate_job: This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval
initiate_multipart_upload: This operation initiates a multipart upload
initiate_vault_lock: This operation initiates the vault locking process by doing the following:
list_jobs: This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished
list_multipart_uploads: This operation lists in-progress multipart uploads for the specified vault
list_parts: This operation lists the parts of an archive that have been uploaded in a specific multipart upload
list_provisioned_capacity: This operation lists the provisioned capacity units for the specified AWS account
list_tags_for_vault: This operation lists all the tags attached to a vault
list_vaults: This operation lists all vaults owned by the calling user's account
purchase_provisioned_capacity: This operation purchases a provisioned capacity unit for an AWS account
remove_tags_from_vault: This operation removes one or more tags from the set of tags attached to a vault
set_data_retrieval_policy: This operation sets and then enacts a data retrieval policy in the region specified in the PUT request
set_vault_access_policy: This operation configures an access policy for a vault and will overwrite an existing policy
set_vault_notifications: This operation configures notifications that will be sent when specific events happen to a vault
upload_archive: This operation adds an archive to a vault
upload_multipart_part: This operation uploads a part of an archive

Examples¶

## Not run: 
svc <- glacier()
# The example deletes an in-progress multipart upload to a vault named
# my-vault:
svc$abort_multipart_upload(
  accountId = "-",
  uploadId = "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLq...",
  vaultName = "my-vault"
)

## End(Not run)