Typed dictionaries

Index > S3 > Typed dictionaries

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

AbortIncompleteMultipartUploadTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AbortIncompleteMultipartUploadTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

AbortMultipartUploadRequestMultipartUploadAbortTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AbortMultipartUploadRequestMultipartUploadAbortTypeDef

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

Definition

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

1. See RequestPayerType

AbortMultipartUploadRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AbortMultipartUploadRequestRequestTypeDef

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

Definition

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

1. See RequestPayerType

AccelerateConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AccelerateConfigurationTypeDef

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

Definition

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

1. See BucketAccelerateStatusType

OwnerTypeDef

Usage Example

from mypy_boto3_s3.type_defs import OwnerTypeDef

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

Definition

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

AccessControlTranslationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AccessControlTranslationTypeDef

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

Definition

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

1. See OwnerOverrideType

TagTypeDef

Usage Example

from mypy_boto3_s3.type_defs import TagTypeDef

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

Definition

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

AnalyticsS3BucketDestinationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AnalyticsS3BucketDestinationTypeDef

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

Definition

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

1. See AnalyticsS3ExportFileFormatType

CopySourceTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CopySourceTypeDef

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

Definition

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

BucketDownloadFileRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketDownloadFileRequestTypeDef

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

Definition

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

BucketDownloadFileobjRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketDownloadFileobjRequestTypeDef

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

Definition

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

BucketObjectRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketObjectRequestTypeDef

def get_value() -> BucketObjectRequestTypeDef:
    return {
        "key": ...,
    }

Definition

class BucketObjectRequestTypeDef(TypedDict):
    key: str,

BucketTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketTypeDef

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

Definition

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

BucketUploadFileRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketUploadFileRequestTypeDef

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

Definition

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

BucketUploadFileobjRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketUploadFileobjRequestTypeDef

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

Definition

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

CORSRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CORSRuleTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CSVInputTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CSVOutputTypeDef

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

Definition

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

1. See QuoteFieldsType

ChecksumTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ChecksumTypeDef

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

Definition

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

ClientDownloadFileRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ClientDownloadFileRequestTypeDef

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

Definition

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

ClientDownloadFileobjRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ClientDownloadFileobjRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import ClientGeneratePresignedPostRequestTypeDef

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

Definition

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

ClientUploadFileRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ClientUploadFileRequestTypeDef

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

Definition

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

ClientUploadFileobjRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ClientUploadFileobjRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CloudFunctionConfigurationTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CommonPrefixTypeDef

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

Definition

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

CompletedPartTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CompletedPartTypeDef

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

Definition

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

ConditionTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ConditionTypeDef

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

Definition

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

CopyObjectResultTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CopyObjectResultTypeDef

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

Definition

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

CopyObjectRequestObjectCopyFromTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CopyObjectRequestObjectCopyFromTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CopyObjectRequestObjectSummaryCopyFromTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CopyPartResultTypeDef

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

Definition

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

CreateBucketConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CreateBucketConfigurationTypeDef

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

Definition

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

1. See BucketLocationConstraintType

CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import CreateMultipartUploadRequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import DefaultRetentionTypeDef

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

Definition

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

1. See ObjectLockRetentionModeType

DeleteBucketAnalyticsConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketAnalyticsConfigurationRequestRequestTypeDef

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

Definition

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

DeleteBucketCorsRequestBucketCorsDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketCorsRequestBucketCorsDeleteTypeDef

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

Definition

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

DeleteBucketCorsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketCorsRequestRequestTypeDef

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

Definition

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

DeleteBucketEncryptionRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketEncryptionRequestRequestTypeDef

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

Definition

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

DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketIntelligentTieringConfigurationRequestRequestTypeDef

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

Definition

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

DeleteBucketInventoryConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketInventoryConfigurationRequestRequestTypeDef

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

Definition

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

DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef

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

Definition

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

DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef

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

Definition

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

DeleteBucketLifecycleRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketLifecycleRequestRequestTypeDef

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

Definition

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

DeleteBucketMetricsConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketMetricsConfigurationRequestRequestTypeDef

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

Definition

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

DeleteBucketOwnershipControlsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketOwnershipControlsRequestRequestTypeDef

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

Definition

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

DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef

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

Definition

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

DeleteBucketPolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketPolicyRequestRequestTypeDef

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

Definition

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

DeleteBucketReplicationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketReplicationRequestRequestTypeDef

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

Definition

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

DeleteBucketRequestBucketDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketRequestBucketDeleteTypeDef

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

Definition

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

DeleteBucketRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketRequestRequestTypeDef

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

Definition

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

DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef

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

Definition

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

DeleteBucketTaggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketTaggingRequestRequestTypeDef

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

Definition

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

DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef

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

Definition

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

DeleteBucketWebsiteRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteBucketWebsiteRequestRequestTypeDef

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

Definition

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

DeleteMarkerReplicationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteMarkerReplicationTypeDef

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

Definition

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

1. See DeleteMarkerReplicationStatusType

DeleteObjectRequestObjectDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectRequestObjectDeleteTypeDef

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

Definition

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

1. See RequestPayerType

DeleteObjectRequestObjectSummaryDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectRequestObjectSummaryDeleteTypeDef

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

Definition

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

1. See RequestPayerType

DeleteObjectRequestObjectVersionDeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectRequestObjectVersionDeleteTypeDef

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

Definition

class DeleteObjectRequestObjectVersionDeleteTypeDef(TypedDict):
    MFA: NotRequired[str],