Class: AWS::Glacier::Client

Inherits:
Core::RESTJSONClient show all
Defined in:
lib/aws/glacier/client.rb

Overview

All operations with Amazon Glacier require your AWS account ID. You can specify the special value of '-' to specify your AWS account ID.

glacier = AWS::Glacier.new
resp = glacier.client.list_vaults(:account_id => '-')

Instance Attribute Summary

Attributes inherited from Core::Client

#config, #http_read_timeout

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#abort_multipart_upload(options = {}) ⇒ Core::Response

Calls the DELETE AbortMultipartUpload API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :upload_id - required - (String)



# File 'lib/aws/glacier/client.rb', line 31

#complete_multipart_upload(options = {}) ⇒ Core::Response

Calls the POST CompleteMultipartUpload API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :upload_id - required - (String)
  • :archive_size - (Integer)
  • :checksum - required - (String)
  • :content_sha256 - (String)



# File 'lib/aws/glacier/client.rb', line 39

#create_vault(options = {}) ⇒ Core::Response

Calls the PUT CreateVault API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)



# File 'lib/aws/glacier/client.rb', line 50

#delete_archive(options = {}) ⇒ Core::Response

Calls the DELETE DeleteArchive API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :archive_id - required - (String)



# File 'lib/aws/glacier/client.rb', line 57

#delete_vault(options = {}) ⇒ Core::Response

Calls the DELETE DeleteVault API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)



# File 'lib/aws/glacier/client.rb', line 65

#delete_vault_notifications(options = {}) ⇒ Core::Response

Calls the DELETE DeleteVaultNotifications API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)



# File 'lib/aws/glacier/client.rb', line 72

#describe_job(options = {}) ⇒ Core::Response

Calls the GET DescribeJob API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :job_id - required - (String)



# File 'lib/aws/glacier/client.rb', line 79

#describe_vault(options = {}) ⇒ Core::Response

Calls the GET DescribeVault API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)



# File 'lib/aws/glacier/client.rb', line 103

#get_job_output(options = {}) ⇒ Core::Response

Calls the GET GetJobOutput API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :job_id - required - (String)
  • :range - (String)



# File 'lib/aws/glacier/client.rb', line 118

#get_vault_notifications(options = {}) ⇒ Core::Response

Calls the GET GetVaultNotifications API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)



# File 'lib/aws/glacier/client.rb', line 127

#initiate_job(options = {}) ⇒ Core::Response

Calls the POST InitiateJob API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :job_parameters - required - (Hash)
    • :format - (String)
    • :type - (String)
    • :archive_id - (String)
    • :description - (String)
    • :sns_topic - (String)



# File 'lib/aws/glacier/client.rb', line 139

#initiate_multipart_upload(options = {}) ⇒ Core::Response

Calls the POST InitiateMultipartUpload API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :archive_description - (String)
  • :part_size - (Integer)



# File 'lib/aws/glacier/client.rb', line 152

#list_jobs(options = {}) ⇒ Core::Response

Calls the GET ListJobs API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :limit - (Integer)
  • :marker - (String)
  • :statuscode - (String)
  • :completed - (String)



# File 'lib/aws/glacier/client.rb', line 161

#list_multipart_uploads(options = {}) ⇒ Core::Response

Calls the GET ListMultipartUploads API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :upload_id_marker - (String)
  • :limit - (Integer)



# File 'lib/aws/glacier/client.rb', line 190

#list_parts(options = {}) ⇒ Core::Response

Calls the GET ListParts API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :upload_id - required - (String)
  • :marker - (String)
  • :limit - (Integer)



# File 'lib/aws/glacier/client.rb', line 208

#list_vaults(options = {}) ⇒ Core::Response

Calls the GET ListVaults API operation.

  • :account_id - required - (String)
  • :marker - (String)
  • :limit - (Integer)



# File 'lib/aws/glacier/client.rb', line 229

#set_vault_notifications(options = {}) ⇒ Core::Response

Calls the PUT SetVaultNotifications API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :vault_notification_config - required - (Hash)
    • :sns_topic - (String)
    • :events - (Array)



# File 'lib/aws/glacier/client.rb', line 247

#upload_archive(options = {}) ⇒ Core::Response

Calls the POST UploadArchive API operation.

  • :vault_name - required - (String)
  • :account_id - required - (String)
  • :archive_description - (String)
  • :checksum - required - (String)
  • :body - required - (IO)
  • :content_sha256 - (String)



# File 'lib/aws/glacier/client.rb', line 257

#upload_multipart_part(options = {}) ⇒ Core::Response

Calls the PUT UploadMultipartPart API operation.

  • :account_id - required - (String)
  • :vault_name - required - (String)
  • :upload_id - required - (String)
  • :checksum - required - (String)
  • :range - (String)
  • :body - required - (IO)
  • :content_sha256 - (String)



# File 'lib/aws/glacier/client.rb', line 268