GlacierClient#
Auto-generated documentation for Glacier type annotations stubs module mypy-boto3-glacier.
GlacierClient#
Type annotations and code completion for boto3.client("glacier").
boto3 documentation
# GlacierClient usage example
from boto3.session import Session
from mypy_boto3_glacier.client import GlacierClient
def get_glacier_client() -> GlacierClient:
return Session().client("glacier")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("glacier").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("glacier")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.InsufficientCapacityException,
client.exceptions.InvalidParameterValueException,
client.exceptions.LimitExceededException,
client.exceptions.MissingParameterValueException,
client.exceptions.PolicyEnforcedException,
client.exceptions.RequestTimeoutException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceUnavailableException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_glacier.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...Methods#
abort_multipart_upload#
This operation aborts a multipart upload identified by the upload ID.
Type annotations and code completion for boto3.client("glacier").abort_multipart_upload method.
boto3 documentation
# abort_multipart_upload method definition
def abort_multipart_upload(
self,
*,
vaultName: str,
uploadId: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# abort_multipart_upload method usage example with argument unpacking
kwargs: AbortMultipartUploadInputRequestTypeDef = { # (1)
"vaultName": ...,
"uploadId": ...,
}
parent.abort_multipart_upload(**kwargs)abort_vault_lock#
This operation aborts the vault locking process if the vault lock is not in the
Locked
state.
Type annotations and code completion for boto3.client("glacier").abort_vault_lock method.
boto3 documentation
# abort_vault_lock method definition
def abort_vault_lock(
self,
*,
vaultName: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# abort_vault_lock method usage example with argument unpacking
kwargs: AbortVaultLockInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.abort_vault_lock(**kwargs)add_tags_to_vault#
This operation adds the specified tags to a vault.
Type annotations and code completion for boto3.client("glacier").add_tags_to_vault method.
boto3 documentation
# add_tags_to_vault method definition
def add_tags_to_vault(
self,
*,
vaultName: str,
accountId: str = '-',
Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# add_tags_to_vault method usage example with argument unpacking
kwargs: AddTagsToVaultInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.add_tags_to_vault(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("glacier").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("glacier").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...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.
Type annotations and code completion for boto3.client("glacier").complete_multipart_upload method.
boto3 documentation
# complete_multipart_upload method definition
def complete_multipart_upload(
self,
*,
vaultName: str,
uploadId: str,
accountId: str = '-',
archiveSize: str = ...,
checksum: str = ...,
) -> ArchiveCreationOutputTypeDef: # (1)
...# complete_multipart_upload method usage example with argument unpacking
kwargs: CompleteMultipartUploadInputRequestTypeDef = { # (1)
"vaultName": ...,
"uploadId": ...,
}
parent.complete_multipart_upload(**kwargs)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.
Type annotations and code completion for boto3.client("glacier").complete_vault_lock method.
boto3 documentation
# complete_vault_lock method definition
def complete_vault_lock(
self,
*,
vaultName: str,
lockId: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# complete_vault_lock method usage example with argument unpacking
kwargs: CompleteVaultLockInputRequestTypeDef = { # (1)
"vaultName": ...,
"lockId": ...,
}
parent.complete_vault_lock(**kwargs)create_vault#
This operation creates a new vault with the specified name.
Type annotations and code completion for boto3.client("glacier").create_vault method.
boto3 documentation
# create_vault method definition
def create_vault(
self,
*,
vaultName: str,
accountId: str = '-',
) -> CreateVaultOutputTypeDef: # (1)
...# create_vault method usage example with argument unpacking
kwargs: CreateVaultInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.create_vault(**kwargs)delete_archive#
This operation deletes an archive from a vault.
Type annotations and code completion for boto3.client("glacier").delete_archive method.
boto3 documentation
# delete_archive method definition
def delete_archive(
self,
*,
vaultName: str,
archiveId: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_archive method usage example with argument unpacking
kwargs: DeleteArchiveInputRequestTypeDef = { # (1)
"vaultName": ...,
"archiveId": ...,
}
parent.delete_archive(**kwargs)delete_vault#
This operation deletes a vault.
Type annotations and code completion for boto3.client("glacier").delete_vault method.
boto3 documentation
# delete_vault method definition
def delete_vault(
self,
*,
vaultName: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_vault method usage example with argument unpacking
kwargs: DeleteVaultInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.delete_vault(**kwargs)delete_vault_access_policy#
This operation deletes the access policy associated with the specified vault.
Type annotations and code completion for boto3.client("glacier").delete_vault_access_policy method.
boto3 documentation
# delete_vault_access_policy method definition
def delete_vault_access_policy(
self,
*,
vaultName: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_vault_access_policy method usage example with argument unpacking
kwargs: DeleteVaultAccessPolicyInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.delete_vault_access_policy(**kwargs)delete_vault_notifications#
This operation deletes the notification configuration set for a vault.
Type annotations and code completion for boto3.client("glacier").delete_vault_notifications method.
boto3 documentation
# delete_vault_notifications method definition
def delete_vault_notifications(
self,
*,
vaultName: str,
accountId: str = '-',
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_vault_notifications method usage example with argument unpacking
kwargs: DeleteVaultNotificationsInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.delete_vault_notifications(**kwargs)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.
Type annotations and code completion for boto3.client("glacier").describe_job method.
boto3 documentation
# describe_job method definition
def describe_job(
self,
*,
vaultName: str,
jobId: str,
accountId: str = '-',
) -> GlacierJobDescriptionResponseTypeDef: # (1)
...# describe_job method usage example with argument unpacking
kwargs: DescribeJobInputRequestTypeDef = { # (1)
"vaultName": ...,
"jobId": ...,
}
parent.describe_job(**kwargs)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.
Type annotations and code completion for boto3.client("glacier").describe_vault method.
boto3 documentation
# describe_vault method definition
def describe_vault(
self,
*,
vaultName: str,
accountId: str = '-',
) -> DescribeVaultResponseTypeDef: # (1)
...# describe_vault method usage example with argument unpacking
kwargs: DescribeVaultInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.describe_vault(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("glacier").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_data_retrieval_policy#
This operation returns the current data retrieval policy for the account and region specified in the GET request.
Type annotations and code completion for boto3.client("glacier").get_data_retrieval_policy method.
boto3 documentation
# get_data_retrieval_policy method definition
def get_data_retrieval_policy(
self,
*,
accountId: str = '-',
) -> GetDataRetrievalPolicyOutputTypeDef: # (1)
...# get_data_retrieval_policy method usage example with argument unpacking
kwargs: GetDataRetrievalPolicyInputRequestTypeDef = { # (1)
"accountId": ...,
}
parent.get_data_retrieval_policy(**kwargs)get_job_output#
This operation downloads the output of the job you initiated using InitiateJob.
Type annotations and code completion for boto3.client("glacier").get_job_output method.
boto3 documentation
# get_job_output method definition
def get_job_output(
self,
*,
vaultName: str,
jobId: str,
accountId: str = '-',
range: str = ...,
) -> GetJobOutputOutputTypeDef: # (1)
...# get_job_output method usage example with argument unpacking
kwargs: GetJobOutputInputRequestTypeDef = { # (1)
"vaultName": ...,
"jobId": ...,
}
parent.get_job_output(**kwargs)