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.

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.

Aws::InstanceProfileCredentials - Used for loading credentials
from an EC2 IMDS on an EC2 instance.

Aws::SharedCredentials - Used for loading credentials from a
shared file, such as ~/.aws/config.

Aws::AssumeRoleCredentials - Used when you need to assume a role.

When :credentials are not configured directly, the following
locations will be searched for credentials:

Aws.config[:credentials]

The :access_key_id, :secret_access_key, and :session_token options.

ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']

~/.aws/credentials

~/.aws/config

EC2 IMDS instance profile - When used by default, the timeouts are
very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentails to enable retries and extended
timeouts.

:region(required, String)
—

The AWS region to connect to. The configured :region is
used to determine the service :endpoint. When not passed,
a default :region is searched for in the following locations:

Aws.config[:region]

ENV['AWS_REGION']

ENV['AMAZON_REGION']

ENV['AWS_DEFAULT_REGION']

~/.aws/credentials

~/.aws/config

:access_key_id(String)

:account_id(String)
— default:
"-"
—

The default Glacier AWS account ID to use for all glacier
operations. The default value of - uses the account
your :credentials belong to.

:active_endpoint_cache(Boolean)
— default:
false
—

When set to true, a thread polling for endpoints will be running in
the background every 60 secs (default). Defaults to false.

:adaptive_retry_wait_to_fill(Boolean)
— default:
true
—

Used only in adaptive retry mode. When true, the request will sleep
until there is sufficent client side capacity to retry the request.
When false, the request will raise a RetryCapacityNotAvailableError and will
not retry instead of sleeping.

:client_side_monitoring(Boolean)
— default:
false
—

When true, client-side metrics will be collected for all API requests from
this client.

:client_side_monitoring_client_id(String)
— default:
""
—

Allows you to provide an identifier for this client which will be attached to
all generated client side metrics. Defaults to an empty string.

:client_side_monitoring_host(String)
— default:
"127.0.0.1"
—

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
side monitoring agent is running on, where client metrics will be published via UDP.

:client_side_monitoring_port(Integer)
— default:
31000
—

Required for publishing client metrics. The port that the client side monitoring
agent is running on, where client metrics will be published via UDP.

The Logger instance to send log messages to. If this option
is not set, logging will be disabled.

:max_attempts(Integer)
— default:
3
—

An integer representing the maximum number attempts that will be made for
a single request, including the initial attempt. For example,
setting this value to 5 will result in a request being retried up to
4 times. Used in standard and adaptive retry modes.

:profile(String)
— default:
"default"
—

Used when loading credentials from the shared credentials file
at HOME/.aws/credentials. When not specified, 'default' is used.

:retry_backoff(Proc)
—

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
This option is only used in the legacy retry mode.

:retry_base_delay(Float)
— default:
0.3
—

The base delay in seconds used by the default backoff function. This option
is only used in the legacy retry mode.

:retry_jitter(Symbol)
— default:
:none
—

A delay randomiser function used by the default backoff function.
Some predefined functions can be referenced by name - :none, :equal, :full,
otherwise a Proc that takes and returns a number. This option is only used
in the legacy retry mode.

The maximum number of times to retry failed requests. Only
~ 500 level server errors and certain ~ 400 level client errors
are retried. Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors, auth errors,
endpoint discovery, and errors from expired credentials.
This option is only used in the legacy retry mode.

:retry_max_delay(Integer)
— default:
0
—

The maximum number of seconds to delay between retries (0 for no limit)
used by the default backoff function. This option is only used in the
legacy retry mode.

:retry_mode(String)
— default:
"legacy"
—

Specifies which retry algorithm to use. Values are:

legacy - The pre-existing retry behavior. This is default value if
no retry mode is provided.

standard - A standardized set of retry rules across the AWS SDKs.
This includes support for retry quotas, which limit the number of
unsuccessful retries a client can make.

