Skip to content

Typed dictionaries#

Index > S3 > Typed dictionaries

Auto-generated documentation for S3 type annotations stubs module mypy-boto3-s3.

AbortIncompleteMultipartUploadTypeDef#

# AbortIncompleteMultipartUploadTypeDef usage example

from mypy_boto3_s3.type_defs import AbortIncompleteMultipartUploadTypeDef

def get_value() -> AbortIncompleteMultipartUploadTypeDef:
    return {
        "DaysAfterInitiation": ...,
    }
# AbortIncompleteMultipartUploadTypeDef definition

class AbortIncompleteMultipartUploadTypeDef(TypedDict):
    DaysAfterInitiation: NotRequired[int],

AbortMultipartUploadOutputTypeDef#

# AbortMultipartUploadOutputTypeDef usage example

from mypy_boto3_s3.type_defs import AbortMultipartUploadOutputTypeDef

def get_value() -> AbortMultipartUploadOutputTypeDef:
    return {
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# AbortMultipartUploadOutputTypeDef definition

class AbortMultipartUploadOutputTypeDef(TypedDict):
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestChargedType
  2. See ResponseMetadataTypeDef

AbortMultipartUploadRequestMultipartUploadAbortTypeDef#

# AbortMultipartUploadRequestMultipartUploadAbortTypeDef usage example

from mypy_boto3_s3.type_defs import AbortMultipartUploadRequestMultipartUploadAbortTypeDef

def get_value() -> AbortMultipartUploadRequestMultipartUploadAbortTypeDef:
    return {
        "RequestPayer": ...,
    }
# AbortMultipartUploadRequestMultipartUploadAbortTypeDef definition

class AbortMultipartUploadRequestMultipartUploadAbortTypeDef(TypedDict):
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

AbortMultipartUploadRequestRequestTypeDef#

# AbortMultipartUploadRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import AbortMultipartUploadRequestRequestTypeDef

def get_value() -> AbortMultipartUploadRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "UploadId": ...,
    }
# AbortMultipartUploadRequestRequestTypeDef definition

class AbortMultipartUploadRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    UploadId: str,
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

AccelerateConfigurationTypeDef#

# AccelerateConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import AccelerateConfigurationTypeDef

def get_value() -> AccelerateConfigurationTypeDef:
    return {
        "Status": ...,
    }
# AccelerateConfigurationTypeDef definition

class AccelerateConfigurationTypeDef(TypedDict):
    Status: NotRequired[BucketAccelerateStatusType],  # (1)
  1. See BucketAccelerateStatusType

OwnerTypeDef#

# OwnerTypeDef usage example

from mypy_boto3_s3.type_defs import OwnerTypeDef

def get_value() -> OwnerTypeDef:
    return {
        "DisplayName": ...,
    }
# OwnerTypeDef definition

class OwnerTypeDef(TypedDict):
    DisplayName: NotRequired[str],
    ID: NotRequired[str],

AccessControlTranslationTypeDef#

# AccessControlTranslationTypeDef usage example

from mypy_boto3_s3.type_defs import AccessControlTranslationTypeDef

def get_value() -> AccessControlTranslationTypeDef:
    return {
        "Owner": ...,
    }
# AccessControlTranslationTypeDef definition

class AccessControlTranslationTypeDef(TypedDict):
    Owner: OwnerOverrideType,  # (1)
  1. See OwnerOverrideType

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_s3.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AnalyticsS3BucketDestinationTypeDef#

# AnalyticsS3BucketDestinationTypeDef usage example

from mypy_boto3_s3.type_defs import AnalyticsS3BucketDestinationTypeDef

def get_value() -> AnalyticsS3BucketDestinationTypeDef:
    return {
        "Format": ...,
        "Bucket": ...,
    }
# AnalyticsS3BucketDestinationTypeDef definition

class AnalyticsS3BucketDestinationTypeDef(TypedDict):
    Format: AnalyticsS3ExportFileFormatType,  # (1)
    Bucket: str,
    BucketAccountId: NotRequired[str],
    Prefix: NotRequired[str],
  1. See AnalyticsS3ExportFileFormatType

CopySourceTypeDef#

# CopySourceTypeDef usage example

from mypy_boto3_s3.type_defs import CopySourceTypeDef

def get_value() -> CopySourceTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# CopySourceTypeDef definition

class CopySourceTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],

BucketDownloadFileRequestTypeDef#

# BucketDownloadFileRequestTypeDef usage example

from mypy_boto3_s3.type_defs import BucketDownloadFileRequestTypeDef

def get_value() -> BucketDownloadFileRequestTypeDef:
    return {
        "Key": ...,
        "Filename": ...,
    }
# BucketDownloadFileRequestTypeDef definition

class BucketDownloadFileRequestTypeDef(TypedDict):
    Key: str,
    Filename: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

BucketDownloadFileobjRequestTypeDef#

# BucketDownloadFileobjRequestTypeDef usage example

from mypy_boto3_s3.type_defs import BucketDownloadFileobjRequestTypeDef

def get_value() -> BucketDownloadFileobjRequestTypeDef:
    return {
        "Key": ...,
        "Fileobj": ...,
    }
# BucketDownloadFileobjRequestTypeDef definition

class BucketDownloadFileobjRequestTypeDef(TypedDict):
    Key: str,
    Fileobj: Union[IO[Any], StreamingBody],
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

BucketTypeDef#

# BucketTypeDef usage example

from mypy_boto3_s3.type_defs import BucketTypeDef

def get_value() -> BucketTypeDef:
    return {
        "Name": ...,
    }
# BucketTypeDef definition

class BucketTypeDef(TypedDict):
    Name: NotRequired[str],
    CreationDate: NotRequired[datetime],

BucketUploadFileRequestTypeDef#

# BucketUploadFileRequestTypeDef usage example

from mypy_boto3_s3.type_defs import BucketUploadFileRequestTypeDef

def get_value() -> BucketUploadFileRequestTypeDef:
    return {
        "Filename": ...,
        "Key": ...,
    }
# BucketUploadFileRequestTypeDef definition

class BucketUploadFileRequestTypeDef(TypedDict):
    Filename: str,
    Key: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

BucketUploadFileobjRequestTypeDef#

# BucketUploadFileobjRequestTypeDef usage example

from mypy_boto3_s3.type_defs import BucketUploadFileobjRequestTypeDef

def get_value() -> BucketUploadFileobjRequestTypeDef:
    return {
        "Fileobj": ...,
        "Key": ...,
    }
# BucketUploadFileobjRequestTypeDef definition

class BucketUploadFileobjRequestTypeDef(TypedDict):
    Fileobj: Union[IO[Any], StreamingBody],
    Key: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

CORSRuleTypeDef#

# CORSRuleTypeDef usage example

from mypy_boto3_s3.type_defs import CORSRuleTypeDef

def get_value() -> CORSRuleTypeDef:
    return {
        "AllowedMethods": ...,
        "AllowedOrigins": ...,
    }
# CORSRuleTypeDef definition

class CORSRuleTypeDef(TypedDict):
    AllowedMethods: List[str],
    AllowedOrigins: List[str],
    ID: NotRequired[str],
    AllowedHeaders: NotRequired[List[str]],
    ExposeHeaders: NotRequired[List[str]],
    MaxAgeSeconds: NotRequired[int],

CSVInputTypeDef#

# CSVInputTypeDef usage example

from mypy_boto3_s3.type_defs import CSVInputTypeDef

def get_value() -> CSVInputTypeDef:
    return {
        "FileHeaderInfo": ...,
    }
# CSVInputTypeDef definition

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

CSVOutputTypeDef#

# CSVOutputTypeDef usage example

from mypy_boto3_s3.type_defs import CSVOutputTypeDef

def get_value() -> CSVOutputTypeDef:
    return {
        "QuoteFields": ...,
    }
# CSVOutputTypeDef definition

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

ChecksumTypeDef#

# ChecksumTypeDef usage example

from mypy_boto3_s3.type_defs import ChecksumTypeDef

def get_value() -> ChecksumTypeDef:
    return {
        "ChecksumCRC32": ...,
    }
# ChecksumTypeDef definition

class ChecksumTypeDef(TypedDict):
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],

ClientDownloadFileRequestTypeDef#

# ClientDownloadFileRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ClientDownloadFileRequestTypeDef

def get_value() -> ClientDownloadFileRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "Filename": ...,
    }
# ClientDownloadFileRequestTypeDef definition

class ClientDownloadFileRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    Filename: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

ClientDownloadFileobjRequestTypeDef#

# ClientDownloadFileobjRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ClientDownloadFileobjRequestTypeDef

def get_value() -> ClientDownloadFileobjRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "Fileobj": ...,
    }
# ClientDownloadFileobjRequestTypeDef definition

class ClientDownloadFileobjRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    Fileobj: Union[IO[Any], StreamingBody],
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

ClientGeneratePresignedPostRequestTypeDef#

# ClientGeneratePresignedPostRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ClientGeneratePresignedPostRequestTypeDef

def get_value() -> ClientGeneratePresignedPostRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# ClientGeneratePresignedPostRequestTypeDef definition

class ClientGeneratePresignedPostRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    Fields: NotRequired[Dict[str, Any]],
    Conditions: NotRequired[Union[List[Any], Dict[str, Any]]],
    ExpiresIn: NotRequired[int],

ClientUploadFileRequestTypeDef#

# ClientUploadFileRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ClientUploadFileRequestTypeDef

def get_value() -> ClientUploadFileRequestTypeDef:
    return {
        "Filename": ...,
        "Bucket": ...,
        "Key": ...,
    }
# ClientUploadFileRequestTypeDef definition

class ClientUploadFileRequestTypeDef(TypedDict):
    Filename: str,
    Bucket: str,
    Key: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

ClientUploadFileobjRequestTypeDef#

# ClientUploadFileobjRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ClientUploadFileobjRequestTypeDef

def get_value() -> ClientUploadFileobjRequestTypeDef:
    return {
        "Fileobj": ...,
        "Bucket": ...,
        "Key": ...,
    }
# ClientUploadFileobjRequestTypeDef definition

class ClientUploadFileobjRequestTypeDef(TypedDict):
    Fileobj: Union[IO[Any], StreamingBody],
    Bucket: str,
    Key: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

CloudFunctionConfigurationTypeDef#

# CloudFunctionConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import CloudFunctionConfigurationTypeDef

def get_value() -> CloudFunctionConfigurationTypeDef:
    return {
        "Id": ...,
    }
# CloudFunctionConfigurationTypeDef definition

class CloudFunctionConfigurationTypeDef(TypedDict):
    Id: NotRequired[str],
    Event: NotRequired[EventType],  # (1)
    Events: NotRequired[List[EventType]],  # (2)
    CloudFunction: NotRequired[str],
    InvocationRole: NotRequired[str],
  1. See EventType
  2. See EventType

CommonPrefixTypeDef#

# CommonPrefixTypeDef usage example

from mypy_boto3_s3.type_defs import CommonPrefixTypeDef

