Skip to content

Type definitions#

Index > Glacier > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

S3LocationUnionTypeDef#

# S3LocationUnionTypeDef definition

S3LocationUnionTypeDef = Union[
    S3LocationTypeDef,  # (1)
    S3LocationOutputTypeDef,  # (2)
]
  1. See S3LocationTypeDef
  2. See S3LocationOutputTypeDef

OutputLocationUnionTypeDef#

# OutputLocationUnionTypeDef definition

OutputLocationUnionTypeDef = Union[
    OutputLocationTypeDef,  # (1)
    OutputLocationOutputTypeDef,  # (2)
]
  1. See OutputLocationTypeDef
  2. See OutputLocationOutputTypeDef

AbortMultipartUploadInputRequestTypeDef#

# AbortMultipartUploadInputRequestTypeDef definition

class AbortMultipartUploadInputRequestTypeDef(TypedDict):
    vaultName: str,
    uploadId: str,
    accountId: NotRequired[str],

AbortVaultLockInputRequestTypeDef#

# AbortVaultLockInputRequestTypeDef definition

class AbortVaultLockInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

AddTagsToVaultInputRequestTypeDef#

# AddTagsToVaultInputRequestTypeDef definition

class AddTagsToVaultInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CSVInputTypeDef#

# CSVInputTypeDef definition

class CSVInputTypeDef(TypedDict):
    FileHeaderInfo: NotRequired[FileHeaderInfoType],  # (1)
    Comments: NotRequired[str],
    QuoteEscapeCharacter: NotRequired[str],
    RecordDelimiter: NotRequired[str],
    FieldDelimiter: NotRequired[str],
    QuoteCharacter: NotRequired[str],
  1. See FileHeaderInfoType

CSVOutputTypeDef#

# CSVOutputTypeDef definition

class CSVOutputTypeDef(TypedDict):
    QuoteFields: NotRequired[QuoteFieldsType],  # (1)
    QuoteEscapeCharacter: NotRequired[str],
    RecordDelimiter: NotRequired[str],
    FieldDelimiter: NotRequired[str],
    QuoteCharacter: NotRequired[str],
  1. See QuoteFieldsType

CompleteMultipartUploadInputMultipartUploadCompleteTypeDef#

# CompleteMultipartUploadInputMultipartUploadCompleteTypeDef definition

class CompleteMultipartUploadInputMultipartUploadCompleteTypeDef(TypedDict):
    archiveSize: NotRequired[str],
    checksum: NotRequired[str],

CompleteMultipartUploadInputRequestTypeDef#

# CompleteMultipartUploadInputRequestTypeDef definition

class CompleteMultipartUploadInputRequestTypeDef(TypedDict):
    vaultName: str,
    uploadId: str,
    accountId: NotRequired[str],
    archiveSize: NotRequired[str],
    checksum: NotRequired[str],

CompleteVaultLockInputRequestTypeDef#

# CompleteVaultLockInputRequestTypeDef definition

class CompleteVaultLockInputRequestTypeDef(TypedDict):
    vaultName: str,
    lockId: str,
    accountId: NotRequired[str],

CreateVaultInputAccountCreateVaultTypeDef#

# CreateVaultInputAccountCreateVaultTypeDef definition

class CreateVaultInputAccountCreateVaultTypeDef(TypedDict):
    vaultName: str,

CreateVaultInputRequestTypeDef#

# CreateVaultInputRequestTypeDef definition

class CreateVaultInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

CreateVaultInputServiceResourceCreateVaultTypeDef#

# CreateVaultInputServiceResourceCreateVaultTypeDef definition

class CreateVaultInputServiceResourceCreateVaultTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

DataRetrievalRuleTypeDef#

# DataRetrievalRuleTypeDef definition

class DataRetrievalRuleTypeDef(TypedDict):
    Strategy: NotRequired[str],
    BytesPerHour: NotRequired[int],

DeleteArchiveInputRequestTypeDef#

# DeleteArchiveInputRequestTypeDef definition

class DeleteArchiveInputRequestTypeDef(TypedDict):
    vaultName: str,
    archiveId: str,
    accountId: NotRequired[str],

