GlacierServiceResource

Index > Glacier > GlacierServiceResource

Auto-generated documentation for Glacier type annotations stubs module mypy-boto3-glacier.

GlacierServiceResource

Type annotations and code completion for boto3.resource("glacier"), included resources and collections. boto3 documentation

# GlacierServiceResource usage example

from mypy_boto3_glacier.service_resource import GlacierServiceResource

def get_glacier_resource() -> GlacierServiceResource:
    return boto3.resource("glacier")

Attributes

• meta: GlacierResourceMeta

• vaults: ServiceResourceVaultsCollection

Collections

ServiceResourceVaultsCollection

Provides access to Vault resource.

Type annotations and code completion for boto3.resource("glacier").vaults collection. boto3 documentation

# ServiceResourceVaultsCollection usage example

from mypy_boto3_glacier.service_resource import ServiceResourceVaultsCollection

def get_collection() -> ServiceResourceVaultsCollection:
    return boto3.resource("glacier").vaults

Methods

GlacierServiceResource.Account method

Creates a Account resource.

Type annotations and code completion for boto3.resource("glacier").Account method. boto3 documentation

# Account method definition

def Account(
    self,
    id: str,
) -> Account:
    ...

GlacierServiceResource.Archive method

Creates a Archive resource.

Type annotations and code completion for boto3.resource("glacier").Archive method. boto3 documentation

# Archive method definition

def Archive(
    self,
    account_id: str,
    vault_name: str,
    id: str,
) -> Archive:
    ...

GlacierServiceResource.Job method

Creates a Job resource.

Type annotations and code completion for boto3.resource("glacier").Job method. boto3 documentation

# Job method definition

def Job(
    self,
    account_id: str,
    vault_name: str,
    id: str,
) -> Job:
    ...

GlacierServiceResource.MultipartUpload method

Creates a MultipartUpload resource.

Type annotations and code completion for boto3.resource("glacier").MultipartUpload method. boto3 documentation

# MultipartUpload method definition

def MultipartUpload(
    self,
    account_id: str,
    vault_name: str,
    id: str,
) -> MultipartUpload:
    ...

GlacierServiceResource.Notification method

Creates a Notification resource.

Type annotations and code completion for boto3.resource("glacier").Notification method. boto3 documentation

# Notification method definition

def Notification(
    self,
    account_id: str,
    vault_name: str,
) -> Notification:
    ...

GlacierServiceResource.Vault method

Creates a Vault resource.

Type annotations and code completion for boto3.resource("glacier").Vault method. boto3 documentation

# Vault method definition

def Vault(
    self,
    account_id: str,
    name: str,
) -> Vault:
    ...

GlacierServiceResource.create_vault method

This operation creates a new vault with the specified name.

Type annotations and code completion for boto3.resource("glacier").create_vault method. boto3 documentation

# create_vault method definition

def create_vault(
    self,
    *,
    vaultName: str,
    accountId: str = '-',
) -> Vault:
    ...

# create_vault method usage example with argument unpacking

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

parent.create_vault(**kwargs)

1. See CreateVaultInputServiceResourceCreateVaultTypeDef

GlacierServiceResource.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Account

Type annotations and code completion for boto3.resource("glacier").Account class. boto3 documentation

# Account usage example

from mypy_boto3_glacier.service_resource import Account

def get_resource() -> Account:
    return boto3.resource("glacier").Account(...)

Account attributes

• id: str
• vaults: AccountVaultsCollection

Account collections

Account.vaults

Provides access to Vault resource.

Type annotations and code completion for boto3.resource("glacier").Account(...).vaults collection. boto3 documentation

# AccountVaultsCollection usage example

from mypy_boto3_glacier.service_resource import AccountVaultsCollection

def get_collection() -> AccountVaultsCollection:
    resource = boto3.resource("glacier").Account(...)
    return resource.vaults

Account methods

Account.Vault method

Creates a Vault resource.

Type annotations and code completion for boto3.resource("glacier").Vault method. boto3 documentation

