GlacierServiceResource

Index > Glacier > GlacierServiceResource

Auto-generated documentation for Glacier type annotations stubs module types-aiobotocore-glacier.

GlacierServiceResource

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_glacier.service_resource import GlacierServiceResource

session = Session()
async with session.resource("glacier") as resource:
    resource: GlacierServiceResource

Attributes

• meta: GlacierResourceMeta

• vaults: ServiceResourceVaultsCollection

Collections

ServiceResourceVaultsCollection

Provides access to Vault resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import ServiceResourceVaultsCollection,

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

Methods

GlacierServiceResource.Account method

Creates a Account resource.

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

Method definition

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

Usage example with kwargs

kwargs: ServiceResourceAccountRequestTypeDef = {  # (1)
    "id": ...,
}

parent.Account(**kwargs)

1. See ServiceResourceAccountRequestTypeDef

GlacierServiceResource.Archive method

Creates a Archive resource.

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

Method definition

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

Usage example with kwargs

kwargs: ServiceResourceArchiveRequestTypeDef = {  # (1)
    "account_id": ...,
    "vault_name": ...,
    "id": ...,
}

parent.Archive(**kwargs)

1. See ServiceResourceArchiveRequestTypeDef

GlacierServiceResource.Job method

Creates a Job resource.

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

Method definition

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

Usage example with kwargs

kwargs: ServiceResourceJobRequestTypeDef = {  # (1)
    "account_id": ...,
    "vault_name": ...,
    "id": ...,
}

parent.Job(**kwargs)

1. See ServiceResourceJobRequestTypeDef

GlacierServiceResource.MultipartUpload method

Creates a MultipartUpload resource.

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

Method definition

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

Usage example with kwargs

kwargs: ServiceResourceMultipartUploadRequestTypeDef = {  # (1)
    "account_id": ...,
    "vault_name": ...,
    "id": ...,
}

parent.MultipartUpload(**kwargs)

1. See ServiceResourceMultipartUploadRequestTypeDef

GlacierServiceResource.Notification method

Creates a Notification resource.

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

Method definition

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

Usage example with kwargs

kwargs: ServiceResourceNotificationRequestTypeDef = {  # (1)
    "account_id": ...,
    "vault_name": ...,
}

parent.Notification(**kwargs)

1. See ServiceResourceNotificationRequestTypeDef

GlacierServiceResource.Vault method

Creates a Vault resource.

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

Method definition

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

Usage example with kwargs

kwargs: ServiceResourceVaultRequestTypeDef = {  # (1)
    "account_id": ...,
    "name": ...,
}

parent.Vault(**kwargs)

1. See ServiceResourceVaultRequestTypeDef

GlacierServiceResource.create_vault method

This operation creates a new vault with the specified name.

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

Method definition

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

Usage example with kwargs

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

Method definition

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

Account

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

Usage example

from types_aiobotocore_glacier.service_resource import Account


async def get_resource() -> Account:
    async with session.resource("glacier") as resource:
        return await resource.Account(...)

Account attributes

• id: str
• vaults: AccountVaultsCollection

Account collections

Account.vaults

Provides access to Vault resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import AccountVaultsCollection,

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

Account methods

Account.Vault method

Creates a Vault resource.

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

Method definition

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

Usage example with kwargs

kwargs: AccountVaultRequestTypeDef = {  # (1)
    "name": ...,
}

parent.Vault(**kwargs)

1. See AccountVaultRequestTypeDef

Account.create_vault method

This operation creates a new vault with the specified name.

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

Method definition

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

Usage example with kwargs

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

Method definition

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

Archive

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

Usage example

from types_aiobotocore_glacier.service_resource import Archive


async def get_resource() -> Archive:
    async with session.resource("glacier") as resource:
        return await resource.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 aioboto3.resource("glacier").Vault method. boto3 documentation

Method definition

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

Archive.delete method

This operation deletes an archive from a vault.

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

Method definition

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

Method definition

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

Method definition

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

Job

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

Usage example

from types_aiobotocore_glacier.service_resource import Job


async def get_resource() -> Job:
    async with session.resource("glacier") as resource:
        return await resource.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 aioboto3.resource("glacier").Vault method. boto3 documentation

Method definition

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

