Skip to content

GlacierClient#

Index > Glacier > 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)
    ...
  1. See EmptyResponseMetadataTypeDef
# abort_multipart_upload method usage example with argument unpacking

kwargs: AbortMultipartUploadInputRequestTypeDef = {  # (1)
    "vaultName": ...,
    "uploadId": ...,
}

parent.abort_multipart_upload(**kwargs)
  1. See AbortMultipartUploadInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# abort_vault_lock method usage example with argument unpacking

kwargs: AbortVaultLockInputRequestTypeDef = {  # (1)
    "vaultName": ...,
}

parent.abort_vault_lock(**kwargs)
  1. See AbortVaultLockInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# add_tags_to_vault method usage example with argument unpacking

kwargs: AddTagsToVaultInputRequestTypeDef = {  # (1)
    "vaultName": ...,
}

parent.add_tags_to_vault(**kwargs)
  1. See AddTagsToVaultInputRequestTypeDef

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)
    ...
  1. See ArchiveCreationOutputTypeDef
# complete_multipart_upload method usage example with argument unpacking

kwargs: CompleteMultipartUploadInputRequestTypeDef = {  # (1)
    "vaultName": ...,
    "uploadId": ...,
}

parent.complete_multipart_upload(**kwargs)
  1. See CompleteMultipartUploadInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# complete_vault_lock method usage example with argument unpacking

kwargs: CompleteVaultLockInputRequestTypeDef = {  # (1)
    "vaultName": ...,
    "lockId": ...,
}

parent.complete_vault_lock(**kwargs)
  1. See CompleteVaultLockInputRequestTypeDef

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)
    ...
  1. See CreateVaultOutputTypeDef
# create_vault method usage example with argument unpacking

kwargs: CreateVaultInputRequestTypeDef = {  # (1)
    "vaultName": ...,
}

parent.create_vault(**kwargs)
  1. See CreateVaultInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_archive method usage example with argument unpacking

kwargs: DeleteArchiveInputRequestTypeDef = {  # (1)
    "vaultName": ...,
    "archiveId": ...,
}

parent.delete_archive(**kwargs)
  1. See DeleteArchiveInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_vault method usage example with argument unpacking

kwargs: DeleteVaultInputRequestTypeDef = {  # (1)
    "vaultName": ...,
}

parent.delete_vault(**kwargs)
  1. See DeleteVaultInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_vault_access_policy method usage example with argument unpacking

kwargs: DeleteVaultAccessPolicyInputRequestTypeDef = {  # (1)
    "vaultName": ...,
}

parent.delete_vault_access_policy(**kwargs)
  1. See DeleteVaultAccessPolicyInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_vault_notifications method usage example with argument unpacking

kwargs: DeleteVaultNotificationsInputRequestTypeDef = {  # (1)
    "vaultName": ...,
}

parent.delete_vault_notifications(**kwargs)
  1. See DeleteVaultNotificationsInputRequestTypeDef

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)
    ...
  1. See GlacierJobDescriptionResponseTypeDef
# describe_job method usage example with argument unpacking

kwargs: DescribeJobInputRequestTypeDef = {  # (1)
    "vaultName": ...,
    "jobId": ...,
}

parent.describe_job(**kwargs)
  1. See DescribeJobInputRequestTypeDef

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.