# Vault method definition

def Vault(
    self,
    name: str,
) -> Vault:
    ...

Account.create_vault method

This operation creates a new vault with the specified name.

Type annotations and code completion for boto3.resource("glacier").create_vault method. boto3 documentation

# create_vault method definition

def create_vault(
    self,
    *,
    vaultName: str,
) -> Vault:
    ...

# create_vault method usage example with argument unpacking

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

parent.create_vault(**kwargs)

1. See CreateVaultInputAccountCreateVaultTypeDef

Account.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Archive

Type annotations and code completion for boto3.resource("glacier").Archive class. boto3 documentation

# Archive usage example

from mypy_boto3_glacier.service_resource import Archive

def get_resource() -> Archive:
    return boto3.resource("glacier").Archive(...)

Archive attributes

• account_id: str
• vault_name: str
• id: str

Archive methods

Archive.Vault method

Creates a Vault resource.

Type annotations and code completion for boto3.resource("glacier").Vault method. boto3 documentation

# Vault method definition

def Vault(
    self,
) -> Vault:
    ...

Archive.delete method

This operation deletes an archive from a vault.

Type annotations and code completion for boto3.resource("glacier").delete method. boto3 documentation

# delete method definition

def delete(
    self,
) -> None:
    ...

Archive.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Archive.initiate_archive_retrieval method

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 boto3.resource("glacier").initiate_archive_retrieval method. boto3 documentation

# initiate_archive_retrieval method definition

def initiate_archive_retrieval(
    self,
) -> Job:
    ...

Job

Type annotations and code completion for boto3.resource("glacier").Job class. boto3 documentation

# Job usage example

from mypy_boto3_glacier.service_resource import Job

def get_resource() -> Job:
    return boto3.resource("glacier").Job(...)

Job attributes

• job_id: str
• job_description: str
• action: ActionCodeType
• archive_id: str
• vault_arn: str
• creation_date: str
• completed: bool
• status_code: StatusCodeType
• status_message: str
• archive_size_in_bytes: int
• inventory_size_in_bytes: int
• sns_topic: str
• completion_date: str
• sha256_tree_hash: str
• archive_sha256_tree_hash: str
• retrieval_byte_range: str
• tier: str
• inventory_retrieval_parameters: InventoryRetrievalJobDescriptionResponseMetadataTypeDef
• job_output_path: str
• select_parameters: SelectParametersResponseMetadataTypeDef
• output_location: OutputLocationResponseMetadataTypeDef
• account_id: str
• vault_name: str
• id: str

Job methods

Job.Vault method

Creates a Vault resource.

Type annotations and code completion for boto3.resource("glacier").Vault method. boto3 documentation

# Vault method definition

def Vault(
    self,
) -> Vault:
    ...

Job.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Job.get_output method

This operation downloads the output of the job you initiated using InitiateJob.

Type annotations and code completion for boto3.resource("glacier").get_output method. boto3 documentation

# get_output method definition

def get_output(
    self,
    *,
    range: str = ...,
) -> GetJobOutputOutputTypeDef:  # (1)
    ...

1. See GetJobOutputOutputTypeDef

# get_output method usage example with argument unpacking

kwargs: GetJobOutputInputJobGetOutputTypeDef = {  # (1)
    "range": ...,
}

parent.get_output(**kwargs)

1. See GetJobOutputInputJobGetOutputTypeDef

Job.load method

Calls meth:Glacier.Client.describe_job to update the attributes of the Job resource.

Type annotations and code completion for boto3.resource("glacier").load method. boto3 documentation

# load method definition

def load(
    self,
) -> None:
    ...

Job.reload method

Calls meth:Glacier.Client.describe_job to update the attributes of the Job resource.

Type annotations and code completion for boto3.resource("glacier").reload method. boto3 documentation

# reload method definition

def reload(
    self,
) -> None:
    ...

MultipartUpload

Type annotations and code completion for boto3.resource("glacier").MultipartUpload class. boto3 documentation