adaptive - An experimental retry mode that includes all the
functionality of standard mode along with automatic client side
throttling. This is a provisional mode that may change behavior
in the future.

:secret_access_key(String)

:session_token(String)

:stub_responses(Boolean)
— default:
false
—

Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP
requests are made, and retries are disabled.

:validate_params(Boolean)
— default:
true
—

When true, request parameters are validated before
sending the request.

The number of
seconds to wait when opening a HTTP session before raising a
Timeout::Error.

:http_read_timeout(Integer)
— default:
60
—

The default
number of seconds to wait for response data. This value can
safely be set per-request on the session.

:http_idle_timeout(Float)
— default:
5
—

The number of
seconds a connection is allowed to sit idle before it is
considered stale. Stale connections are closed and removed
from the pool before making a request.

:http_continue_timeout(Float)
— default:
1
—

The number of
seconds to wait for a 100-continue response before sending the
request body. This option has no effect unless the request has
"Expect" header set to "100-continue". Defaults to nil which
disables this behaviour. This value can safely be set per
request on the session.

:http_wire_trace(Boolean)
— default:
false
—

When true,
HTTP debug output will be sent to the :logger.

:ssl_verify_peer(Boolean)
— default:
true
—

When true,
SSL peer certificates are verified when establishing a
connection.

:ssl_ca_bundle(String)
—

Full path to the SSL
certificate authority bundle file that should be used when
verifying peer certificates. If you do not pass
:ssl_ca_bundle or :ssl_ca_directory the the system default
will be used if available.

:ssl_ca_directory(String)
—

Full path of the
directory that contains the unbundled SSL certificate
authority files for verifying peer certificates. If you do
not pass :ssl_ca_bundle or :ssl_ca_directory the the
system default will be used if available.

Instance Method Details

#abort_multipart_upload(params = {}) ⇒ Struct

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.

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
Access Control Using AWS Identity and Access Management (IAM).

# The example deletes an in-progress multipart upload to a vault named my-vault:
resp=client.abort_multipart_upload({account_id:"-",upload_id:"19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",vault_name:"my-vault",})

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 S3 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.

#abort_vault_lock(params = {}) ⇒ Struct

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 Amazon Glacier Vault Lock. For more information
about vault lock policies, see Amazon Glacier Access Control with
Vault Lock Policies.

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.

Examples:

Example: To abort a vault lock

# The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named
# examplevault.
resp=client.abort_vault_lock({account_id:"-",vault_name:"examplevault",})

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.

#add_tags_to_vault(params = {}) ⇒ Struct

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
Tagging Amazon S3 Glacier Resources.

Examples:

Example: To add tags to a vault

# The example adds two tags to a my-vault.
resp=client.add_tags_to_vault({tags:{"examplekey1"=>"examplevalue1","examplekey2"=>"examplevalue2",},account_id:"-",vault_name:"my-vault",})

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:tags(Hash<String,String>)
—

The tags to add to the vault. Each tag is composed of a key and a
value. The value can be an empty string.

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. After assembling and saving the
archive to the vault, 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 Computing Checksums. On the server side,
Glacier also constructs the SHA256 tree hash of the assembled archive.
If the values match, 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, Glacier also checks for any missing content ranges when
assembling the archive, if missing content ranges are found, 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
Access Control Using AWS Identity and Access Management (IAM).

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:upload_id(required, String)
—

The upload ID of the multipart upload.

:archive_size(Integer)
—

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.

:checksum(String)
—

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 S3 Glacier (Glacier), Glacier returns an
error and the request fails.

#complete_vault_lock(params = {}) ⇒ Struct

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, Amazon Glacier
Vault Lock.

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.

Examples:

Example: To complete a vault lock

# The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked
# state.
resp=client.complete_vault_lock({account_id:"-",lock_id:"AE863rKkWZU53SLW5be4DUcW",vault_name:"example-vault",})

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.