DeleteVaultAccessPolicyInputRequestTypeDef#

# DeleteVaultAccessPolicyInputRequestTypeDef definition

class DeleteVaultAccessPolicyInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

DeleteVaultInputRequestTypeDef#

# DeleteVaultInputRequestTypeDef definition

class DeleteVaultInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

DeleteVaultNotificationsInputRequestTypeDef#

# DeleteVaultNotificationsInputRequestTypeDef definition

class DeleteVaultNotificationsInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

DescribeJobInputRequestTypeDef#

# DescribeJobInputRequestTypeDef definition

class DescribeJobInputRequestTypeDef(TypedDict):
    vaultName: str,
    jobId: str,
    accountId: NotRequired[str],

DescribeVaultInputRequestTypeDef#

# DescribeVaultInputRequestTypeDef definition

class DescribeVaultInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeVaultOutputTypeDef#

# DescribeVaultOutputTypeDef definition

class DescribeVaultOutputTypeDef(TypedDict):
    VaultARN: NotRequired[str],
    VaultName: NotRequired[str],
    CreationDate: NotRequired[str],
    LastInventoryDate: NotRequired[str],
    NumberOfArchives: NotRequired[int],
    SizeInBytes: NotRequired[int],

EncryptionTypeDef#

# EncryptionTypeDef definition

class EncryptionTypeDef(TypedDict):
    EncryptionType: NotRequired[EncryptionTypeType],  # (1)
    KMSKeyId: NotRequired[str],
    KMSContext: NotRequired[str],
  1. See EncryptionTypeType

GetDataRetrievalPolicyInputRequestTypeDef#

# GetDataRetrievalPolicyInputRequestTypeDef definition

class GetDataRetrievalPolicyInputRequestTypeDef(TypedDict):
    accountId: NotRequired[str],

GetJobOutputInputJobGetOutputTypeDef#

# GetJobOutputInputJobGetOutputTypeDef definition

class GetJobOutputInputJobGetOutputTypeDef(TypedDict):
    range: NotRequired[str],

GetJobOutputInputRequestTypeDef#

# GetJobOutputInputRequestTypeDef definition

class GetJobOutputInputRequestTypeDef(TypedDict):
    vaultName: str,
    jobId: str,
    accountId: NotRequired[str],
    range: NotRequired[str],

GetVaultAccessPolicyInputRequestTypeDef#

# GetVaultAccessPolicyInputRequestTypeDef definition

class GetVaultAccessPolicyInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

VaultAccessPolicyTypeDef#

# VaultAccessPolicyTypeDef definition

class VaultAccessPolicyTypeDef(TypedDict):
    Policy: NotRequired[str],

GetVaultLockInputRequestTypeDef#

# GetVaultLockInputRequestTypeDef definition

class GetVaultLockInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

GetVaultNotificationsInputRequestTypeDef#

# GetVaultNotificationsInputRequestTypeDef definition

class GetVaultNotificationsInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

VaultNotificationConfigOutputTypeDef#

# VaultNotificationConfigOutputTypeDef definition

class VaultNotificationConfigOutputTypeDef(TypedDict):
    SNSTopic: NotRequired[str],
    Events: NotRequired[list[str]],

InventoryRetrievalJobDescriptionTypeDef#

# InventoryRetrievalJobDescriptionTypeDef definition

class InventoryRetrievalJobDescriptionTypeDef(TypedDict):
    Format: NotRequired[str],
    StartDate: NotRequired[str],
    EndDate: NotRequired[str],
    Limit: NotRequired[str],
    Marker: NotRequired[str],

GranteeTypeDef#

# GranteeTypeDef definition

class GranteeTypeDef(TypedDict):
    Type: TypeType,  # (1)
    DisplayName: NotRequired[str],
    URI: NotRequired[str],
    ID: NotRequired[str],
    EmailAddress: NotRequired[str],
  1. See TypeType

InitiateMultipartUploadInputRequestTypeDef#

# InitiateMultipartUploadInputRequestTypeDef definition

class InitiateMultipartUploadInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    archiveDescription: NotRequired[str],
    partSize: NotRequired[str],

InitiateMultipartUploadInputVaultInitiateMultipartUploadTypeDef#

# InitiateMultipartUploadInputVaultInitiateMultipartUploadTypeDef definition

class InitiateMultipartUploadInputVaultInitiateMultipartUploadTypeDef(TypedDict):
    archiveDescription: NotRequired[str],
    partSize: NotRequired[str],

VaultLockPolicyTypeDef#

# VaultLockPolicyTypeDef definition

class VaultLockPolicyTypeDef(TypedDict):
    Policy: NotRequired[str],

InventoryRetrievalJobInputTypeDef#

# InventoryRetrievalJobInputTypeDef definition

class InventoryRetrievalJobInputTypeDef(TypedDict):
    StartDate: NotRequired[str],
    EndDate: NotRequired[str],
    Limit: NotRequired[str],
    Marker: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListJobsInputRequestTypeDef#

# ListJobsInputRequestTypeDef definition

class ListJobsInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    limit: NotRequired[str],
    marker: NotRequired[str],
    statuscode: NotRequired[str],
    completed: NotRequired[str],

ListMultipartUploadsInputRequestTypeDef#

# ListMultipartUploadsInputRequestTypeDef definition

class ListMultipartUploadsInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    marker: NotRequired[str],
    limit: NotRequired[str],

UploadListElementTypeDef#

# UploadListElementTypeDef definition

class UploadListElementTypeDef(TypedDict):
    MultipartUploadId: NotRequired[str],
    VaultARN: NotRequired[str],
    ArchiveDescription: NotRequired[str],
    PartSizeInBytes: NotRequired[int],
    CreationDate: NotRequired[str],

ListPartsInputMultipartUploadPartsTypeDef#

# ListPartsInputMultipartUploadPartsTypeDef definition

class ListPartsInputMultipartUploadPartsTypeDef(TypedDict):
    marker: NotRequired[str],
    limit: NotRequired[str],

ListPartsInputRequestTypeDef#

# ListPartsInputRequestTypeDef definition

class ListPartsInputRequestTypeDef(TypedDict):
    vaultName: str,
    uploadId: str,
    accountId: NotRequired[str],
    marker: NotRequired[str],
    limit: NotRequired[str],

PartListElementTypeDef#

# PartListElementTypeDef definition

class PartListElementTypeDef(TypedDict):
    RangeInBytes: NotRequired[str],
    SHA256TreeHash: NotRequired[str],

ListProvisionedCapacityInputRequestTypeDef#

# ListProvisionedCapacityInputRequestTypeDef definition

class ListProvisionedCapacityInputRequestTypeDef(TypedDict):
    accountId: NotRequired[str],

ProvisionedCapacityDescriptionTypeDef#

# ProvisionedCapacityDescriptionTypeDef definition

class ProvisionedCapacityDescriptionTypeDef(TypedDict):
    CapacityId: NotRequired[str],
    StartDate: NotRequired[str],
    ExpirationDate: NotRequired[str],

ListTagsForVaultInputRequestTypeDef#

# ListTagsForVaultInputRequestTypeDef definition

class ListTagsForVaultInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],

ListVaultsInputRequestTypeDef#

# ListVaultsInputRequestTypeDef definition

class ListVaultsInputRequestTypeDef(TypedDict):
    accountId: NotRequired[str],
    marker: NotRequired[str],
    limit: NotRequired[str],

PurchaseProvisionedCapacityInputRequestTypeDef#

# PurchaseProvisionedCapacityInputRequestTypeDef definition

class PurchaseProvisionedCapacityInputRequestTypeDef(TypedDict):
    accountId: NotRequired[str],

RemoveTagsFromVaultInputRequestTypeDef#

# RemoveTagsFromVaultInputRequestTypeDef definition

class RemoveTagsFromVaultInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    TagKeys: NotRequired[Sequence[str]],

VaultNotificationConfigTypeDef#

# VaultNotificationConfigTypeDef definition

class VaultNotificationConfigTypeDef(TypedDict):
    SNSTopic: NotRequired[str],
    Events: NotRequired[Sequence[str]],