# MultipartUpload usage example

from mypy_boto3_glacier.service_resource import MultipartUpload

def get_resource() -> MultipartUpload:
    return boto3.resource("glacier").MultipartUpload(...)

MultipartUpload attributes

• multipart_upload_id: str
• vault_arn: str
• archive_description: str
• part_size_in_bytes: int
• creation_date: str
• account_id: str
• vault_name: str
• id: str

MultipartUpload methods

MultipartUpload.Vault method

Creates a Vault resource.

Type annotations and code completion for boto3.resource("glacier").Vault method. boto3 documentation

# Vault method definition

def Vault(
    self,
) -> Vault:
    ...

MultipartUpload.abort method

This operation aborts a multipart upload identified by the upload ID.

Type annotations and code completion for boto3.resource("glacier").abort method. boto3 documentation

# abort method definition

def abort(
    self,
) -> None:
    ...

MultipartUpload.complete method

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.resource("glacier").complete method. boto3 documentation

# complete method definition

def complete(
    self,
    *,
    archiveSize: str = ...,
    checksum: str = ...,
) -> ArchiveCreationOutputTypeDef:  # (1)
    ...

1. See ArchiveCreationOutputTypeDef

# complete method usage example with argument unpacking

kwargs: CompleteMultipartUploadInputMultipartUploadCompleteTypeDef = {  # (1)
    "archiveSize": ...,
}

parent.complete(**kwargs)

1. See CompleteMultipartUploadInputMultipartUploadCompleteTypeDef

MultipartUpload.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

MultipartUpload.parts method

This operation lists the parts of an archive that have been uploaded in a specific multipart upload.

Type annotations and code completion for boto3.resource("glacier").parts method. boto3 documentation

# parts method definition

def parts(
    self,
    *,
    marker: str = ...,
    limit: str = ...,
) -> ListPartsOutputTypeDef:  # (1)
    ...

1. See ListPartsOutputTypeDef

# parts method usage example with argument unpacking

kwargs: ListPartsInputMultipartUploadPartsTypeDef = {  # (1)
    "marker": ...,
}

parent.parts(**kwargs)

1. See ListPartsInputMultipartUploadPartsTypeDef

MultipartUpload.upload_part method

This operation uploads a part of an archive.

Type annotations and code completion for boto3.resource("glacier").upload_part method. boto3 documentation

# upload_part method definition