:vault_name(required, String)
—

The name of the vault.

:lock_id(required, String)
—

The lockId value is the lock ID obtained from a InitiateVaultLock
request.

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 S3 Glacier.

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
Access Control Using AWS Identity and Access Management (IAM).

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 S3 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.

#delete_archive(params = {}) ⇒ Struct

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 has successfully prepared the archive
for download when Amazon S3 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
Access Control Using AWS Identity and Access Management (IAM).

# The example deletes the archive specified by the archive ID.
resp=client.delete_archive({account_id:"-",archive_id:"NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",vault_name:"examplevault",})

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 S3 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.

#delete_vault(params = {}) ⇒ Struct

This operation deletes a vault. Amazon S3 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 S3 Glacier
returns an error. You can use DescribeVault to return the number of
archives in a vault, and you can use Initiate a Job (POST jobs)
to initiate a new inventory retrieval for a vault. The inventory
contains the archive IDs you use to delete archives using Delete
Archive (DELETE archive).

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
Access Control Using AWS Identity and Access Management (IAM).

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 S3 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.

#delete_vault_access_policy(params = {}) ⇒ Struct

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 S3 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.

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 S3 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.

#delete_vault_notifications(params = {}) ⇒ Struct

This operation deletes the notification configuration set for a vault.
The operation is eventually consistent; that is, it might take some
time for Amazon S3 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
Access Control Using AWS Identity and Access Management (IAM).

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 S3 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.

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. 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 Glacier can notify the
topic after it completes the job.

A job ID will not expire for at least 24 hours after 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
Access Control Using AWS Identity and Access Management (IAM).

For more information about using this operation, see the documentation
for the underlying REST API Describe Job in the Amazon Glacier
Developer Guide.

Examples:

Example: To get information about a previously initiated job

# The example returns information about the previously initiated job specified by the job ID.
resp=client.describe_job({account_id:"-",job_id:"zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",vault_name:"my-vault",})resp.to_houtputsthefollowing:{action:"InventoryRetrieval",completed:false,creation_date:Time.parse("2015-07-17T20:23:41.616Z"),inventory_retrieval_parameters:{format:"JSON",},job_id:"zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",status_code:"InProgress",vault_arn:"arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",}

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 S3 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.

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 S3 Glacier generates vault inventories
approximately daily. For more information, see Downloading a Vault
Inventory in Amazon S3 Glacier.

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
Access Control Using AWS Identity and Access Management (IAM).