ArchiveCreationOutputTypeDef#

# ArchiveCreationOutputTypeDef definition

class ArchiveCreationOutputTypeDef(TypedDict):
    location: str,
    checksum: str,
    archiveId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateVaultOutputTypeDef#

# CreateVaultOutputTypeDef definition

class CreateVaultOutputTypeDef(TypedDict):
    location: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeVaultResponseTypeDef#

# DescribeVaultResponseTypeDef definition

class DescribeVaultResponseTypeDef(TypedDict):
    VaultARN: str,
    VaultName: str,
    CreationDate: str,
    LastInventoryDate: str,
    NumberOfArchives: int,
    SizeInBytes: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetJobOutputOutputTypeDef#

# GetJobOutputOutputTypeDef definition

class GetJobOutputOutputTypeDef(TypedDict):
    body: StreamingBody,
    checksum: str,
    status: int,
    contentRange: str,
    acceptRanges: str,
    contentType: str,
    archiveDescription: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetVaultLockOutputTypeDef#

# GetVaultLockOutputTypeDef definition

class GetVaultLockOutputTypeDef(TypedDict):
    Policy: str,
    State: str,
    ExpirationDate: str,
    CreationDate: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiateJobOutputTypeDef#

# InitiateJobOutputTypeDef definition

class InitiateJobOutputTypeDef(TypedDict):
    location: str,
    jobId: str,
    jobOutputPath: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiateMultipartUploadOutputTypeDef#

# InitiateMultipartUploadOutputTypeDef definition

class InitiateMultipartUploadOutputTypeDef(TypedDict):
    location: str,
    uploadId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiateVaultLockOutputTypeDef#

# InitiateVaultLockOutputTypeDef definition

class InitiateVaultLockOutputTypeDef(TypedDict):
    lockId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForVaultOutputTypeDef#

# ListTagsForVaultOutputTypeDef definition

class ListTagsForVaultOutputTypeDef(TypedDict):
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PurchaseProvisionedCapacityOutputTypeDef#

# PurchaseProvisionedCapacityOutputTypeDef definition

class PurchaseProvisionedCapacityOutputTypeDef(TypedDict):
    capacityId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UploadMultipartPartOutputTypeDef#

# UploadMultipartPartOutputTypeDef definition

class UploadMultipartPartOutputTypeDef(TypedDict):
    checksum: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UploadArchiveInputRequestTypeDef#

# UploadArchiveInputRequestTypeDef definition

class UploadArchiveInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    archiveDescription: NotRequired[str],
    checksum: NotRequired[str],
    body: NotRequired[BlobTypeDef],

UploadArchiveInputVaultUploadArchiveTypeDef#

# UploadArchiveInputVaultUploadArchiveTypeDef definition

class UploadArchiveInputVaultUploadArchiveTypeDef(TypedDict):
    archiveDescription: NotRequired[str],
    checksum: NotRequired[str],
    body: NotRequired[BlobTypeDef],

UploadMultipartPartInputMultipartUploadUploadPartTypeDef#

# UploadMultipartPartInputMultipartUploadUploadPartTypeDef definition

class UploadMultipartPartInputMultipartUploadUploadPartTypeDef(TypedDict):
    checksum: NotRequired[str],
    range: NotRequired[str],
    body: NotRequired[BlobTypeDef],

UploadMultipartPartInputRequestTypeDef#

# UploadMultipartPartInputRequestTypeDef definition

class UploadMultipartPartInputRequestTypeDef(TypedDict):
    vaultName: str,
    uploadId: str,
    accountId: NotRequired[str],
    checksum: NotRequired[str],
    range: NotRequired[str],
    body: NotRequired[BlobTypeDef],

InputSerializationTypeDef#

# InputSerializationTypeDef definition

class InputSerializationTypeDef(TypedDict):
    csv: NotRequired[CSVInputTypeDef],  # (1)
  1. See CSVInputTypeDef

OutputSerializationTypeDef#

# OutputSerializationTypeDef definition