def upload_part(
    self,
    *,
    checksum: str = ...,
    range: str = ...,
    body: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> UploadMultipartPartOutputTypeDef:  # (1)
    ...

1. See UploadMultipartPartOutputTypeDef

# upload_part method usage example with argument unpacking

kwargs: UploadMultipartPartInputMultipartUploadUploadPartTypeDef = {  # (1)
    "checksum": ...,
}

parent.upload_part(**kwargs)

1. See UploadMultipartPartInputMultipartUploadUploadPartTypeDef

Notification

Type annotations and code completion for boto3.resource("glacier").Notification class. boto3 documentation

# Notification usage example

from mypy_boto3_glacier.service_resource import Notification

def get_resource() -> Notification:
    return boto3.resource("glacier").Notification(...)

Notification attributes

• sns_topic: str
• events: List[str]
• account_id: str
• vault_name: str

Notification methods

Notification.Vault method

Creates a Vault resource.

Type annotations and code completion for boto3.resource("glacier").Vault method. boto3 documentation

# Vault method definition

def Vault(
    self,
) -> Vault:
    ...

Notification.delete method

This operation deletes the notification configuration set for a vault.

Type annotations and code completion for boto3.resource("glacier").delete method. boto3 documentation

# delete method definition

def delete(
    self,
) -> None:
    ...

Notification.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Notification.load method

Calls meth:Glacier.Client.get_vault_notifications to update the attributes of the Notification resource.

Type annotations and code completion for boto3.resource("glacier").load method. boto3 documentation

# load method definition

def load(
    self,
) -> None:
    ...

Notification.reload method

Calls meth:Glacier.Client.get_vault_notifications to update the attributes of the Notification resource.

Type annotations and code completion for boto3.resource("glacier").reload method. boto3 documentation

# reload method definition

def reload(
    self,
) -> None:
    ...

Notification.set method

This operation configures notifications that will be sent when specific events happen to a vault.

Type annotations and code completion for boto3.resource("glacier").set method. boto3 documentation

# set method definition

def set(
    self,
    *,
    vaultNotificationConfig: VaultNotificationConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See VaultNotificationConfigTypeDef

# set method usage example with argument unpacking

kwargs: SetVaultNotificationsInputNotificationSetTypeDef = {  # (1)
    "vaultNotificationConfig": ...,
}

parent.set(**kwargs)

1. See SetVaultNotificationsInputNotificationSetTypeDef

Vault

Type annotations and code completion for boto3.resource("glacier").Vault class. boto3 documentation

# Vault usage example

from mypy_boto3_glacier.service_resource import Vault

def get_resource() -> Vault:
    return boto3.resource("glacier").Vault(...)

Vault attributes

• vault_arn: str
• vault_name: str
• creation_date: str
• last_inventory_date: str
• number_of_archives: int
• size_in_bytes: int
• account_id: str
• name: str
• completed_jobs: VaultCompletedJobsCollection
• failed_jobs: VaultFailedJobsCollection
• jobs: VaultJobsCollection
• jobs_in_progress: VaultJobsInProgressCollection
• multipart_uplaods: VaultMultipartUplaodsCollection
• multipart_uploads: VaultMultipartUploadsCollection
• succeeded_jobs: VaultSucceededJobsCollection

Vault collections

Vault.completed_jobs

Provides access to Job resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).completed_jobs collection. boto3 documentation

# VaultCompletedJobsCollection usage example

from mypy_boto3_glacier.service_resource import VaultCompletedJobsCollection

def get_collection() -> VaultCompletedJobsCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.completed_jobs

Vault.failed_jobs

Provides access to Job resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).failed_jobs collection. boto3 documentation

# VaultFailedJobsCollection usage example

from mypy_boto3_glacier.service_resource import VaultFailedJobsCollection

def get_collection() -> VaultFailedJobsCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.failed_jobs

Vault.jobs

Provides access to Job resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).jobs collection. boto3 documentation

# VaultJobsCollection usage example

from mypy_boto3_glacier.service_resource import VaultJobsCollection

def get_collection() -> VaultJobsCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.jobs

Vault.jobs_in_progress

Provides access to Job resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).jobs_in_progress collection. boto3 documentation

# VaultJobsInProgressCollection usage example

from mypy_boto3_glacier.service_resource import VaultJobsInProgressCollection

def get_collection() -> VaultJobsInProgressCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.jobs_in_progress

Vault.multipart_uplaods

Provides access to MultipartUpload resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).multipart_uplaods collection. boto3 documentation

# VaultMultipartUplaodsCollection usage example

from mypy_boto3_glacier.service_resource import VaultMultipartUplaodsCollection

def get_collection() -> VaultMultipartUplaodsCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.multipart_uplaods

Vault.multipart_uploads

Provides access to MultipartUpload resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).multipart_uploads collection. boto3 documentation

# VaultMultipartUploadsCollection usage example

from mypy_boto3_glacier.service_resource import VaultMultipartUploadsCollection

def get_collection() -> VaultMultipartUploadsCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.multipart_uploads

Vault.succeeded_jobs

Provides access to Job resource.

Type annotations and code completion for boto3.resource("glacier").Vault(...).succeeded_jobs collection. boto3 documentation

# VaultSucceededJobsCollection usage example

from mypy_boto3_glacier.service_resource import VaultSucceededJobsCollection

def get_collection() -> VaultSucceededJobsCollection:
    resource = boto3.resource("glacier").Vault(...)
    return resource.succeeded_jobs

Vault methods

Vault.Account method