def get_value() -> CommonPrefixTypeDef:
    return {
        "Prefix": ...,
    }
# CommonPrefixTypeDef definition

class CommonPrefixTypeDef(TypedDict):
    Prefix: NotRequired[str],

CompleteMultipartUploadOutputTypeDef#

# CompleteMultipartUploadOutputTypeDef usage example

from mypy_boto3_s3.type_defs import CompleteMultipartUploadOutputTypeDef

def get_value() -> CompleteMultipartUploadOutputTypeDef:
    return {
        "Location": ...,
        "Bucket": ...,
        "Key": ...,
        "Expiration": ...,
        "ETag": ...,
        "ChecksumCRC32": ...,
        "ChecksumCRC32C": ...,
        "ChecksumSHA1": ...,
        "ChecksumSHA256": ...,
        "ServerSideEncryption": ...,
        "VersionId": ...,
        "SSEKMSKeyId": ...,
        "BucketKeyEnabled": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# CompleteMultipartUploadOutputTypeDef definition

class CompleteMultipartUploadOutputTypeDef(TypedDict):
    Location: str,
    Bucket: str,
    Key: str,
    Expiration: str,
    ETag: str,
    ChecksumCRC32: str,
    ChecksumCRC32C: str,
    ChecksumSHA1: str,
    ChecksumSHA256: str,
    ServerSideEncryption: ServerSideEncryptionType,  # (1)
    VersionId: str,
    SSEKMSKeyId: str,
    BucketKeyEnabled: bool,
    RequestCharged: RequestChargedType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ServerSideEncryptionType
  2. See RequestChargedType
  3. See ResponseMetadataTypeDef

CompletedPartTypeDef#

# CompletedPartTypeDef usage example

from mypy_boto3_s3.type_defs import CompletedPartTypeDef

def get_value() -> CompletedPartTypeDef:
    return {
        "ETag": ...,
    }
# CompletedPartTypeDef definition

class CompletedPartTypeDef(TypedDict):
    ETag: NotRequired[str],
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    PartNumber: NotRequired[int],

ConditionTypeDef#

# ConditionTypeDef usage example

from mypy_boto3_s3.type_defs import ConditionTypeDef

def get_value() -> ConditionTypeDef:
    return {
        "HttpErrorCodeReturnedEquals": ...,
    }
# ConditionTypeDef definition

class ConditionTypeDef(TypedDict):
    HttpErrorCodeReturnedEquals: NotRequired[str],
    KeyPrefixEquals: NotRequired[str],

CopyObjectResultTypeDef#

# CopyObjectResultTypeDef usage example

from mypy_boto3_s3.type_defs import CopyObjectResultTypeDef

def get_value() -> CopyObjectResultTypeDef:
    return {
        "ETag": ...,
    }
# CopyObjectResultTypeDef definition

class CopyObjectResultTypeDef(TypedDict):
    ETag: NotRequired[str],
    LastModified: NotRequired[datetime],
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],

CopyObjectRequestObjectCopyFromTypeDef#

# CopyObjectRequestObjectCopyFromTypeDef usage example

from mypy_boto3_s3.type_defs import CopyObjectRequestObjectCopyFromTypeDef

def get_value() -> CopyObjectRequestObjectCopyFromTypeDef:
    return {
        "CopySource": ...,
    }
# CopyObjectRequestObjectCopyFromTypeDef definition

class CopyObjectRequestObjectCopyFromTypeDef(TypedDict):
    CopySource: str,
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    CacheControl: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentType: NotRequired[str],
    CopySourceIfMatch: NotRequired[str],
    CopySourceIfModifiedSince: NotRequired[Union[datetime, str]],
    CopySourceIfNoneMatch: NotRequired[str],
    CopySourceIfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Expires: NotRequired[Union[datetime, str]],
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    Metadata: NotRequired[Mapping[str, str]],
    MetadataDirective: NotRequired[MetadataDirectiveType],  # (3)
    TaggingDirective: NotRequired[TaggingDirectiveType],  # (4)
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (5)
    StorageClass: NotRequired[StorageClassType],  # (6)
    WebsiteRedirectLocation: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSEKMSEncryptionContext: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],
    CopySourceSSECustomerAlgorithm: NotRequired[str],
    CopySourceSSECustomerKey: NotRequired[str],
    CopySourceSSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (7)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (8)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (9)
    ExpectedBucketOwner: NotRequired[str],
    ExpectedSourceBucketOwner: NotRequired[str],
  1. See ObjectCannedACLType
  2. See ChecksumAlgorithmType
  3. See MetadataDirectiveType
  4. See TaggingDirectiveType
  5. See ServerSideEncryptionType
  6. See StorageClassType
  7. See RequestPayerType
  8. See ObjectLockModeType
  9. See ObjectLockLegalHoldStatusType

CopyObjectRequestObjectSummaryCopyFromTypeDef#

# CopyObjectRequestObjectSummaryCopyFromTypeDef usage example

from mypy_boto3_s3.type_defs import CopyObjectRequestObjectSummaryCopyFromTypeDef

def get_value() -> CopyObjectRequestObjectSummaryCopyFromTypeDef:
    return {
        "CopySource": ...,
    }
# CopyObjectRequestObjectSummaryCopyFromTypeDef definition

class CopyObjectRequestObjectSummaryCopyFromTypeDef(TypedDict):
    CopySource: str,
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    CacheControl: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentType: NotRequired[str],
    CopySourceIfMatch: NotRequired[str],
    CopySourceIfModifiedSince: NotRequired[Union[datetime, str]],
    CopySourceIfNoneMatch: NotRequired[str],
    CopySourceIfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Expires: NotRequired[Union[datetime, str]],
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    Metadata: NotRequired[Mapping[str, str]],
    MetadataDirective: NotRequired[MetadataDirectiveType],  # (3)
    TaggingDirective: NotRequired[TaggingDirectiveType],  # (4)
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (5)
    StorageClass: NotRequired[StorageClassType],  # (6)
    WebsiteRedirectLocation: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSEKMSEncryptionContext: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],
    CopySourceSSECustomerAlgorithm: NotRequired[str],
    CopySourceSSECustomerKey: NotRequired[str],
    CopySourceSSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (7)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (8)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (9)
    ExpectedBucketOwner: NotRequired[str],
    ExpectedSourceBucketOwner: NotRequired[str],
  1. See ObjectCannedACLType
  2. See ChecksumAlgorithmType
  3. See MetadataDirectiveType
  4. See TaggingDirectiveType
  5. See ServerSideEncryptionType
  6. See StorageClassType
  7. See RequestPayerType
  8. See ObjectLockModeType
  9. See ObjectLockLegalHoldStatusType

CopyPartResultTypeDef#

# CopyPartResultTypeDef usage example

from mypy_boto3_s3.type_defs import CopyPartResultTypeDef

def get_value() -> CopyPartResultTypeDef:
    return {
        "ETag": ...,
    }
# CopyPartResultTypeDef definition

class CopyPartResultTypeDef(TypedDict):
    ETag: NotRequired[str],
    LastModified: NotRequired[datetime],
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],

CreateBucketConfigurationTypeDef#

# CreateBucketConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import CreateBucketConfigurationTypeDef

def get_value() -> CreateBucketConfigurationTypeDef:
    return {
        "LocationConstraint": ...,
    }
# CreateBucketConfigurationTypeDef definition

class CreateBucketConfigurationTypeDef(TypedDict):
    LocationConstraint: NotRequired[BucketLocationConstraintType],  # (1)
  1. See BucketLocationConstraintType

CreateBucketOutputTypeDef#

# CreateBucketOutputTypeDef usage example

from mypy_boto3_s3.type_defs import CreateBucketOutputTypeDef

def get_value() -> CreateBucketOutputTypeDef:
    return {
        "Location": ...,
        "ResponseMetadata": ...,
    }
# CreateBucketOutputTypeDef definition

class CreateBucketOutputTypeDef(TypedDict):
    Location: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMultipartUploadOutputTypeDef#

# CreateMultipartUploadOutputTypeDef usage example

from mypy_boto3_s3.type_defs import CreateMultipartUploadOutputTypeDef

def get_value() -> CreateMultipartUploadOutputTypeDef:
    return {
        "AbortDate": ...,
        "AbortRuleId": ...,
        "Bucket": ...,
        "Key": ...,
        "UploadId": ...,
        "ServerSideEncryption": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "SSEKMSEncryptionContext": ...,
        "BucketKeyEnabled": ...,
        "RequestCharged": ...,
        "ChecksumAlgorithm": ...,
        "ResponseMetadata": ...,
    }
# CreateMultipartUploadOutputTypeDef definition

class CreateMultipartUploadOutputTypeDef(TypedDict):
    AbortDate: datetime,
    AbortRuleId: str,
    Bucket: str,
    Key: str,
    UploadId: str,
    ServerSideEncryption: ServerSideEncryptionType,  # (1)
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    SSEKMSEncryptionContext: str,
    BucketKeyEnabled: bool,
    RequestCharged: RequestChargedType,  # (2)
    ChecksumAlgorithm: ChecksumAlgorithmType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ServerSideEncryptionType
  2. See RequestChargedType
  3. See ChecksumAlgorithmType
  4. See ResponseMetadataTypeDef

CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef#

# CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef usage example

from mypy_boto3_s3.type_defs import CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef

def get_value() -> CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef:
    return {
        "ACL": ...,
    }
# CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef definition

class CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef(TypedDict):
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    CacheControl: NotRequired[str],
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentType: NotRequired[str],
    Expires: NotRequired[Union[datetime, str]],
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    Metadata: NotRequired[Mapping[str, str]],
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (2)
    StorageClass: NotRequired[StorageClassType],  # (3)
    WebsiteRedirectLocation: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSEKMSEncryptionContext: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],
    RequestPayer: NotRequired[RequestPayerType],  # (4)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (5)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (6)
    ExpectedBucketOwner: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (7)
  1. See ObjectCannedACLType
  2. See ServerSideEncryptionType
  3. See StorageClassType
  4. See RequestPayerType
  5. See ObjectLockModeType
  6. See ObjectLockLegalHoldStatusType
  7. See ChecksumAlgorithmType

CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef#

# CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef usage example

from mypy_boto3_s3.type_defs import CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef

def get_value() -> CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef:
    return {
        "ACL": ...,
    }
# CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef definition

class CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef(TypedDict):
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    CacheControl: NotRequired[str],
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentType: NotRequired[str],
    Expires: NotRequired[Union[datetime, str]],
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    Metadata: NotRequired[Mapping[str, str]],
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (2)
    StorageClass: NotRequired[StorageClassType],  # (3)
    WebsiteRedirectLocation: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSEKMSEncryptionContext: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],
    RequestPayer: NotRequired[RequestPayerType],  # (4)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (5)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (6)
    ExpectedBucketOwner: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (7)
  1. See ObjectCannedACLType
  2. See ServerSideEncryptionType
  3. See StorageClassType
  4. See RequestPayerType
  5. See ObjectLockModeType
  6. See ObjectLockLegalHoldStatusType
  7. See ChecksumAlgorithmType