class OutputSerializationTypeDef(TypedDict):
    csv: NotRequired[CSVOutputTypeDef],  # (1)
  1. See CSVOutputTypeDef

DataRetrievalPolicyOutputTypeDef#

# DataRetrievalPolicyOutputTypeDef definition

class DataRetrievalPolicyOutputTypeDef(TypedDict):
    Rules: NotRequired[list[DataRetrievalRuleTypeDef]],  # (1)
  1. See DataRetrievalRuleTypeDef

DataRetrievalPolicyTypeDef#

# DataRetrievalPolicyTypeDef definition

class DataRetrievalPolicyTypeDef(TypedDict):
    Rules: NotRequired[Sequence[DataRetrievalRuleTypeDef]],  # (1)
  1. See DataRetrievalRuleTypeDef

DescribeVaultInputWaitTypeDef#

# DescribeVaultInputWaitTypeDef definition

class DescribeVaultInputWaitTypeDef(TypedDict):
    accountId: str,
    vaultName: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

ListVaultsOutputTypeDef#

# ListVaultsOutputTypeDef definition

class ListVaultsOutputTypeDef(TypedDict):
    VaultList: list[DescribeVaultOutputTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DescribeVaultOutputTypeDef
  2. See ResponseMetadataTypeDef

GetVaultAccessPolicyOutputTypeDef#

# GetVaultAccessPolicyOutputTypeDef definition

class GetVaultAccessPolicyOutputTypeDef(TypedDict):
    policy: VaultAccessPolicyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VaultAccessPolicyTypeDef
  2. See ResponseMetadataTypeDef

SetVaultAccessPolicyInputRequestTypeDef#

# SetVaultAccessPolicyInputRequestTypeDef definition

class SetVaultAccessPolicyInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    policy: NotRequired[VaultAccessPolicyTypeDef],  # (1)
  1. See VaultAccessPolicyTypeDef

GetVaultNotificationsOutputTypeDef#

# GetVaultNotificationsOutputTypeDef definition

class GetVaultNotificationsOutputTypeDef(TypedDict):
    vaultNotificationConfig: VaultNotificationConfigOutputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VaultNotificationConfigOutputTypeDef
  2. See ResponseMetadataTypeDef

GrantTypeDef#

# GrantTypeDef definition

class GrantTypeDef(TypedDict):
    Grantee: NotRequired[GranteeTypeDef],  # (1)
    Permission: NotRequired[PermissionType],  # (2)
  1. See GranteeTypeDef
  2. See PermissionType

InitiateVaultLockInputRequestTypeDef#

# InitiateVaultLockInputRequestTypeDef definition

class InitiateVaultLockInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    policy: NotRequired[VaultLockPolicyTypeDef],  # (1)
  1. See VaultLockPolicyTypeDef

ListJobsInputPaginateTypeDef#

# ListJobsInputPaginateTypeDef definition

class ListJobsInputPaginateTypeDef(TypedDict):
    accountId: str,
    vaultName: str,
    statuscode: NotRequired[str],
    completed: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMultipartUploadsInputPaginateTypeDef#

# ListMultipartUploadsInputPaginateTypeDef definition

class ListMultipartUploadsInputPaginateTypeDef(TypedDict):
    accountId: str,
    vaultName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPartsInputPaginateTypeDef#

# ListPartsInputPaginateTypeDef definition

class ListPartsInputPaginateTypeDef(TypedDict):
    accountId: str,
    vaultName: str,
    uploadId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListVaultsInputPaginateTypeDef#

# ListVaultsInputPaginateTypeDef definition

class ListVaultsInputPaginateTypeDef(TypedDict):
    accountId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMultipartUploadsOutputTypeDef#

# ListMultipartUploadsOutputTypeDef definition

class ListMultipartUploadsOutputTypeDef(TypedDict):
    UploadsList: list[UploadListElementTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UploadListElementTypeDef
  2. See ResponseMetadataTypeDef

ListPartsOutputTypeDef#

# ListPartsOutputTypeDef definition

class ListPartsOutputTypeDef(TypedDict):
    MultipartUploadId: str,
    VaultARN: str,
    ArchiveDescription: str,
    PartSizeInBytes: int,
    CreationDate: str,
    Parts: list[PartListElementTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PartListElementTypeDef
  2. See ResponseMetadataTypeDef

ListProvisionedCapacityOutputTypeDef#

# ListProvisionedCapacityOutputTypeDef definition

class ListProvisionedCapacityOutputTypeDef(TypedDict):
    ProvisionedCapacityList: list[ProvisionedCapacityDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProvisionedCapacityDescriptionTypeDef
  2. See ResponseMetadataTypeDef

SetVaultNotificationsInputNotificationSetTypeDef#

# SetVaultNotificationsInputNotificationSetTypeDef definition

class SetVaultNotificationsInputNotificationSetTypeDef(TypedDict):
    vaultNotificationConfig: NotRequired[VaultNotificationConfigTypeDef],  # (1)
  1. See VaultNotificationConfigTypeDef

SetVaultNotificationsInputRequestTypeDef#

# SetVaultNotificationsInputRequestTypeDef definition

class SetVaultNotificationsInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    vaultNotificationConfig: NotRequired[VaultNotificationConfigTypeDef],  # (1)
  1. See VaultNotificationConfigTypeDef

SelectParametersTypeDef#

# SelectParametersTypeDef definition

class SelectParametersTypeDef(TypedDict):
    InputSerialization: NotRequired[InputSerializationTypeDef],  # (1)
    ExpressionType: NotRequired[ExpressionTypeType],  # (2)
    Expression: NotRequired[str],
    OutputSerialization: NotRequired[OutputSerializationTypeDef],  # (3)
  1. See InputSerializationTypeDef
  2. See ExpressionTypeType
  3. See OutputSerializationTypeDef

GetDataRetrievalPolicyOutputTypeDef#

# GetDataRetrievalPolicyOutputTypeDef definition

class GetDataRetrievalPolicyOutputTypeDef(TypedDict):
    Policy: DataRetrievalPolicyOutputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataRetrievalPolicyOutputTypeDef
  2. See ResponseMetadataTypeDef

SetDataRetrievalPolicyInputRequestTypeDef#

# SetDataRetrievalPolicyInputRequestTypeDef definition

class SetDataRetrievalPolicyInputRequestTypeDef(TypedDict):
    accountId: NotRequired[str],
    Policy: NotRequired[DataRetrievalPolicyTypeDef],  # (1)
  1. See DataRetrievalPolicyTypeDef

S3LocationOutputTypeDef#

# S3LocationOutputTypeDef definition

class S3LocationOutputTypeDef(TypedDict):
    BucketName: NotRequired[str],
    Prefix: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
    CannedACL: NotRequired[CannedACLType],  # (2)
    AccessControlList: NotRequired[list[GrantTypeDef]],  # (3)
    Tagging: NotRequired[dict[str, str]],
    UserMetadata: NotRequired[dict[str, str]],
    StorageClass: NotRequired[StorageClassType],  # (4)
  1. See EncryptionTypeDef
  2. See CannedACLType
  3. See GrantTypeDef
  4. See StorageClassType

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    BucketName: NotRequired[str],
    Prefix: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
    CannedACL: NotRequired[CannedACLType],  # (2)
    AccessControlList: NotRequired[Sequence[GrantTypeDef]],  # (3)
    Tagging: NotRequired[Mapping[str, str]],
    UserMetadata: NotRequired[Mapping[str, str]],
    StorageClass: NotRequired[StorageClassType],  # (4)
  1. See EncryptionTypeDef
  2. See CannedACLType
  3. See GrantTypeDef
  4. See StorageClassType

OutputLocationOutputTypeDef#

# OutputLocationOutputTypeDef definition

class OutputLocationOutputTypeDef(TypedDict):
    S3: NotRequired[S3LocationOutputTypeDef],  # (1)
  1. See S3LocationOutputTypeDef

GlacierJobDescriptionResponseTypeDef#

# GlacierJobDescriptionResponseTypeDef definition

class GlacierJobDescriptionResponseTypeDef(TypedDict):
    JobId: str,
    JobDescription: str,
    Action: ActionCodeType,  # (1)
    ArchiveId: str,
    VaultARN: str,
    CreationDate: str,
    Completed: bool,
    StatusCode: StatusCodeType,  # (2)
    StatusMessage: str,
    ArchiveSizeInBytes: int,
    InventorySizeInBytes: int,
    SNSTopic: str,
    CompletionDate: str,
    SHA256TreeHash: str,
    ArchiveSHA256TreeHash: str,
    RetrievalByteRange: str,
    Tier: str,
    InventoryRetrievalParameters: InventoryRetrievalJobDescriptionTypeDef,  # (3)
    JobOutputPath: str,
    SelectParameters: SelectParametersTypeDef,  # (4)
    OutputLocation: OutputLocationOutputTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See ActionCodeType
  2. See StatusCodeType
  3. See InventoryRetrievalJobDescriptionTypeDef
  4. See SelectParametersTypeDef
  5. See OutputLocationOutputTypeDef
  6. See ResponseMetadataTypeDef

GlacierJobDescriptionTypeDef#

# GlacierJobDescriptionTypeDef definition

class GlacierJobDescriptionTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobDescription: NotRequired[str],
    Action: NotRequired[ActionCodeType],  # (1)
    ArchiveId: NotRequired[str],
    VaultARN: NotRequired[str],
    CreationDate: NotRequired[str],
    Completed: NotRequired[bool],
    StatusCode: NotRequired[StatusCodeType],  # (2)
    StatusMessage: NotRequired[str],
    ArchiveSizeInBytes: NotRequired[int],
    InventorySizeInBytes: NotRequired[int],
    SNSTopic: NotRequired[str],
    CompletionDate: NotRequired[str],
    SHA256TreeHash: NotRequired[str],
    ArchiveSHA256TreeHash: NotRequired[str],
    RetrievalByteRange: NotRequired[str],
    Tier: NotRequired[str],
    InventoryRetrievalParameters: NotRequired[InventoryRetrievalJobDescriptionTypeDef],  # (3)
    JobOutputPath: NotRequired[str],
    SelectParameters: NotRequired[SelectParametersTypeDef],  # (4)
    OutputLocation: NotRequired[OutputLocationOutputTypeDef],  # (5)
  1. See ActionCodeType
  2. See StatusCodeType
  3. See InventoryRetrievalJobDescriptionTypeDef
  4. See SelectParametersTypeDef
  5. See OutputLocationOutputTypeDef

OutputLocationTypeDef#

# OutputLocationTypeDef definition

class OutputLocationTypeDef(TypedDict):
    S3: NotRequired[S3LocationUnionTypeDef],  # (1)
  1. See S3LocationTypeDef S3LocationOutputTypeDef

ListJobsOutputTypeDef#

# ListJobsOutputTypeDef definition

class ListJobsOutputTypeDef(TypedDict):
    JobList: list[GlacierJobDescriptionTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlacierJobDescriptionTypeDef
  2. See ResponseMetadataTypeDef

JobParametersTypeDef#

# JobParametersTypeDef definition

class JobParametersTypeDef(TypedDict):
    Format: NotRequired[str],
    Type: NotRequired[str],
    ArchiveId: NotRequired[str],
    Description: NotRequired[str],
    SNSTopic: NotRequired[str],
    RetrievalByteRange: NotRequired[str],
    Tier: NotRequired[str],
    InventoryRetrievalParameters: NotRequired[InventoryRetrievalJobInputTypeDef],  # (1)
    SelectParameters: NotRequired[SelectParametersTypeDef],  # (2)
    OutputLocation: NotRequired[OutputLocationUnionTypeDef],  # (3)
  1. See InventoryRetrievalJobInputTypeDef
  2. See SelectParametersTypeDef
  3. See OutputLocationTypeDef OutputLocationOutputTypeDef

InitiateJobInputRequestTypeDef#

# InitiateJobInputRequestTypeDef definition

class InitiateJobInputRequestTypeDef(TypedDict):
    vaultName: str,
    accountId: NotRequired[str],
    jobParameters: NotRequired[JobParametersTypeDef],  # (1)
  1. See JobParametersTypeDef