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],
    RequestPayer: NotRequired[RequestPayerType],  # (1)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],

1. See RequestPayerType

DeleteObjectRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectRequestRequestTypeDef

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

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

DeleteObjectTaggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectTaggingRequestRequestTypeDef

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

Definition

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

DeletedObjectTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeletedObjectTypeDef

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

Definition

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

ErrorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ErrorTypeDef

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

Definition

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

DeletePublicAccessBlockRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeletePublicAccessBlockRequestRequestTypeDef

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

Definition

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

ObjectIdentifierTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectIdentifierTypeDef

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

Definition

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

EncryptionConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import EncryptionConfigurationTypeDef

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

Definition

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

EncryptionTypeDef

Usage Example

from mypy_boto3_s3.type_defs import EncryptionTypeDef

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

Definition

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

1. See ServerSideEncryptionType

ErrorDocumentTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ErrorDocumentTypeDef

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

Definition

class ErrorDocumentTypeDef(TypedDict):
    Key: str,

ExistingObjectReplicationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ExistingObjectReplicationTypeDef

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

Definition

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

1. See ExistingObjectReplicationStatusType

FilterRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import FilterRuleTypeDef

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

Definition

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

1. See FilterRuleNameType

GetBucketAccelerateConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketAccelerateConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketAclRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketAclRequestRequestTypeDef

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

Definition

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

GetBucketAnalyticsConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketAnalyticsConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketCorsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketCorsRequestRequestTypeDef

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

Definition

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

GetBucketEncryptionRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketEncryptionRequestRequestTypeDef

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

Definition

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

GetBucketIntelligentTieringConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketIntelligentTieringConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketInventoryConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketInventoryConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketLifecycleConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLifecycleConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketLifecycleRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLifecycleRequestRequestTypeDef

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

Definition

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

GetBucketLocationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLocationRequestRequestTypeDef

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

Definition

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

GetBucketLoggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLoggingRequestRequestTypeDef

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

Definition

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

GetBucketMetricsConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketMetricsConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketNotificationConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketNotificationConfigurationRequestRequestTypeDef

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

Definition

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

GetBucketOwnershipControlsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketOwnershipControlsRequestRequestTypeDef

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

Definition

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

GetBucketPolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketPolicyRequestRequestTypeDef

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

Definition

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

PolicyStatusTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PolicyStatusTypeDef

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

Definition

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

GetBucketPolicyStatusRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketPolicyStatusRequestRequestTypeDef

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

Definition

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

GetBucketReplicationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketReplicationRequestRequestTypeDef

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

Definition

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

GetBucketRequestPaymentRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketRequestPaymentRequestRequestTypeDef

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

Definition

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

GetBucketTaggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketTaggingRequestRequestTypeDef

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

Definition

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

GetBucketVersioningRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketVersioningRequestRequestTypeDef

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

Definition

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

IndexDocumentTypeDef

Usage Example

from mypy_boto3_s3.type_defs import IndexDocumentTypeDef

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

Definition

class IndexDocumentTypeDef(TypedDict):
    Suffix: str,

RedirectAllRequestsToTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RedirectAllRequestsToTypeDef

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

Definition

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

1. See ProtocolType

GetBucketWebsiteRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketWebsiteRequestRequestTypeDef

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

Definition

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

GetObjectAclRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectAclRequestRequestTypeDef

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

Definition

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

1. See RequestPayerType

ObjectPartTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectPartTypeDef

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

Definition

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

GetObjectAttributesRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectAttributesRequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import ObjectLockLegalHoldTypeDef

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

Definition

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

1. See ObjectLockLegalHoldStatusType

GetObjectLegalHoldRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectLegalHoldRequestRequestTypeDef

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

Definition

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

1. See RequestPayerType

GetObjectLockConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectLockConfigurationRequestRequestTypeDef

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

Definition

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

GetObjectRequestObjectGetTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectRequestObjectGetTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import GetObjectRequestObjectSummaryGetTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import GetObjectRequestObjectVersionGetTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import GetObjectRequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import ObjectLockRetentionTypeDef

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

Definition

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

1. See ObjectLockRetentionModeType

GetObjectRetentionRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectRetentionRequestRequestTypeDef

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

Definition

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

1. See RequestPayerType

GetObjectTaggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectTaggingRequestRequestTypeDef

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

Definition

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

1. See RequestPayerType

GetObjectTorrentRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectTorrentRequestRequestTypeDef

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

Definition

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

1. See RequestPayerType

PublicAccessBlockConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PublicAccessBlockConfigurationTypeDef

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

Definition

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

GetPublicAccessBlockRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetPublicAccessBlockRequestRequestTypeDef

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

Definition

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

GlacierJobParametersTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GlacierJobParametersTypeDef

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

Definition

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

1. See TierType

GranteeTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GranteeTypeDef

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

Definition

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

1. See TypeType

WaiterConfigTypeDef

Usage Example

from mypy_boto3_s3.type_defs import WaiterConfigTypeDef

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

Definition

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

HeadBucketRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import HeadBucketRequestRequestTypeDef

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

Definition

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

HeadObjectRequestObjectVersionHeadTypeDef

Usage Example

from mypy_boto3_s3.type_defs import HeadObjectRequestObjectVersionHeadTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import HeadObjectRequestRequestTypeDef

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

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

InitiatorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InitiatorTypeDef

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

Definition

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

JSONInputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import JSONInputTypeDef

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

Definition

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

1. See JSONTypeType

TieringTypeDef

Usage Example

from mypy_boto3_s3.type_defs import TieringTypeDef

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

Definition

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

1. See IntelligentTieringAccessTierType

InventoryFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InventoryFilterTypeDef

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

Definition

class InventoryFilterTypeDef(TypedDict):
    Prefix: str,

InventoryScheduleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InventoryScheduleTypeDef

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

Definition

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

1. See InventoryFrequencyType

SSEKMSTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SSEKMSTypeDef

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

Definition

class SSEKMSTypeDef(TypedDict):
    KeyId: str,

JSONOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import JSONOutputTypeDef

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

Definition

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

LifecycleExpirationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LifecycleExpirationTypeDef

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

Definition

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

NoncurrentVersionExpirationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NoncurrentVersionExpirationTypeDef

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

Definition

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

NoncurrentVersionTransitionTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NoncurrentVersionTransitionTypeDef

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

Definition

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

1. See TransitionStorageClassType

TransitionTypeDef

Usage Example

from mypy_boto3_s3.type_defs import TransitionTypeDef

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

Definition

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

1. See TransitionStorageClassType

ListBucketAnalyticsConfigurationsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketAnalyticsConfigurationsRequestRequestTypeDef

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

Definition

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

ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketIntelligentTieringConfigurationsRequestRequestTypeDef

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

Definition

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

ListBucketInventoryConfigurationsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketInventoryConfigurationsRequestRequestTypeDef

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

Definition

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

ListBucketMetricsConfigurationsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketMetricsConfigurationsRequestRequestTypeDef

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

Definition

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

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PaginatorConfigTypeDef

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

Definition

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

ListMultipartUploadsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListMultipartUploadsRequestRequestTypeDef

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

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

ListObjectVersionsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectVersionsRequestRequestTypeDef

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

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

ListObjectsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectsRequestRequestTypeDef

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

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

ListObjectsV2RequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectsV2RequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import PartTypeDef

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

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],

ListPartsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListPartsRequestRequestTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import MetadataEntryTypeDef

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

Definition

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

ReplicationTimeValueTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicationTimeValueTypeDef

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

Definition

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

MultipartUploadPartRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import MultipartUploadPartRequestTypeDef

def get_value() -> MultipartUploadPartRequestTypeDef:
    return {
        "part_number": ...,
    }

Definition

class MultipartUploadPartRequestTypeDef(TypedDict):
    part_number: str,

QueueConfigurationDeprecatedTypeDef

Usage Example

from mypy_boto3_s3.type_defs import QueueConfigurationDeprecatedTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import TopicConfigurationDeprecatedTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import ObjectDownloadFileRequestTypeDef

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

Definition

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

ObjectDownloadFileobjRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectDownloadFileobjRequestTypeDef

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

Definition

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

ObjectMultipartUploadRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectMultipartUploadRequestTypeDef

def get_value() -> ObjectMultipartUploadRequestTypeDef:
    return {
        "id": ...,
    }

Definition

class ObjectMultipartUploadRequestTypeDef(TypedDict):
    id: str,

ObjectSummaryMultipartUploadRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectSummaryMultipartUploadRequestTypeDef

def get_value() -> ObjectSummaryMultipartUploadRequestTypeDef:
    return {
        "id": ...,
    }

Definition

class ObjectSummaryMultipartUploadRequestTypeDef(TypedDict):
    id: str,

ObjectSummaryVersionRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectSummaryVersionRequestTypeDef

def get_value() -> ObjectSummaryVersionRequestTypeDef:
    return {
        "id": ...,
    }

Definition

class ObjectSummaryVersionRequestTypeDef(TypedDict):
    id: str,

ObjectUploadFileRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectUploadFileRequestTypeDef

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

Definition

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

ObjectUploadFileobjRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectUploadFileobjRequestTypeDef

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

Definition

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

ObjectVersionRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectVersionRequestTypeDef

def get_value() -> ObjectVersionRequestTypeDef:
    return {
        "id": ...,
    }

Definition

class ObjectVersionRequestTypeDef(TypedDict):
    id: str,

OwnershipControlsRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import OwnershipControlsRuleTypeDef

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

Definition

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

1. See ObjectOwnershipType

ProgressTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ProgressTypeDef

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

Definition

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

PutBucketPolicyRequestBucketPolicyPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketPolicyRequestBucketPolicyPutTypeDef

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

Definition

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

1. See ChecksumAlgorithmType

PutBucketPolicyRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketPolicyRequestRequestTypeDef

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

Definition

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

1. See ChecksumAlgorithmType

RequestPaymentConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RequestPaymentConfigurationTypeDef

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

Definition

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

1. See PayerType

PutBucketVersioningRequestBucketVersioningEnableTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningEnableTypeDef

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

Definition

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

1. See ChecksumAlgorithmType

VersioningConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import VersioningConfigurationTypeDef

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

Definition

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

1. See MFADeleteType
2. See BucketVersioningStatusType

PutBucketVersioningRequestBucketVersioningSuspendTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningSuspendTypeDef

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

Definition

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

1. See ChecksumAlgorithmType

PutObjectRequestBucketPutObjectTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectRequestBucketPutObjectTypeDef

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

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

Usage Example

from mypy_boto3_s3.type_defs import PutObjectRequestObjectPutTypeDef

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

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],
    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

PutObjectRequestObjectSummaryPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectRequestObjectSummaryPutTypeDef

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

Definition

class PutObjectRequestObjectSummaryPutTypeDef(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],
    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

PutObjectRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectRequestRequestTypeDef

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

Definition

class PutObjectRequestRequestTypeDef(TypedDict):
    Bucket: str,
    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

RecordsEventTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RecordsEventTypeDef

def get_value() -> RecordsEventTypeDef:
    return {
        "Payload": ...,
    }

Definition

class RecordsEventTypeDef(TypedDict):
    Payload: NotRequired[bytes],

RedirectTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RedirectTypeDef

def get_value() -> RedirectTypeDef:
    return {
        "HostName": ...,
    }

Definition

class RedirectTypeDef(TypedDict):
    HostName: NotRequired[str],
    HttpRedirectCode: NotRequired[str],
    Protocol: NotRequired[ProtocolType],  # (1)
    ReplaceKeyPrefixWith: NotRequired[str],
    ReplaceKeyWith: NotRequired[str],

1. See ProtocolType

ReplicaModificationsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicaModificationsTypeDef

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

Definition

class ReplicaModificationsTypeDef(TypedDict):
    Status: ReplicaModificationsStatusType,  # (1)

1. See ReplicaModificationsStatusType

RequestProgressTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RequestProgressTypeDef

def get_value() -> RequestProgressTypeDef:
    return {
        "Enabled": ...,
    }

Definition

class RequestProgressTypeDef(TypedDict):
    Enabled: NotRequired[bool],

ScanRangeTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ScanRangeTypeDef

def get_value() -> ScanRangeTypeDef:
    return {
        "Start": ...,
    }

Definition

class ScanRangeTypeDef(TypedDict):
    Start: NotRequired[int],
    End: NotRequired[int],

ServerSideEncryptionByDefaultTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServerSideEncryptionByDefaultTypeDef

def get_value() -> ServerSideEncryptionByDefaultTypeDef:
    return {
        "SSEAlgorithm": ...,
    }

Definition

class ServerSideEncryptionByDefaultTypeDef(TypedDict):
    SSEAlgorithm: ServerSideEncryptionType,  # (1)
    KMSMasterKeyID: NotRequired[str],

1. See ServerSideEncryptionType

ServiceResourceBucketAclRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketAclRequestTypeDef

def get_value() -> ServiceResourceBucketAclRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketAclRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketCorsRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketCorsRequestTypeDef

def get_value() -> ServiceResourceBucketCorsRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketCorsRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketLifecycleConfigurationRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketLifecycleConfigurationRequestTypeDef

def get_value() -> ServiceResourceBucketLifecycleConfigurationRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketLifecycleConfigurationRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketLifecycleRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketLifecycleRequestTypeDef

def get_value() -> ServiceResourceBucketLifecycleRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketLifecycleRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketLoggingRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketLoggingRequestTypeDef

def get_value() -> ServiceResourceBucketLoggingRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketLoggingRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketNotificationRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketNotificationRequestTypeDef

def get_value() -> ServiceResourceBucketNotificationRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketNotificationRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketPolicyRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketPolicyRequestTypeDef

def get_value() -> ServiceResourceBucketPolicyRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketPolicyRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketRequestPaymentRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketRequestPaymentRequestTypeDef

def get_value() -> ServiceResourceBucketRequestPaymentRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketRequestPaymentRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketRequestTypeDef

def get_value() -> ServiceResourceBucketRequestTypeDef:
    return {
        "name": ...,
    }

Definition

class ServiceResourceBucketRequestTypeDef(TypedDict):
    name: str,

ServiceResourceBucketTaggingRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketTaggingRequestTypeDef

def get_value() -> ServiceResourceBucketTaggingRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketTaggingRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketVersioningRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketVersioningRequestTypeDef

def get_value() -> ServiceResourceBucketVersioningRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketVersioningRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceBucketWebsiteRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceBucketWebsiteRequestTypeDef

def get_value() -> ServiceResourceBucketWebsiteRequestTypeDef:
    return {
        "bucket_name": ...,
    }

Definition

class ServiceResourceBucketWebsiteRequestTypeDef(TypedDict):
    bucket_name: str,

ServiceResourceMultipartUploadPartRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceMultipartUploadPartRequestTypeDef

def get_value() -> ServiceResourceMultipartUploadPartRequestTypeDef:
    return {
        "bucket_name": ...,
        "object_key": ...,
        "multipart_upload_id": ...,
        "part_number": ...,
    }

Definition

class ServiceResourceMultipartUploadPartRequestTypeDef(TypedDict):
    bucket_name: str,
    object_key: str,
    multipart_upload_id: str,
    part_number: str,

ServiceResourceMultipartUploadRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceMultipartUploadRequestTypeDef

def get_value() -> ServiceResourceMultipartUploadRequestTypeDef:
    return {
        "bucket_name": ...,
        "object_key": ...,
        "id": ...,
    }

Definition

class ServiceResourceMultipartUploadRequestTypeDef(TypedDict):
    bucket_name: str,
    object_key: str,
    id: str,

ServiceResourceObjectAclRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceObjectAclRequestTypeDef

def get_value() -> ServiceResourceObjectAclRequestTypeDef:
    return {
        "bucket_name": ...,
        "object_key": ...,
    }

Definition

class ServiceResourceObjectAclRequestTypeDef(TypedDict):
    bucket_name: str,
    object_key: str,

ServiceResourceObjectRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceObjectRequestTypeDef

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

Definition

class ServiceResourceObjectRequestTypeDef(TypedDict):
    bucket_name: str,
    key: str,

ServiceResourceObjectSummaryRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceObjectSummaryRequestTypeDef

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

Definition

class ServiceResourceObjectSummaryRequestTypeDef(TypedDict):
    bucket_name: str,
    key: str,

ServiceResourceObjectVersionRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServiceResourceObjectVersionRequestTypeDef

def get_value() -> ServiceResourceObjectVersionRequestTypeDef:
    return {
        "bucket_name": ...,
        "object_key": ...,
        "id": ...,
    }

Definition

class ServiceResourceObjectVersionRequestTypeDef(TypedDict):
    bucket_name: str,
    object_key: str,
    id: str,

SseKmsEncryptedObjectsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SseKmsEncryptedObjectsTypeDef

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

Definition

class SseKmsEncryptedObjectsTypeDef(TypedDict):
    Status: SseKmsEncryptedObjectsStatusType,  # (1)

1. See SseKmsEncryptedObjectsStatusType

StatsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import StatsTypeDef

def get_value() -> StatsTypeDef:
    return {
        "BytesScanned": ...,
    }

Definition

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

UploadPartRequestMultipartUploadPartUploadTypeDef

Usage Example

from mypy_boto3_s3.type_defs import UploadPartRequestMultipartUploadPartUploadTypeDef

def get_value() -> UploadPartRequestMultipartUploadPartUploadTypeDef:
    return {
        "Body": ...,
    }

Definition

class UploadPartRequestMultipartUploadPartUploadTypeDef(TypedDict):
    Body: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    ContentLength: NotRequired[int],
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ChecksumAlgorithmType
2. See RequestPayerType

UploadPartRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import UploadPartRequestRequestTypeDef

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

Definition

class UploadPartRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    PartNumber: int,
    UploadId: str,
    Body: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    ContentLength: NotRequired[int],
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ChecksumAlgorithmType
2. See RequestPayerType

WriteGetObjectResponseRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import WriteGetObjectResponseRequestRequestTypeDef

def get_value() -> WriteGetObjectResponseRequestRequestTypeDef:
    return {
        "RequestRoute": ...,
        "RequestToken": ...,
    }

Definition

class WriteGetObjectResponseRequestRequestTypeDef(TypedDict):
    RequestRoute: str,
    RequestToken: str,
    Body: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    StatusCode: NotRequired[int],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
    AcceptRanges: NotRequired[str],
    CacheControl: NotRequired[str],
    ContentDisposition: NotRequired[str],
    ContentEncoding: NotRequired[str],
    ContentLanguage: NotRequired[str],
    ContentLength: NotRequired[int],
    ContentRange: NotRequired[str],
    ContentType: NotRequired[str],
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    DeleteMarker: NotRequired[bool],
    ETag: NotRequired[str],
    Expires: NotRequired[Union[datetime, str]],
    Expiration: NotRequired[str],
    LastModified: NotRequired[Union[datetime, str]],
    MissingMeta: NotRequired[int],
    Metadata: NotRequired[Mapping[str, str]],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (1)
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (2)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    PartsCount: NotRequired[int],
    ReplicationStatus: NotRequired[ReplicationStatusType],  # (3)
    RequestCharged: NotRequired[RequestChargedType],  # (4)
    Restore: NotRequired[str],
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (5)
    SSECustomerAlgorithm: NotRequired[str],
    SSEKMSKeyId: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    StorageClass: NotRequired[StorageClassType],  # (6)
    TagCount: NotRequired[int],
    VersionId: NotRequired[str],
    BucketKeyEnabled: NotRequired[bool],

1. See ObjectLockModeType
2. See ObjectLockLegalHoldStatusType
3. See ReplicationStatusType
4. See RequestChargedType
5. See ServerSideEncryptionType
6. See StorageClassType

AbortMultipartUploadOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AbortMultipartUploadOutputTypeDef

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

Definition

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

1. See RequestChargedType
2. See ResponseMetadataTypeDef

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": ...,
    }

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

CreateBucketOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CreateBucketOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

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": ...,
    }

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

DeleteObjectOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectOutputTypeDef

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

Definition

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

1. See RequestChargedType
2. See ResponseMetadataTypeDef

DeleteObjectTaggingOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectTaggingOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import EmptyResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ErrorDocumentResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ErrorDocumentResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

GetBucketAccelerateConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketAccelerateConfigurationOutputTypeDef

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

Definition

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

1. See BucketAccelerateStatusType
2. See ResponseMetadataTypeDef

GetBucketLocationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLocationOutputTypeDef

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

Definition

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

1. See BucketLocationConstraintType
2. See ResponseMetadataTypeDef

GetBucketPolicyOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketPolicyOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

GetBucketRequestPaymentOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketRequestPaymentOutputTypeDef

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

Definition

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

1. See PayerType
2. See ResponseMetadataTypeDef

GetBucketVersioningOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketVersioningOutputTypeDef

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

Definition

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

1. See BucketVersioningStatusType
2. See MFADeleteStatusType
3. See ResponseMetadataTypeDef

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": ...,
    }

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

GetObjectTorrentOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectTorrentOutputTypeDef

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

Definition

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

1. See RequestChargedType
2. See ResponseMetadataTypeDef

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": ...,
    }

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

IndexDocumentResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import IndexDocumentResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

InitiatorResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InitiatorResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

OwnerResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import OwnerResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

PutObjectAclOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectAclOutputTypeDef

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

Definition

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

1. See RequestChargedType
2. See ResponseMetadataTypeDef

PutObjectLegalHoldOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectLegalHoldOutputTypeDef

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

Definition

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

1. See RequestChargedType
2. See ResponseMetadataTypeDef

PutObjectLockConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectLockConfigurationOutputTypeDef

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

Definition

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

1. See RequestChargedType
2. See ResponseMetadataTypeDef

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": ...,
    }

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

PutObjectRetentionOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectRetentionOutputTypeDef

def get_value() -> PutObjectRetentionOutputTypeDef:
    return {
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }

Definition

class PutObjectRetentionOutputTypeDef(TypedDict):
    RequestCharged: RequestChargedType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RequestChargedType
2. See ResponseMetadataTypeDef

PutObjectTaggingOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectTaggingOutputTypeDef

def get_value() -> PutObjectTaggingOutputTypeDef:
    return {
        "VersionId": ...,
        "ResponseMetadata": ...,
    }

Definition

class PutObjectTaggingOutputTypeDef(TypedDict):
    VersionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

RedirectAllRequestsToResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RedirectAllRequestsToResponseMetadataTypeDef

def get_value() -> RedirectAllRequestsToResponseMetadataTypeDef:
    return {
        "HostName": ...,
        "Protocol": ...,
        "ResponseMetadata": ...,
    }

Definition

class RedirectAllRequestsToResponseMetadataTypeDef(TypedDict):
    HostName: str,
    Protocol: ProtocolType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProtocolType
2. See ResponseMetadataTypeDef

RestoreObjectOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RestoreObjectOutputTypeDef

def get_value() -> RestoreObjectOutputTypeDef:
    return {
        "RequestCharged": ...,
        "RestoreOutputPath": ...,
        "ResponseMetadata": ...,
    }

Definition

class RestoreObjectOutputTypeDef(TypedDict):
    RequestCharged: RequestChargedType,  # (1)
    RestoreOutputPath: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RequestChargedType
2. See ResponseMetadataTypeDef

UploadPartOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import UploadPartOutputTypeDef

def get_value() -> UploadPartOutputTypeDef:
    return {
        "ServerSideEncryption": ...,
        "ETag": ...,
        "ChecksumCRC32": ...,
        "ChecksumCRC32C": ...,
        "ChecksumSHA1": ...,
        "ChecksumSHA256": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "BucketKeyEnabled": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }

Definition

class UploadPartOutputTypeDef(TypedDict):
    ServerSideEncryption: ServerSideEncryptionType,  # (1)
    ETag: str,
    ChecksumCRC32: str,
    ChecksumCRC32C: str,
    ChecksumSHA1: str,
    ChecksumSHA256: str,
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    BucketKeyEnabled: bool,
    RequestCharged: RequestChargedType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See ServerSideEncryptionType
2. See RequestChargedType
3. See ResponseMetadataTypeDef

PutBucketAccelerateConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketAccelerateConfigurationRequestRequestTypeDef

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

Definition

class PutBucketAccelerateConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    AccelerateConfiguration: AccelerateConfigurationTypeDef,  # (1)
    ExpectedBucketOwner: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)

1. See AccelerateConfigurationTypeDef
2. See ChecksumAlgorithmType

DeleteMarkerEntryTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteMarkerEntryTypeDef

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

Definition

class DeleteMarkerEntryTypeDef(TypedDict):
    Owner: NotRequired[OwnerTypeDef],  # (1)
    Key: NotRequired[str],
    VersionId: NotRequired[str],
    IsLatest: NotRequired[bool],
    LastModified: NotRequired[datetime],

1. See OwnerTypeDef

ObjectTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectTypeDef

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

Definition

class ObjectTypeDef(TypedDict):
    Key: NotRequired[str],
    LastModified: NotRequired[datetime],
    ETag: NotRequired[str],
    ChecksumAlgorithm: NotRequired[List[ChecksumAlgorithmType]],  # (1)
    Size: NotRequired[int],
    StorageClass: NotRequired[ObjectStorageClassType],  # (2)
    Owner: NotRequired[OwnerTypeDef],  # (3)

1. See ChecksumAlgorithmType
2. See ObjectStorageClassType
3. See OwnerTypeDef

ObjectVersionTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectVersionTypeDef

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

Definition

class ObjectVersionTypeDef(TypedDict):
    ETag: NotRequired[str],
    ChecksumAlgorithm: NotRequired[List[ChecksumAlgorithmType]],  # (1)
    Size: NotRequired[int],
    StorageClass: NotRequired[ObjectVersionStorageClassType],  # (2)
    Key: NotRequired[str],
    VersionId: NotRequired[str],
    IsLatest: NotRequired[bool],
    LastModified: NotRequired[datetime],
    Owner: NotRequired[OwnerTypeDef],  # (3)