CreateMultipartUploadRequestRequestTypeDef#

# CreateMultipartUploadRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import CreateMultipartUploadRequestRequestTypeDef

def get_value() -> CreateMultipartUploadRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# CreateMultipartUploadRequestRequestTypeDef definition

class CreateMultipartUploadRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    CacheControl: NotRequired[str],
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentType: NotRequired[str],
    Expires: NotRequired[Union[datetime, str]],
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    Metadata: NotRequired[Mapping[str, str]],
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (2)
    StorageClass: NotRequired[StorageClassType],  # (3)
    WebsiteRedirectLocation: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSEKMSEncryptionContext: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],
    RequestPayer: NotRequired[RequestPayerType],  # (4)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (5)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (6)
    ExpectedBucketOwner: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (7)
  1. See ObjectCannedACLType
  2. See ServerSideEncryptionType
  3. See StorageClassType
  4. See RequestPayerType
  5. See ObjectLockModeType
  6. See ObjectLockLegalHoldStatusType
  7. See ChecksumAlgorithmType

DefaultRetentionTypeDef#

# DefaultRetentionTypeDef usage example

from mypy_boto3_s3.type_defs import DefaultRetentionTypeDef

def get_value() -> DefaultRetentionTypeDef:
    return {
        "Mode": ...,
    }
# DefaultRetentionTypeDef definition

class DefaultRetentionTypeDef(TypedDict):
    Mode: NotRequired[ObjectLockRetentionModeType],  # (1)
    Days: NotRequired[int],
    Years: NotRequired[int],
  1. See ObjectLockRetentionModeType

DeleteBucketAnalyticsConfigurationRequestRequestTypeDef#

# DeleteBucketAnalyticsConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketAnalyticsConfigurationRequestRequestTypeDef

def get_value() -> DeleteBucketAnalyticsConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# DeleteBucketAnalyticsConfigurationRequestRequestTypeDef definition

class DeleteBucketAnalyticsConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketCorsRequestBucketCorsDeleteTypeDef#

# DeleteBucketCorsRequestBucketCorsDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketCorsRequestBucketCorsDeleteTypeDef

def get_value() -> DeleteBucketCorsRequestBucketCorsDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketCorsRequestBucketCorsDeleteTypeDef definition

class DeleteBucketCorsRequestBucketCorsDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketCorsRequestRequestTypeDef#

# DeleteBucketCorsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketCorsRequestRequestTypeDef

def get_value() -> DeleteBucketCorsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketCorsRequestRequestTypeDef definition

class DeleteBucketCorsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketEncryptionRequestRequestTypeDef#

# DeleteBucketEncryptionRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketEncryptionRequestRequestTypeDef

def get_value() -> DeleteBucketEncryptionRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketEncryptionRequestRequestTypeDef definition

class DeleteBucketEncryptionRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef#

# DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef

def get_value() -> DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef definition

class DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,

DeleteBucketInventoryConfigurationRequestRequestTypeDef#

# DeleteBucketInventoryConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketInventoryConfigurationRequestRequestTypeDef

def get_value() -> DeleteBucketInventoryConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# DeleteBucketInventoryConfigurationRequestRequestTypeDef definition

class DeleteBucketInventoryConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef#

# DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef

def get_value() -> DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef definition

class DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef#

# DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef

def get_value() -> DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef definition

class DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketLifecycleRequestRequestTypeDef#

# DeleteBucketLifecycleRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketLifecycleRequestRequestTypeDef

def get_value() -> DeleteBucketLifecycleRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketLifecycleRequestRequestTypeDef definition

class DeleteBucketLifecycleRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketMetricsConfigurationRequestRequestTypeDef#

# DeleteBucketMetricsConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketMetricsConfigurationRequestRequestTypeDef

def get_value() -> DeleteBucketMetricsConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# DeleteBucketMetricsConfigurationRequestRequestTypeDef definition

class DeleteBucketMetricsConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketOwnershipControlsRequestRequestTypeDef#

# DeleteBucketOwnershipControlsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketOwnershipControlsRequestRequestTypeDef

def get_value() -> DeleteBucketOwnershipControlsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketOwnershipControlsRequestRequestTypeDef definition

class DeleteBucketOwnershipControlsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef#

# DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef

def get_value() -> DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef definition

class DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketPolicyRequestRequestTypeDef#

# DeleteBucketPolicyRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketPolicyRequestRequestTypeDef

def get_value() -> DeleteBucketPolicyRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketPolicyRequestRequestTypeDef definition

class DeleteBucketPolicyRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketReplicationRequestRequestTypeDef#

# DeleteBucketReplicationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketReplicationRequestRequestTypeDef

def get_value() -> DeleteBucketReplicationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketReplicationRequestRequestTypeDef definition

class DeleteBucketReplicationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketRequestBucketDeleteTypeDef#

# DeleteBucketRequestBucketDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketRequestBucketDeleteTypeDef

def get_value() -> DeleteBucketRequestBucketDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketRequestBucketDeleteTypeDef definition

class DeleteBucketRequestBucketDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketRequestRequestTypeDef#

# DeleteBucketRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketRequestRequestTypeDef

def get_value() -> DeleteBucketRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketRequestRequestTypeDef definition

class DeleteBucketRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef#

# DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef

def get_value() -> DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef definition

class DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketTaggingRequestRequestTypeDef#

# DeleteBucketTaggingRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketTaggingRequestRequestTypeDef

def get_value() -> DeleteBucketTaggingRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketTaggingRequestRequestTypeDef definition

class DeleteBucketTaggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef#

# DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef

def get_value() -> DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef:
    return {
        "ExpectedBucketOwner": ...,
    }
# DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef definition

class DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef(TypedDict):
    ExpectedBucketOwner: NotRequired[str],

DeleteBucketWebsiteRequestRequestTypeDef#

# DeleteBucketWebsiteRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteBucketWebsiteRequestRequestTypeDef

def get_value() -> DeleteBucketWebsiteRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeleteBucketWebsiteRequestRequestTypeDef definition

class DeleteBucketWebsiteRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

DeleteMarkerReplicationTypeDef#

# DeleteMarkerReplicationTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteMarkerReplicationTypeDef

def get_value() -> DeleteMarkerReplicationTypeDef:
    return {
        "Status": ...,
    }
# DeleteMarkerReplicationTypeDef definition

class DeleteMarkerReplicationTypeDef(TypedDict):
    Status: NotRequired[DeleteMarkerReplicationStatusType],  # (1)
  1. See DeleteMarkerReplicationStatusType

DeleteObjectOutputTypeDef#

# DeleteObjectOutputTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectOutputTypeDef

def get_value() -> DeleteObjectOutputTypeDef:
    return {
        "DeleteMarker": ...,
        "VersionId": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# DeleteObjectOutputTypeDef definition

class DeleteObjectOutputTypeDef(TypedDict):
    DeleteMarker: bool,
    VersionId: str,
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestChargedType
  2. See ResponseMetadataTypeDef

DeleteObjectRequestObjectDeleteTypeDef#

# DeleteObjectRequestObjectDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectRequestObjectDeleteTypeDef

def get_value() -> DeleteObjectRequestObjectDeleteTypeDef:
    return {
        "MFA": ...,
    }
# DeleteObjectRequestObjectDeleteTypeDef definition

class DeleteObjectRequestObjectDeleteTypeDef(TypedDict):
    MFA: NotRequired[str],
    VersionId: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

DeleteObjectRequestObjectSummaryDeleteTypeDef#

# DeleteObjectRequestObjectSummaryDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectRequestObjectSummaryDeleteTypeDef

def get_value() -> DeleteObjectRequestObjectSummaryDeleteTypeDef:
    return {
        "MFA": ...,
    }
# DeleteObjectRequestObjectSummaryDeleteTypeDef definition

class DeleteObjectRequestObjectSummaryDeleteTypeDef(TypedDict):
    MFA: NotRequired[str],
    VersionId: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

DeleteObjectRequestObjectVersionDeleteTypeDef#

# DeleteObjectRequestObjectVersionDeleteTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectRequestObjectVersionDeleteTypeDef

def get_value() -> DeleteObjectRequestObjectVersionDeleteTypeDef:
    return {
        "MFA": ...,
    }
# DeleteObjectRequestObjectVersionDeleteTypeDef definition

class DeleteObjectRequestObjectVersionDeleteTypeDef(TypedDict):
    MFA: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

DeleteObjectRequestRequestTypeDef#

# DeleteObjectRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectRequestRequestTypeDef

def get_value() -> DeleteObjectRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# DeleteObjectRequestRequestTypeDef definition

class DeleteObjectRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    MFA: NotRequired[str],
    VersionId: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

DeleteObjectTaggingOutputTypeDef#

# DeleteObjectTaggingOutputTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectTaggingOutputTypeDef

def get_value() -> DeleteObjectTaggingOutputTypeDef:
    return {
        "VersionId": ...,
        "ResponseMetadata": ...,
    }
# DeleteObjectTaggingOutputTypeDef definition

class DeleteObjectTaggingOutputTypeDef(TypedDict):
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteObjectTaggingRequestRequestTypeDef#

# DeleteObjectTaggingRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeleteObjectTaggingRequestRequestTypeDef

def get_value() -> DeleteObjectTaggingRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# DeleteObjectTaggingRequestRequestTypeDef definition

class DeleteObjectTaggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

DeletedObjectTypeDef#

# DeletedObjectTypeDef usage example

from mypy_boto3_s3.type_defs import DeletedObjectTypeDef

def get_value() -> DeletedObjectTypeDef:
    return {
        "Key": ...,
    }
# DeletedObjectTypeDef definition

class DeletedObjectTypeDef(TypedDict):
    Key: NotRequired[str],
    VersionId: NotRequired[str],
    DeleteMarker: NotRequired[bool],
    DeleteMarkerVersionId: NotRequired[str],

ErrorTypeDef#

# ErrorTypeDef usage example

from mypy_boto3_s3.type_defs import ErrorTypeDef

def get_value() -> ErrorTypeDef:
    return {
        "Key": ...,
    }
# ErrorTypeDef definition

class ErrorTypeDef(TypedDict):
    Key: NotRequired[str],
    VersionId: NotRequired[str],
    Code: NotRequired[str],
    Message: NotRequired[str],

DeletePublicAccessBlockRequestRequestTypeDef#

# DeletePublicAccessBlockRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import DeletePublicAccessBlockRequestRequestTypeDef

def get_value() -> DeletePublicAccessBlockRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# DeletePublicAccessBlockRequestRequestTypeDef definition

class DeletePublicAccessBlockRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

ObjectIdentifierTypeDef#

# ObjectIdentifierTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectIdentifierTypeDef

def get_value() -> ObjectIdentifierTypeDef:
    return {
        "Key": ...,
    }
# ObjectIdentifierTypeDef definition

class ObjectIdentifierTypeDef(TypedDict):
    Key: str,
    VersionId: NotRequired[str],

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import EncryptionConfigurationTypeDef

def get_value() -> EncryptionConfigurationTypeDef:
    return {
        "ReplicaKmsKeyID": ...,
    }
# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    ReplicaKmsKeyID: NotRequired[str],

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_s3.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

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

EncryptionTypeDef#

# EncryptionTypeDef usage example

from mypy_boto3_s3.type_defs import EncryptionTypeDef

def get_value() -> EncryptionTypeDef:
    return {
        "EncryptionType": ...,
    }
# EncryptionTypeDef definition

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

ErrorDocumentResponseMetadataTypeDef#

# ErrorDocumentResponseMetadataTypeDef usage example

from mypy_boto3_s3.type_defs import ErrorDocumentResponseMetadataTypeDef

def get_value() -> ErrorDocumentResponseMetadataTypeDef:
    return {
        "Key": ...,
        "ResponseMetadata": ...,
    }
# ErrorDocumentResponseMetadataTypeDef definition

class ErrorDocumentResponseMetadataTypeDef(TypedDict):
    Key: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ErrorDocumentTypeDef#

# ErrorDocumentTypeDef usage example

from mypy_boto3_s3.type_defs import ErrorDocumentTypeDef

def get_value() -> ErrorDocumentTypeDef:
    return {
        "Key": ...,
    }
# ErrorDocumentTypeDef definition

class ErrorDocumentTypeDef(TypedDict):
    Key: str,

ExistingObjectReplicationTypeDef#

# ExistingObjectReplicationTypeDef usage example

from mypy_boto3_s3.type_defs import ExistingObjectReplicationTypeDef

def get_value() -> ExistingObjectReplicationTypeDef:
    return {
        "Status": ...,
    }
# ExistingObjectReplicationTypeDef definition

class ExistingObjectReplicationTypeDef(TypedDict):
    Status: ExistingObjectReplicationStatusType,  # (1)
  1. See ExistingObjectReplicationStatusType

FilterRuleTypeDef#

# FilterRuleTypeDef usage example

from mypy_boto3_s3.type_defs import FilterRuleTypeDef

def get_value() -> FilterRuleTypeDef:
    return {
        "Name": ...,
    }
# FilterRuleTypeDef definition

class FilterRuleTypeDef(TypedDict):
    Name: NotRequired[FilterRuleNameType],  # (1)
    Value: NotRequired[str],
  1. See FilterRuleNameType

GetBucketAccelerateConfigurationOutputTypeDef#

# GetBucketAccelerateConfigurationOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketAccelerateConfigurationOutputTypeDef

def get_value() -> GetBucketAccelerateConfigurationOutputTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }
# GetBucketAccelerateConfigurationOutputTypeDef definition