Creates a Account resource.

Type annotations and code completion for boto3.resource("glacier").Account method. boto3 documentation

# Account method definition

def Account(
    self,
) -> Account:
    ...

Vault.Archive method

Creates a Archive resource.

Type annotations and code completion for boto3.resource("glacier").Archive method. boto3 documentation

# Archive method definition

def Archive(
    self,
    id: str,
) -> Archive:
    ...

Vault.Job method

Creates a Job resource.

Type annotations and code completion for boto3.resource("glacier").Job method. boto3 documentation

# Job method definition

def Job(
    self,
    id: str,
) -> Job:
    ...

Vault.MultipartUpload method

Creates a MultipartUpload resource.

Type annotations and code completion for boto3.resource("glacier").MultipartUpload method. boto3 documentation

# MultipartUpload method definition

def MultipartUpload(
    self,
    id: str,
) -> MultipartUpload:
    ...

Vault.Notification method

Creates a Notification resource.

Type annotations and code completion for boto3.resource("glacier").Notification method. boto3 documentation

# Notification method definition

def Notification(
    self,
) -> Notification:
    ...

Vault.create method

This operation creates a new vault with the specified name.

Type annotations and code completion for boto3.resource("glacier").create method. boto3 documentation

# create method definition

def create(
    self,
) -> CreateVaultOutputTypeDef:  # (1)
    ...

1. See CreateVaultOutputTypeDef

Vault.delete method

This operation deletes a vault.

Type annotations and code completion for boto3.resource("glacier").delete method. boto3 documentation

# delete method definition

def delete(
    self,
) -> None:
    ...

Vault.get_available_subresources method

Returns a list of all the available sub-resources for this Resource.

Type annotations and code completion for boto3.resource("glacier").get_available_subresources method. boto3 documentation

# get_available_subresources method definition

def get_available_subresources(
    self,
) -> Sequence[str]:
    ...

Vault.initiate_inventory_retrieval method

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 boto3.resource("glacier").initiate_inventory_retrieval method. boto3 documentation

# initiate_inventory_retrieval method definition

def initiate_inventory_retrieval(
    self,
) -> Job:
    ...

Vault.initiate_multipart_upload method

This operation initiates a multipart upload.

Type annotations and code completion for boto3.resource("glacier").initiate_multipart_upload method. boto3 documentation

# initiate_multipart_upload method definition

def initiate_multipart_upload(
    self,
    *,
    archiveDescription: str = ...,
    partSize: str = ...,
) -> MultipartUpload:
    ...

# initiate_multipart_upload method usage example with argument unpacking

kwargs: InitiateMultipartUploadInputVaultInitiateMultipartUploadTypeDef = {  # (1)
    "archiveDescription": ...,
}

parent.initiate_multipart_upload(**kwargs)

1. See InitiateMultipartUploadInputVaultInitiateMultipartUploadTypeDef

Vault.load method

Calls meth:Glacier.Client.describe_vault to update the attributes of the Vault resource.

Type annotations and code completion for boto3.resource("glacier").load method. boto3 documentation

# load method definition

def load(
    self,
) -> None:
    ...

Vault.reload method

Calls meth:Glacier.Client.describe_vault to update the attributes of the Vault resource.

Type annotations and code completion for boto3.resource("glacier").reload method. boto3 documentation

# reload method definition

def reload(
    self,
) -> None:
    ...

Vault.upload_archive method

This operation adds an archive to a vault.

Type annotations and code completion for boto3.resource("glacier").upload_archive method. boto3 documentation

# upload_archive method definition

def upload_archive(
    self,
    *,
    archiveDescription: str = ...,
    checksum: str = ...,
    body: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> Archive:
    ...

# upload_archive method usage example with argument unpacking

kwargs: UploadArchiveInputVaultUploadArchiveTypeDef = {  # (1)
    "archiveDescription": ...,
}

parent.upload_archive(**kwargs)

1. See UploadArchiveInputVaultUploadArchiveTypeDef