1. See ChecksumAlgorithmType
2. See ObjectVersionStorageClassType
3. See OwnerTypeDef

AnalyticsAndOperatorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AnalyticsAndOperatorTypeDef

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

Definition

class AnalyticsAndOperatorTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)

1. See TagTypeDef

GetBucketTaggingOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketTaggingOutputTypeDef

def get_value() -> GetBucketTaggingOutputTypeDef:
    return {
        "TagSet": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketTaggingOutputTypeDef(TypedDict):
    TagSet: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagTypeDef
2. See ResponseMetadataTypeDef

GetObjectTaggingOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectTaggingOutputTypeDef

def get_value() -> GetObjectTaggingOutputTypeDef:
    return {
        "VersionId": ...,
        "TagSet": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetObjectTaggingOutputTypeDef(TypedDict):
    VersionId: str,
    TagSet: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagTypeDef
2. See ResponseMetadataTypeDef

IntelligentTieringAndOperatorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import IntelligentTieringAndOperatorTypeDef

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

Definition

class IntelligentTieringAndOperatorTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)

1. See TagTypeDef

LifecycleRuleAndOperatorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LifecycleRuleAndOperatorTypeDef

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

Definition

class LifecycleRuleAndOperatorTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
    ObjectSizeGreaterThan: NotRequired[int],
    ObjectSizeLessThan: NotRequired[int],

1. See TagTypeDef

MetricsAndOperatorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import MetricsAndOperatorTypeDef

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

Definition

class MetricsAndOperatorTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)
    AccessPointArn: NotRequired[str],

1. See TagTypeDef

ReplicationRuleAndOperatorTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicationRuleAndOperatorTypeDef

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

Definition

class ReplicationRuleAndOperatorTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (1)

1. See TagTypeDef

TaggingTypeDef

Usage Example

from mypy_boto3_s3.type_defs import TaggingTypeDef

def get_value() -> TaggingTypeDef:
    return {
        "TagSet": ...,
    }

Definition

class TaggingTypeDef(TypedDict):
    TagSet: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

AnalyticsExportDestinationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AnalyticsExportDestinationTypeDef

def get_value() -> AnalyticsExportDestinationTypeDef:
    return {
        "S3BucketDestination": ...,
    }

Definition

class AnalyticsExportDestinationTypeDef(TypedDict):
    S3BucketDestination: AnalyticsS3BucketDestinationTypeDef,  # (1)

1. See AnalyticsS3BucketDestinationTypeDef

BucketCopyRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketCopyRequestTypeDef

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

Definition

class BucketCopyRequestTypeDef(TypedDict):
    CopySource: CopySourceTypeDef,  # (1)
    Key: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    SourceClient: NotRequired[BaseClient],
    Config: NotRequired[TransferConfig],

1. See CopySourceTypeDef

ClientCopyRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ClientCopyRequestTypeDef

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

Definition

class ClientCopyRequestTypeDef(TypedDict):
    CopySource: CopySourceTypeDef,  # (1)
    Bucket: str,
    Key: str,
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    SourceClient: NotRequired[BaseClient],
    Config: NotRequired[TransferConfig],

1. See CopySourceTypeDef

CopyObjectRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CopyObjectRequestRequestTypeDef

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

Definition

class CopyObjectRequestRequestTypeDef(TypedDict):
    Bucket: str,
    CopySource: Union[str, CopySourceTypeDef],  # (1)
    Key: str,
    ACL: NotRequired[ObjectCannedACLType],  # (2)
    CacheControl: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    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],  # (4)
    TaggingDirective: NotRequired[TaggingDirectiveType],  # (5)
    ServerSideEncryption: NotRequired[ServerSideEncryptionType],  # (6)
    StorageClass: NotRequired[StorageClassType],  # (7)
    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],  # (8)
    Tagging: NotRequired[str],
    ObjectLockMode: NotRequired[ObjectLockModeType],  # (9)
    ObjectLockRetainUntilDate: NotRequired[Union[datetime, str]],
    ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType],  # (10)
    ExpectedBucketOwner: NotRequired[str],
    ExpectedSourceBucketOwner: NotRequired[str],

1. See CopySourceTypeDef
2. See ObjectCannedACLType
3. See ChecksumAlgorithmType
4. See MetadataDirectiveType
5. See TaggingDirectiveType
6. See ServerSideEncryptionType
7. See StorageClassType
8. See RequestPayerType
9. See ObjectLockModeType
10. See ObjectLockLegalHoldStatusType

ObjectCopyRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectCopyRequestTypeDef

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

Definition

class ObjectCopyRequestTypeDef(TypedDict):
    CopySource: CopySourceTypeDef,  # (1)
    ExtraArgs: NotRequired[Dict[str, Any]],
    Callback: NotRequired[Callable[..., Any]],
    SourceClient: NotRequired[BaseClient],
    Config: NotRequired[TransferConfig],

1. See CopySourceTypeDef

UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef

Usage Example

from mypy_boto3_s3.type_defs import UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef

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

Definition

class UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef(TypedDict):
    CopySource: Union[str, CopySourceTypeDef],  # (1)
    CopySourceIfMatch: NotRequired[str],
    CopySourceIfModifiedSince: NotRequired[Union[datetime, str]],
    CopySourceIfNoneMatch: NotRequired[str],
    CopySourceIfUnmodifiedSince: NotRequired[Union[datetime, str]],
    CopySourceRange: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    CopySourceSSECustomerAlgorithm: NotRequired[str],
    CopySourceSSECustomerKey: NotRequired[str],
    CopySourceSSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    ExpectedSourceBucketOwner: NotRequired[str],

1. See CopySourceTypeDef
2. See RequestPayerType

UploadPartCopyRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import UploadPartCopyRequestRequestTypeDef

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

Definition

class UploadPartCopyRequestRequestTypeDef(TypedDict):
    Bucket: str,
    CopySource: Union[str, CopySourceTypeDef],  # (1)
    Key: str,
    PartNumber: int,
    UploadId: str,
    CopySourceIfMatch: NotRequired[str],
    CopySourceIfModifiedSince: NotRequired[Union[datetime, str]],
    CopySourceIfNoneMatch: NotRequired[str],
    CopySourceIfUnmodifiedSince: NotRequired[Union[datetime, str]],
    CopySourceRange: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    CopySourceSSECustomerAlgorithm: NotRequired[str],
    CopySourceSSECustomerKey: NotRequired[str],
    CopySourceSSECustomerKeyMD5: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    ExpectedSourceBucketOwner: NotRequired[str],

1. See CopySourceTypeDef
2. See RequestPayerType

ListBucketsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketsOutputTypeDef

def get_value() -> ListBucketsOutputTypeDef:
    return {
        "Buckets": ...,
        "Owner": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListBucketsOutputTypeDef(TypedDict):
    Buckets: List[BucketTypeDef],  # (1)
    Owner: OwnerTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See BucketTypeDef
2. See OwnerTypeDef
3. See ResponseMetadataTypeDef

CORSConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CORSConfigurationTypeDef

def get_value() -> CORSConfigurationTypeDef:
    return {
        "CORSRules": ...,
    }

Definition

class CORSConfigurationTypeDef(TypedDict):
    CORSRules: Sequence[CORSRuleTypeDef],  # (1)

1. See CORSRuleTypeDef

GetBucketCorsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketCorsOutputTypeDef

def get_value() -> GetBucketCorsOutputTypeDef:
    return {
        "CORSRules": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketCorsOutputTypeDef(TypedDict):
    CORSRules: List[CORSRuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CORSRuleTypeDef
2. See ResponseMetadataTypeDef

CompletedMultipartUploadTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CompletedMultipartUploadTypeDef

def get_value() -> CompletedMultipartUploadTypeDef:
    return {
        "Parts": ...,
    }

Definition

class CompletedMultipartUploadTypeDef(TypedDict):
    Parts: NotRequired[Sequence[CompletedPartTypeDef]],  # (1)

1. See CompletedPartTypeDef

CopyObjectOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CopyObjectOutputTypeDef

def get_value() -> CopyObjectOutputTypeDef:
    return {
        "CopyObjectResult": ...,
        "Expiration": ...,
        "CopySourceVersionId": ...,
        "VersionId": ...,
        "ServerSideEncryption": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "SSEKMSEncryptionContext": ...,
        "BucketKeyEnabled": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }

Definition

class CopyObjectOutputTypeDef(TypedDict):
    CopyObjectResult: CopyObjectResultTypeDef,  # (1)
    Expiration: str,
    CopySourceVersionId: str,
    VersionId: str,
    ServerSideEncryption: ServerSideEncryptionType,  # (2)
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    SSEKMSEncryptionContext: str,
    BucketKeyEnabled: bool,
    RequestCharged: RequestChargedType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See CopyObjectResultTypeDef
2. See ServerSideEncryptionType
3. See RequestChargedType
4. See ResponseMetadataTypeDef

UploadPartCopyOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import UploadPartCopyOutputTypeDef

def get_value() -> UploadPartCopyOutputTypeDef:
    return {
        "CopySourceVersionId": ...,
        "CopyPartResult": ...,
        "ServerSideEncryption": ...,
        "SSECustomerAlgorithm": ...,
        "SSECustomerKeyMD5": ...,
        "SSEKMSKeyId": ...,
        "BucketKeyEnabled": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }

Definition

class UploadPartCopyOutputTypeDef(TypedDict):
    CopySourceVersionId: str,
    CopyPartResult: CopyPartResultTypeDef,  # (1)
    ServerSideEncryption: ServerSideEncryptionType,  # (2)
    SSECustomerAlgorithm: str,
    SSECustomerKeyMD5: str,
    SSEKMSKeyId: str,
    BucketKeyEnabled: bool,
    RequestCharged: RequestChargedType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See CopyPartResultTypeDef
2. See ServerSideEncryptionType
3. See RequestChargedType
4. See ResponseMetadataTypeDef

CreateBucketRequestBucketCreateTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CreateBucketRequestBucketCreateTypeDef

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

Definition

class CreateBucketRequestBucketCreateTypeDef(TypedDict):
    ACL: NotRequired[BucketCannedACLType],  # (1)
    CreateBucketConfiguration: NotRequired[CreateBucketConfigurationTypeDef],  # (2)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    ObjectLockEnabledForBucket: NotRequired[bool],
    ObjectOwnership: NotRequired[ObjectOwnershipType],  # (3)

1. See BucketCannedACLType
2. See CreateBucketConfigurationTypeDef
3. See ObjectOwnershipType

CreateBucketRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CreateBucketRequestRequestTypeDef

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

Definition

class CreateBucketRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ACL: NotRequired[BucketCannedACLType],  # (1)
    CreateBucketConfiguration: NotRequired[CreateBucketConfigurationTypeDef],  # (2)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    ObjectLockEnabledForBucket: NotRequired[bool],
    ObjectOwnership: NotRequired[ObjectOwnershipType],  # (3)

1. See BucketCannedACLType
2. See CreateBucketConfigurationTypeDef
3. See ObjectOwnershipType

CreateBucketRequestServiceResourceCreateBucketTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CreateBucketRequestServiceResourceCreateBucketTypeDef

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

Definition

class CreateBucketRequestServiceResourceCreateBucketTypeDef(TypedDict):
    Bucket: str,
    ACL: NotRequired[BucketCannedACLType],  # (1)
    CreateBucketConfiguration: NotRequired[CreateBucketConfigurationTypeDef],  # (2)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    ObjectLockEnabledForBucket: NotRequired[bool],
    ObjectOwnership: NotRequired[ObjectOwnershipType],  # (3)

1. See BucketCannedACLType
2. See CreateBucketConfigurationTypeDef
3. See ObjectOwnershipType

ObjectLockRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectLockRuleTypeDef

def get_value() -> ObjectLockRuleTypeDef:
    return {
        "DefaultRetention": ...,
    }

Definition

class ObjectLockRuleTypeDef(TypedDict):
    DefaultRetention: NotRequired[DefaultRetentionTypeDef],  # (1)

1. See DefaultRetentionTypeDef

DeleteObjectsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectsOutputTypeDef

def get_value() -> DeleteObjectsOutputTypeDef:
    return {
        "Deleted": ...,
        "RequestCharged": ...,
        "Errors": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteObjectsOutputTypeDef(TypedDict):
    Deleted: List[DeletedObjectTypeDef],  # (1)
    RequestCharged: RequestChargedType,  # (2)
    Errors: List[ErrorTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See DeletedObjectTypeDef
2. See RequestChargedType
3. See ErrorTypeDef
4. See ResponseMetadataTypeDef

DeleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteTypeDef

def get_value() -> DeleteTypeDef:
    return {
        "Objects": ...,
    }

Definition

class DeleteTypeDef(TypedDict):
    Objects: Sequence[ObjectIdentifierTypeDef],  # (1)
    Quiet: NotRequired[bool],

1. See ObjectIdentifierTypeDef

S3KeyFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import S3KeyFilterTypeDef

def get_value() -> S3KeyFilterTypeDef:
    return {
        "FilterRules": ...,
    }

Definition

class S3KeyFilterTypeDef(TypedDict):
    FilterRules: NotRequired[List[FilterRuleTypeDef]],  # (1)

1. See FilterRuleTypeDef

GetBucketPolicyStatusOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketPolicyStatusOutputTypeDef

def get_value() -> GetBucketPolicyStatusOutputTypeDef:
    return {
        "PolicyStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketPolicyStatusOutputTypeDef(TypedDict):
    PolicyStatus: PolicyStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See PolicyStatusTypeDef
2. See ResponseMetadataTypeDef

GetObjectAttributesPartsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectAttributesPartsTypeDef

def get_value() -> GetObjectAttributesPartsTypeDef:
    return {
        "TotalPartsCount": ...,
    }

Definition

class GetObjectAttributesPartsTypeDef(TypedDict):
    TotalPartsCount: NotRequired[int],
    PartNumberMarker: NotRequired[int],
    NextPartNumberMarker: NotRequired[int],
    MaxParts: NotRequired[int],
    IsTruncated: NotRequired[bool],
    Parts: NotRequired[List[ObjectPartTypeDef]],  # (1)

1. See ObjectPartTypeDef

GetObjectLegalHoldOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectLegalHoldOutputTypeDef

def get_value() -> GetObjectLegalHoldOutputTypeDef:
    return {
        "LegalHold": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetObjectLegalHoldOutputTypeDef(TypedDict):
    LegalHold: ObjectLockLegalHoldTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ObjectLockLegalHoldTypeDef
2. See ResponseMetadataTypeDef

PutObjectLegalHoldRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectLegalHoldRequestRequestTypeDef

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

Definition

class PutObjectLegalHoldRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    LegalHold: NotRequired[ObjectLockLegalHoldTypeDef],  # (1)
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    VersionId: NotRequired[str],
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    ExpectedBucketOwner: NotRequired[str],

1. See ObjectLockLegalHoldTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

GetObjectRetentionOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectRetentionOutputTypeDef

def get_value() -> GetObjectRetentionOutputTypeDef:
    return {
        "Retention": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetObjectRetentionOutputTypeDef(TypedDict):
    Retention: ObjectLockRetentionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ObjectLockRetentionTypeDef
2. See ResponseMetadataTypeDef

PutObjectRetentionRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectRetentionRequestRequestTypeDef

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

Definition

class PutObjectRetentionRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    Retention: NotRequired[ObjectLockRetentionTypeDef],  # (1)
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    VersionId: NotRequired[str],
    BypassGovernanceRetention: NotRequired[bool],
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    ExpectedBucketOwner: NotRequired[str],

1. See ObjectLockRetentionTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

GetPublicAccessBlockOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetPublicAccessBlockOutputTypeDef

def get_value() -> GetPublicAccessBlockOutputTypeDef:
    return {
        "PublicAccessBlockConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetPublicAccessBlockOutputTypeDef(TypedDict):
    PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See PublicAccessBlockConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutPublicAccessBlockRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutPublicAccessBlockRequestRequestTypeDef

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

Definition

class PutPublicAccessBlockRequestRequestTypeDef(TypedDict):
    Bucket: str,
    PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef,  # (1)
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See PublicAccessBlockConfigurationTypeDef
2. See ChecksumAlgorithmType

GrantTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GrantTypeDef

def get_value() -> GrantTypeDef:
    return {
        "Grantee": ...,
    }

Definition

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

1. See GranteeTypeDef
2. See PermissionType

TargetGrantTypeDef

Usage Example

from mypy_boto3_s3.type_defs import TargetGrantTypeDef

def get_value() -> TargetGrantTypeDef:
    return {
        "Grantee": ...,
    }

Definition

class TargetGrantTypeDef(TypedDict):
    Grantee: NotRequired[GranteeTypeDef],  # (1)
    Permission: NotRequired[BucketLogsPermissionType],  # (2)

1. See GranteeTypeDef
2. See BucketLogsPermissionType

HeadBucketRequestBucketExistsWaitTypeDef

Usage Example

from mypy_boto3_s3.type_defs import HeadBucketRequestBucketExistsWaitTypeDef

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

Definition

class HeadBucketRequestBucketExistsWaitTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)

1. See WaiterConfigTypeDef

HeadBucketRequestBucketNotExistsWaitTypeDef

Usage Example

from mypy_boto3_s3.type_defs import HeadBucketRequestBucketNotExistsWaitTypeDef

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

Definition

class HeadBucketRequestBucketNotExistsWaitTypeDef(TypedDict):
    Bucket: str,
    ExpectedBucketOwner: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)

1. See WaiterConfigTypeDef

HeadObjectRequestObjectExistsWaitTypeDef

Usage Example

from mypy_boto3_s3.type_defs import HeadObjectRequestObjectExistsWaitTypeDef

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

Definition

class HeadObjectRequestObjectExistsWaitTypeDef(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)
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (3)

1. See RequestPayerType
2. See ChecksumModeType
3. See WaiterConfigTypeDef

HeadObjectRequestObjectNotExistsWaitTypeDef

Usage Example

from mypy_boto3_s3.type_defs import HeadObjectRequestObjectNotExistsWaitTypeDef

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

Definition

class HeadObjectRequestObjectNotExistsWaitTypeDef(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)
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (3)

1. See RequestPayerType
2. See ChecksumModeType
3. See WaiterConfigTypeDef

MultipartUploadTypeDef

Usage Example

from mypy_boto3_s3.type_defs import MultipartUploadTypeDef

def get_value() -> MultipartUploadTypeDef:
    return {
        "UploadId": ...,
    }

Definition

class MultipartUploadTypeDef(TypedDict):
    UploadId: NotRequired[str],
    Key: NotRequired[str],
    Initiated: NotRequired[datetime],
    StorageClass: NotRequired[StorageClassType],  # (1)
    Owner: NotRequired[OwnerTypeDef],  # (2)
    Initiator: NotRequired[InitiatorTypeDef],  # (3)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (4)

1. See StorageClassType
2. See OwnerTypeDef
3. See InitiatorTypeDef
4. See ChecksumAlgorithmType

InputSerializationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InputSerializationTypeDef

def get_value() -> InputSerializationTypeDef:
    return {
        "CSV": ...,
    }

Definition

class InputSerializationTypeDef(TypedDict):
    CSV: NotRequired[CSVInputTypeDef],  # (1)
    CompressionType: NotRequired[CompressionTypeType],  # (2)
    JSON: NotRequired[JSONInputTypeDef],  # (3)
    Parquet: NotRequired[Mapping[str, Any]],

1. See CSVInputTypeDef
2. See CompressionTypeType
3. See JSONInputTypeDef

InventoryEncryptionTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InventoryEncryptionTypeDef

def get_value() -> InventoryEncryptionTypeDef:
    return {
        "SSES3": ...,
    }

Definition

class InventoryEncryptionTypeDef(TypedDict):
    SSES3: NotRequired[Dict[str, Any]],
    SSEKMS: NotRequired[SSEKMSTypeDef],  # (1)

1. See SSEKMSTypeDef

OutputSerializationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import OutputSerializationTypeDef

def get_value() -> OutputSerializationTypeDef:
    return {
        "CSV": ...,
    }

Definition

class OutputSerializationTypeDef(TypedDict):
    CSV: NotRequired[CSVOutputTypeDef],  # (1)
    JSON: NotRequired[JSONOutputTypeDef],  # (2)

1. See CSVOutputTypeDef
2. See JSONOutputTypeDef

RuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RuleTypeDef

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

Definition

class RuleTypeDef(TypedDict):
    Prefix: str,
    Status: ExpirationStatusType,  # (2)
    Expiration: NotRequired[LifecycleExpirationTypeDef],  # (1)
    ID: NotRequired[str],
    Transition: NotRequired[TransitionTypeDef],  # (3)
    NoncurrentVersionTransition: NotRequired[NoncurrentVersionTransitionTypeDef],  # (4)
    NoncurrentVersionExpiration: NotRequired[NoncurrentVersionExpirationTypeDef],  # (5)
    AbortIncompleteMultipartUpload: NotRequired[AbortIncompleteMultipartUploadTypeDef],  # (6)

1. See LifecycleExpirationTypeDef
2. See ExpirationStatusType
3. See TransitionTypeDef
4. See NoncurrentVersionTransitionTypeDef
5. See NoncurrentVersionExpirationTypeDef
6. See AbortIncompleteMultipartUploadTypeDef

ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListMultipartUploadsRequestListMultipartUploadsPaginateTypeDef

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

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

ListObjectVersionsRequestListObjectVersionsPaginateTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectVersionsRequestListObjectVersionsPaginateTypeDef

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

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

ListObjectsRequestListObjectsPaginateTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectsRequestListObjectsPaginateTypeDef

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

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

ListObjectsV2RequestListObjectsV2PaginateTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectsV2RequestListObjectsV2PaginateTypeDef

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

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

ListPartsRequestListPartsPaginateTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListPartsRequestListPartsPaginateTypeDef

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

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

ListPartsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListPartsOutputTypeDef

def get_value() -> ListPartsOutputTypeDef:
    return {
        "AbortDate": ...,
        "AbortRuleId": ...,
        "Bucket": ...,
        "Key": ...,
        "UploadId": ...,
        "PartNumberMarker": ...,
        "NextPartNumberMarker": ...,
        "MaxParts": ...,
        "IsTruncated": ...,
        "Parts": ...,
        "Initiator": ...,
        "Owner": ...,
        "StorageClass": ...,
        "RequestCharged": ...,
        "ChecksumAlgorithm": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListPartsOutputTypeDef(TypedDict):
    AbortDate: datetime,
    AbortRuleId: str,
    Bucket: str,
    Key: str,
    UploadId: str,
    PartNumberMarker: int,
    NextPartNumberMarker: int,
    MaxParts: int,
    IsTruncated: bool,
    Parts: List[PartTypeDef],  # (1)
    Initiator: InitiatorTypeDef,  # (2)
    Owner: OwnerTypeDef,  # (3)
    StorageClass: StorageClassType,  # (4)
    RequestCharged: RequestChargedType,  # (5)
    ChecksumAlgorithm: ChecksumAlgorithmType,  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

1. See PartTypeDef
2. See InitiatorTypeDef
3. See OwnerTypeDef
4. See StorageClassType
5. See RequestChargedType
6. See ChecksumAlgorithmType
7. See ResponseMetadataTypeDef

MetricsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import MetricsTypeDef

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

Definition

class MetricsTypeDef(TypedDict):
    Status: MetricsStatusType,  # (1)
    EventThreshold: NotRequired[ReplicationTimeValueTypeDef],  # (2)

1. See MetricsStatusType
2. See ReplicationTimeValueTypeDef

ReplicationTimeTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicationTimeTypeDef

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

Definition

class ReplicationTimeTypeDef(TypedDict):
    Status: ReplicationTimeStatusType,  # (1)
    Time: ReplicationTimeValueTypeDef,  # (2)

1. See ReplicationTimeStatusType
2. See ReplicationTimeValueTypeDef

NotificationConfigurationDeprecatedResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NotificationConfigurationDeprecatedResponseMetadataTypeDef

def get_value() -> NotificationConfigurationDeprecatedResponseMetadataTypeDef:
    return {
        "TopicConfiguration": ...,
        "QueueConfiguration": ...,
        "CloudFunctionConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class NotificationConfigurationDeprecatedResponseMetadataTypeDef(TypedDict):
    TopicConfiguration: TopicConfigurationDeprecatedTypeDef,  # (1)
    QueueConfiguration: QueueConfigurationDeprecatedTypeDef,  # (2)
    CloudFunctionConfiguration: CloudFunctionConfigurationTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See TopicConfigurationDeprecatedTypeDef
2. See QueueConfigurationDeprecatedTypeDef
3. See CloudFunctionConfigurationTypeDef
4. See ResponseMetadataTypeDef

NotificationConfigurationDeprecatedTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NotificationConfigurationDeprecatedTypeDef

def get_value() -> NotificationConfigurationDeprecatedTypeDef:
    return {
        "TopicConfiguration": ...,
    }

Definition

class NotificationConfigurationDeprecatedTypeDef(TypedDict):
    TopicConfiguration: NotRequired[TopicConfigurationDeprecatedTypeDef],  # (1)
    QueueConfiguration: NotRequired[QueueConfigurationDeprecatedTypeDef],  # (2)
    CloudFunctionConfiguration: NotRequired[CloudFunctionConfigurationTypeDef],  # (3)

1. See TopicConfigurationDeprecatedTypeDef
2. See QueueConfigurationDeprecatedTypeDef
3. See CloudFunctionConfigurationTypeDef

OwnershipControlsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import OwnershipControlsTypeDef

def get_value() -> OwnershipControlsTypeDef:
    return {
        "Rules": ...,
    }

Definition

class OwnershipControlsTypeDef(TypedDict):
    Rules: List[OwnershipControlsRuleTypeDef],  # (1)

1. See OwnershipControlsRuleTypeDef

ProgressEventTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ProgressEventTypeDef

def get_value() -> ProgressEventTypeDef:
    return {
        "Details": ...,
    }

Definition

class ProgressEventTypeDef(TypedDict):
    Details: NotRequired[ProgressTypeDef],  # (1)

1. See ProgressTypeDef

PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef

def get_value() -> PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef:
    return {
        "RequestPaymentConfiguration": ...,
    }

Definition

class PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef(TypedDict):
    RequestPaymentConfiguration: RequestPaymentConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See RequestPaymentConfigurationTypeDef
2. See ChecksumAlgorithmType

PutBucketRequestPaymentRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketRequestPaymentRequestRequestTypeDef

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

Definition

class PutBucketRequestPaymentRequestRequestTypeDef(TypedDict):
    Bucket: str,
    RequestPaymentConfiguration: RequestPaymentConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See RequestPaymentConfigurationTypeDef
2. See ChecksumAlgorithmType

PutBucketVersioningRequestBucketVersioningPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningPutTypeDef

def get_value() -> PutBucketVersioningRequestBucketVersioningPutTypeDef:
    return {
        "VersioningConfiguration": ...,
    }

Definition

class PutBucketVersioningRequestBucketVersioningPutTypeDef(TypedDict):
    VersioningConfiguration: VersioningConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    MFA: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See VersioningConfigurationTypeDef
2. See ChecksumAlgorithmType

PutBucketVersioningRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketVersioningRequestRequestTypeDef

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

Definition

class PutBucketVersioningRequestRequestTypeDef(TypedDict):
    Bucket: str,
    VersioningConfiguration: VersioningConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    MFA: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See VersioningConfigurationTypeDef
2. See ChecksumAlgorithmType

RoutingRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RoutingRuleTypeDef

def get_value() -> RoutingRuleTypeDef:
    return {
        "Redirect": ...,
    }

Definition

class RoutingRuleTypeDef(TypedDict):
    Redirect: RedirectTypeDef,  # (2)
    Condition: NotRequired[ConditionTypeDef],  # (1)

1. See ConditionTypeDef
2. See RedirectTypeDef

ServerSideEncryptionRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServerSideEncryptionRuleTypeDef

def get_value() -> ServerSideEncryptionRuleTypeDef:
    return {
        "ApplyServerSideEncryptionByDefault": ...,
    }

Definition

class ServerSideEncryptionRuleTypeDef(TypedDict):
    ApplyServerSideEncryptionByDefault: NotRequired[ServerSideEncryptionByDefaultTypeDef],  # (1)
    BucketKeyEnabled: NotRequired[bool],

1. See ServerSideEncryptionByDefaultTypeDef

SourceSelectionCriteriaTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SourceSelectionCriteriaTypeDef

def get_value() -> SourceSelectionCriteriaTypeDef:
    return {
        "SseKmsEncryptedObjects": ...,
    }

Definition

class SourceSelectionCriteriaTypeDef(TypedDict):
    SseKmsEncryptedObjects: NotRequired[SseKmsEncryptedObjectsTypeDef],  # (1)
    ReplicaModifications: NotRequired[ReplicaModificationsTypeDef],  # (2)

1. See SseKmsEncryptedObjectsTypeDef
2. See ReplicaModificationsTypeDef

StatsEventTypeDef

Usage Example

from mypy_boto3_s3.type_defs import StatsEventTypeDef

def get_value() -> StatsEventTypeDef:
    return {
        "Details": ...,
    }

Definition

class StatsEventTypeDef(TypedDict):
    Details: NotRequired[StatsTypeDef],  # (1)

1. See StatsTypeDef

ListObjectsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectsOutputTypeDef

def get_value() -> ListObjectsOutputTypeDef:
    return {
        "IsTruncated": ...,
        "Marker": ...,
        "NextMarker": ...,
        "Contents": ...,
        "Name": ...,
        "Prefix": ...,
        "Delimiter": ...,
        "MaxKeys": ...,
        "CommonPrefixes": ...,
        "EncodingType": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListObjectsOutputTypeDef(TypedDict):
    IsTruncated: bool,
    Marker: str,
    NextMarker: str,
    Contents: List[ObjectTypeDef],  # (1)
    Name: str,
    Prefix: str,
    Delimiter: str,
    MaxKeys: int,
    CommonPrefixes: List[CommonPrefixTypeDef],  # (2)
    EncodingType: EncodingTypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See ObjectTypeDef
2. See CommonPrefixTypeDef
3. See EncodingTypeType
4. See ResponseMetadataTypeDef

ListObjectsV2OutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectsV2OutputTypeDef

def get_value() -> ListObjectsV2OutputTypeDef:
    return {
        "IsTruncated": ...,
        "Contents": ...,
        "Name": ...,
        "Prefix": ...,
        "Delimiter": ...,
        "MaxKeys": ...,
        "CommonPrefixes": ...,
        "EncodingType": ...,
        "KeyCount": ...,
        "ContinuationToken": ...,
        "NextContinuationToken": ...,
        "StartAfter": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListObjectsV2OutputTypeDef(TypedDict):
    IsTruncated: bool,
    Contents: List[ObjectTypeDef],  # (1)
    Name: str,
    Prefix: str,
    Delimiter: str,
    MaxKeys: int,
    CommonPrefixes: List[CommonPrefixTypeDef],  # (2)
    EncodingType: EncodingTypeType,  # (3)
    KeyCount: int,
    ContinuationToken: str,
    NextContinuationToken: str,
    StartAfter: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See ObjectTypeDef
2. See CommonPrefixTypeDef
3. See EncodingTypeType
4. See ResponseMetadataTypeDef

ListObjectVersionsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListObjectVersionsOutputTypeDef

def get_value() -> ListObjectVersionsOutputTypeDef:
    return {
        "IsTruncated": ...,
        "KeyMarker": ...,
        "VersionIdMarker": ...,
        "NextKeyMarker": ...,
        "NextVersionIdMarker": ...,
        "Versions": ...,
        "DeleteMarkers": ...,
        "Name": ...,
        "Prefix": ...,
        "Delimiter": ...,
        "MaxKeys": ...,
        "CommonPrefixes": ...,
        "EncodingType": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListObjectVersionsOutputTypeDef(TypedDict):
    IsTruncated: bool,
    KeyMarker: str,
    VersionIdMarker: str,
    NextKeyMarker: str,
    NextVersionIdMarker: str,
    Versions: List[ObjectVersionTypeDef],  # (1)
    DeleteMarkers: List[DeleteMarkerEntryTypeDef],  # (2)
    Name: str,
    Prefix: str,
    Delimiter: str,
    MaxKeys: int,
    CommonPrefixes: List[CommonPrefixTypeDef],  # (3)
    EncodingType: EncodingTypeType,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

1. See ObjectVersionTypeDef
2. See DeleteMarkerEntryTypeDef
3. See CommonPrefixTypeDef
4. See EncodingTypeType
5. See ResponseMetadataTypeDef

AnalyticsFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AnalyticsFilterTypeDef

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

Definition

class AnalyticsFilterTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tag: NotRequired[TagTypeDef],  # (1)
    And: NotRequired[AnalyticsAndOperatorTypeDef],  # (2)

1. See TagTypeDef
2. See AnalyticsAndOperatorTypeDef

IntelligentTieringFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import IntelligentTieringFilterTypeDef

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

Definition

class IntelligentTieringFilterTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tag: NotRequired[TagTypeDef],  # (1)
    And: NotRequired[IntelligentTieringAndOperatorTypeDef],  # (2)

1. See TagTypeDef
2. See IntelligentTieringAndOperatorTypeDef

LifecycleRuleFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LifecycleRuleFilterTypeDef

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

Definition

class LifecycleRuleFilterTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tag: NotRequired[TagTypeDef],  # (1)
    ObjectSizeGreaterThan: NotRequired[int],
    ObjectSizeLessThan: NotRequired[int],
    And: NotRequired[LifecycleRuleAndOperatorTypeDef],  # (2)

1. See TagTypeDef
2. See LifecycleRuleAndOperatorTypeDef

MetricsFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import MetricsFilterTypeDef

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

Definition

class MetricsFilterTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tag: NotRequired[TagTypeDef],  # (1)
    AccessPointArn: NotRequired[str],
    And: NotRequired[MetricsAndOperatorTypeDef],  # (2)

1. See TagTypeDef
2. See MetricsAndOperatorTypeDef

ReplicationRuleFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicationRuleFilterTypeDef

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

Definition

class ReplicationRuleFilterTypeDef(TypedDict):
    Prefix: NotRequired[str],
    Tag: NotRequired[TagTypeDef],  # (1)
    And: NotRequired[ReplicationRuleAndOperatorTypeDef],  # (2)

1. See TagTypeDef
2. See ReplicationRuleAndOperatorTypeDef

PutBucketTaggingRequestBucketTaggingPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketTaggingRequestBucketTaggingPutTypeDef

def get_value() -> PutBucketTaggingRequestBucketTaggingPutTypeDef:
    return {
        "Tagging": ...,
    }

Definition

class PutBucketTaggingRequestBucketTaggingPutTypeDef(TypedDict):
    Tagging: TaggingTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See TaggingTypeDef
2. See ChecksumAlgorithmType

PutBucketTaggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketTaggingRequestRequestTypeDef

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

Definition

class PutBucketTaggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Tagging: TaggingTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See TaggingTypeDef
2. See ChecksumAlgorithmType

PutObjectTaggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectTaggingRequestRequestTypeDef

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

Definition

class PutObjectTaggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    Tagging: TaggingTypeDef,  # (1)
    VersionId: NotRequired[str],
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (3)

1. See TaggingTypeDef
2. See ChecksumAlgorithmType
3. See RequestPayerType

StorageClassAnalysisDataExportTypeDef

Usage Example

from mypy_boto3_s3.type_defs import StorageClassAnalysisDataExportTypeDef

def get_value() -> StorageClassAnalysisDataExportTypeDef:
    return {
        "OutputSchemaVersion": ...,
        "Destination": ...,
    }

Definition

class StorageClassAnalysisDataExportTypeDef(TypedDict):
    OutputSchemaVersion: StorageClassAnalysisSchemaVersionType,  # (1)
    Destination: AnalyticsExportDestinationTypeDef,  # (2)

1. See StorageClassAnalysisSchemaVersionType
2. See AnalyticsExportDestinationTypeDef

PutBucketCorsRequestBucketCorsPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketCorsRequestBucketCorsPutTypeDef

def get_value() -> PutBucketCorsRequestBucketCorsPutTypeDef:
    return {
        "CORSConfiguration": ...,
    }

Definition

class PutBucketCorsRequestBucketCorsPutTypeDef(TypedDict):
    CORSConfiguration: CORSConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See CORSConfigurationTypeDef
2. See ChecksumAlgorithmType

PutBucketCorsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketCorsRequestRequestTypeDef

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

Definition

class PutBucketCorsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    CORSConfiguration: CORSConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See CORSConfigurationTypeDef
2. See ChecksumAlgorithmType

CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef

def get_value() -> CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef:
    return {
        "MultipartUpload": ...,
    }

Definition

class CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef(TypedDict):
    MultipartUpload: NotRequired[CompletedMultipartUploadTypeDef],  # (1)
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],

1. See CompletedMultipartUploadTypeDef
2. See RequestPayerType

CompleteMultipartUploadRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import CompleteMultipartUploadRequestRequestTypeDef

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

Definition

class CompleteMultipartUploadRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    UploadId: str,
    MultipartUpload: NotRequired[CompletedMultipartUploadTypeDef],  # (1)
    ChecksumCRC32: NotRequired[str],
    ChecksumCRC32C: NotRequired[str],
    ChecksumSHA1: NotRequired[str],
    ChecksumSHA256: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ExpectedBucketOwner: NotRequired[str],
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],

1. See CompletedMultipartUploadTypeDef
2. See RequestPayerType

ObjectLockConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ObjectLockConfigurationTypeDef

def get_value() -> ObjectLockConfigurationTypeDef:
    return {
        "ObjectLockEnabled": ...,
    }

Definition

class ObjectLockConfigurationTypeDef(TypedDict):
    ObjectLockEnabled: NotRequired[ObjectLockEnabledType],  # (1)
    Rule: NotRequired[ObjectLockRuleTypeDef],  # (2)

1. See ObjectLockEnabledType
2. See ObjectLockRuleTypeDef

DeleteObjectsRequestBucketDeleteObjectsTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectsRequestBucketDeleteObjectsTypeDef

def get_value() -> DeleteObjectsRequestBucketDeleteObjectsTypeDef:
    return {
        "Delete": ...,
    }

Definition

class DeleteObjectsRequestBucketDeleteObjectsTypeDef(TypedDict):
    Delete: DeleteTypeDef,  # (1)
    MFA: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)

1. See DeleteTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

DeleteObjectsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DeleteObjectsRequestRequestTypeDef

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

Definition

class DeleteObjectsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Delete: DeleteTypeDef,  # (1)
    MFA: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    BypassGovernanceRetention: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)

1. See DeleteTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

NotificationConfigurationFilterTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NotificationConfigurationFilterTypeDef

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

Definition

class NotificationConfigurationFilterTypeDef(TypedDict):
    Key: NotRequired[S3KeyFilterTypeDef],  # (1)

1. See S3KeyFilterTypeDef

GetObjectAttributesOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectAttributesOutputTypeDef

def get_value() -> GetObjectAttributesOutputTypeDef:
    return {
        "DeleteMarker": ...,
        "LastModified": ...,
        "VersionId": ...,
        "RequestCharged": ...,
        "ETag": ...,
        "Checksum": ...,
        "ObjectParts": ...,
        "StorageClass": ...,
        "ObjectSize": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetObjectAttributesOutputTypeDef(TypedDict):
    DeleteMarker: bool,
    LastModified: datetime,
    VersionId: str,
    RequestCharged: RequestChargedType,  # (1)
    ETag: str,
    Checksum: ChecksumTypeDef,  # (2)
    ObjectParts: GetObjectAttributesPartsTypeDef,  # (3)
    StorageClass: StorageClassType,  # (4)
    ObjectSize: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

1. See RequestChargedType
2. See ChecksumTypeDef
3. See GetObjectAttributesPartsTypeDef
4. See StorageClassType
5. See ResponseMetadataTypeDef

AccessControlPolicyTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AccessControlPolicyTypeDef

def get_value() -> AccessControlPolicyTypeDef:
    return {
        "Grants": ...,
    }

Definition

class AccessControlPolicyTypeDef(TypedDict):
    Grants: NotRequired[Sequence[GrantTypeDef]],  # (1)
    Owner: NotRequired[OwnerTypeDef],  # (2)

1. See GrantTypeDef
2. See OwnerTypeDef

GetBucketAclOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketAclOutputTypeDef

def get_value() -> GetBucketAclOutputTypeDef:
    return {
        "Owner": ...,
        "Grants": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketAclOutputTypeDef(TypedDict):
    Owner: OwnerTypeDef,  # (1)
    Grants: List[GrantTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See OwnerTypeDef
2. See GrantTypeDef
3. See ResponseMetadataTypeDef

GetObjectAclOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectAclOutputTypeDef

def get_value() -> GetObjectAclOutputTypeDef:
    return {
        "Owner": ...,
        "Grants": ...,
        "RequestCharged": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetObjectAclOutputTypeDef(TypedDict):
    Owner: OwnerTypeDef,  # (1)
    Grants: List[GrantTypeDef],  # (2)
    RequestCharged: RequestChargedType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See OwnerTypeDef
2. See GrantTypeDef
3. See RequestChargedType
4. See ResponseMetadataTypeDef

S3LocationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import S3LocationTypeDef

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

Definition

class S3LocationTypeDef(TypedDict):
    BucketName: str,
    Prefix: str,
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
    CannedACL: NotRequired[ObjectCannedACLType],  # (2)
    AccessControlList: NotRequired[Sequence[GrantTypeDef]],  # (3)
    Tagging: NotRequired[TaggingTypeDef],  # (4)
    UserMetadata: NotRequired[Sequence[MetadataEntryTypeDef]],  # (5)
    StorageClass: NotRequired[StorageClassType],  # (6)

1. See EncryptionTypeDef
2. See ObjectCannedACLType
3. See GrantTypeDef
4. See TaggingTypeDef
5. See MetadataEntryTypeDef
6. See StorageClassType

LoggingEnabledResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LoggingEnabledResponseMetadataTypeDef

def get_value() -> LoggingEnabledResponseMetadataTypeDef:
    return {
        "TargetBucket": ...,
        "TargetGrants": ...,
        "TargetPrefix": ...,
        "ResponseMetadata": ...,
    }

Definition

class LoggingEnabledResponseMetadataTypeDef(TypedDict):
    TargetBucket: str,
    TargetGrants: List[TargetGrantTypeDef],  # (1)
    TargetPrefix: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TargetGrantTypeDef
2. See ResponseMetadataTypeDef

LoggingEnabledTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LoggingEnabledTypeDef

def get_value() -> LoggingEnabledTypeDef:
    return {
        "TargetBucket": ...,
        "TargetPrefix": ...,
    }

Definition

class LoggingEnabledTypeDef(TypedDict):
    TargetBucket: str,
    TargetPrefix: str,
    TargetGrants: NotRequired[List[TargetGrantTypeDef]],  # (1)

1. See TargetGrantTypeDef

ListMultipartUploadsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListMultipartUploadsOutputTypeDef

def get_value() -> ListMultipartUploadsOutputTypeDef:
    return {
        "Bucket": ...,
        "KeyMarker": ...,
        "UploadIdMarker": ...,
        "NextKeyMarker": ...,
        "Prefix": ...,
        "Delimiter": ...,
        "NextUploadIdMarker": ...,
        "MaxUploads": ...,
        "IsTruncated": ...,
        "Uploads": ...,
        "CommonPrefixes": ...,
        "EncodingType": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListMultipartUploadsOutputTypeDef(TypedDict):
    Bucket: str,
    KeyMarker: str,
    UploadIdMarker: str,
    NextKeyMarker: str,
    Prefix: str,
    Delimiter: str,
    NextUploadIdMarker: str,
    MaxUploads: int,
    IsTruncated: bool,
    Uploads: List[MultipartUploadTypeDef],  # (1)
    CommonPrefixes: List[CommonPrefixTypeDef],  # (2)
    EncodingType: EncodingTypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See MultipartUploadTypeDef
2. See CommonPrefixTypeDef
3. See EncodingTypeType
4. See ResponseMetadataTypeDef

InventoryS3BucketDestinationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InventoryS3BucketDestinationTypeDef

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

Definition

class InventoryS3BucketDestinationTypeDef(TypedDict):
    Bucket: str,
    Format: InventoryFormatType,  # (1)
    AccountId: NotRequired[str],
    Prefix: NotRequired[str],
    Encryption: NotRequired[InventoryEncryptionTypeDef],  # (2)

1. See InventoryFormatType
2. See InventoryEncryptionTypeDef

SelectObjectContentRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SelectObjectContentRequestRequestTypeDef

def get_value() -> SelectObjectContentRequestRequestTypeDef:
    return {
        "Bucket": ...,
        "Key": ...,
        "Expression": ...,
        "ExpressionType": ...,
        "InputSerialization": ...,
        "OutputSerialization": ...,
    }

Definition

class SelectObjectContentRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    Expression: str,
    ExpressionType: ExpressionTypeType,  # (1)
    InputSerialization: InputSerializationTypeDef,  # (2)
    OutputSerialization: OutputSerializationTypeDef,  # (3)
    SSECustomerAlgorithm: NotRequired[str],
    SSECustomerKey: NotRequired[str],
    SSECustomerKeyMD5: NotRequired[str],
    RequestProgress: NotRequired[RequestProgressTypeDef],  # (4)
    ScanRange: NotRequired[ScanRangeTypeDef],  # (5)
    ExpectedBucketOwner: NotRequired[str],

1. See ExpressionTypeType
2. See InputSerializationTypeDef
3. See OutputSerializationTypeDef
4. See RequestProgressTypeDef
5. See ScanRangeTypeDef

SelectParametersTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SelectParametersTypeDef

def get_value() -> SelectParametersTypeDef:
    return {
        "InputSerialization": ...,
        "ExpressionType": ...,
        "Expression": ...,
        "OutputSerialization": ...,
    }

Definition

class SelectParametersTypeDef(TypedDict):
    InputSerialization: InputSerializationTypeDef,  # (1)
    ExpressionType: ExpressionTypeType,  # (2)
    Expression: str,
    OutputSerialization: OutputSerializationTypeDef,  # (3)

1. See InputSerializationTypeDef
2. See ExpressionTypeType
3. See OutputSerializationTypeDef

GetBucketLifecycleOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLifecycleOutputTypeDef

def get_value() -> GetBucketLifecycleOutputTypeDef:
    return {
        "Rules": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketLifecycleOutputTypeDef(TypedDict):
    Rules: List[RuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RuleTypeDef
2. See ResponseMetadataTypeDef

LifecycleConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LifecycleConfigurationTypeDef

def get_value() -> LifecycleConfigurationTypeDef:
    return {
        "Rules": ...,
    }

Definition

class LifecycleConfigurationTypeDef(TypedDict):
    Rules: Sequence[RuleTypeDef],  # (1)

1. See RuleTypeDef

DestinationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import DestinationTypeDef

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

Definition

class DestinationTypeDef(TypedDict):
    Bucket: str,
    Account: NotRequired[str],
    StorageClass: NotRequired[StorageClassType],  # (1)
    AccessControlTranslation: NotRequired[AccessControlTranslationTypeDef],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    ReplicationTime: NotRequired[ReplicationTimeTypeDef],  # (4)
    Metrics: NotRequired[MetricsTypeDef],  # (5)

1. See StorageClassType
2. See AccessControlTranslationTypeDef
3. See EncryptionConfigurationTypeDef
4. See ReplicationTimeTypeDef
5. See MetricsTypeDef

PutBucketNotificationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketNotificationRequestRequestTypeDef

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

Definition

class PutBucketNotificationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    NotificationConfiguration: NotificationConfigurationDeprecatedTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See NotificationConfigurationDeprecatedTypeDef
2. See ChecksumAlgorithmType

GetBucketOwnershipControlsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketOwnershipControlsOutputTypeDef

def get_value() -> GetBucketOwnershipControlsOutputTypeDef:
    return {
        "OwnershipControls": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketOwnershipControlsOutputTypeDef(TypedDict):
    OwnershipControls: OwnershipControlsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See OwnershipControlsTypeDef
2. See ResponseMetadataTypeDef

PutBucketOwnershipControlsRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketOwnershipControlsRequestRequestTypeDef

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

Definition

class PutBucketOwnershipControlsRequestRequestTypeDef(TypedDict):
    Bucket: str,
    OwnershipControls: OwnershipControlsTypeDef,  # (1)
    ContentMD5: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See OwnershipControlsTypeDef

GetBucketWebsiteOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketWebsiteOutputTypeDef

def get_value() -> GetBucketWebsiteOutputTypeDef:
    return {
        "RedirectAllRequestsTo": ...,
        "IndexDocument": ...,
        "ErrorDocument": ...,
        "RoutingRules": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketWebsiteOutputTypeDef(TypedDict):
    RedirectAllRequestsTo: RedirectAllRequestsToTypeDef,  # (1)
    IndexDocument: IndexDocumentTypeDef,  # (2)
    ErrorDocument: ErrorDocumentTypeDef,  # (3)
    RoutingRules: List[RoutingRuleTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

1. See RedirectAllRequestsToTypeDef
2. See IndexDocumentTypeDef
3. See ErrorDocumentTypeDef
4. See RoutingRuleTypeDef
5. See ResponseMetadataTypeDef

WebsiteConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import WebsiteConfigurationTypeDef

def get_value() -> WebsiteConfigurationTypeDef:
    return {
        "ErrorDocument": ...,
    }

Definition

class WebsiteConfigurationTypeDef(TypedDict):
    ErrorDocument: NotRequired[ErrorDocumentTypeDef],  # (1)
    IndexDocument: NotRequired[IndexDocumentTypeDef],  # (2)
    RedirectAllRequestsTo: NotRequired[RedirectAllRequestsToTypeDef],  # (3)
    RoutingRules: NotRequired[Sequence[RoutingRuleTypeDef]],  # (4)

1. See ErrorDocumentTypeDef
2. See IndexDocumentTypeDef
3. See RedirectAllRequestsToTypeDef
4. See RoutingRuleTypeDef

ServerSideEncryptionConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ServerSideEncryptionConfigurationTypeDef

def get_value() -> ServerSideEncryptionConfigurationTypeDef:
    return {
        "Rules": ...,
    }

Definition

class ServerSideEncryptionConfigurationTypeDef(TypedDict):
    Rules: List[ServerSideEncryptionRuleTypeDef],  # (1)

1. See ServerSideEncryptionRuleTypeDef

SelectObjectContentEventStreamTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SelectObjectContentEventStreamTypeDef

def get_value() -> SelectObjectContentEventStreamTypeDef:
    return {
        "Records": ...,
    }

Definition

class SelectObjectContentEventStreamTypeDef(TypedDict):
    Records: NotRequired[RecordsEventTypeDef],  # (1)
    Stats: NotRequired[StatsEventTypeDef],  # (2)
    Progress: NotRequired[ProgressEventTypeDef],  # (3)
    Cont: NotRequired[Dict[str, Any]],
    End: NotRequired[Dict[str, Any]],

1. See RecordsEventTypeDef
2. See StatsEventTypeDef
3. See ProgressEventTypeDef

IntelligentTieringConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import IntelligentTieringConfigurationTypeDef

def get_value() -> IntelligentTieringConfigurationTypeDef:
    return {
        "Id": ...,
        "Status": ...,
        "Tierings": ...,
    }

Definition

class IntelligentTieringConfigurationTypeDef(TypedDict):
    Id: str,
    Status: IntelligentTieringStatusType,  # (2)
    Tierings: List[TieringTypeDef],  # (3)
    Filter: NotRequired[IntelligentTieringFilterTypeDef],  # (1)

1. See IntelligentTieringFilterTypeDef
2. See IntelligentTieringStatusType
3. See TieringTypeDef

LifecycleRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LifecycleRuleTypeDef

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

Definition

class LifecycleRuleTypeDef(TypedDict):
    Status: ExpirationStatusType,  # (3)
    Expiration: NotRequired[LifecycleExpirationTypeDef],  # (1)
    ID: NotRequired[str],
    Prefix: NotRequired[str],
    Filter: NotRequired[LifecycleRuleFilterTypeDef],  # (2)
    Transitions: NotRequired[List[TransitionTypeDef]],  # (4)
    NoncurrentVersionTransitions: NotRequired[List[NoncurrentVersionTransitionTypeDef]],  # (5)
    NoncurrentVersionExpiration: NotRequired[NoncurrentVersionExpirationTypeDef],  # (6)
    AbortIncompleteMultipartUpload: NotRequired[AbortIncompleteMultipartUploadTypeDef],  # (7)

1. See LifecycleExpirationTypeDef
2. See LifecycleRuleFilterTypeDef
3. See ExpirationStatusType
4. See TransitionTypeDef
5. See NoncurrentVersionTransitionTypeDef
6. See NoncurrentVersionExpirationTypeDef
7. See AbortIncompleteMultipartUploadTypeDef

MetricsConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import MetricsConfigurationTypeDef

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

Definition

class MetricsConfigurationTypeDef(TypedDict):
    Id: str,
    Filter: NotRequired[MetricsFilterTypeDef],  # (1)

1. See MetricsFilterTypeDef

StorageClassAnalysisTypeDef

Usage Example

from mypy_boto3_s3.type_defs import StorageClassAnalysisTypeDef

def get_value() -> StorageClassAnalysisTypeDef:
    return {
        "DataExport": ...,
    }

Definition

class StorageClassAnalysisTypeDef(TypedDict):
    DataExport: NotRequired[StorageClassAnalysisDataExportTypeDef],  # (1)

1. See StorageClassAnalysisDataExportTypeDef

GetObjectLockConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetObjectLockConfigurationOutputTypeDef

def get_value() -> GetObjectLockConfigurationOutputTypeDef:
    return {
        "ObjectLockConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetObjectLockConfigurationOutputTypeDef(TypedDict):
    ObjectLockConfiguration: ObjectLockConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ObjectLockConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutObjectLockConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectLockConfigurationRequestRequestTypeDef

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

Definition

class PutObjectLockConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ObjectLockConfiguration: NotRequired[ObjectLockConfigurationTypeDef],  # (1)
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    Token: NotRequired[str],
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    ExpectedBucketOwner: NotRequired[str],

1. See ObjectLockConfigurationTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

LambdaFunctionConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import LambdaFunctionConfigurationTypeDef

def get_value() -> LambdaFunctionConfigurationTypeDef:
    return {
        "LambdaFunctionArn": ...,
        "Events": ...,
    }

Definition

class LambdaFunctionConfigurationTypeDef(TypedDict):
    LambdaFunctionArn: str,
    Events: List[EventType],  # (1)
    Id: NotRequired[str],
    Filter: NotRequired[NotificationConfigurationFilterTypeDef],  # (2)

1. See EventType
2. See NotificationConfigurationFilterTypeDef

QueueConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import QueueConfigurationTypeDef

def get_value() -> QueueConfigurationTypeDef:
    return {
        "QueueArn": ...,
        "Events": ...,
    }

Definition

class QueueConfigurationTypeDef(TypedDict):
    QueueArn: str,
    Events: List[EventType],  # (1)
    Id: NotRequired[str],
    Filter: NotRequired[NotificationConfigurationFilterTypeDef],  # (2)

1. See EventType
2. See NotificationConfigurationFilterTypeDef

TopicConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import TopicConfigurationTypeDef

def get_value() -> TopicConfigurationTypeDef:
    return {
        "TopicArn": ...,
        "Events": ...,
    }

Definition

class TopicConfigurationTypeDef(TypedDict):
    TopicArn: str,
    Events: List[EventType],  # (1)
    Id: NotRequired[str],
    Filter: NotRequired[NotificationConfigurationFilterTypeDef],  # (2)

1. See EventType
2. See NotificationConfigurationFilterTypeDef

PutBucketAclRequestBucketAclPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketAclRequestBucketAclPutTypeDef

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

Definition

class PutBucketAclRequestBucketAclPutTypeDef(TypedDict):
    ACL: NotRequired[BucketCannedACLType],  # (1)
    AccessControlPolicy: NotRequired[AccessControlPolicyTypeDef],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See BucketCannedACLType
2. See AccessControlPolicyTypeDef
3. See ChecksumAlgorithmType

PutBucketAclRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketAclRequestRequestTypeDef

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

Definition

class PutBucketAclRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ACL: NotRequired[BucketCannedACLType],  # (1)
    AccessControlPolicy: NotRequired[AccessControlPolicyTypeDef],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See BucketCannedACLType
2. See AccessControlPolicyTypeDef
3. See ChecksumAlgorithmType

PutObjectAclRequestObjectAclPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectAclRequestObjectAclPutTypeDef

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

Definition

class PutObjectAclRequestObjectAclPutTypeDef(TypedDict):
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    AccessControlPolicy: NotRequired[AccessControlPolicyTypeDef],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (4)
    VersionId: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See ObjectCannedACLType
2. See AccessControlPolicyTypeDef
3. See ChecksumAlgorithmType
4. See RequestPayerType

PutObjectAclRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutObjectAclRequestRequestTypeDef

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

Definition

class PutObjectAclRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    ACL: NotRequired[ObjectCannedACLType],  # (1)
    AccessControlPolicy: NotRequired[AccessControlPolicyTypeDef],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    GrantFullControl: NotRequired[str],
    GrantRead: NotRequired[str],
    GrantReadACP: NotRequired[str],
    GrantWrite: NotRequired[str],
    GrantWriteACP: NotRequired[str],
    RequestPayer: NotRequired[RequestPayerType],  # (4)
    VersionId: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See ObjectCannedACLType
2. See AccessControlPolicyTypeDef
3. See ChecksumAlgorithmType
4. See RequestPayerType

OutputLocationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import OutputLocationTypeDef

def get_value() -> OutputLocationTypeDef:
    return {
        "S3": ...,
    }

Definition

class OutputLocationTypeDef(TypedDict):
    S3: NotRequired[S3LocationTypeDef],  # (1)

1. See S3LocationTypeDef

BucketLoggingStatusTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketLoggingStatusTypeDef

def get_value() -> BucketLoggingStatusTypeDef:
    return {
        "LoggingEnabled": ...,
    }

Definition

class BucketLoggingStatusTypeDef(TypedDict):
    LoggingEnabled: NotRequired[LoggingEnabledTypeDef],  # (1)

1. See LoggingEnabledTypeDef

GetBucketLoggingOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLoggingOutputTypeDef

def get_value() -> GetBucketLoggingOutputTypeDef:
    return {
        "LoggingEnabled": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketLoggingOutputTypeDef(TypedDict):
    LoggingEnabled: LoggingEnabledTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LoggingEnabledTypeDef
2. See ResponseMetadataTypeDef

InventoryDestinationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InventoryDestinationTypeDef

def get_value() -> InventoryDestinationTypeDef:
    return {
        "S3BucketDestination": ...,
    }

Definition

class InventoryDestinationTypeDef(TypedDict):
    S3BucketDestination: InventoryS3BucketDestinationTypeDef,  # (1)

1. See InventoryS3BucketDestinationTypeDef

PutBucketLifecycleRequestBucketLifecyclePutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketLifecycleRequestBucketLifecyclePutTypeDef

def get_value() -> PutBucketLifecycleRequestBucketLifecyclePutTypeDef:
    return {
        "ChecksumAlgorithm": ...,
    }

Definition

class PutBucketLifecycleRequestBucketLifecyclePutTypeDef(TypedDict):
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    LifecycleConfiguration: NotRequired[LifecycleConfigurationTypeDef],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ChecksumAlgorithmType
2. See LifecycleConfigurationTypeDef

PutBucketLifecycleRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketLifecycleRequestRequestTypeDef

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

Definition

class PutBucketLifecycleRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    LifecycleConfiguration: NotRequired[LifecycleConfigurationTypeDef],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ChecksumAlgorithmType
2. See LifecycleConfigurationTypeDef

ReplicationRuleTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicationRuleTypeDef

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

Definition

class ReplicationRuleTypeDef(TypedDict):
    Status: ReplicationRuleStatusType,  # (2)
    Destination: DestinationTypeDef,  # (5)
    ID: NotRequired[str],
    Priority: NotRequired[int],
    Prefix: NotRequired[str],
    Filter: NotRequired[ReplicationRuleFilterTypeDef],  # (1)
    SourceSelectionCriteria: NotRequired[SourceSelectionCriteriaTypeDef],  # (3)
    ExistingObjectReplication: NotRequired[ExistingObjectReplicationTypeDef],  # (4)
    DeleteMarkerReplication: NotRequired[DeleteMarkerReplicationTypeDef],  # (6)

1. See ReplicationRuleFilterTypeDef
2. See ReplicationRuleStatusType
3. See SourceSelectionCriteriaTypeDef
4. See ExistingObjectReplicationTypeDef
5. See DestinationTypeDef
6. See DeleteMarkerReplicationTypeDef

PutBucketWebsiteRequestBucketWebsitePutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketWebsiteRequestBucketWebsitePutTypeDef

def get_value() -> PutBucketWebsiteRequestBucketWebsitePutTypeDef:
    return {
        "WebsiteConfiguration": ...,
    }

Definition

class PutBucketWebsiteRequestBucketWebsitePutTypeDef(TypedDict):
    WebsiteConfiguration: WebsiteConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See WebsiteConfigurationTypeDef
2. See ChecksumAlgorithmType

PutBucketWebsiteRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketWebsiteRequestRequestTypeDef

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

Definition

class PutBucketWebsiteRequestRequestTypeDef(TypedDict):
    Bucket: str,
    WebsiteConfiguration: WebsiteConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See WebsiteConfigurationTypeDef
2. See ChecksumAlgorithmType

GetBucketEncryptionOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketEncryptionOutputTypeDef

def get_value() -> GetBucketEncryptionOutputTypeDef:
    return {
        "ServerSideEncryptionConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketEncryptionOutputTypeDef(TypedDict):
    ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ServerSideEncryptionConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutBucketEncryptionRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketEncryptionRequestRequestTypeDef

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

Definition

class PutBucketEncryptionRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef,  # (1)
    ContentMD5: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ServerSideEncryptionConfigurationTypeDef
2. See ChecksumAlgorithmType

SelectObjectContentOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import SelectObjectContentOutputTypeDef

def get_value() -> SelectObjectContentOutputTypeDef:
    return {
        "Payload": ...,
        "ResponseMetadata": ...,
    }

Definition

class SelectObjectContentOutputTypeDef(TypedDict):
    Payload: SelectObjectContentEventStreamTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SelectObjectContentEventStreamTypeDef
2. See ResponseMetadataTypeDef

GetBucketIntelligentTieringConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketIntelligentTieringConfigurationOutputTypeDef

def get_value() -> GetBucketIntelligentTieringConfigurationOutputTypeDef:
    return {
        "IntelligentTieringConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketIntelligentTieringConfigurationOutputTypeDef(TypedDict):
    IntelligentTieringConfiguration: IntelligentTieringConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IntelligentTieringConfigurationTypeDef
2. See ResponseMetadataTypeDef

ListBucketIntelligentTieringConfigurationsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketIntelligentTieringConfigurationsOutputTypeDef

def get_value() -> ListBucketIntelligentTieringConfigurationsOutputTypeDef:
    return {
        "IsTruncated": ...,
        "ContinuationToken": ...,
        "NextContinuationToken": ...,
        "IntelligentTieringConfigurationList": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListBucketIntelligentTieringConfigurationsOutputTypeDef(TypedDict):
    IsTruncated: bool,
    ContinuationToken: str,
    NextContinuationToken: str,
    IntelligentTieringConfigurationList: List[IntelligentTieringConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IntelligentTieringConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutBucketIntelligentTieringConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketIntelligentTieringConfigurationRequestRequestTypeDef

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

Definition

class PutBucketIntelligentTieringConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    IntelligentTieringConfiguration: IntelligentTieringConfigurationTypeDef,  # (1)

1. See IntelligentTieringConfigurationTypeDef

BucketLifecycleConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import BucketLifecycleConfigurationTypeDef

def get_value() -> BucketLifecycleConfigurationTypeDef:
    return {
        "Rules": ...,
    }

Definition

class BucketLifecycleConfigurationTypeDef(TypedDict):
    Rules: Sequence[LifecycleRuleTypeDef],  # (1)

1. See LifecycleRuleTypeDef

GetBucketLifecycleConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketLifecycleConfigurationOutputTypeDef

def get_value() -> GetBucketLifecycleConfigurationOutputTypeDef:
    return {
        "Rules": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketLifecycleConfigurationOutputTypeDef(TypedDict):
    Rules: List[LifecycleRuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See LifecycleRuleTypeDef
2. See ResponseMetadataTypeDef

GetBucketMetricsConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketMetricsConfigurationOutputTypeDef

def get_value() -> GetBucketMetricsConfigurationOutputTypeDef:
    return {
        "MetricsConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketMetricsConfigurationOutputTypeDef(TypedDict):
    MetricsConfiguration: MetricsConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MetricsConfigurationTypeDef
2. See ResponseMetadataTypeDef

ListBucketMetricsConfigurationsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketMetricsConfigurationsOutputTypeDef

def get_value() -> ListBucketMetricsConfigurationsOutputTypeDef:
    return {
        "IsTruncated": ...,
        "ContinuationToken": ...,
        "NextContinuationToken": ...,
        "MetricsConfigurationList": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListBucketMetricsConfigurationsOutputTypeDef(TypedDict):
    IsTruncated: bool,
    ContinuationToken: str,
    NextContinuationToken: str,
    MetricsConfigurationList: List[MetricsConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MetricsConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutBucketMetricsConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketMetricsConfigurationRequestRequestTypeDef

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

Definition

class PutBucketMetricsConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    MetricsConfiguration: MetricsConfigurationTypeDef,  # (1)
    ExpectedBucketOwner: NotRequired[str],

1. See MetricsConfigurationTypeDef

AnalyticsConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import AnalyticsConfigurationTypeDef

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

Definition

class AnalyticsConfigurationTypeDef(TypedDict):
    Id: str,
    StorageClassAnalysis: StorageClassAnalysisTypeDef,  # (2)
    Filter: NotRequired[AnalyticsFilterTypeDef],  # (1)

1. See AnalyticsFilterTypeDef
2. See StorageClassAnalysisTypeDef

NotificationConfigurationResponseMetadataTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NotificationConfigurationResponseMetadataTypeDef

def get_value() -> NotificationConfigurationResponseMetadataTypeDef:
    return {
        "TopicConfigurations": ...,
        "QueueConfigurations": ...,
        "LambdaFunctionConfigurations": ...,
        "EventBridgeConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class NotificationConfigurationResponseMetadataTypeDef(TypedDict):
    TopicConfigurations: List[TopicConfigurationTypeDef],  # (1)
    QueueConfigurations: List[QueueConfigurationTypeDef],  # (2)
    LambdaFunctionConfigurations: List[LambdaFunctionConfigurationTypeDef],  # (3)
    EventBridgeConfiguration: Dict[str, Any],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See TopicConfigurationTypeDef
2. See QueueConfigurationTypeDef
3. See LambdaFunctionConfigurationTypeDef
4. See ResponseMetadataTypeDef

NotificationConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import NotificationConfigurationTypeDef

def get_value() -> NotificationConfigurationTypeDef:
    return {
        "TopicConfigurations": ...,
    }

Definition

class NotificationConfigurationTypeDef(TypedDict):
    TopicConfigurations: NotRequired[Sequence[TopicConfigurationTypeDef]],  # (1)
    QueueConfigurations: NotRequired[Sequence[QueueConfigurationTypeDef]],  # (2)
    LambdaFunctionConfigurations: NotRequired[Sequence[LambdaFunctionConfigurationTypeDef]],  # (3)
    EventBridgeConfiguration: NotRequired[Mapping[str, Any]],

1. See TopicConfigurationTypeDef
2. See QueueConfigurationTypeDef
3. See LambdaFunctionConfigurationTypeDef

RestoreRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RestoreRequestTypeDef

def get_value() -> RestoreRequestTypeDef:
    return {
        "Days": ...,
    }

Definition

class RestoreRequestTypeDef(TypedDict):
    Days: NotRequired[int],
    GlacierJobParameters: NotRequired[GlacierJobParametersTypeDef],  # (1)
    Type: NotRequired[RestoreRequestTypeType],  # (2)
    Tier: NotRequired[TierType],  # (3)
    Description: NotRequired[str],
    SelectParameters: NotRequired[SelectParametersTypeDef],  # (4)
    OutputLocation: NotRequired[OutputLocationTypeDef],  # (5)

1. See GlacierJobParametersTypeDef
2. See RestoreRequestTypeType
3. See TierType
4. See SelectParametersTypeDef
5. See OutputLocationTypeDef

PutBucketLoggingRequestBucketLoggingPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketLoggingRequestBucketLoggingPutTypeDef

def get_value() -> PutBucketLoggingRequestBucketLoggingPutTypeDef:
    return {
        "BucketLoggingStatus": ...,
    }

Definition

class PutBucketLoggingRequestBucketLoggingPutTypeDef(TypedDict):
    BucketLoggingStatus: BucketLoggingStatusTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See BucketLoggingStatusTypeDef
2. See ChecksumAlgorithmType

PutBucketLoggingRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketLoggingRequestRequestTypeDef

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

Definition

class PutBucketLoggingRequestRequestTypeDef(TypedDict):
    Bucket: str,
    BucketLoggingStatus: BucketLoggingStatusTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See BucketLoggingStatusTypeDef
2. See ChecksumAlgorithmType

InventoryConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import InventoryConfigurationTypeDef

def get_value() -> InventoryConfigurationTypeDef:
    return {
        "Destination": ...,
        "IsEnabled": ...,
        "Id": ...,
        "IncludedObjectVersions": ...,
        "Schedule": ...,
    }

Definition

class InventoryConfigurationTypeDef(TypedDict):
    Destination: InventoryDestinationTypeDef,  # (1)
    IsEnabled: bool,
    Id: str,
    IncludedObjectVersions: InventoryIncludedObjectVersionsType,  # (3)
    Schedule: InventoryScheduleTypeDef,  # (5)
    Filter: NotRequired[InventoryFilterTypeDef],  # (2)
    OptionalFields: NotRequired[List[InventoryOptionalFieldType]],  # (4)

1. See InventoryDestinationTypeDef
2. See InventoryFilterTypeDef
3. See InventoryIncludedObjectVersionsType
4. See InventoryOptionalFieldType
5. See InventoryScheduleTypeDef

ReplicationConfigurationTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ReplicationConfigurationTypeDef

def get_value() -> ReplicationConfigurationTypeDef:
    return {
        "Role": ...,
        "Rules": ...,
    }

Definition

class ReplicationConfigurationTypeDef(TypedDict):
    Role: str,
    Rules: List[ReplicationRuleTypeDef],  # (1)

1. See ReplicationRuleTypeDef

PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef

def get_value() -> PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef:
    return {
        "ChecksumAlgorithm": ...,
    }

Definition

class PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef(TypedDict):
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    LifecycleConfiguration: NotRequired[BucketLifecycleConfigurationTypeDef],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ChecksumAlgorithmType
2. See BucketLifecycleConfigurationTypeDef

PutBucketLifecycleConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketLifecycleConfigurationRequestRequestTypeDef

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

Definition

class PutBucketLifecycleConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    LifecycleConfiguration: NotRequired[BucketLifecycleConfigurationTypeDef],  # (2)
    ExpectedBucketOwner: NotRequired[str],

1. See ChecksumAlgorithmType
2. See BucketLifecycleConfigurationTypeDef

GetBucketAnalyticsConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketAnalyticsConfigurationOutputTypeDef

def get_value() -> GetBucketAnalyticsConfigurationOutputTypeDef:
    return {
        "AnalyticsConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketAnalyticsConfigurationOutputTypeDef(TypedDict):
    AnalyticsConfiguration: AnalyticsConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AnalyticsConfigurationTypeDef
2. See ResponseMetadataTypeDef

ListBucketAnalyticsConfigurationsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketAnalyticsConfigurationsOutputTypeDef

def get_value() -> ListBucketAnalyticsConfigurationsOutputTypeDef:
    return {
        "IsTruncated": ...,
        "ContinuationToken": ...,
        "NextContinuationToken": ...,
        "AnalyticsConfigurationList": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListBucketAnalyticsConfigurationsOutputTypeDef(TypedDict):
    IsTruncated: bool,
    ContinuationToken: str,
    NextContinuationToken: str,
    AnalyticsConfigurationList: List[AnalyticsConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See AnalyticsConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutBucketAnalyticsConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketAnalyticsConfigurationRequestRequestTypeDef

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

Definition

class PutBucketAnalyticsConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    AnalyticsConfiguration: AnalyticsConfigurationTypeDef,  # (1)
    ExpectedBucketOwner: NotRequired[str],

1. See AnalyticsConfigurationTypeDef

PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef

def get_value() -> PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef:
    return {
        "NotificationConfiguration": ...,
    }

Definition

class PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef(TypedDict):
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (1)
    ExpectedBucketOwner: NotRequired[str],
    SkipDestinationValidation: NotRequired[bool],

1. See NotificationConfigurationTypeDef

PutBucketNotificationConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketNotificationConfigurationRequestRequestTypeDef

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

Definition

class PutBucketNotificationConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    NotificationConfiguration: NotificationConfigurationTypeDef,  # (1)
    ExpectedBucketOwner: NotRequired[str],
    SkipDestinationValidation: NotRequired[bool],

1. See NotificationConfigurationTypeDef

RestoreObjectRequestObjectRestoreObjectTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RestoreObjectRequestObjectRestoreObjectTypeDef

def get_value() -> RestoreObjectRequestObjectRestoreObjectTypeDef:
    return {
        "VersionId": ...,
    }

Definition

class RestoreObjectRequestObjectRestoreObjectTypeDef(TypedDict):
    VersionId: NotRequired[str],
    RestoreRequest: NotRequired[RestoreRequestTypeDef],  # (1)
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    ExpectedBucketOwner: NotRequired[str],

1. See RestoreRequestTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

RestoreObjectRequestObjectSummaryRestoreObjectTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RestoreObjectRequestObjectSummaryRestoreObjectTypeDef

def get_value() -> RestoreObjectRequestObjectSummaryRestoreObjectTypeDef:
    return {
        "VersionId": ...,
    }

Definition

class RestoreObjectRequestObjectSummaryRestoreObjectTypeDef(TypedDict):
    VersionId: NotRequired[str],
    RestoreRequest: NotRequired[RestoreRequestTypeDef],  # (1)
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    ExpectedBucketOwner: NotRequired[str],

1. See RestoreRequestTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

RestoreObjectRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import RestoreObjectRequestRequestTypeDef

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

Definition

class RestoreObjectRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],
    RestoreRequest: NotRequired[RestoreRequestTypeDef],  # (1)
    RequestPayer: NotRequired[RequestPayerType],  # (2)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (3)
    ExpectedBucketOwner: NotRequired[str],

1. See RestoreRequestTypeDef
2. See RequestPayerType
3. See ChecksumAlgorithmType

GetBucketInventoryConfigurationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketInventoryConfigurationOutputTypeDef

def get_value() -> GetBucketInventoryConfigurationOutputTypeDef:
    return {
        "InventoryConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketInventoryConfigurationOutputTypeDef(TypedDict):
    InventoryConfiguration: InventoryConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See InventoryConfigurationTypeDef
2. See ResponseMetadataTypeDef

ListBucketInventoryConfigurationsOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import ListBucketInventoryConfigurationsOutputTypeDef

def get_value() -> ListBucketInventoryConfigurationsOutputTypeDef:
    return {
        "ContinuationToken": ...,
        "InventoryConfigurationList": ...,
        "IsTruncated": ...,
        "NextContinuationToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListBucketInventoryConfigurationsOutputTypeDef(TypedDict):
    ContinuationToken: str,
    InventoryConfigurationList: List[InventoryConfigurationTypeDef],  # (1)
    IsTruncated: bool,
    NextContinuationToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See InventoryConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutBucketInventoryConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketInventoryConfigurationRequestRequestTypeDef

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

Definition

class PutBucketInventoryConfigurationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    Id: str,
    InventoryConfiguration: InventoryConfigurationTypeDef,  # (1)
    ExpectedBucketOwner: NotRequired[str],

1. See InventoryConfigurationTypeDef

GetBucketReplicationOutputTypeDef

Usage Example

from mypy_boto3_s3.type_defs import GetBucketReplicationOutputTypeDef

def get_value() -> GetBucketReplicationOutputTypeDef:
    return {
        "ReplicationConfiguration": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetBucketReplicationOutputTypeDef(TypedDict):
    ReplicationConfiguration: ReplicationConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ReplicationConfigurationTypeDef
2. See ResponseMetadataTypeDef

PutBucketReplicationRequestRequestTypeDef

Usage Example

from mypy_boto3_s3.type_defs import PutBucketReplicationRequestRequestTypeDef

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

Definition

class PutBucketReplicationRequestRequestTypeDef(TypedDict):
    Bucket: str,
    ReplicationConfiguration: ReplicationConfigurationTypeDef,  # (1)
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (2)
    Token: NotRequired[str],
    ExpectedBucketOwner: NotRequired[str],

1. See ReplicationConfigurationTypeDef
2. See ChecksumAlgorithmType