class GetBucketAccelerateConfigurationOutputTypeDef(TypedDict):
    Status: BucketAccelerateStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BucketAccelerateStatusType
  2. See ResponseMetadataTypeDef

GetBucketAccelerateConfigurationRequestRequestTypeDef#

# GetBucketAccelerateConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketAccelerateConfigurationRequestRequestTypeDef

def get_value() -> GetBucketAccelerateConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketAccelerateConfigurationRequestRequestTypeDef definition

class GetBucketAccelerateConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketAclRequestRequestTypeDef#

# GetBucketAclRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketAclRequestRequestTypeDef

def get_value() -> GetBucketAclRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketAclRequestRequestTypeDef definition

class GetBucketAclRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketAnalyticsConfigurationRequestRequestTypeDef#

# GetBucketAnalyticsConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketAnalyticsConfigurationRequestRequestTypeDef

def get_value() -> GetBucketAnalyticsConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# GetBucketAnalyticsConfigurationRequestRequestTypeDef definition

class GetBucketAnalyticsConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketCorsRequestRequestTypeDef#

# GetBucketCorsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketCorsRequestRequestTypeDef

def get_value() -> GetBucketCorsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketCorsRequestRequestTypeDef definition

class GetBucketCorsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketEncryptionRequestRequestTypeDef#

# GetBucketEncryptionRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketEncryptionRequestRequestTypeDef

def get_value() -> GetBucketEncryptionRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketEncryptionRequestRequestTypeDef definition

class GetBucketEncryptionRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketIntelligentTieringConfigurationRequestRequestTypeDef#

# GetBucketIntelligentTieringConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketIntelligentTieringConfigurationRequestRequestTypeDef

def get_value() -> GetBucketIntelligentTieringConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# GetBucketIntelligentTieringConfigurationRequestRequestTypeDef definition

class GetBucketIntelligentTieringConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,

GetBucketInventoryConfigurationRequestRequestTypeDef#

# GetBucketInventoryConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketInventoryConfigurationRequestRequestTypeDef

def get_value() -> GetBucketInventoryConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# GetBucketInventoryConfigurationRequestRequestTypeDef definition

class GetBucketInventoryConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketLifecycleConfigurationRequestRequestTypeDef#

# GetBucketLifecycleConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketLifecycleConfigurationRequestRequestTypeDef

def get_value() -> GetBucketLifecycleConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketLifecycleConfigurationRequestRequestTypeDef definition

class GetBucketLifecycleConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketLifecycleRequestRequestTypeDef#

# GetBucketLifecycleRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketLifecycleRequestRequestTypeDef

def get_value() -> GetBucketLifecycleRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketLifecycleRequestRequestTypeDef definition

class GetBucketLifecycleRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketLocationOutputTypeDef#

# GetBucketLocationOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketLocationOutputTypeDef

def get_value() -> GetBucketLocationOutputTypeDef:
    return {
        "LocationConstraint": ...,
        "ResponseMetadata": ...,
    }
# GetBucketLocationOutputTypeDef definition

class GetBucketLocationOutputTypeDef(TypedDict):
    LocationConstraint: BucketLocationConstraintType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BucketLocationConstraintType
  2. See ResponseMetadataTypeDef

GetBucketLocationRequestRequestTypeDef#

# GetBucketLocationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketLocationRequestRequestTypeDef

def get_value() -> GetBucketLocationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketLocationRequestRequestTypeDef definition

class GetBucketLocationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketLoggingRequestRequestTypeDef#

# GetBucketLoggingRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketLoggingRequestRequestTypeDef

def get_value() -> GetBucketLoggingRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketLoggingRequestRequestTypeDef definition

class GetBucketLoggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketMetricsConfigurationRequestRequestTypeDef#

# GetBucketMetricsConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketMetricsConfigurationRequestRequestTypeDef

def get_value() -> GetBucketMetricsConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Id": ...,
    }
# GetBucketMetricsConfigurationRequestRequestTypeDef definition

class GetBucketMetricsConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketNotificationConfigurationRequestRequestTypeDef#

# GetBucketNotificationConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketNotificationConfigurationRequestRequestTypeDef

def get_value() -> GetBucketNotificationConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketNotificationConfigurationRequestRequestTypeDef definition

class GetBucketNotificationConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketOwnershipControlsRequestRequestTypeDef#

# GetBucketOwnershipControlsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketOwnershipControlsRequestRequestTypeDef

def get_value() -> GetBucketOwnershipControlsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketOwnershipControlsRequestRequestTypeDef definition

class GetBucketOwnershipControlsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketPolicyOutputTypeDef#

# GetBucketPolicyOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketPolicyOutputTypeDef

def get_value() -> GetBucketPolicyOutputTypeDef:
    return {
        "Policy": ...,
        "ResponseMetadata": ...,
    }
# GetBucketPolicyOutputTypeDef definition

class GetBucketPolicyOutputTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBucketPolicyRequestRequestTypeDef#

# GetBucketPolicyRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketPolicyRequestRequestTypeDef

def get_value() -> GetBucketPolicyRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketPolicyRequestRequestTypeDef definition

class GetBucketPolicyRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

PolicyStatusTypeDef#

# PolicyStatusTypeDef usage example

from mypy_boto3_s3.type_defs import PolicyStatusTypeDef

def get_value() -> PolicyStatusTypeDef:
    return {
        "IsPublic": ...,
    }
# PolicyStatusTypeDef definition

class PolicyStatusTypeDef(TypedDict):
    IsPublic: NotRequired[bool],

GetBucketPolicyStatusRequestRequestTypeDef#

# GetBucketPolicyStatusRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketPolicyStatusRequestRequestTypeDef

def get_value() -> GetBucketPolicyStatusRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketPolicyStatusRequestRequestTypeDef definition

class GetBucketPolicyStatusRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketReplicationRequestRequestTypeDef#

# GetBucketReplicationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketReplicationRequestRequestTypeDef

def get_value() -> GetBucketReplicationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketReplicationRequestRequestTypeDef definition

class GetBucketReplicationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketRequestPaymentOutputTypeDef#

# GetBucketRequestPaymentOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketRequestPaymentOutputTypeDef

def get_value() -> GetBucketRequestPaymentOutputTypeDef:
    return {
        "Payer": ...,
        "ResponseMetadata": ...,
    }
# GetBucketRequestPaymentOutputTypeDef definition

class GetBucketRequestPaymentOutputTypeDef(TypedDict):
    Payer: PayerType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PayerType
  2. See ResponseMetadataTypeDef

GetBucketRequestPaymentRequestRequestTypeDef#

# GetBucketRequestPaymentRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketRequestPaymentRequestRequestTypeDef

def get_value() -> GetBucketRequestPaymentRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketRequestPaymentRequestRequestTypeDef definition

class GetBucketRequestPaymentRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketTaggingRequestRequestTypeDef#

# GetBucketTaggingRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketTaggingRequestRequestTypeDef

def get_value() -> GetBucketTaggingRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketTaggingRequestRequestTypeDef definition

class GetBucketTaggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetBucketVersioningOutputTypeDef#

# GetBucketVersioningOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketVersioningOutputTypeDef

def get_value() -> GetBucketVersioningOutputTypeDef:
    return {
        "Status": ...,
        "MFADelete": ...,
        "ResponseMetadata": ...,
    }
# GetBucketVersioningOutputTypeDef definition

class GetBucketVersioningOutputTypeDef(TypedDict):
    Status: BucketVersioningStatusType,  # (1)
    MFADelete: MFADeleteStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BucketVersioningStatusType
  2. See MFADeleteStatusType
  3. See ResponseMetadataTypeDef

GetBucketVersioningRequestRequestTypeDef#

# GetBucketVersioningRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketVersioningRequestRequestTypeDef

def get_value() -> GetBucketVersioningRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketVersioningRequestRequestTypeDef definition

class GetBucketVersioningRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

IndexDocumentTypeDef#

# IndexDocumentTypeDef usage example

from mypy_boto3_s3.type_defs import IndexDocumentTypeDef

