Glacier module#
Index > Glacier
Auto-generated documentation for Glacier type annotations stubs module mypy-boto3-glacier.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Glacier
.
From PyPI with pip#
Install boto3-stubs
for Glacier
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[glacier]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[glacier]'
# standalone installation
python -m pip install mypy-boto3-glacier
How to uninstall#
python -m pip uninstall -y mypy-boto3-glacier
Usage#
Code samples can be found in Examples.
GlacierClient#
Type annotations and code completion for boto3.client("glacier")
as GlacierClient
boto3 documentation
# GlacierClient usage example
from boto3.session import Session
from mypy_boto3_glacier.client import GlacierClient
def get_client() -> GlacierClient:
return Session().client("glacier")
Paginators#
Type annotations and code completion for paginators
from boto3.client("glacier").get_paginator("...")
.
# ListJobsPaginator usage example
from boto3.session import Session
from mypy_boto3_glacier.paginator import ListJobsPaginator
def get_list_jobs_paginator() -> ListJobsPaginator:
return Session().client("glacier").get_paginator("list_jobs"))
Waiters#
Type annotations and code completion for waiters
from boto3.client("glacier").get_waiter("...")
.
# VaultExistsWaiter usage example
from boto3.session import Session
from mypy_boto3_glacier.waiter import VaultExistsWaiter
def get_vault_exists_waiter() -> VaultExistsWaiter:
return Session().client("glacier").get_waiter("vault_exists")
GlacierServiceResource#
Type annotations and code completion for boto3.resource("glacier")
as
GlacierServiceResource
boto3 documentation
# GlacierServiceResource usage example
from boto3.session import Session
from mypy_boto3_glacier.service_resource import GlacierServiceResource
def get_glacier_resource() -> GlacierServiceResource:
return Session().resource("glacier")
Collections#
Type annotations and code completion for collections
from boto3.resource("glacier").*
.
# ServiceResourceVaultsCollection usage example
from boto3.session import Session
from mypy_boto3_glacier.service_resource import ServiceResourceVaultsCollection
def get_collection() -> ServiceResourceVaultsCollection:
return Session().resource("glacier").vaults
Resources#
Type annotations and code completion for additional resources
from boto3.resource("glacier").*
.
# Account usage example
from boto3.session import Session
from mypy_boto3_glacier.service_resource import Account
def get_resource() -> Account:
return Session().resource("glacier").Account(...)
Literals#
Type annotations for literals used in methods and schemas.
# ActionCodeType usage example
from mypy_boto3_glacier.literals import ActionCodeType
def get_value() -> ActionCodeType:
return "ArchiveRetrieval"
- ActionCodeType
- CannedACLType
- EncryptionTypeType
- ExpressionTypeType
- FileHeaderInfoType
- ListJobsPaginatorName
- ListMultipartUploadsPaginatorName
- ListPartsPaginatorName
- ListVaultsPaginatorName
- PermissionType
- QuoteFieldsType
- StatusCodeType
- StorageClassType
- TypeType
- VaultExistsWaiterName
- VaultNotExistsWaiterName
- GlacierServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AbortMultipartUploadInputRequestTypeDef usage example
from mypy_boto3_glacier.type_defs import AbortMultipartUploadInputRequestTypeDef
def get_value() -> AbortMultipartUploadInputRequestTypeDef:
return {
"vaultName": ...,
"uploadId": ...,
}
- AbortMultipartUploadInputRequestTypeDef
- AbortVaultLockInputRequestTypeDef
- AddTagsToVaultInputRequestTypeDef
- ArchiveCreationOutputTypeDef
- CSVInputTypeDef
- CSVOutputTypeDef
- CompleteMultipartUploadInputMultipartUploadCompleteTypeDef
- CompleteMultipartUploadInputRequestTypeDef
- CompleteVaultLockInputRequestTypeDef
- CreateVaultInputAccountCreateVaultTypeDef
- CreateVaultInputRequestTypeDef
- CreateVaultInputServiceResourceCreateVaultTypeDef
- CreateVaultOutputTypeDef
- DataRetrievalRuleTypeDef
- DeleteArchiveInputRequestTypeDef
- DeleteVaultAccessPolicyInputRequestTypeDef
- DeleteVaultInputRequestTypeDef
- DeleteVaultNotificationsInputRequestTypeDef
- DescribeJobInputRequestTypeDef
- DescribeVaultInputRequestTypeDef
- WaiterConfigTypeDef
- DescribeVaultOutputResponseMetadataTypeDef
- DescribeVaultOutputTypeDef
- EmptyResponseMetadataTypeDef
- EncryptionTypeDef
- GetDataRetrievalPolicyInputRequestTypeDef
- GetJobOutputInputJobGetOutputTypeDef
- GetJobOutputInputRequestTypeDef
- GetJobOutputOutputTypeDef
- GetVaultAccessPolicyInputRequestTypeDef
- VaultAccessPolicyTypeDef
- GetVaultLockInputRequestTypeDef
- GetVaultLockOutputTypeDef
- GetVaultNotificationsInputRequestTypeDef
- VaultNotificationConfigTypeDef
- InventoryRetrievalJobDescriptionTypeDef
- GranteeTypeDef
- InitiateJobOutputTypeDef
- InitiateMultipartUploadInputRequestTypeDef
- InitiateMultipartUploadInputVaultInitiateMultipartUploadTypeDef
- InitiateMultipartUploadOutputTypeDef
- VaultLockPolicyTypeDef
- InitiateVaultLockOutputTypeDef
- InventoryRetrievalJobDescriptionResponseMetadataTypeDef
- InventoryRetrievalJobInputTypeDef
- ListJobsInputListJobsPaginateTypeDef
- ListJobsInputRequestTypeDef
- ListMultipartUploadsInputListMultipartUploadsPaginateTypeDef
- ListMultipartUploadsInputRequestTypeDef
- UploadListElementTypeDef
- ListPartsInputListPartsPaginateTypeDef
- ListPartsInputMultipartUploadPartsTypeDef
- ListPartsInputRequestTypeDef
- PartListElementTypeDef
- ListProvisionedCapacityInputRequestTypeDef
- ProvisionedCapacityDescriptionTypeDef
- ListTagsForVaultInputRequestTypeDef
- ListTagsForVaultOutputTypeDef
- ListVaultsInputListVaultsPaginateTypeDef
- ListVaultsInputRequestTypeDef
- PaginatorConfigTypeDef
- PurchaseProvisionedCapacityInputRequestTypeDef
- PurchaseProvisionedCapacityOutputTypeDef
- RemoveTagsFromVaultInputRequestTypeDef
- ResponseMetadataTypeDef
- UploadArchiveInputRequestTypeDef
- UploadArchiveInputVaultUploadArchiveTypeDef
- UploadMultipartPartInputMultipartUploadUploadPartTypeDef
- UploadMultipartPartInputRequestTypeDef
- UploadMultipartPartOutputTypeDef
- InputSerializationTypeDef
- OutputSerializationTypeDef
- DataRetrievalPolicyTypeDef
- DescribeVaultInputVaultExistsWaitTypeDef
- DescribeVaultInputVaultNotExistsWaitTypeDef
- ListVaultsOutputTypeDef
- GetVaultAccessPolicyOutputTypeDef
- SetVaultAccessPolicyInputRequestTypeDef
- GetVaultNotificationsOutputTypeDef
- SetVaultNotificationsInputNotificationSetTypeDef
- SetVaultNotificationsInputRequestTypeDef
- GrantTypeDef
- InitiateVaultLockInputRequestTypeDef
- ListMultipartUploadsOutputTypeDef
- ListPartsOutputTypeDef
- ListProvisionedCapacityOutputTypeDef
- SelectParametersResponseMetadataTypeDef
- SelectParametersTypeDef
- GetDataRetrievalPolicyOutputTypeDef
- SetDataRetrievalPolicyInputRequestTypeDef
- S3LocationTypeDef
- OutputLocationResponseMetadataTypeDef
- OutputLocationTypeDef
- GlacierJobDescriptionResponseMetadataTypeDef
- GlacierJobDescriptionTypeDef
- JobParametersTypeDef
- ListJobsOutputTypeDef
- InitiateJobInputRequestTypeDef