GlacierClient#
Auto-generated documentation for Glacier type annotations stubs module types-aiobotocore-glacier.
GlacierClient#
Type annotations and code completion for session.create_client("glacier")
boto3 documentation
GlacierClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_glacier.client import GlacierClient
session = get_session()
async with session.create_client("glacier") as client:
client: GlacierClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("glacier").exceptions
structure.
GlacierClient.exceptions usage example
async with session.create_client("glacier") as client:
try:
do_something(client)
except (
client.ClientError,
client.InsufficientCapacityException,
client.InvalidParameterValueException,
client.LimitExceededException,
client.MissingParameterValueException,
client.PolicyEnforcedException,
client.RequestTimeoutException,
client.ResourceNotFoundException,
client.ServiceUnavailableException,
) as e:
print(e)
GlacierClient usage type checking example
from types_aiobotocore_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 session.create_client("glacier").abort_multipart_upload
method.
boto3 documentation
# abort_multipart_upload method definition
await 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 session.create_client("glacier").abort_vault_lock
method.
boto3 documentation
# abort_vault_lock method definition
await 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 session.create_client("glacier").add_tags_to_vault
method.
boto3 documentation
# add_tags_to_vault method definition
await 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 session.create_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 session.create_client("glacier").close
method.
boto3 documentation
# close method definition
await 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 session.create_client("glacier").complete_multipart_upload
method.
boto3 documentation
# complete_multipart_upload method definition
await 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 session.create_client("glacier").complete_vault_lock
method.
boto3 documentation
# complete_vault_lock method definition
await 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 session.create_client("glacier").create_vault
method.
boto3 documentation
# create_vault method definition
await 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 session.create_client("glacier").delete_archive
method.
boto3 documentation
# delete_archive method definition
await 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 session.create_client("glacier").delete_vault
method.
boto3 documentation
# delete_vault method definition
await 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 session.create_client("glacier").delete_vault_access_policy
method.
boto3 documentation
# delete_vault_access_policy method definition
await 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 session.create_client("glacier").delete_vault_notifications
method.
boto3 documentation
# delete_vault_notifications method definition
await 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 session.create_client("glacier").describe_job
method.
boto3 documentation
# describe_job method definition
await 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 session.create_client("glacier").describe_vault
method.
boto3 documentation
# describe_vault method definition
await 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 session.create_client("glacier").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("glacier").get_data_retrieval_policy
method.
boto3 documentation
# get_data_retrieval_policy method definition
await 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 session.create_client("glacier").get_job_output
method.
boto3 documentation
# get_job_output method definition
await 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)
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)_.
Type annotations and code completion for session.create_client("glacier").get_vault_access_policy
method.
boto3 documentation
# get_vault_access_policy method definition
await def get_vault_access_policy(
self,
*,
vaultName: str,
accountId: str = '-',
) -> GetVaultAccessPolicyOutputTypeDef: # (1)
...
# get_vault_access_policy method usage example with argument unpacking
kwargs: GetVaultAccessPolicyInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.get_vault_access_policy(**kwargs)
get_vault_lock#
This operation retrieves the following attributes from the lock-policy
subresource set on the specified vault: * The vault lock policy set on the
vault.
Type annotations and code completion for session.create_client("glacier").get_vault_lock
method.
boto3 documentation
# get_vault_lock method definition
await def get_vault_lock(
self,
*,
vaultName: str,
accountId: str = '-',
) -> GetVaultLockOutputTypeDef: # (1)
...
# get_vault_lock method usage example with argument unpacking
kwargs: GetVaultLockInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.get_vault_lock(**kwargs)
get_vault_notifications#
This operation retrieves the notification-configuration
subresource of the
specified vault.
Type annotations and code completion for session.create_client("glacier").get_vault_notifications
method.
boto3 documentation
# get_vault_notifications method definition
await def get_vault_notifications(
self,
*,
vaultName: str,
accountId: str = '-',
) -> GetVaultNotificationsOutputTypeDef: # (1)
...
# get_vault_notifications method usage example with argument unpacking
kwargs: GetVaultNotificationsInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.get_vault_notifications(**kwargs)
initiate_job#
This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval.
Type annotations and code completion for session.create_client("glacier").initiate_job
method.
boto3 documentation
# initiate_job method definition
await def initiate_job(
self,
*,
vaultName: str,
accountId: str = '-',
jobParameters: JobParametersTypeDef = ..., # (1)
) -> InitiateJobOutputTypeDef: # (2)
...
# initiate_job method usage example with argument unpacking
kwargs: InitiateJobInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.initiate_job(**kwargs)
initiate_multipart_upload#
This operation initiates a multipart upload.
Type annotations and code completion for session.create_client("glacier").initiate_multipart_upload
method.
boto3 documentation
# initiate_multipart_upload method definition
await def initiate_multipart_upload(
self,
*,
vaultName: str,
accountId: str = '-',
archiveDescription: str = ...,
partSize: str = ...,
) -> InitiateMultipartUploadOutputTypeDef: # (1)
...
# initiate_multipart_upload method usage example with argument unpacking
kwargs: InitiateMultipartUploadInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.initiate_multipart_upload(**kwargs)
initiate_vault_lock#
This operation initiates the vault locking process by doing the following: * Installing a vault lock policy on the specified vault.
Type annotations and code completion for session.create_client("glacier").initiate_vault_lock
method.
boto3 documentation
# initiate_vault_lock method definition
await def initiate_vault_lock(
self,
*,
vaultName: str,
accountId: str = '-',
policy: VaultLockPolicyTypeDef = ..., # (1)
) -> InitiateVaultLockOutputTypeDef: # (2)
...
# initiate_vault_lock method usage example with argument unpacking
kwargs: InitiateVaultLockInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.initiate_vault_lock(**kwargs)
list_jobs#
This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.
Type annotations and code completion for session.create_client("glacier").list_jobs
method.
boto3 documentation
# list_jobs method definition
await def list_jobs(
self,
*,
vaultName: str,
accountId: str = '-',
limit: str = ...,
marker: str = ...,
statuscode: str = ...,
completed: str = ...,
) -> ListJobsOutputTypeDef: # (1)
...
# list_jobs method usage example with argument unpacking
kwargs: ListJobsInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.list_jobs(**kwargs)
list_multipart_uploads#
This operation lists in-progress multipart uploads for the specified vault.
Type annotations and code completion for session.create_client("glacier").list_multipart_uploads
method.
boto3 documentation
# list_multipart_uploads method definition
await def list_multipart_uploads(
self,
*,
vaultName: str,
accountId: str = '-',
marker: str = ...,
limit: str = ...,
) -> ListMultipartUploadsOutputTypeDef: # (1)
...
# list_multipart_uploads method usage example with argument unpacking
kwargs: ListMultipartUploadsInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.list_multipart_uploads(**kwargs)
list_parts#
This operation lists the parts of an archive that have been uploaded in a specific multipart upload.
Type annotations and code completion for session.create_client("glacier").list_parts
method.
boto3 documentation
# list_parts method definition
await def list_parts(
self,
*,
vaultName: str,
uploadId: str,
accountId: str = '-',
marker: str = ...,
limit: str = ...,
) -> ListPartsOutputTypeDef: # (1)
...
# list_parts method usage example with argument unpacking
kwargs: ListPartsInputRequestTypeDef = { # (1)
"vaultName": ...,
"uploadId": ...,
}
parent.list_parts(**kwargs)
list_provisioned_capacity#
This operation lists the provisioned capacity units for the specified AWS account.
Type annotations and code completion for session.create_client("glacier").list_provisioned_capacity
method.
boto3 documentation
# list_provisioned_capacity method definition
await def list_provisioned_capacity(
self,
*,
accountId: str = '-',
) -> ListProvisionedCapacityOutputTypeDef: # (1)
...
# list_provisioned_capacity method usage example with argument unpacking
kwargs: ListProvisionedCapacityInputRequestTypeDef = { # (1)
"accountId": ...,
}
parent.list_provisioned_capacity(**kwargs)
list_tags_for_vault#
This operation lists all the tags attached to a vault.
Type annotations and code completion for session.create_client("glacier").list_tags_for_vault
method.
boto3 documentation
# list_tags_for_vault method definition
await def list_tags_for_vault(
self,
*,
vaultName: str,
accountId: str = '-',
) -> ListTagsForVaultOutputTypeDef: # (1)
...
# list_tags_for_vault method usage example with argument unpacking
kwargs: ListTagsForVaultInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.list_tags_for_vault(**kwargs)
list_vaults#
This operation lists all vaults owned by the calling user's account.
Type annotations and code completion for session.create_client("glacier").list_vaults
method.
boto3 documentation
# list_vaults method definition
await def list_vaults(
self,
*,
accountId: str = '-',
marker: str = ...,
limit: str = ...,
) -> ListVaultsOutputTypeDef: # (1)
...
# list_vaults method usage example with argument unpacking
kwargs: ListVaultsInputRequestTypeDef = { # (1)
"accountId": ...,
}
parent.list_vaults(**kwargs)
purchase_provisioned_capacity#
This operation purchases a provisioned capacity unit for an AWS account.
Type annotations and code completion for session.create_client("glacier").purchase_provisioned_capacity
method.
boto3 documentation
# purchase_provisioned_capacity method definition
await def purchase_provisioned_capacity(
self,
*,
accountId: str = '-',
) -> PurchaseProvisionedCapacityOutputTypeDef: # (1)
...
# purchase_provisioned_capacity method usage example with argument unpacking
kwargs: PurchaseProvisionedCapacityInputRequestTypeDef = { # (1)
"accountId": ...,
}
parent.purchase_provisioned_capacity(**kwargs)
remove_tags_from_vault#
This operation removes one or more tags from the set of tags attached to a vault.
Type annotations and code completion for session.create_client("glacier").remove_tags_from_vault
method.
boto3 documentation
# remove_tags_from_vault method definition
await def remove_tags_from_vault(
self,
*,
vaultName: str,
accountId: str = '-',
TagKeys: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# remove_tags_from_vault method usage example with argument unpacking
kwargs: RemoveTagsFromVaultInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.remove_tags_from_vault(**kwargs)
set_data_retrieval_policy#
This operation sets and then enacts a data retrieval policy in the region specified in the PUT request.
Type annotations and code completion for session.create_client("glacier").set_data_retrieval_policy
method.
boto3 documentation
# set_data_retrieval_policy method definition
await def set_data_retrieval_policy(
self,
*,
accountId: str = '-',
Policy: DataRetrievalPolicyTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# set_data_retrieval_policy method usage example with argument unpacking
kwargs: SetDataRetrievalPolicyInputRequestTypeDef = { # (1)
"accountId": ...,
}
parent.set_data_retrieval_policy(**kwargs)
set_vault_access_policy#
This operation configures an access policy for a vault and will overwrite an existing policy.
Type annotations and code completion for session.create_client("glacier").set_vault_access_policy
method.
boto3 documentation
# set_vault_access_policy method definition
await def set_vault_access_policy(
self,
*,
vaultName: str,
accountId: str = '-',
policy: VaultAccessPolicyTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# set_vault_access_policy method usage example with argument unpacking
kwargs: SetVaultAccessPolicyInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.set_vault_access_policy(**kwargs)
set_vault_notifications#
This operation configures notifications that will be sent when specific events happen to a vault.
Type annotations and code completion for session.create_client("glacier").set_vault_notifications
method.
boto3 documentation
# set_vault_notifications method definition
await def set_vault_notifications(
self,
*,
vaultName: str,
accountId: str = '-',
vaultNotificationConfig: VaultNotificationConfigTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# set_vault_notifications method usage example with argument unpacking
kwargs: SetVaultNotificationsInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.set_vault_notifications(**kwargs)
upload_archive#
This operation adds an archive to a vault.
Type annotations and code completion for session.create_client("glacier").upload_archive
method.
boto3 documentation
# upload_archive method definition
await def upload_archive(
self,
*,
vaultName: str,
accountId: str = '-',
archiveDescription: str = ...,
checksum: str = ...,
body: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> ArchiveCreationOutputTypeDef: # (1)
...
# upload_archive method usage example with argument unpacking
kwargs: UploadArchiveInputRequestTypeDef = { # (1)
"vaultName": ...,
}
parent.upload_archive(**kwargs)
upload_multipart_part#
This operation uploads a part of an archive.
Type annotations and code completion for session.create_client("glacier").upload_multipart_part
method.
boto3 documentation
# upload_multipart_part method definition
await def upload_multipart_part(
self,
*,
vaultName: str,
uploadId: str,
accountId: str = '-',
checksum: str = ...,
range: str = ...,
body: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> UploadMultipartPartOutputTypeDef: # (1)
...
# upload_multipart_part method usage example with argument unpacking
kwargs: UploadMultipartPartInputRequestTypeDef = { # (1)
"vaultName": ...,
"uploadId": ...,
}
parent.upload_multipart_part(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("glacier").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> GlacierClient:
...
__aexit__#
Type annotations and code completion for session.create_client("glacier").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("glacier").get_paginator
method with overloads.
client.get_paginator("list_jobs")
-> ListJobsPaginatorclient.get_paginator("list_multipart_uploads")
-> ListMultipartUploadsPaginatorclient.get_paginator("list_parts")
-> ListPartsPaginatorclient.get_paginator("list_vaults")
-> ListVaultsPaginator
get_waiter#
Type annotations and code completion for session.create_client("glacier").get_waiter
method with overloads.
client.get_waiter("vault_exists")
-> VaultExistsWaiterclient.get_waiter("vault_not_exists")
-> VaultNotExistsWaiter