def get_value() -> IndexDocumentTypeDef:
    return {
        "Suffix": ...,
    }
# IndexDocumentTypeDef definition

class IndexDocumentTypeDef(TypedDict):
    Suffix: str,

RedirectAllRequestsToTypeDef#

# RedirectAllRequestsToTypeDef usage example

from mypy_boto3_s3.type_defs import RedirectAllRequestsToTypeDef

def get_value() -> RedirectAllRequestsToTypeDef:
    return {
        "HostName": ...,
    }
# RedirectAllRequestsToTypeDef definition

class RedirectAllRequestsToTypeDef(TypedDict):
    HostName: str,
    Protocol: NotRequired[ProtocolType],  # (1)
  1. See ProtocolType

GetBucketWebsiteRequestRequestTypeDef#

# GetBucketWebsiteRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetBucketWebsiteRequestRequestTypeDef

def get_value() -> GetBucketWebsiteRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetBucketWebsiteRequestRequestTypeDef definition

class GetBucketWebsiteRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetObjectAclRequestRequestTypeDef#

# GetObjectAclRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectAclRequestRequestTypeDef

def get_value() -> GetObjectAclRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# GetObjectAclRequestRequestTypeDef definition

class GetObjectAclRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

ObjectPartTypeDef#

# ObjectPartTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectPartTypeDef

def get_value() -> ObjectPartTypeDef:
    return {
        "PartNumber": ...,
    }
# ObjectPartTypeDef definition

class ObjectPartTypeDef(TypedDict):
    PartNumber: NotRequired[int],
    Size: NotRequired[int],
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],

GetObjectAttributesRequestRequestTypeDef#

# GetObjectAttributesRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectAttributesRequestRequestTypeDef

def get_value() -> GetObjectAttributesRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "ObjectAttributes": ...,
    }
# GetObjectAttributesRequestRequestTypeDef definition

class GetObjectAttributesRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    ObjectAttributes: Sequence[ObjectAttributesType],  # (1)
    VersionId: NotRequired[str],
    MaxParts: NotRequired[int],
    PartNumberMarker: NotRequired[int],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
  1. See ObjectAttributesType
  2. See RequestPayerType

ObjectLockLegalHoldTypeDef#

# ObjectLockLegalHoldTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectLockLegalHoldTypeDef

def get_value() -> ObjectLockLegalHoldTypeDef:
    return {
        "Status": ...,
    }
# ObjectLockLegalHoldTypeDef definition

class ObjectLockLegalHoldTypeDef(TypedDict):
    Status: NotRequired[ObjectLockLegalHoldStatusType],  # (1)
  1. See ObjectLockLegalHoldStatusType

GetObjectLegalHoldRequestRequestTypeDef#

# GetObjectLegalHoldRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectLegalHoldRequestRequestTypeDef

def get_value() -> GetObjectLegalHoldRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# GetObjectLegalHoldRequestRequestTypeDef definition

class GetObjectLegalHoldRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

GetObjectLockConfigurationRequestRequestTypeDef#

# GetObjectLockConfigurationRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectLockConfigurationRequestRequestTypeDef

def get_value() -> GetObjectLockConfigurationRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetObjectLockConfigurationRequestRequestTypeDef definition

class GetObjectLockConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GetObjectOutputTypeDef#

# GetObjectOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectOutputTypeDef

def get_value() -> GetObjectOutputTypeDef:
    return {
        "Body": ...,
        "DeleteMarker": ...,
        "AcceptRanges": ...,
        "Expiration": ...,
        "Restore": ...,
        "LastModified": ...,
        "ContentLength": ...,
        "ETag": ...,
        "ChecksumCRC32": ...,
        "ChecksumCRC32C": ...,
        "ChecksumSHA1": ...,
        "ChecksumSHA256": ...,
        "MissingMeta": ...,
        "VersionId": ...,
        "CacheControl": ...,
        "ContentDisposition": ...,
        "ContentEncoding": ...,
        "ContentLanguage": ...,
        "ContentRange": ...,
        "ContentType": ...,
        "Expires": ...,
        "WebsiteRedirectLocation": ...,
        "ServerSideEncryption": ...,
        "Metadata": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "BucketKeyEnabled": ...,
        "StorageClass": ...,
        "RequestCharged": ...,
        "ReplicationStatus": ...,
        "PartsCount": ...,
        "TagCount": ...,
        "ObjectLockMode": ...,
        "ObjectLockRetainUntilDate": ...,
        "ObjectLockLegalHoldStatus": ...,
        "ResponseMetadata": ...,
    }
# GetObjectOutputTypeDef definition

class GetObjectOutputTypeDef(TypedDict):
    Body: StreamingBody,
    DeleteMarker: bool,
    AcceptRanges: str,
    Expiration: str,
    Restore: str,
    LastModified: datetime,
    ContentLength: int,
    ETag: str,
    ChecksumCRC32: str,
    ChecksumCRC32C: str,
    ChecksumSHA1: str,
    ChecksumSHA256: str,
    MissingMeta: int,
    VersionId: str,
    CacheControl: str,
    ContentDisposition: str,
    ContentEncoding: str,
    ContentLanguage: str,
    ContentRange: str,
    ContentType: str,
    Expires: datetime,
    WebsiteRedirectLocation: str,
    ServerSideEncryption: ServerSideEncryptionType,  # (1)
    Metadata: Dict[str, str],
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    BucketKeyEnabled: bool,
    StorageClass: StorageClassType,  # (2)
    RequestCharged: RequestChargedType,  # (3)
    ReplicationStatus: ReplicationStatusType,  # (4)
    PartsCount: int,
    TagCount: int,
    ObjectLockMode: ObjectLockModeType,  # (5)
    ObjectLockRetainUntilDate: datetime,
    ObjectLockLegalHoldStatus: ObjectLockLegalHoldStatusType,  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See ServerSideEncryptionType
  2. See StorageClassType
  3. See RequestChargedType
  4. See ReplicationStatusType
  5. See ObjectLockModeType
  6. See ObjectLockLegalHoldStatusType
  7. See ResponseMetadataTypeDef

GetObjectRequestObjectGetTypeDef#

# GetObjectRequestObjectGetTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectRequestObjectGetTypeDef

def get_value() -> GetObjectRequestObjectGetTypeDef:
    return {
        "IfMatch": ...,
    }
# GetObjectRequestObjectGetTypeDef definition

class GetObjectRequestObjectGetTypeDef(TypedDict):
    IfMatch: NotRequired[str],
    IfModifiedSince: NotRequired[Union[datetime, str]],
    IfNoneMatch: NotRequired[str],
    IfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Range: NotRequired[str],
    ResponseCacheControl: NotRequired[str],
    ResponseContentDisposition: NotRequired[str],
    ResponseContentEncoding: NotRequired[str],
    ResponseContentLanguage: NotRequired[str],
    ResponseContentType: NotRequired[str],
    ResponseExpires: NotRequired[Union[datetime, str]],
    VersionId: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    PartNumber: NotRequired[int],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumMode: NotRequired[ChecksumModeType],  # (2)
  1. See RequestPayerType
  2. See ChecksumModeType

GetObjectRequestObjectSummaryGetTypeDef#

# GetObjectRequestObjectSummaryGetTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectRequestObjectSummaryGetTypeDef

def get_value() -> GetObjectRequestObjectSummaryGetTypeDef:
    return {
        "IfMatch": ...,
    }
# GetObjectRequestObjectSummaryGetTypeDef definition

class GetObjectRequestObjectSummaryGetTypeDef(TypedDict):
    IfMatch: NotRequired[str],
    IfModifiedSince: NotRequired[Union[datetime, str]],
    IfNoneMatch: NotRequired[str],
    IfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Range: NotRequired[str],
    ResponseCacheControl: NotRequired[str],
    ResponseContentDisposition: NotRequired[str],
    ResponseContentEncoding: NotRequired[str],
    ResponseContentLanguage: NotRequired[str],
    ResponseContentType: NotRequired[str],
    ResponseExpires: NotRequired[Union[datetime, str]],
    VersionId: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    PartNumber: NotRequired[int],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumMode: NotRequired[ChecksumModeType],  # (2)
  1. See RequestPayerType
  2. See ChecksumModeType

GetObjectRequestObjectVersionGetTypeDef#

# GetObjectRequestObjectVersionGetTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectRequestObjectVersionGetTypeDef

def get_value() -> GetObjectRequestObjectVersionGetTypeDef:
    return {
        "IfMatch": ...,
    }
# GetObjectRequestObjectVersionGetTypeDef definition

class GetObjectRequestObjectVersionGetTypeDef(TypedDict):
    IfMatch: NotRequired[str],
    IfModifiedSince: NotRequired[Union[datetime, str]],
    IfNoneMatch: NotRequired[str],
    IfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Range: NotRequired[str],
    ResponseCacheControl: NotRequired[str],
    ResponseContentDisposition: NotRequired[str],
    ResponseContentEncoding: NotRequired[str],
    ResponseContentLanguage: NotRequired[str],
    ResponseContentType: NotRequired[str],
    ResponseExpires: NotRequired[Union[datetime, str]],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    PartNumber: NotRequired[int],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumMode: NotRequired[ChecksumModeType],  # (2)
  1. See RequestPayerType
  2. See ChecksumModeType

GetObjectRequestRequestTypeDef#

# GetObjectRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectRequestRequestTypeDef

def get_value() -> GetObjectRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# GetObjectRequestRequestTypeDef definition

class GetObjectRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    IfMatch: NotRequired[str],
    IfModifiedSince: NotRequired[Union[datetime, str]],
    IfNoneMatch: NotRequired[str],
    IfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Range: NotRequired[str],
    ResponseCacheControl: NotRequired[str],
    ResponseContentDisposition: NotRequired[str],
    ResponseContentEncoding: NotRequired[str],
    ResponseContentLanguage: NotRequired[str],
    ResponseContentType: NotRequired[str],
    ResponseExpires: NotRequired[Union[datetime, str]],
    VersionId: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    PartNumber: NotRequired[int],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumMode: NotRequired[ChecksumModeType],  # (2)
  1. See RequestPayerType
  2. See ChecksumModeType

ObjectLockRetentionTypeDef#

# ObjectLockRetentionTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectLockRetentionTypeDef

def get_value() -> ObjectLockRetentionTypeDef:
    return {
        "Mode": ...,
    }
# ObjectLockRetentionTypeDef definition

class ObjectLockRetentionTypeDef(TypedDict):
    Mode: NotRequired[ObjectLockRetentionModeType],  # (1)
    RetainUntilDate: NotRequired[datetime],
  1. See ObjectLockRetentionModeType

GetObjectRetentionRequestRequestTypeDef#

# GetObjectRetentionRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectRetentionRequestRequestTypeDef

def get_value() -> GetObjectRetentionRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# GetObjectRetentionRequestRequestTypeDef definition

class GetObjectRetentionRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

GetObjectTaggingRequestRequestTypeDef#

# GetObjectTaggingRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectTaggingRequestRequestTypeDef

def get_value() -> GetObjectTaggingRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# GetObjectTaggingRequestRequestTypeDef definition

class GetObjectTaggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
  1. See RequestPayerType

GetObjectTorrentOutputTypeDef#

# GetObjectTorrentOutputTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectTorrentOutputTypeDef

def get_value() -> GetObjectTorrentOutputTypeDef:
    return {
        "Body": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# GetObjectTorrentOutputTypeDef definition

class GetObjectTorrentOutputTypeDef(TypedDict):
    Body: StreamingBody,
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestChargedType
  2. See ResponseMetadataTypeDef

GetObjectTorrentRequestRequestTypeDef#

# GetObjectTorrentRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetObjectTorrentRequestRequestTypeDef

def get_value() -> GetObjectTorrentRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# GetObjectTorrentRequestRequestTypeDef definition

class GetObjectTorrentRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
  1. See RequestPayerType

PublicAccessBlockConfigurationTypeDef#

# PublicAccessBlockConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import PublicAccessBlockConfigurationTypeDef

def get_value() -> PublicAccessBlockConfigurationTypeDef:
    return {
        "BlockPublicAcls": ...,
    }
# PublicAccessBlockConfigurationTypeDef definition

class PublicAccessBlockConfigurationTypeDef(TypedDict):
    BlockPublicAcls: NotRequired[bool],
    IgnorePublicAcls: NotRequired[bool],
    BlockPublicPolicy: NotRequired[bool],
    RestrictPublicBuckets: NotRequired[bool],

GetPublicAccessBlockRequestRequestTypeDef#

# GetPublicAccessBlockRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import GetPublicAccessBlockRequestRequestTypeDef

def get_value() -> GetPublicAccessBlockRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# GetPublicAccessBlockRequestRequestTypeDef definition

class GetPublicAccessBlockRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

GlacierJobParametersTypeDef#

# GlacierJobParametersTypeDef usage example

from mypy_boto3_s3.type_defs import GlacierJobParametersTypeDef

def get_value() -> GlacierJobParametersTypeDef:
    return {
        "Tier": ...,
    }
# GlacierJobParametersTypeDef definition

class GlacierJobParametersTypeDef(TypedDict):
    Tier: TierType,  # (1)
  1. See TierType

GranteeTypeDef#

# GranteeTypeDef usage example

from mypy_boto3_s3.type_defs import GranteeTypeDef

def get_value() -> GranteeTypeDef:
    return {
        "Type": ...,
    }
# GranteeTypeDef definition

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

WaiterConfigTypeDef#

# WaiterConfigTypeDef usage example

from mypy_boto3_s3.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }
# WaiterConfigTypeDef definition

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

HeadBucketRequestRequestTypeDef#

# HeadBucketRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import HeadBucketRequestRequestTypeDef

def get_value() -> HeadBucketRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# HeadBucketRequestRequestTypeDef definition

class HeadBucketRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],

HeadObjectOutputTypeDef#

# HeadObjectOutputTypeDef usage example

from mypy_boto3_s3.type_defs import HeadObjectOutputTypeDef

def get_value() -> HeadObjectOutputTypeDef:
    return {
        "DeleteMarker": ...,
        "AcceptRanges": ...,
        "Expiration": ...,
        "Restore": ...,
        "ArchiveStatus": ...,
        "LastModified": ...,
        "ContentLength": ...,
        "ChecksumCRC32": ...,
        "ChecksumCRC32C": ...,
        "ChecksumSHA1": ...,
        "ChecksumSHA256": ...,
        "ETag": ...,
        "MissingMeta": ...,
        "VersionId": ...,
        "CacheControl": ...,
        "ContentDisposition": ...,
        "ContentEncoding": ...,
        "ContentLanguage": ...,
        "ContentType": ...,
        "Expires": ...,
        "WebsiteRedirectLocation": ...,
        "ServerSideEncryption": ...,
        "Metadata": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "BucketKeyEnabled": ...,
        "StorageClass": ...,
        "RequestCharged": ...,
        "ReplicationStatus": ...,
        "PartsCount": ...,
        "ObjectLockMode": ...,
        "ObjectLockRetainUntilDate": ...,
        "ObjectLockLegalHoldStatus": ...,
        "ResponseMetadata": ...,
    }
# HeadObjectOutputTypeDef definition

class HeadObjectOutputTypeDef(TypedDict):
    DeleteMarker: bool,
    AcceptRanges: str,
    Expiration: str,
    Restore: str,
    ArchiveStatus: ArchiveStatusType,  # (1)
    LastModified: datetime,
    ContentLength: int,
    ChecksumCRC32: str,
    ChecksumCRC32C: str,
    ChecksumSHA1: str,
    ChecksumSHA256: str,
    ETag: str,
    MissingMeta: int,
    VersionId: str,
    CacheControl: str,
    ContentDisposition: str,
    ContentEncoding: str,
    ContentLanguage: str,
    ContentType: str,
    Expires: datetime,
    WebsiteRedirectLocation: str,
    ServerSideEncryption: ServerSideEncryptionType,  # (2)
    Metadata: Dict[str, str],
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    BucketKeyEnabled: bool,
    StorageClass: StorageClassType,  # (3)
    RequestCharged: RequestChargedType,  # (4)
    ReplicationStatus: ReplicationStatusType,  # (5)
    PartsCount: int,
    ObjectLockMode: ObjectLockModeType,  # (6)
    ObjectLockRetainUntilDate: datetime,
    ObjectLockLegalHoldStatus: ObjectLockLegalHoldStatusType,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See ArchiveStatusType
  2. See ServerSideEncryptionType
  3. See StorageClassType
  4. See RequestChargedType
  5. See ReplicationStatusType
  6. See ObjectLockModeType
  7. See ObjectLockLegalHoldStatusType
  8. See ResponseMetadataTypeDef

HeadObjectRequestObjectVersionHeadTypeDef#

# HeadObjectRequestObjectVersionHeadTypeDef usage example

from mypy_boto3_s3.type_defs import HeadObjectRequestObjectVersionHeadTypeDef

def get_value() -> HeadObjectRequestObjectVersionHeadTypeDef:
    return {
        "IfMatch": ...,
    }
# HeadObjectRequestObjectVersionHeadTypeDef definition

class HeadObjectRequestObjectVersionHeadTypeDef(TypedDict):
    IfMatch: NotRequired[str],
    IfModifiedSince: NotRequired[Union[datetime, str]],
    IfNoneMatch: NotRequired[str],
    IfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Range: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    PartNumber: NotRequired[int],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumMode: NotRequired[ChecksumModeType],  # (2)
  1. See RequestPayerType
  2. See ChecksumModeType

HeadObjectRequestRequestTypeDef#

# HeadObjectRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import HeadObjectRequestRequestTypeDef

def get_value() -> HeadObjectRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
    }
# HeadObjectRequestRequestTypeDef definition

class HeadObjectRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    IfMatch: NotRequired[str],
    IfModifiedSince: NotRequired[Union[datetime, str]],
    IfNoneMatch: NotRequired[str],
    IfUnmodifiedSince: NotRequired[Union[datetime, str]],
    Range: NotRequired[str],
    VersionId: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    PartNumber: NotRequired[int],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumMode: NotRequired[ChecksumModeType],  # (2)
  1. See RequestPayerType
  2. See ChecksumModeType

IndexDocumentResponseMetadataTypeDef#

# IndexDocumentResponseMetadataTypeDef usage example

from mypy_boto3_s3.type_defs import IndexDocumentResponseMetadataTypeDef

def get_value() -> IndexDocumentResponseMetadataTypeDef:
    return {
        "Suffix": ...,
        "ResponseMetadata": ...,
    }
# IndexDocumentResponseMetadataTypeDef definition

class IndexDocumentResponseMetadataTypeDef(TypedDict):
    Suffix: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiatorResponseMetadataTypeDef#

# InitiatorResponseMetadataTypeDef usage example

from mypy_boto3_s3.type_defs import InitiatorResponseMetadataTypeDef

def get_value() -> InitiatorResponseMetadataTypeDef:
    return {
        "ID": ...,
        "DisplayName": ...,
        "ResponseMetadata": ...,
    }
# InitiatorResponseMetadataTypeDef definition

class InitiatorResponseMetadataTypeDef(TypedDict):
    ID: str,
    DisplayName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiatorTypeDef#

# InitiatorTypeDef usage example

from mypy_boto3_s3.type_defs import InitiatorTypeDef

def get_value() -> InitiatorTypeDef:
    return {
        "ID": ...,
    }
# InitiatorTypeDef definition

class InitiatorTypeDef(TypedDict):
    ID: NotRequired[str],
    DisplayName: NotRequired[str],

JSONInputTypeDef#

# JSONInputTypeDef usage example

from mypy_boto3_s3.type_defs import JSONInputTypeDef

def get_value() -> JSONInputTypeDef:
    return {
        "Type": ...,
    }
# JSONInputTypeDef definition

class JSONInputTypeDef(TypedDict):
    Type: NotRequired[JSONTypeType],  # (1)
  1. See JSONTypeType

TieringTypeDef#

# TieringTypeDef usage example

from mypy_boto3_s3.type_defs import TieringTypeDef

def get_value() -> TieringTypeDef:
    return {
        "Days": ...,
        "AccessTier": ...,
    }
# TieringTypeDef definition

class TieringTypeDef(TypedDict):
    Days: int,
    AccessTier: IntelligentTieringAccessTierType,  # (1)
  1. See IntelligentTieringAccessTierType

InventoryFilterTypeDef#

# InventoryFilterTypeDef usage example

from mypy_boto3_s3.type_defs import InventoryFilterTypeDef

def get_value() -> InventoryFilterTypeDef:
    return {
        "Prefix": ...,
    }
# InventoryFilterTypeDef definition

class InventoryFilterTypeDef(TypedDict):
    Prefix: str,

InventoryScheduleTypeDef#

# InventoryScheduleTypeDef usage example

from mypy_boto3_s3.type_defs import InventoryScheduleTypeDef

def get_value() -> InventoryScheduleTypeDef:
    return {
        "Frequency": ...,
    }
# InventoryScheduleTypeDef definition

class InventoryScheduleTypeDef(TypedDict):
    Frequency: InventoryFrequencyType,  # (1)
  1. See InventoryFrequencyType

SSEKMSTypeDef#

# SSEKMSTypeDef usage example

from mypy_boto3_s3.type_defs import SSEKMSTypeDef

def get_value() -> SSEKMSTypeDef:
    return {
        "KeyId": ...,
    }
# SSEKMSTypeDef definition

class SSEKMSTypeDef(TypedDict):
    KeyId: str,

JSONOutputTypeDef#

# JSONOutputTypeDef usage example

from mypy_boto3_s3.type_defs import JSONOutputTypeDef

def get_value() -> JSONOutputTypeDef:
    return {
        "RecordDelimiter": ...,
    }
# JSONOutputTypeDef definition