The following waiters are defined for this operation (see #wait_until for detailed usage):

vault_exists

vault_not_exists

Examples:

Example: To retrieve information about a vault

# The example retrieves data about a vault named my-vault.
resp=client.describe_vault({account_id:"-",vault_name:"my-vault",})resp.to_houtputsthefollowing:{creation_date:Time.parse("2016-09-23T19:27:18.665Z"),number_of_archives:0,size_in_bytes:0,vault_arn:"arn:aws:glacier:us-west-2:111122223333:vaults/my-vault",vault_name:"my-vault",}

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 S3 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.

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 Amazon Glacier Data Retrieval
Policies.

Examples:

Example: To get the current data retrieval policy for an account

# The example returns the current data retrieval policy for the account.
resp=client.get_data_retrieval_policy({account_id:"-",})resp.to_houtputsthefollowing:{policy:{rules:[{bytes_per_hour:10737418240,strategy:"BytesPerHour",},],},}

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.

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.

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 S3 Glacier
(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.

A job ID will not expire for at least 24 hours after 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.

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 S3 Glacier The expected size is also returned in
the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range
you specify, 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.

A job ID does not expire for at least 24 hours after 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
Access Control Using AWS Identity and Access Management (IAM).

# The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.
resp=client.get_job_output({account_id:"-",job_id:"zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",range:"",vault_name:"my-vaul",})resp.to_houtputsthefollowing:{accept_ranges:"bytes",body:"inventory-data",content_type:"application/json",status:200,}

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:job_id(required, String)
—

The job ID whose data is downloaded.

:range(String)
—

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 S3 Glacier. You compare this value with the checksum you
computed to ensure you have downloaded the entire archive content
with no errors.

# The example retrieves the access-policy set on the vault named example-vault.
resp=client.get_vault_access_policy({account_id:"-",vault_name:"example-vault",})resp.to_houtputsthefollowing:{policy:{policy:"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}",},}

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 S3 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.

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.

When the lock ID expires. The lock ID is used to complete the vault
locking process.

When the vault lock was initiated and put into the InProgress
state.

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, Amazon Glacier Vault Lock.

Example: To retrieve vault lock-policy related attributes that are set on a vault

# The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.
resp=client.get_vault_lock({account_id:"-",vault_name:"examplevault",})resp.to_houtputsthefollowing:{creation_date:Time.parse("exampledate"),expiration_date:Time.parse("exampledate"),policy:"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}",state:"InProgress",}

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 S3 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.

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 Configuring Vault
Notifications in Amazon S3 Glacier.

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
Access Control Using AWS Identity and Access Management (IAM).

Example: To get the notification-configuration for the specified vault

# The example retrieves the notification-configuration for the vault named my-vault.
resp=client.get_vault_notifications({account_id:"-",vault_name:"my-vault",})resp.to_houtputsthefollowing:{vault_notification_config:{events:["InventoryRetrievalCompleted","ArchiveRetrievalCompleted",],sns_topic:"arn:aws:sns:us-west-2:0123456789012:my-vault",},}

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 S3 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.

This operation initiates a job of the specified type, which can be a
select, an archival retrieval, or a vault retrieval. For more
information about using this operation, see the documentation for the
underlying REST API Initiate a Job.

Examples:

Example: To initiate an inventory-retrieval job

# The example initiates an inventory-retrieval job for the vault named examplevault.
resp=client.initiate_job({account_id:"-",job_parameters:{description:"My inventory job",format:"CSV",sns_topic:"arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",type:"inventory-retrieval",},vault_name:"examplevault",})resp.to_houtputsthefollowing:{job_id:" HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",location:"/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",}

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 S3 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.

This operation initiates a multipart upload. Amazon S3 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.

You don't need to know the size of the archive when you start a
multipart upload because Amazon S3 Glacier does not require you to
specify the overall archive size.

After you complete the multipart upload, Amazon S3 Glacier (Glacier)
removes the multipart upload resource referenced by the ID. 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
Access Control Using AWS Identity and Access Management (IAM).

# The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per
# file.
resp=client.initiate_multipart_upload({account_id:"-",part_size:1048576,vault_name:"my-vault",})resp.to_houtputsthefollowing:{location:"/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",upload_id:"19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",}

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:archive_description(String)
—

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).

:part_size(Integer)
—

The size of each part except the last, in bytes. The last part can be
smaller than this part size.

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, Amazon Glacier Vault
Lock.

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.

Examples:

Example: To initiate the vault locking process

# The example initiates the vault locking process for the vault named my-vault.
resp=client.initiate_vault_lock({account_id:"-",policy:{policy:"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}",},vault_name:"my-vault",})resp.to_houtputsthefollowing:{lock_id:"AE863rKkWZU53SLW5be4DUcW",}

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.

This operation lists jobs for a vault, including jobs that are
in-progress and jobs that have recently finished. The List Job
operation returns a list of these jobs sorted by job initiation time.

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.

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.

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 50. The number of jobs returned might be fewer than
the limit, but the number of returned jobs never exceeds the limit.

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 more information about using this operation, see the documentation
for the underlying REST API List Jobs.

# The example lists jobs for the vault named my-vault.
resp=client.list_jobs({account_id:"-",vault_name:"my-vault",})resp.to_houtputsthefollowing:{job_list:[{action:"ArchiveRetrieval",archive_id:"kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",archive_sha256_tree_hash:"9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",archive_size_in_bytes:3145728,completed:false,creation_date:Time.parse("2015-07-17T21:16:13.840Z"),job_description:"Retrieve archive on 2015-07-17",job_id:"l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav",retrieval_byte_range:"0-3145727",sha256_tree_hash:"9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",sns_topic:"arn:aws:sns:us-west-2:0123456789012:my-vault",status_code:"InProgress",vault_arn:"arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",},{action:"InventoryRetrieval",completed:false,creation_date:Time.parse("2015-07-17T20:23:41.616Z"),inventory_retrieval_parameters:{format:"JSON",},job_id:"zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",status_code:"InProgress",vault_arn:"arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",},],}

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:limit(Integer)
—

The maximum number of jobs to be returned. The default limit is 50.
The number of jobs returned might be fewer than the specified limit,
but the number of returned jobs never exceeds the limit.

:marker(String)
—

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.

:statuscode(String)
—

The type of job status to return. You can specify the following
values: InProgress, Succeeded, or Failed.

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 50 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.

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
Access Control Using AWS Identity and Access Management (IAM).

# The example lists all the in-progress multipart uploads for the vault named examplevault.
resp=client.list_multipart_uploads({account_id:"-",vault_name:"examplevault",})resp.to_houtputsthefollowing:{marker:"null",uploads_list:[{archive_description:"archive 1",creation_date:Time.parse("2012-03-19T23:20:59.130Z"),multipart_upload_id:"xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev",part_size_in_bytes:4194304,vault_arn:"arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",},{archive_description:"archive 2",creation_date:Time.parse("2012-04-01T15:00:00.000Z"),multipart_upload_id:"nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",part_size_in_bytes:4194304,vault_arn:"arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",},{archive_description:"archive 3",creation_date:Time.parse("2012-03-20T17:03:43.221Z"),multipart_upload_id:"qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",part_size_in_bytes:4194304,vault_arn:"arn:aws:glacier:us-west-2:012345678901:vaults/examplevault",},],}

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:marker(String)
—

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.

:limit(Integer)
—

Specifies the maximum number of uploads returned in the response body.
If this value is not specified, the List Uploads operation returns up
to 50 uploads.

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 50 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
Access Control Using AWS Identity and Access Management (IAM).

Example: To list the parts of an archive that have been uploaded in a multipart upload

# The example lists all the parts of a multipart upload.
resp=client.list_parts({account_id:"-",upload_id:"OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",vault_name:"examplevault",})resp.to_houtputsthefollowing:{archive_description:"archive description",creation_date:Time.parse("2012-03-20T17:03:43.221Z"),marker:"null",multipart_upload_id:"OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",part_size_in_bytes:4194304,parts:[{range_in_bytes:"0-4194303",sha256_tree_hash:"01d34dabf7be316472c93b1ef80721f5d4",},{range_in_bytes:"4194304-8388607",sha256_tree_hash:"0195875365afda349fc21c84c099987164",},],vault_arn:"arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault",}

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:upload_id(required, String)
—

The upload ID of the multipart upload.

:marker(String)
—

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.

:limit(Integer)
—

The maximum number of parts to be returned. The default limit is 50.
The number of parts returned might be fewer than the specified limit,
but the number of returned parts never exceeds the limit.

This operation lists the provisioned capacity units for the specified
AWS account.

Examples:

Example: To list the provisioned capacity units for an account

# The example lists the provisioned capacity units for an account.
resp=client.list_provisioned_capacity({account_id:"-",})resp.to_houtputsthefollowing:{provisioned_capacity_list:[{capacity_id:"zSaq7NzHFQDANTfQkDen4V7z",expiration_date:Time.parse("2016-12-12T00:00:00.000Z"),start_date:Time.parse("2016-11-11T20:11:51.095Z"),},{capacity_id:"yXaq7NzHFQNADTfQkDen4V7z",expiration_date:Time.parse("2017-01-15T00:00:00.000Z"),start_date:Time.parse("2016-12-13T20:11:51.095Z"),},],}

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 S3 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.

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 Tagging Amazon S3 Glacier Resources.

Examples:

Example: To list the tags for a vault

# The example lists all the tags attached to the vault examplevault.
resp=client.list_tags_for_vault({account_id:"-",vault_name:"examplevault",})resp.to_houtputsthefollowing:{tags:{"date"=>"july2015","id"=>"1234",},}

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 S3 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.

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 10 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
Access Control Using AWS Identity and Access Management (IAM).

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.

:marker(String)
—

A string used for pagination. The marker specifies the vault ARN after
which the listing of vaults should begin.

:limit(Integer)
—

The maximum number of vaults to be returned. The default limit is 10.
The number of vaults returned might be fewer than the specified limit,
but the number of returned vaults never exceeds the limit.

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 S3 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.

#remove_tags_from_vault(params = {}) ⇒ Struct

This operation removes one or more tags from the set of tags attached
to a vault. For more information about tags, see Tagging Amazon S3
Glacier Resources. This operation is idempotent. The operation
will be successful, even if there are no tags attached to the vault.

Examples:

Example: To remove tags from a vault

# The example removes two tags from the vault named examplevault.
resp=client.remove_tags_from_vault({tag_keys:["examplekey1","examplekey2",],account_id:"-",vault_name:"examplevault",})

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 S3 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.

#set_data_retrieval_policy(params = {}) ⇒ Struct

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 Amazon Glacier Data Retrieval
Policies.

Examples:

Example: To set and then enact a data retrieval policy

# The example sets and then enacts a data retrieval policy.
resp=client.set_data_retrieval_policy({policy:{rules:[{bytes_per_hour:10737418240,strategy:"BytesPerHour",},],},account_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.

#set_vault_access_policy(params = {}) ⇒ Struct

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 Amazon Glacier Access Control with Vault Access
Policies.

Examples:

Example: To set the access-policy on a vault

# The example configures an access policy for the vault named examplevault.
resp=client.set_vault_access_policy({account_id:"-",policy:{policy:"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}",},vault_name:"examplevault",})

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 S3 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.

#set_vault_notifications(params = {}) ⇒ Struct

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 S3 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.

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
Access Control Using AWS Identity and Access Management (IAM).

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 S3 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.

This operation adds an archive to a vault. This is a synchronous
operation, and for a successful upload, your data is durably
persisted. Amazon S3 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 S3 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 Computing
Checksums.

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
Access Control Using AWS Identity and Access Management (IAM).

# The example adds an archive to a vault.
resp=client.upload_archive({account_id:"-",archive_description:"",body:"example-data-to-upload",checksum:"",vault_name:"my-vault",})resp.to_houtputsthefollowing:{archive_id:"kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",checksum:"969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67",location:"/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",}

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 S3 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.

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 matchTo 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 S3 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 Computing Checksums.

Part size does not matchThe 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 alignThe 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
Access Control Using AWS Identity and Access Management (IAM).

# The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.
resp=client.upload_multipart_part({account_id:"-",body:"part1",checksum:"c06f7cd4baacb087002a99a5f48bf953",range:"bytes 0-1048575/*",upload_id:"19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",vault_name:"examplevault",})resp.to_houtputsthefollowing:{checksum:"c06f7cd4baacb087002a99a5f48bf953",}

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 S3 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.

:vault_name(required, String)
—

The name of the vault.

:upload_id(required, String)
—

The upload ID of the multipart upload.

:checksum(String)
—

The SHA256 tree hash of the data being uploaded.

:range(String)
—

Identifies the range of bytes in the assembled archive that will be
uploaded in this part. Amazon S3 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/*.