Method definition

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

Method definition

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

1. See GetJobOutputOutputTypeDef

Usage example with kwargs

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

Method definition

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

Method definition

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

MultipartUpload

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

Usage example

from types_aiobotocore_glacier.service_resource import MultipartUpload


async def get_resource() -> MultipartUpload:
    async with session.resource("glacier") as resource:
        return await resource.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 aioboto3.resource("glacier").Vault method. boto3 documentation

Method definition

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

MultipartUpload.abort method

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

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

Method definition

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

Method definition

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

1. See ArchiveCreationOutputTypeDef

Usage example with kwargs

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

Method definition

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

Method definition

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

1. See ListPartsOutputTypeDef

Usage example with kwargs

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

Method definition

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

1. See UploadMultipartPartOutputTypeDef

Usage example with kwargs

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

parent.upload_part(**kwargs)

1. See UploadMultipartPartInputMultipartUploadUploadPartTypeDef

Notification

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

Usage example

from types_aiobotocore_glacier.service_resource import Notification


async def get_resource() -> Notification:
    async with session.resource("glacier") as resource:
        return await resource.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 aioboto3.resource("glacier").Vault method. boto3 documentation

Method definition

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

Notification.delete method

This operation deletes the notification configuration set for a vault.

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

Method definition

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

Method definition

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

Method definition

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

Method definition

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

Method definition

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

1. See VaultNotificationConfigTypeDef

Usage example with kwargs

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

parent.set(**kwargs)

1. See SetVaultNotificationsInputNotificationSetTypeDef

Vault

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

Usage example

from types_aiobotocore_glacier.service_resource import Vault


async def get_resource() -> Vault:
    async with session.resource("glacier") as resource:
        return await resource.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 session.resource("glacier").Vault(...).completed_jobs collection. boto3 documentation

Usage example

from types_aiobotocore_glacier.service_resource import VaultCompletedJobsCollection,

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

Vault.failed_jobs

Provides access to Job resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import VaultFailedJobsCollection,

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

Vault.jobs

Provides access to Job resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import VaultJobsCollection,

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

Vault.jobs_in_progress

Provides access to Job resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import VaultJobsInProgressCollection,

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

Vault.multipart_uplaods

Provides access to MultipartUpload resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import VaultMultipartUplaodsCollection,

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

Vault.multipart_uploads

Provides access to MultipartUpload resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import VaultMultipartUploadsCollection,

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

Vault.succeeded_jobs

Provides access to Job resource.

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

Usage example

from types_aiobotocore_glacier.service_resource import VaultSucceededJobsCollection,

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

Vault methods

Vault.Account method

Creates a Account resource.

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

Method definition

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

Vault.Archive method

Creates a Archive resource.

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

Method definition

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

Usage example with kwargs

kwargs: VaultArchiveRequestTypeDef = {  # (1)
    "id": ...,
}

parent.Archive(**kwargs)

1. See VaultArchiveRequestTypeDef

Vault.Job method

Creates a Job resource.

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

Method definition

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

Usage example with kwargs

kwargs: VaultJobRequestTypeDef = {  # (1)
    "id": ...,
}

parent.Job(**kwargs)

1. See VaultJobRequestTypeDef

Vault.MultipartUpload method

Creates a MultipartUpload resource.

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

Method definition

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

Usage example with kwargs

kwargs: VaultMultipartUploadRequestTypeDef = {  # (1)
    "id": ...,
}

parent.MultipartUpload(**kwargs)

1. See VaultMultipartUploadRequestTypeDef

Vault.Notification method

Creates a Notification resource.

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

Method definition

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

Vault.create method

This operation creates a new vault with the specified name.

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

Method definition

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

1. See CreateVaultOutputTypeDef

Vault.delete method

This operation deletes a vault.

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

Method definition

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

Method definition

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

Method definition

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

Vault.initiate_multipart_upload method

This operation initiates a multipart upload.

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

Method definition

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

Usage example with kwargs

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

Method definition

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

Method definition

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

Vault.upload_archive method

This operation adds an archive to a vault.

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

Method definition

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

Usage example with kwargs

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

parent.upload_archive(**kwargs)

1. See UploadArchiveInputVaultUploadArchiveTypeDef