class JSONOutputTypeDef(TypedDict):
    RecordDelimiter: NotRequired[str],

LifecycleExpirationTypeDef#

# LifecycleExpirationTypeDef usage example

from mypy_boto3_s3.type_defs import LifecycleExpirationTypeDef

def get_value() -> LifecycleExpirationTypeDef:
    return {
        "Date": ...,
    }
# LifecycleExpirationTypeDef definition

class LifecycleExpirationTypeDef(TypedDict):
    Date: NotRequired[datetime],
    Days: NotRequired[int],
    ExpiredObjectDeleteMarker: NotRequired[bool],

NoncurrentVersionExpirationTypeDef#

# NoncurrentVersionExpirationTypeDef usage example

from mypy_boto3_s3.type_defs import NoncurrentVersionExpirationTypeDef

def get_value() -> NoncurrentVersionExpirationTypeDef:
    return {
        "NoncurrentDays": ...,
    }
# NoncurrentVersionExpirationTypeDef definition

class NoncurrentVersionExpirationTypeDef(TypedDict):
    NoncurrentDays: NotRequired[int],
    NewerNoncurrentVersions: NotRequired[int],

NoncurrentVersionTransitionTypeDef#

# NoncurrentVersionTransitionTypeDef usage example

from mypy_boto3_s3.type_defs import NoncurrentVersionTransitionTypeDef

def get_value() -> NoncurrentVersionTransitionTypeDef:
    return {
        "NoncurrentDays": ...,
    }
# NoncurrentVersionTransitionTypeDef definition

class NoncurrentVersionTransitionTypeDef(TypedDict):
    NoncurrentDays: NotRequired[int],
    StorageClass: NotRequired[TransitionStorageClassType],  # (1)
    NewerNoncurrentVersions: NotRequired[int],
  1. See TransitionStorageClassType

TransitionTypeDef#

# TransitionTypeDef usage example

from mypy_boto3_s3.type_defs import TransitionTypeDef

def get_value() -> TransitionTypeDef:
    return {
        "Date": ...,
    }
# TransitionTypeDef definition

class TransitionTypeDef(TypedDict):
    Date: NotRequired[datetime],
    Days: NotRequired[int],
    StorageClass: NotRequired[TransitionStorageClassType],  # (1)
  1. See TransitionStorageClassType

ListBucketAnalyticsConfigurationsRequestRequestTypeDef#

# ListBucketAnalyticsConfigurationsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListBucketAnalyticsConfigurationsRequestRequestTypeDef

def get_value() -> ListBucketAnalyticsConfigurationsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListBucketAnalyticsConfigurationsRequestRequestTypeDef definition

class ListBucketAnalyticsConfigurationsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ContinuationToken: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef#

# ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef

def get_value() -> ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef definition

class ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ContinuationToken: NotRequired[str],

ListBucketInventoryConfigurationsRequestRequestTypeDef#

# ListBucketInventoryConfigurationsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListBucketInventoryConfigurationsRequestRequestTypeDef

def get_value() -> ListBucketInventoryConfigurationsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListBucketInventoryConfigurationsRequestRequestTypeDef definition

class ListBucketInventoryConfigurationsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ContinuationToken: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

ListBucketMetricsConfigurationsRequestRequestTypeDef#

# ListBucketMetricsConfigurationsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListBucketMetricsConfigurationsRequestRequestTypeDef

def get_value() -> ListBucketMetricsConfigurationsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListBucketMetricsConfigurationsRequestRequestTypeDef definition

class ListBucketMetricsConfigurationsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ContinuationToken: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef#

# ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef usage example

from mypy_boto3_s3.type_defs import ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef

def get_value() -> ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef:
    return {
        "Bucket": ...,
    }
# ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef definition

class ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    Prefix: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See EncodingTypeType
  2. See PaginatorConfigTypeDef

ListMultipartUploadsRequestRequestTypeDef#

# ListMultipartUploadsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListMultipartUploadsRequestRequestTypeDef

def get_value() -> ListMultipartUploadsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListMultipartUploadsRequestRequestTypeDef definition

class ListMultipartUploadsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    KeyMarker: NotRequired[str],
    MaxUploads: NotRequired[int],
    Prefix: NotRequired[str],
    UploadIdMarker: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
  1. See EncodingTypeType

ListObjectVersionsRequestListObjectVersionsPaginateTypeDef#

# ListObjectVersionsRequestListObjectVersionsPaginateTypeDef usage example

from mypy_boto3_s3.type_defs import ListObjectVersionsRequestListObjectVersionsPaginateTypeDef

def get_value() -> ListObjectVersionsRequestListObjectVersionsPaginateTypeDef:
    return {
        "Bucket": ...,
    }
# ListObjectVersionsRequestListObjectVersionsPaginateTypeDef definition

class ListObjectVersionsRequestListObjectVersionsPaginateTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    Prefix: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See EncodingTypeType
  2. See PaginatorConfigTypeDef

ListObjectVersionsRequestRequestTypeDef#

# ListObjectVersionsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListObjectVersionsRequestRequestTypeDef

def get_value() -> ListObjectVersionsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListObjectVersionsRequestRequestTypeDef definition

class ListObjectVersionsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    KeyMarker: NotRequired[str],
    MaxKeys: NotRequired[int],
    Prefix: NotRequired[str],
    VersionIdMarker: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
  1. See EncodingTypeType

ListObjectsRequestListObjectsPaginateTypeDef#

# ListObjectsRequestListObjectsPaginateTypeDef usage example

from mypy_boto3_s3.type_defs import ListObjectsRequestListObjectsPaginateTypeDef

def get_value() -> ListObjectsRequestListObjectsPaginateTypeDef:
    return {
        "Bucket": ...,
    }
# ListObjectsRequestListObjectsPaginateTypeDef definition

class ListObjectsRequestListObjectsPaginateTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    Prefix: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See PaginatorConfigTypeDef

ListObjectsRequestRequestTypeDef#

# ListObjectsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListObjectsRequestRequestTypeDef

def get_value() -> ListObjectsRequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListObjectsRequestRequestTypeDef definition

class ListObjectsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    Marker: NotRequired[str],
    MaxKeys: NotRequired[int],
    Prefix: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
  1. See EncodingTypeType
  2. See RequestPayerType

ListObjectsV2RequestListObjectsV2PaginateTypeDef#

# ListObjectsV2RequestListObjectsV2PaginateTypeDef usage example

from mypy_boto3_s3.type_defs import ListObjectsV2RequestListObjectsV2PaginateTypeDef

def get_value() -> ListObjectsV2RequestListObjectsV2PaginateTypeDef:
    return {
        "Bucket": ...,
    }
# ListObjectsV2RequestListObjectsV2PaginateTypeDef definition

class ListObjectsV2RequestListObjectsV2PaginateTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    Prefix: NotRequired[str],
    FetchOwner: NotRequired[bool],
    StartAfter: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See EncodingTypeType
  2. See RequestPayerType
  3. See PaginatorConfigTypeDef

ListObjectsV2RequestRequestTypeDef#

# ListObjectsV2RequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListObjectsV2RequestRequestTypeDef

def get_value() -> ListObjectsV2RequestRequestTypeDef:
    return {
        "Bucket": ...,
    }
# ListObjectsV2RequestRequestTypeDef definition

class ListObjectsV2RequestRequestTypeDef(TypedDict):
    Bucket: str,
    Delimiter: NotRequired[str],
    EncodingType: NotRequired[EncodingTypeType],  # (1)
    MaxKeys: NotRequired[int],
    Prefix: NotRequired[str],
    ContinuationToken: NotRequired[str],
    FetchOwner: NotRequired[bool],
    StartAfter: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
  1. See EncodingTypeType
  2. See RequestPayerType

PartTypeDef#

# PartTypeDef usage example

from mypy_boto3_s3.type_defs import PartTypeDef

def get_value() -> PartTypeDef:
    return {
        "PartNumber": ...,
    }
# PartTypeDef definition

class PartTypeDef(TypedDict):
    PartNumber: NotRequired[int],
    LastModified: NotRequired[datetime],
    ETag: NotRequired[str],
    Size: NotRequired[int],
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],

ListPartsRequestListPartsPaginateTypeDef#

# ListPartsRequestListPartsPaginateTypeDef usage example

from mypy_boto3_s3.type_defs import ListPartsRequestListPartsPaginateTypeDef

def get_value() -> ListPartsRequestListPartsPaginateTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "UploadId": ...,
    }
# ListPartsRequestListPartsPaginateTypeDef definition

class ListPartsRequestListPartsPaginateTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    UploadId: str,
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See RequestPayerType
  2. See PaginatorConfigTypeDef

ListPartsRequestRequestTypeDef#

# ListPartsRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ListPartsRequestRequestTypeDef

def get_value() -> ListPartsRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "UploadId": ...,
    }
# ListPartsRequestRequestTypeDef definition

class ListPartsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    UploadId: str,
    MaxParts: NotRequired[int],
    PartNumberMarker: NotRequired[int],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    ExpectedBucketOwner: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
  1. See RequestPayerType

MetadataEntryTypeDef#

# MetadataEntryTypeDef usage example

from mypy_boto3_s3.type_defs import MetadataEntryTypeDef

def get_value() -> MetadataEntryTypeDef:
    return {
        "Name": ...,
    }
# MetadataEntryTypeDef definition

class MetadataEntryTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

ReplicationTimeValueTypeDef#

# ReplicationTimeValueTypeDef usage example

from mypy_boto3_s3.type_defs import ReplicationTimeValueTypeDef

def get_value() -> ReplicationTimeValueTypeDef:
    return {
        "Minutes": ...,
    }
# ReplicationTimeValueTypeDef definition

class ReplicationTimeValueTypeDef(TypedDict):
    Minutes: NotRequired[int],

QueueConfigurationDeprecatedTypeDef#

# QueueConfigurationDeprecatedTypeDef usage example

from mypy_boto3_s3.type_defs import QueueConfigurationDeprecatedTypeDef

def get_value() -> QueueConfigurationDeprecatedTypeDef:
    return {
        "Id": ...,
    }
# QueueConfigurationDeprecatedTypeDef definition

class QueueConfigurationDeprecatedTypeDef(TypedDict):
    Id: NotRequired[str],
    Event: NotRequired[EventType],  # (1)
    Events: NotRequired[List[EventType]],  # (2)
    Queue: NotRequired[str],
  1. See EventType
  2. See EventType

TopicConfigurationDeprecatedTypeDef#

# TopicConfigurationDeprecatedTypeDef usage example

from mypy_boto3_s3.type_defs import TopicConfigurationDeprecatedTypeDef

def get_value() -> TopicConfigurationDeprecatedTypeDef:
    return {
        "Id": ...,
    }
# TopicConfigurationDeprecatedTypeDef definition

class TopicConfigurationDeprecatedTypeDef(TypedDict):
    Id: NotRequired[str],
    Events: NotRequired[List[EventType]],  # (1)
    Event: NotRequired[EventType],  # (2)
    Topic: NotRequired[str],
  1. See EventType
  2. See EventType

