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
# GlacierServiceResource usage example
from types_aiobotocore_glacier.service_resource import GlacierServiceResource
def get_glacier_resource() -> GlacierServiceResource:
return session.resource("glacier")
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
# ServiceResourceVaultsCollection 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
# Account method definition
await def Account(
self,
id: str,
) -> Account:
...
GlacierServiceResource.Archive method#
Creates a Archive resource.
Type annotations and code completion for session.resource("glacier").Archive
method.
boto3 documentation
# Archive method definition
await 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 session.resource("glacier").Job
method.
boto3 documentation
# Job method definition
await 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 session.resource("glacier").MultipartUpload
method.
boto3 documentation
# MultipartUpload method definition
await 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 session.resource("glacier").Notification
method.
boto3 documentation
# Notification method definition
await def Notification(
self,
account_id: str,
vault_name: str,
) -> Notification:
...
GlacierServiceResource.Vault method#
Creates a Vault resource.
Type annotations and code completion for session.resource("glacier").Vault
method.
boto3 documentation
# Vault method definition
await 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 session.resource("glacier").create_vault
method.
boto3 documentation
# create_vault method definition
await 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)
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
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Account#
Type annotations and code completion for session.resource("glacier").Account
class.
boto3 documentation
# Account usage example
from types_aiobotocore_glacier.service_resource import Account
def get_resource() -> Account:
return session.resource("glacier").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
# AccountVaultsCollection 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 aiobotocore.resource("glacier").Vault
method.
boto3 documentation
# Vault method definition
await 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 aiobotocore.resource("glacier").create_vault
method.
boto3 documentation
# create_vault method definition
await def create_vault(
self,
*,
vaultName: str,
) -> Vault:
...
# create_vault method usage example with argument unpacking
kwargs: CreateVaultInputAccountCreateVaultTypeDef = { # (1)
"vaultName": ...,
}
parent.create_vault(**kwargs)
Account.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("glacier").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
await def get_available_subresources(
self,
) -> Sequence[str]:
...
Archive#
Type annotations and code completion for session.resource("glacier").Archive
class.
boto3 documentation
# Archive usage example
from types_aiobotocore_glacier.service_resource import Archive
def get_resource() -> Archive:
return session.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 aiobotocore.resource("glacier").Vault
method.
boto3 documentation
# Vault method definition
await def Vault(
self,
) -> Vault:
...
Archive.delete method#
This operation deletes an archive from a vault.
Type annotations and code completion for aiobotocore.resource("glacier").delete
method.
boto3 documentation
# delete 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 aiobotocore.resource("glacier").get_available_subresources
method.
boto3 documentation
# get_available_subresources 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 aiobotocore.resource("glacier").initiate_archive_retrieval
method.
boto3 documentation
# initiate_archive_retrieval method definition
await def initiate_archive_retrieval(
self,
) -> Job:
...
Job#
Type annotations and code completion for session.resource("glacier").Job
class.
boto3 documentation
# Job usage example
from types_aiobotocore_glacier.service_resource import Job
def get_resource() -> Job:
return session.resource("glacier").Job(...)
Job attributes#
job_id
:Awaitable
[str
]job_description
:Awaitable
[str
]action
:Awaitable
[ActionCodeType]archive_id
:Awaitable
[str
]vault_arn
:Awaitable
[str
]creation_date
:Awaitable
[str
]completed
:Awaitable
[bool
]status_code
:Awaitable
[StatusCodeType]status_message
:Awaitable
[str
]archive_size_in_bytes
:Awaitable
[int
]inventory_size_in_bytes
:Awaitable
[int
]sns_topic
:Awaitable
[str
]completion_date
:Awaitable
[str
]sha256_tree_hash
:Awaitable
[str
]archive_sha256_tree_hash
:Awaitable
[str
]retrieval_byte_range
:Awaitable
[str
]tier
:Awaitable
[str
]inventory_retrieval_parameters
:Awaitable
[InventoryRetrievalJobDescriptionResponseTypeDef]job_output_path
:Awaitable
[str
]select_parameters
:Awaitable
[SelectParametersResponseTypeDef]output_location
:Awaitable
[OutputLocationResponseTypeDef]account_id
:str
vault_name
:str
id
:str
Job methods#
Job.Vault method#
Creates a Vault resource.
Type annotations and code completion for aiobotocore.resource("glacier").Vault
method.
boto3 documentation
# Vault 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 aiobotocore.resource("glacier").get_available_subresources
method.
boto3 documentation
# get_available_subresources 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 aiobotocore.resource("glacier").get_output
method.
boto3 documentation
# get_output method definition
await def get_output(
self,
*,
range: str = ...,
) -> GetJobOutputOutputTypeDef: # (1)
...
# get_output method usage example with argument unpacking
kwargs: GetJobOutputInputJobGetOutputTypeDef = { # (1)
"range": ...,
}
parent.get_output(**kwargs)
Job.load method#
Calls meth:Glacier.Client.describe_job
to update the attributes of the Job
resource.
Type annotations and code completion for aiobotocore.resource("glacier").load
method.
boto3 documentation
# load 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 aiobotocore.resource("glacier").reload
method.
boto3 documentation
# reload method definition
await def reload(
self,
) -> None:
...
MultipartUpload#
Type annotations and code completion for session.resource("glacier").MultipartUpload
class.
boto3 documentation
# MultipartUpload usage example
from types_aiobotocore_glacier.service_resource import MultipartUpload
def get_resource() -> MultipartUpload:
return session.resource("glacier").MultipartUpload(...)
MultipartUpload attributes#
multipart_upload_id
:Awaitable
[str
]vault_arn
:Awaitable
[str
]archive_description
:Awaitable
[str
]part_size_in_bytes
:Awaitable
[int
]creation_date
:Awaitable
[str
]account_id
:str
vault_name
:str
id
:str
MultipartUpload methods#
MultipartUpload.Vault method#
Creates a Vault resource.
Type annotations and code completion for aiobotocore.resource("glacier").Vault
method.
boto3 documentation
# Vault 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 aiobotocore.resource("glacier").abort
method.
boto3 documentation
# abort 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 aiobotocore.resource("glacier").complete
method.
boto3 documentation
# complete method definition
await def complete(
self,
*,
archiveSize: str = ...,
checksum: str = ...,
) -> ArchiveCreationOutputTypeDef: # (1)
...
# complete method usage example with argument unpacking
kwargs: CompleteMultipartUploadInputMultipartUploadCompleteTypeDef = { # (1)
"archiveSize": ...,
}
parent.complete(**kwargs)
MultipartUpload.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for aiobotocore.resource("glacier").get_available_subresources
method.
boto3 documentation
# get_available_subresources 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 aiobotocore.resource("glacier").parts
method.
boto3 documentation
# parts method definition
await def parts(
self,
*,
marker: str = ...,
limit: str = ...,
) -> ListPartsOutputTypeDef: # (1)
...
# parts method usage example with argument unpacking
kwargs: ListPartsInputMultipartUploadPartsTypeDef = { # (1)
"marker": ...,
}
parent.parts(**kwargs)
MultipartUpload.upload_part method#
This operation uploads a part of an archive.
Type annotations and code completion for aiobotocore.resource("glacier").upload_part
method.
boto3 documentation
# upload_part method definition
await def upload_part(
self,
*,
checksum: str = ...,
range: str = ...,
body: Union[str, bytes, IO[Any], StreamingBody] = ...,
) -> UploadMultipartPartOutputTypeDef: # (1)
...
# upload_part method usage example with argument unpacking
kwargs: UploadMultipartPartInputMultipartUploadUploadPartTypeDef = { # (1)
"checksum": ...,
}
parent.upload_part(**kwargs)
Notification#
Type annotations and code completion for session.resource("glacier").Notification
class.
boto3 documentation
# Notification usage example
from types_aiobotocore_glacier.service_resource import Notification
def get_resource() -> Notification:
return session.resource("glacier").Notification(...)
Notification attributes#
sns_topic
:Awaitable
[str
]events
:Awaitable
[List
[str
]]account_id
:str
vault_name
:str
Notification methods#
Notification.Vault method#
Creates a Vault resource.
Type annotations and code completion for aiobotocore.resource("glacier").Vault
method.
boto3 documentation
# Vault 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 aiobotocore.resource("glacier").delete
method.
boto3 documentation
# delete 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 aiobotocore.resource("glacier").get_available_subresources
method.
boto3 documentation
# get_available_subresources 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 aiobotocore.resource("glacier").load
method.
boto3 documentation
# load 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 aiobotocore.resource("glacier").reload
method.
boto3 documentation
# reload 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 aiobotocore.resource("glacier").set
method.
boto3 documentation
# set method definition
await def set(
self,
*,
vaultNotificationConfig: VaultNotificationConfigNotificationTypeDef = ..., # (1)
) -> None:
...
# set method usage example with argument unpacking
kwargs: SetVaultNotificationsInputNotificationSetTypeDef = { # (1)
"vaultNotificationConfig": ...,
}
parent.set(**kwargs)
Vault#
Type annotations and code completion for session.resource("glacier").Vault
class.
boto3 documentation
# Vault usage example
from types_aiobotocore_glacier.service_resource import Vault
def get_resource() -> Vault:
return session.resource("glacier").Vault(...)
Vault attributes#
vault_arn
:Awaitable
[str
]vault_name
:Awaitable
[str
]creation_date
:Awaitable
[str
]last_inventory_date
:Awaitable
[str
]number_of_archives
:Awaitable
[int
]size_in_bytes
:Awaitable
[int
]account_id
:str
name
:str
completed_jobs
: VaultCompletedJobsCollectionfailed_jobs
: VaultFailedJobsCollectionjobs
: VaultJobsCollectionjobs_in_progress
: VaultJobsInProgressCollectionmultipart_uplaods
: VaultMultipartUplaodsCollectionmultipart_uploads
: VaultMultipartUploadsCollectionsucceeded_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
# VaultCompletedJobsCollection 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
# VaultFailedJobsCollection 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
# VaultJobsCollection 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
# VaultJobsInProgressCollection 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
# VaultMultipartUplaodsCollection 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
# VaultMultipartUploadsCollection 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
# VaultSucceededJobsCollection 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 aiobotocore.resource("glacier").Account
method.
boto3 documentation
# Account method definition
await def Account(
self,
) -> Account:
...
Vault.Archive method#
Creates a Archive resource.
Type annotations and code completion for aiobotocore.resource("glacier").Archive
method.
boto3 documentation
# Archive method definition
await def Archive(
self,
id: str,
) -> Archive:
...
Vault.Job method#
Creates a Job resource.
Type annotations and code completion for aiobotocore.resource("glacier").Job
method.
boto3 documentation
# Job method definition
await def Job(
self,
id: str,
) -> Job:
...
Vault.MultipartUpload method#
Creates a MultipartUpload resource.
Type annotations and code completion for aiobotocore.resource("glacier").MultipartUpload
method.
boto3 documentation
# MultipartUpload method definition
await def MultipartUpload(
self,
id: str,
) -> MultipartUpload:
...
Vault.Notification method#
Creates a Notification resource.
Type annotations and code completion for aiobotocore.resource("glacier").Notification
method.
boto3 documentation
# Notification 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 aiobotocore.resource("glacier").create
method.
boto3 documentation
# create method definition
await def create(
self,
) -> CreateVaultOutputTypeDef: # (1)
...
Vault.delete method#
This operation deletes a vault.
Type annotations and code completion for aiobotocore.resource("glacier").delete
method.
boto3 documentation
# delete 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 aiobotocore.resource("glacier").get_available_subresources
method.
boto3 documentation
# get_available_subresources 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 aiobotocore.resource("glacier").initiate_inventory_retrieval
method.
boto3 documentation
# initiate_inventory_retrieval 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 aiobotocore.resource("glacier").initiate_multipart_upload
method.
boto3 documentation
# initiate_multipart_upload method definition
await 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)
Vault.load method#
Calls meth:Glacier.Client.describe_vault
to update the attributes of the
Vault resource.
Type annotations and code completion for aiobotocore.resource("glacier").load
method.
boto3 documentation
# load 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 aiobotocore.resource("glacier").reload
method.
boto3 documentation
# reload 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 aiobotocore.resource("glacier").upload_archive
method.
boto3 documentation
# upload_archive method definition
await 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)