ObjectDownloadFileRequestTypeDef#

# ObjectDownloadFileRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectDownloadFileRequestTypeDef

def get_value() -> ObjectDownloadFileRequestTypeDef:
    return {
        "Filename": ...,
    }
# ObjectDownloadFileRequestTypeDef definition

class ObjectDownloadFileRequestTypeDef(TypedDict):
    Filename: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

ObjectDownloadFileobjRequestTypeDef#

# ObjectDownloadFileobjRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectDownloadFileobjRequestTypeDef

def get_value() -> ObjectDownloadFileobjRequestTypeDef:
    return {
        "Fileobj": ...,
    }
# ObjectDownloadFileobjRequestTypeDef definition

class ObjectDownloadFileobjRequestTypeDef(TypedDict):
    Fileobj: Union[IO[Any], StreamingBody],
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

ObjectUploadFileRequestTypeDef#

# ObjectUploadFileRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectUploadFileRequestTypeDef

def get_value() -> ObjectUploadFileRequestTypeDef:
    return {
        "Filename": ...,
    }
# ObjectUploadFileRequestTypeDef definition

class ObjectUploadFileRequestTypeDef(TypedDict):
    Filename: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

ObjectUploadFileobjRequestTypeDef#

# ObjectUploadFileobjRequestTypeDef usage example

from mypy_boto3_s3.type_defs import ObjectUploadFileobjRequestTypeDef

def get_value() -> ObjectUploadFileobjRequestTypeDef:
    return {
        "Fileobj": ...,
    }
# ObjectUploadFileobjRequestTypeDef definition

class ObjectUploadFileobjRequestTypeDef(TypedDict):
    Fileobj: Union[IO[Any], StreamingBody],
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    Config: NotRequired[TransferConfig],

OwnerResponseMetadataTypeDef#

# OwnerResponseMetadataTypeDef usage example

from mypy_boto3_s3.type_defs import OwnerResponseMetadataTypeDef

def get_value() -> OwnerResponseMetadataTypeDef:
    return {
        "DisplayName": ...,
        "ID": ...,
        "ResponseMetadata": ...,
    }
# OwnerResponseMetadataTypeDef definition

class OwnerResponseMetadataTypeDef(TypedDict):
    DisplayName: str,
    ID: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

OwnershipControlsRuleTypeDef#

# OwnershipControlsRuleTypeDef usage example

from mypy_boto3_s3.type_defs import OwnershipControlsRuleTypeDef

def get_value() -> OwnershipControlsRuleTypeDef:
    return {
        "ObjectOwnership": ...,
    }
# OwnershipControlsRuleTypeDef definition

class OwnershipControlsRuleTypeDef(TypedDict):
    ObjectOwnership: ObjectOwnershipType,  # (1)
  1. See ObjectOwnershipType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_s3.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

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

ProgressTypeDef#

# ProgressTypeDef usage example

from mypy_boto3_s3.type_defs import ProgressTypeDef

def get_value() -> ProgressTypeDef:
    return {
        "BytesScanned": ...,
    }
# ProgressTypeDef definition

class ProgressTypeDef(TypedDict):
    BytesScanned: NotRequired[int],
    BytesProcessed: NotRequired[int],
    BytesReturned: NotRequired[int],

PutBucketPolicyRequestBucketPolicyPutTypeDef#

# PutBucketPolicyRequestBucketPolicyPutTypeDef usage example

from mypy_boto3_s3.type_defs import PutBucketPolicyRequestBucketPolicyPutTypeDef

def get_value() -> PutBucketPolicyRequestBucketPolicyPutTypeDef:
    return {
        "Policy": ...,
    }
# PutBucketPolicyRequestBucketPolicyPutTypeDef definition

class PutBucketPolicyRequestBucketPolicyPutTypeDef(TypedDict):
    Policy: str,
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    ConfirmRemoveSelfBucketAccess: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
  1. See ChecksumAlgorithmType

PutBucketPolicyRequestRequestTypeDef#

# PutBucketPolicyRequestRequestTypeDef usage example

from mypy_boto3_s3.type_defs import PutBucketPolicyRequestRequestTypeDef

def get_value() -> PutBucketPolicyRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Policy": ...,
    }
# PutBucketPolicyRequestRequestTypeDef definition

class PutBucketPolicyRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Policy: str,
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    ConfirmRemoveSelfBucketAccess: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
  1. See ChecksumAlgorithmType

RequestPaymentConfigurationTypeDef#

# RequestPaymentConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import RequestPaymentConfigurationTypeDef

def get_value() -> RequestPaymentConfigurationTypeDef:
    return {
        "Payer": ...,
    }
# RequestPaymentConfigurationTypeDef definition

class RequestPaymentConfigurationTypeDef(TypedDict):
    Payer: PayerType,  # (1)
  1. See PayerType

PutBucketVersioningRequestBucketVersioningEnableTypeDef#

# PutBucketVersioningRequestBucketVersioningEnableTypeDef usage example

from mypy_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningEnableTypeDef

def get_value() -> PutBucketVersioningRequestBucketVersioningEnableTypeDef:
    return {
        "ChecksumAlgorithm": ...,
    }
# PutBucketVersioningRequestBucketVersioningEnableTypeDef definition

class PutBucketVersioningRequestBucketVersioningEnableTypeDef(TypedDict):
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    MFA: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
  1. See ChecksumAlgorithmType

VersioningConfigurationTypeDef#

# VersioningConfigurationTypeDef usage example

from mypy_boto3_s3.type_defs import VersioningConfigurationTypeDef

def get_value() -> VersioningConfigurationTypeDef:
    return {
        "MFADelete": ...,
    }
# VersioningConfigurationTypeDef definition

class VersioningConfigurationTypeDef(TypedDict):
    MFADelete: NotRequired[MFADeleteType],  # (1)
    Status: NotRequired[BucketVersioningStatusType],  # (2)
  1. See MFADeleteType
  2. See BucketVersioningStatusType

PutBucketVersioningRequestBucketVersioningSuspendTypeDef#

# PutBucketVersioningRequestBucketVersioningSuspendTypeDef usage example

from mypy_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningSuspendTypeDef

def get_value() -> PutBucketVersioningRequestBucketVersioningSuspendTypeDef:
    return {
        "ChecksumAlgorithm": ...,
    }
# PutBucketVersioningRequestBucketVersioningSuspendTypeDef definition

class PutBucketVersioningRequestBucketVersioningSuspendTypeDef(TypedDict):
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    MFA: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],
  1. See ChecksumAlgorithmType

PutObjectAclOutputTypeDef#

# PutObjectAclOutputTypeDef usage example

from mypy_boto3_s3.type_defs import PutObjectAclOutputTypeDef

def get_value() -> PutObjectAclOutputTypeDef:
    return {
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# PutObjectAclOutputTypeDef definition

class PutObjectAclOutputTypeDef(TypedDict):
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestChargedType
  2. See ResponseMetadataTypeDef

PutObjectLegalHoldOutputTypeDef#

# PutObjectLegalHoldOutputTypeDef usage example

from mypy_boto3_s3.type_defs import PutObjectLegalHoldOutputTypeDef

def get_value() -> PutObjectLegalHoldOutputTypeDef:
    return {
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# PutObjectLegalHoldOutputTypeDef definition

class PutObjectLegalHoldOutputTypeDef(TypedDict):
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestChargedType
  2. See ResponseMetadataTypeDef

PutObjectLockConfigurationOutputTypeDef#

# PutObjectLockConfigurationOutputTypeDef usage example

from mypy_boto3_s3.type_defs import PutObjectLockConfigurationOutputTypeDef

def get_value() -> PutObjectLockConfigurationOutputTypeDef:
    return {
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# PutObjectLockConfigurationOutputTypeDef definition

class PutObjectLockConfigurationOutputTypeDef(TypedDict):
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestChargedType
  2. See ResponseMetadataTypeDef

PutObjectOutputTypeDef#

# PutObjectOutputTypeDef usage example

from mypy_boto3_s3.type_defs import PutObjectOutputTypeDef

def get_value() -> PutObjectOutputTypeDef:
    return {
        "Expiration": ...,
        "ETag": ...,
        "ChecksumCRC32": ...,
        "ChecksumCRC32C": ...,
        "ChecksumSHA1": ...,
        "ChecksumSHA256": ...,
        "ServerSideEncryption": ...,
        "VersionId": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "SSEKMSEncryptionContext": ...,
        "BucketKeyEnabled": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }
# PutObjectOutputTypeDef definition

class PutObjectOutputTypeDef(TypedDict):
    Expiration: str,
    ETag: str,
    ChecksumCRC32: str,
    ChecksumCRC32C: str,
    ChecksumSHA1: str,
    ChecksumSHA256: str,
    ServerSideEncryption: ServerSideEncryptionType,  # (1)
    VersionId: str,
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    SSEKMSEncryptionContext: str,
    BucketKeyEnabled: bool,
    RequestCharged: RequestChargedType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ServerSideEncryptionType
  2. See RequestChargedType
  3. See ResponseMetadataTypeDef

PutObjectRequestBucketPutObjectTypeDef#

# PutObjectRequestBucketPutObjectTypeDef usage example

from mypy_boto3_s3.type_defs import PutObjectRequestBucketPutObjectTypeDef

def get_value() -> PutObjectRequestBucketPutObjectTypeDef:
    return {
        "Key": ...,
    }
# PutObjectRequestBucketPutObjectTypeDef definition

class PutObjectRequestBucketPutObjectTypeDef(TypedDict):
    Key: str,
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    Body: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    CacheControl: NotRequired[str],
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentLength: NotRequired[int],
    ContentMD5: NotRequired[str],
    ContentType: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    Expires: NotRequired[Union[datetime, str]],
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    Metadata: NotRequired[Mapping[str, str]],
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (3)
    StorageClass: NotRequired[StorageClassType],  # (4)
    WebsiteRedirectLocation: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSEKMSEncryptionContext: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],
    RequestPayer: NotRequired[RequestPayerType],  # (5)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (6)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (7)
    ExpectedBucketOwner: NotRequired[str],
  1. See ObjectCannedACLType
  2. See ChecksumAlgorithmType
  3. See ServerSideEncryptionType
  4. See StorageClassType
  5. See RequestPayerType
  6. See ObjectLockModeType
  7. See ObjectLockLegalHoldStatusType

PutObjectRequestObjectPutTypeDef#

# PutObjectRequestObjectPutTypeDef usage example

from mypy_boto3_s3.type_defs import PutObjectRequestObjectPutTypeDef

def get_value() -> PutObjectRequestObjectPutTypeDef:
    return {
        "ACL": ...,
    }
# PutObjectRequestObjectPutTypeDef definition

class PutObjectRequestObjectPutTypeDef(TypedDict):
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    Body: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    CacheControl: NotRequired[str],
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentLength: NotRequired[int],
    ContentMD5: NotRequired[str],
    ContentType: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ChecksumCRC32: NotRequired[str],