Type definitions#
Auto-generated documentation for S3 type annotations stubs module types-boto3-s3.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_s3.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]BlobTypeDef#
# BlobTypeDef Union usage example
from types_boto3_s3.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]FileobjTypeDef#
# FileobjTypeDef Union usage example
from types_boto3_s3.type_defs import FileobjTypeDef
def get_value() -> FileobjTypeDef:
return ...
# FileobjTypeDef definition
FileobjTypeDef = Union[
IO[Any],
StreamingBody,
]CopySourceOrStrTypeDef#
# CopySourceOrStrTypeDef Union usage example
from types_boto3_s3.type_defs import CopySourceOrStrTypeDef
def get_value() -> CopySourceOrStrTypeDef:
return ...
# CopySourceOrStrTypeDef definition
CopySourceOrStrTypeDef = Union[
str,
CopySourceTypeDef, # (1)
]CORSRuleUnionTypeDef#
# CORSRuleUnionTypeDef Union usage example
from types_boto3_s3.type_defs import CORSRuleUnionTypeDef
def get_value() -> CORSRuleUnionTypeDef:
return ...
# CORSRuleUnionTypeDef definition
CORSRuleUnionTypeDef = Union[
CORSRuleTypeDef, # (1)
CORSRuleOutputTypeDef, # (2)
]- See CORSRuleTypeDef
- See CORSRuleOutputTypeDef
CloudFunctionConfigurationUnionTypeDef#
# CloudFunctionConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import CloudFunctionConfigurationUnionTypeDef
def get_value() -> CloudFunctionConfigurationUnionTypeDef:
return ...
# CloudFunctionConfigurationUnionTypeDef definition
CloudFunctionConfigurationUnionTypeDef = Union[
CloudFunctionConfigurationTypeDef, # (1)
CloudFunctionConfigurationOutputTypeDef, # (2)
]QueueConfigurationDeprecatedUnionTypeDef#
# QueueConfigurationDeprecatedUnionTypeDef Union usage example
from types_boto3_s3.type_defs import QueueConfigurationDeprecatedUnionTypeDef
def get_value() -> QueueConfigurationDeprecatedUnionTypeDef:
return ...
# QueueConfigurationDeprecatedUnionTypeDef definition
QueueConfigurationDeprecatedUnionTypeDef = Union[
QueueConfigurationDeprecatedTypeDef, # (1)
QueueConfigurationDeprecatedOutputTypeDef, # (2)
]TopicConfigurationDeprecatedUnionTypeDef#
# TopicConfigurationDeprecatedUnionTypeDef Union usage example
from types_boto3_s3.type_defs import TopicConfigurationDeprecatedUnionTypeDef
def get_value() -> TopicConfigurationDeprecatedUnionTypeDef:
return ...
# TopicConfigurationDeprecatedUnionTypeDef definition
TopicConfigurationDeprecatedUnionTypeDef = Union[
TopicConfigurationDeprecatedTypeDef, # (1)
TopicConfigurationDeprecatedOutputTypeDef, # (2)
]LifecycleExpirationUnionTypeDef#
# LifecycleExpirationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import LifecycleExpirationUnionTypeDef
def get_value() -> LifecycleExpirationUnionTypeDef:
return ...
# LifecycleExpirationUnionTypeDef definition
LifecycleExpirationUnionTypeDef = Union[
LifecycleExpirationTypeDef, # (1)
LifecycleExpirationOutputTypeDef, # (2)
]ObjectLockRetentionUnionTypeDef#
# ObjectLockRetentionUnionTypeDef Union usage example
from types_boto3_s3.type_defs import ObjectLockRetentionUnionTypeDef
def get_value() -> ObjectLockRetentionUnionTypeDef:
return ...
# ObjectLockRetentionUnionTypeDef definition
ObjectLockRetentionUnionTypeDef = Union[
ObjectLockRetentionTypeDef, # (1)
ObjectLockRetentionOutputTypeDef, # (2)
]TransitionUnionTypeDef#
# TransitionUnionTypeDef Union usage example
from types_boto3_s3.type_defs import TransitionUnionTypeDef
def get_value() -> TransitionUnionTypeDef:
return ...
# TransitionUnionTypeDef definition
TransitionUnionTypeDef = Union[
TransitionTypeDef, # (1)
TransitionOutputTypeDef, # (2)
]LifecycleRuleAndOperatorUnionTypeDef#
# LifecycleRuleAndOperatorUnionTypeDef Union usage example
from types_boto3_s3.type_defs import LifecycleRuleAndOperatorUnionTypeDef
def get_value() -> LifecycleRuleAndOperatorUnionTypeDef:
return ...
# LifecycleRuleAndOperatorUnionTypeDef definition
LifecycleRuleAndOperatorUnionTypeDef = Union[
LifecycleRuleAndOperatorTypeDef, # (1)
LifecycleRuleAndOperatorOutputTypeDef, # (2)
]S3KeyFilterUnionTypeDef#
# S3KeyFilterUnionTypeDef Union usage example
from types_boto3_s3.type_defs import S3KeyFilterUnionTypeDef
def get_value() -> S3KeyFilterUnionTypeDef:
return ...
# S3KeyFilterUnionTypeDef definition
S3KeyFilterUnionTypeDef = Union[
S3KeyFilterTypeDef, # (1)
S3KeyFilterOutputTypeDef, # (2)
]OwnershipControlsUnionTypeDef#
# OwnershipControlsUnionTypeDef Union usage example
from types_boto3_s3.type_defs import OwnershipControlsUnionTypeDef
def get_value() -> OwnershipControlsUnionTypeDef:
return ...
# OwnershipControlsUnionTypeDef definition
OwnershipControlsUnionTypeDef = Union[
OwnershipControlsTypeDef, # (1)
OwnershipControlsOutputTypeDef, # (2)
]TargetObjectKeyFormatUnionTypeDef#
# TargetObjectKeyFormatUnionTypeDef Union usage example
from types_boto3_s3.type_defs import TargetObjectKeyFormatUnionTypeDef
def get_value() -> TargetObjectKeyFormatUnionTypeDef:
return ...
# TargetObjectKeyFormatUnionTypeDef definition
TargetObjectKeyFormatUnionTypeDef = Union[
TargetObjectKeyFormatTypeDef, # (1)
TargetObjectKeyFormatOutputTypeDef, # (2)
]ServerSideEncryptionConfigurationUnionTypeDef#
# ServerSideEncryptionConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import ServerSideEncryptionConfigurationUnionTypeDef
def get_value() -> ServerSideEncryptionConfigurationUnionTypeDef:
return ...
# ServerSideEncryptionConfigurationUnionTypeDef definition
ServerSideEncryptionConfigurationUnionTypeDef = Union[
ServerSideEncryptionConfigurationTypeDef, # (1)
ServerSideEncryptionConfigurationOutputTypeDef, # (2)
]RuleUnionTypeDef#
# RuleUnionTypeDef Union usage example
from types_boto3_s3.type_defs import RuleUnionTypeDef
def get_value() -> RuleUnionTypeDef:
return ...
# RuleUnionTypeDef definition
RuleUnionTypeDef = Union[
RuleTypeDef, # (1)
RuleOutputTypeDef, # (2)
]- See RuleTypeDef
- See RuleOutputTypeDef
IntelligentTieringConfigurationUnionTypeDef#
# IntelligentTieringConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import IntelligentTieringConfigurationUnionTypeDef
def get_value() -> IntelligentTieringConfigurationUnionTypeDef:
return ...
# IntelligentTieringConfigurationUnionTypeDef definition
IntelligentTieringConfigurationUnionTypeDef = Union[
IntelligentTieringConfigurationTypeDef, # (1)
IntelligentTieringConfigurationOutputTypeDef, # (2)
]LifecycleRuleFilterUnionTypeDef#
# LifecycleRuleFilterUnionTypeDef Union usage example
from types_boto3_s3.type_defs import LifecycleRuleFilterUnionTypeDef
def get_value() -> LifecycleRuleFilterUnionTypeDef:
return ...
# LifecycleRuleFilterUnionTypeDef definition
LifecycleRuleFilterUnionTypeDef = Union[
LifecycleRuleFilterTypeDef, # (1)
LifecycleRuleFilterOutputTypeDef, # (2)
]MetricsConfigurationUnionTypeDef#
# MetricsConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import MetricsConfigurationUnionTypeDef
def get_value() -> MetricsConfigurationUnionTypeDef:
return ...
# MetricsConfigurationUnionTypeDef definition
MetricsConfigurationUnionTypeDef = Union[
MetricsConfigurationTypeDef, # (1)
MetricsConfigurationOutputTypeDef, # (2)
]NotificationConfigurationFilterUnionTypeDef#
# NotificationConfigurationFilterUnionTypeDef Union usage example
from types_boto3_s3.type_defs import NotificationConfigurationFilterUnionTypeDef
def get_value() -> NotificationConfigurationFilterUnionTypeDef:
return ...
# NotificationConfigurationFilterUnionTypeDef definition
NotificationConfigurationFilterUnionTypeDef = Union[
NotificationConfigurationFilterTypeDef, # (1)
NotificationConfigurationFilterOutputTypeDef, # (2)
]LoggingEnabledUnionTypeDef#
# LoggingEnabledUnionTypeDef Union usage example
from types_boto3_s3.type_defs import LoggingEnabledUnionTypeDef
def get_value() -> LoggingEnabledUnionTypeDef:
return ...
# LoggingEnabledUnionTypeDef definition
LoggingEnabledUnionTypeDef = Union[
LoggingEnabledTypeDef, # (1)
LoggingEnabledOutputTypeDef, # (2)
]AnalyticsConfigurationUnionTypeDef#
# AnalyticsConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import AnalyticsConfigurationUnionTypeDef
def get_value() -> AnalyticsConfigurationUnionTypeDef:
return ...
# AnalyticsConfigurationUnionTypeDef definition
AnalyticsConfigurationUnionTypeDef = Union[
AnalyticsConfigurationTypeDef, # (1)
AnalyticsConfigurationOutputTypeDef, # (2)
]InventoryConfigurationUnionTypeDef#
# InventoryConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import InventoryConfigurationUnionTypeDef
def get_value() -> InventoryConfigurationUnionTypeDef:
return ...
# InventoryConfigurationUnionTypeDef definition
InventoryConfigurationUnionTypeDef = Union[
InventoryConfigurationTypeDef, # (1)
InventoryConfigurationOutputTypeDef, # (2)
]ReplicationConfigurationUnionTypeDef#
# ReplicationConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import ReplicationConfigurationUnionTypeDef
def get_value() -> ReplicationConfigurationUnionTypeDef:
return ...
# ReplicationConfigurationUnionTypeDef definition
ReplicationConfigurationUnionTypeDef = Union[
ReplicationConfigurationTypeDef, # (1)
ReplicationConfigurationOutputTypeDef, # (2)
]LifecycleRuleUnionTypeDef#
# LifecycleRuleUnionTypeDef Union usage example
from types_boto3_s3.type_defs import LifecycleRuleUnionTypeDef
def get_value() -> LifecycleRuleUnionTypeDef:
return ...
# LifecycleRuleUnionTypeDef definition
LifecycleRuleUnionTypeDef = Union[
LifecycleRuleTypeDef, # (1)
LifecycleRuleOutputTypeDef, # (2)
]LambdaFunctionConfigurationUnionTypeDef#
# LambdaFunctionConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import LambdaFunctionConfigurationUnionTypeDef
def get_value() -> LambdaFunctionConfigurationUnionTypeDef:
return ...
# LambdaFunctionConfigurationUnionTypeDef definition
LambdaFunctionConfigurationUnionTypeDef = Union[
LambdaFunctionConfigurationTypeDef, # (1)
LambdaFunctionConfigurationOutputTypeDef, # (2)
]QueueConfigurationUnionTypeDef#
# QueueConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import QueueConfigurationUnionTypeDef
def get_value() -> QueueConfigurationUnionTypeDef:
return ...
# QueueConfigurationUnionTypeDef definition
QueueConfigurationUnionTypeDef = Union[
QueueConfigurationTypeDef, # (1)
QueueConfigurationOutputTypeDef, # (2)
]TopicConfigurationUnionTypeDef#
# TopicConfigurationUnionTypeDef Union usage example
from types_boto3_s3.type_defs import TopicConfigurationUnionTypeDef
def get_value() -> TopicConfigurationUnionTypeDef:
return ...
# TopicConfigurationUnionTypeDef definition
TopicConfigurationUnionTypeDef = Union[
TopicConfigurationTypeDef, # (1)
TopicConfigurationOutputTypeDef, # (2)
]AbortIncompleteMultipartUploadTypeDef#
# AbortIncompleteMultipartUploadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AbortIncompleteMultipartUploadTypeDef
def get_value() -> AbortIncompleteMultipartUploadTypeDef:
return {
"DaysAfterInitiation": ...,
}
# AbortIncompleteMultipartUploadTypeDef definition
class AbortIncompleteMultipartUploadTypeDef(TypedDict):
DaysAfterInitiation: NotRequired[int],ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],AccelerateConfigurationTypeDef#
# AccelerateConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AccelerateConfigurationTypeDef
def get_value() -> AccelerateConfigurationTypeDef:
return {
"Status": ...,
}
# AccelerateConfigurationTypeDef definition
class AccelerateConfigurationTypeDef(TypedDict):
Status: NotRequired[BucketAccelerateStatusType], # (1)OwnerTypeDef#
# OwnerTypeDef TypedDict usage example
from types_boto3_s3.type_defs import OwnerTypeDef
def get_value() -> OwnerTypeDef:
return {
"DisplayName": ...,
}
# OwnerTypeDef definition
class OwnerTypeDef(TypedDict):
DisplayName: NotRequired[str],
ID: NotRequired[str],AccessControlTranslationTypeDef#
# AccessControlTranslationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AccessControlTranslationTypeDef
def get_value() -> AccessControlTranslationTypeDef:
return {
"Owner": ...,
}
# AccessControlTranslationTypeDef definition
class AccessControlTranslationTypeDef(TypedDict):
Owner: OwnerOverrideType, # (1)TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,AnalyticsS3BucketDestinationTypeDef#
# AnalyticsS3BucketDestinationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsS3BucketDestinationTypeDef
def get_value() -> AnalyticsS3BucketDestinationTypeDef:
return {
"Format": ...,
}
# AnalyticsS3BucketDestinationTypeDef definition
class AnalyticsS3BucketDestinationTypeDef(TypedDict):
Format: AnalyticsS3ExportFileFormatType, # (1)
Bucket: str,
BucketAccountId: NotRequired[str],
Prefix: NotRequired[str],CopySourceTypeDef#
# CopySourceTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopySourceTypeDef
def get_value() -> CopySourceTypeDef:
return {
"Bucket": ...,
}
# CopySourceTypeDef definition
class CopySourceTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],BucketDownloadFileRequestTypeDef#
# BucketDownloadFileRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketDownloadFileRequestTypeDef
def get_value() -> BucketDownloadFileRequestTypeDef:
return {
"Key": ...,
}
# BucketDownloadFileRequestTypeDef definition
class BucketDownloadFileRequestTypeDef(TypedDict):
Key: str,
Filename: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],BucketInfoTypeDef#
# BucketInfoTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketInfoTypeDef
def get_value() -> BucketInfoTypeDef:
return {
"DataRedundancy": ...,
}
# BucketInfoTypeDef definition
class BucketInfoTypeDef(TypedDict):
DataRedundancy: NotRequired[DataRedundancyType], # (1)
Type: NotRequired[BucketTypeType], # (2)- See DataRedundancyType
- See BucketTypeType
BucketTypeDef#
# BucketTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketTypeDef
def get_value() -> BucketTypeDef:
return {
"Name": ...,
}
# BucketTypeDef definition
class BucketTypeDef(TypedDict):
Name: NotRequired[str],
CreationDate: NotRequired[datetime],
BucketRegion: NotRequired[str],BucketUploadFileRequestTypeDef#
# BucketUploadFileRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketUploadFileRequestTypeDef
def get_value() -> BucketUploadFileRequestTypeDef:
return {
"Filename": ...,
}
# BucketUploadFileRequestTypeDef definition
class BucketUploadFileRequestTypeDef(TypedDict):
Filename: str,
Key: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],CORSRuleOutputTypeDef#
# CORSRuleOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CORSRuleOutputTypeDef
def get_value() -> CORSRuleOutputTypeDef:
return {
"ID": ...,
}
# CORSRuleOutputTypeDef definition
class CORSRuleOutputTypeDef(TypedDict):
AllowedMethods: List[str],
AllowedOrigins: List[str],
ID: NotRequired[str],
AllowedHeaders: NotRequired[List[str]],
ExposeHeaders: NotRequired[List[str]],
MaxAgeSeconds: NotRequired[int],CORSRuleTypeDef#
# CORSRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CORSRuleTypeDef
def get_value() -> CORSRuleTypeDef:
return {
"ID": ...,
}
# CORSRuleTypeDef definition
class CORSRuleTypeDef(TypedDict):
AllowedMethods: Sequence[str],
AllowedOrigins: Sequence[str],
ID: NotRequired[str],
AllowedHeaders: NotRequired[Sequence[str]],
ExposeHeaders: NotRequired[Sequence[str]],
MaxAgeSeconds: NotRequired[int],CSVInputTypeDef#
# CSVInputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CSVInputTypeDef
def get_value() -> CSVInputTypeDef:
return {
"FileHeaderInfo": ...,
}
# CSVInputTypeDef definition
class CSVInputTypeDef(TypedDict):
FileHeaderInfo: NotRequired[FileHeaderInfoType], # (1)
Comments: NotRequired[str],
QuoteEscapeCharacter: NotRequired[str],
RecordDelimiter: NotRequired[str],
FieldDelimiter: NotRequired[str],
QuoteCharacter: NotRequired[str],
AllowQuotedRecordDelimiter: NotRequired[bool],CSVOutputTypeDef#
# CSVOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CSVOutputTypeDef
def get_value() -> CSVOutputTypeDef:
return {
"QuoteFields": ...,
}
# CSVOutputTypeDef definition
class CSVOutputTypeDef(TypedDict):
QuoteFields: NotRequired[QuoteFieldsType], # (1)
QuoteEscapeCharacter: NotRequired[str],
RecordDelimiter: NotRequired[str],
FieldDelimiter: NotRequired[str],
QuoteCharacter: NotRequired[str],- See QuoteFieldsType
ChecksumTypeDef#
# ChecksumTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ChecksumTypeDef
def get_value() -> ChecksumTypeDef:
return {
"ChecksumCRC32": ...,
}
# ChecksumTypeDef definition
class ChecksumTypeDef(TypedDict):
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
ChecksumType: NotRequired[ChecksumTypeType], # (1)- See ChecksumTypeType
ClientDownloadFileRequestTypeDef#
# ClientDownloadFileRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ClientDownloadFileRequestTypeDef
def get_value() -> ClientDownloadFileRequestTypeDef:
return {
"Bucket": ...,
}
# ClientDownloadFileRequestTypeDef definition
class ClientDownloadFileRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
Filename: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],ClientGeneratePresignedPostRequestTypeDef#
# ClientGeneratePresignedPostRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ClientGeneratePresignedPostRequestTypeDef
def get_value() -> ClientGeneratePresignedPostRequestTypeDef:
return {
"Bucket": ...,
}
# ClientGeneratePresignedPostRequestTypeDef definition
class ClientGeneratePresignedPostRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
Fields: NotRequired[Union[Dict[str, Any], None]],
Conditions: NotRequired[Union[List[Any], Dict[str, Any], None]],
ExpiresIn: NotRequired[int],ClientUploadFileRequestTypeDef#
# ClientUploadFileRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ClientUploadFileRequestTypeDef
def get_value() -> ClientUploadFileRequestTypeDef:
return {
"Filename": ...,
}
# ClientUploadFileRequestTypeDef definition
class ClientUploadFileRequestTypeDef(TypedDict):
Filename: str,
Bucket: str,
Key: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],CloudFunctionConfigurationOutputTypeDef#
# CloudFunctionConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CloudFunctionConfigurationOutputTypeDef
def get_value() -> CloudFunctionConfigurationOutputTypeDef:
return {
"Id": ...,
}
# CloudFunctionConfigurationOutputTypeDef definition
class CloudFunctionConfigurationOutputTypeDef(TypedDict):
Id: NotRequired[str],
Event: NotRequired[EventType], # (1)
Events: NotRequired[List[EventType]], # (2)
CloudFunction: NotRequired[str],
InvocationRole: NotRequired[str],CloudFunctionConfigurationTypeDef#
# CloudFunctionConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CloudFunctionConfigurationTypeDef
def get_value() -> CloudFunctionConfigurationTypeDef:
return {
"Id": ...,
}
# CloudFunctionConfigurationTypeDef definition
class CloudFunctionConfigurationTypeDef(TypedDict):
Id: NotRequired[str],
Event: NotRequired[EventType], # (1)
Events: NotRequired[Sequence[EventType]], # (2)
CloudFunction: NotRequired[str],
InvocationRole: NotRequired[str],CommonPrefixTypeDef#
# CommonPrefixTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CommonPrefixTypeDef
def get_value() -> CommonPrefixTypeDef:
return {
"Prefix": ...,
}
# CommonPrefixTypeDef definition
class CommonPrefixTypeDef(TypedDict):
Prefix: NotRequired[str],CompletedPartTypeDef#
# CompletedPartTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CompletedPartTypeDef
def get_value() -> CompletedPartTypeDef:
return {
"ETag": ...,
}
# CompletedPartTypeDef definition
class CompletedPartTypeDef(TypedDict):
ETag: NotRequired[str],
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
PartNumber: NotRequired[int],ConditionTypeDef#
# ConditionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ConditionTypeDef
def get_value() -> ConditionTypeDef:
return {
"HttpErrorCodeReturnedEquals": ...,
}
# ConditionTypeDef definition
class ConditionTypeDef(TypedDict):
HttpErrorCodeReturnedEquals: NotRequired[str],
KeyPrefixEquals: NotRequired[str],CopyObjectResultTypeDef#
# CopyObjectResultTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopyObjectResultTypeDef
def get_value() -> CopyObjectResultTypeDef:
return {
"ETag": ...,
}
# CopyObjectResultTypeDef definition
class CopyObjectResultTypeDef(TypedDict):
ETag: NotRequired[str],
LastModified: NotRequired[datetime],
ChecksumType: NotRequired[ChecksumTypeType], # (1)
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],- See ChecksumTypeType
CopyPartResultTypeDef#
# CopyPartResultTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopyPartResultTypeDef
def get_value() -> CopyPartResultTypeDef:
return {
"ETag": ...,
}
# CopyPartResultTypeDef definition
class CopyPartResultTypeDef(TypedDict):
ETag: NotRequired[str],
LastModified: NotRequired[datetime],
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],LocationInfoTypeDef#
# LocationInfoTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LocationInfoTypeDef
def get_value() -> LocationInfoTypeDef:
return {
"Type": ...,
}
# LocationInfoTypeDef definition
class LocationInfoTypeDef(TypedDict):
Type: NotRequired[LocationTypeType], # (1)
Name: NotRequired[str],- See LocationTypeType
SessionCredentialsTypeDef#
# SessionCredentialsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SessionCredentialsTypeDef
def get_value() -> SessionCredentialsTypeDef:
return {
"AccessKeyId": ...,
}
# SessionCredentialsTypeDef definition
class SessionCredentialsTypeDef(TypedDict):
AccessKeyId: str,
SecretAccessKey: str,
SessionToken: str,
Expiration: datetime,CreateSessionRequestTypeDef#
# CreateSessionRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateSessionRequestTypeDef
def get_value() -> CreateSessionRequestTypeDef:
return {
"Bucket": ...,
}
# CreateSessionRequestTypeDef definition
class CreateSessionRequestTypeDef(TypedDict):
Bucket: str,
SessionMode: NotRequired[SessionModeType], # (1)
ServerSideEncryption: NotRequired[ServerSideEncryptionType], # (2)
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],DefaultRetentionTypeDef#
# DefaultRetentionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DefaultRetentionTypeDef
def get_value() -> DefaultRetentionTypeDef:
return {
"Mode": ...,
}
# DefaultRetentionTypeDef definition
class DefaultRetentionTypeDef(TypedDict):
Mode: NotRequired[ObjectLockRetentionModeType], # (1)
Days: NotRequired[int],
Years: NotRequired[int],DeleteBucketAnalyticsConfigurationRequestTypeDef#
# DeleteBucketAnalyticsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketAnalyticsConfigurationRequestTypeDef
def get_value() -> DeleteBucketAnalyticsConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketAnalyticsConfigurationRequestTypeDef definition
class DeleteBucketAnalyticsConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketCorsRequestBucketCorsDeleteTypeDef#
# DeleteBucketCorsRequestBucketCorsDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketCorsRequestBucketCorsDeleteTypeDef
def get_value() -> DeleteBucketCorsRequestBucketCorsDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketCorsRequestBucketCorsDeleteTypeDef definition
class DeleteBucketCorsRequestBucketCorsDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketCorsRequestTypeDef#
# DeleteBucketCorsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketCorsRequestTypeDef
def get_value() -> DeleteBucketCorsRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketCorsRequestTypeDef definition
class DeleteBucketCorsRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketEncryptionRequestTypeDef#
# DeleteBucketEncryptionRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketEncryptionRequestTypeDef
def get_value() -> DeleteBucketEncryptionRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketEncryptionRequestTypeDef definition
class DeleteBucketEncryptionRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketIntelligentTieringConfigurationRequestTypeDef#
# DeleteBucketIntelligentTieringConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketIntelligentTieringConfigurationRequestTypeDef
def get_value() -> DeleteBucketIntelligentTieringConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketIntelligentTieringConfigurationRequestTypeDef definition
class DeleteBucketIntelligentTieringConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,DeleteBucketInventoryConfigurationRequestTypeDef#
# DeleteBucketInventoryConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketInventoryConfigurationRequestTypeDef
def get_value() -> DeleteBucketInventoryConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketInventoryConfigurationRequestTypeDef definition
class DeleteBucketInventoryConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef#
# DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef
def get_value() -> DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef definition
class DeleteBucketLifecycleRequestBucketLifecycleConfigurationDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef#
# DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef
def get_value() -> DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef definition
class DeleteBucketLifecycleRequestBucketLifecycleDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketLifecycleRequestTypeDef#
# DeleteBucketLifecycleRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketLifecycleRequestTypeDef
def get_value() -> DeleteBucketLifecycleRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketLifecycleRequestTypeDef definition
class DeleteBucketLifecycleRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketMetadataTableConfigurationRequestTypeDef#
# DeleteBucketMetadataTableConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketMetadataTableConfigurationRequestTypeDef
def get_value() -> DeleteBucketMetadataTableConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketMetadataTableConfigurationRequestTypeDef definition
class DeleteBucketMetadataTableConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketMetricsConfigurationRequestTypeDef#
# DeleteBucketMetricsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketMetricsConfigurationRequestTypeDef
def get_value() -> DeleteBucketMetricsConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketMetricsConfigurationRequestTypeDef definition
class DeleteBucketMetricsConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketOwnershipControlsRequestTypeDef#
# DeleteBucketOwnershipControlsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketOwnershipControlsRequestTypeDef
def get_value() -> DeleteBucketOwnershipControlsRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketOwnershipControlsRequestTypeDef definition
class DeleteBucketOwnershipControlsRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef#
# DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef
def get_value() -> DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef definition
class DeleteBucketPolicyRequestBucketPolicyDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketPolicyRequestTypeDef#
# DeleteBucketPolicyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketPolicyRequestTypeDef
def get_value() -> DeleteBucketPolicyRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketPolicyRequestTypeDef definition
class DeleteBucketPolicyRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketReplicationRequestTypeDef#
# DeleteBucketReplicationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketReplicationRequestTypeDef
def get_value() -> DeleteBucketReplicationRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketReplicationRequestTypeDef definition
class DeleteBucketReplicationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketRequestBucketDeleteTypeDef#
# DeleteBucketRequestBucketDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketRequestBucketDeleteTypeDef
def get_value() -> DeleteBucketRequestBucketDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketRequestBucketDeleteTypeDef definition
class DeleteBucketRequestBucketDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketRequestTypeDef#
# DeleteBucketRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketRequestTypeDef
def get_value() -> DeleteBucketRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketRequestTypeDef definition
class DeleteBucketRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef#
# DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef
def get_value() -> DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef definition
class DeleteBucketTaggingRequestBucketTaggingDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketTaggingRequestTypeDef#
# DeleteBucketTaggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketTaggingRequestTypeDef
def get_value() -> DeleteBucketTaggingRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketTaggingRequestTypeDef definition
class DeleteBucketTaggingRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef#
# DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef
def get_value() -> DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef:
return {
"ExpectedBucketOwner": ...,
}
# DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef definition
class DeleteBucketWebsiteRequestBucketWebsiteDeleteTypeDef(TypedDict):
ExpectedBucketOwner: NotRequired[str],DeleteBucketWebsiteRequestTypeDef#
# DeleteBucketWebsiteRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteBucketWebsiteRequestTypeDef
def get_value() -> DeleteBucketWebsiteRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteBucketWebsiteRequestTypeDef definition
class DeleteBucketWebsiteRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],DeleteMarkerReplicationTypeDef#
# DeleteMarkerReplicationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteMarkerReplicationTypeDef
def get_value() -> DeleteMarkerReplicationTypeDef:
return {
"Status": ...,
}
# DeleteMarkerReplicationTypeDef definition
class DeleteMarkerReplicationTypeDef(TypedDict):
Status: NotRequired[DeleteMarkerReplicationStatusType], # (1)DeleteObjectTaggingRequestTypeDef#
# DeleteObjectTaggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectTaggingRequestTypeDef
def get_value() -> DeleteObjectTaggingRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteObjectTaggingRequestTypeDef definition
class DeleteObjectTaggingRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],DeletedObjectTypeDef#
# DeletedObjectTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeletedObjectTypeDef
def get_value() -> DeletedObjectTypeDef:
return {
"Key": ...,
}
# DeletedObjectTypeDef definition
class DeletedObjectTypeDef(TypedDict):
Key: NotRequired[str],
VersionId: NotRequired[str],
DeleteMarker: NotRequired[bool],
DeleteMarkerVersionId: NotRequired[str],ErrorTypeDef#
# ErrorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ErrorTypeDef
def get_value() -> ErrorTypeDef:
return {
"Key": ...,
}
# ErrorTypeDef definition
class ErrorTypeDef(TypedDict):
Key: NotRequired[str],
VersionId: NotRequired[str],
Code: NotRequired[str],
Message: NotRequired[str],DeletePublicAccessBlockRequestTypeDef#
# DeletePublicAccessBlockRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeletePublicAccessBlockRequestTypeDef
def get_value() -> DeletePublicAccessBlockRequestTypeDef:
return {
"Bucket": ...,
}
# DeletePublicAccessBlockRequestTypeDef definition
class DeletePublicAccessBlockRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],EncryptionConfigurationTypeDef#
# EncryptionConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import EncryptionConfigurationTypeDef
def get_value() -> EncryptionConfigurationTypeDef:
return {
"ReplicaKmsKeyID": ...,
}
# EncryptionConfigurationTypeDef definition
class EncryptionConfigurationTypeDef(TypedDict):
ReplicaKmsKeyID: NotRequired[str],EncryptionTypeDef#
# EncryptionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import EncryptionTypeDef
def get_value() -> EncryptionTypeDef:
return {
"EncryptionType": ...,
}
# EncryptionTypeDef definition
class EncryptionTypeDef(TypedDict):
EncryptionType: ServerSideEncryptionType, # (1)
KMSKeyId: NotRequired[str],
KMSContext: NotRequired[str],ErrorDetailsTypeDef#
# ErrorDetailsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ErrorDetailsTypeDef
def get_value() -> ErrorDetailsTypeDef:
return {
"ErrorCode": ...,
}
# ErrorDetailsTypeDef definition
class ErrorDetailsTypeDef(TypedDict):
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],ErrorDocumentTypeDef#
# ErrorDocumentTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ErrorDocumentTypeDef
def get_value() -> ErrorDocumentTypeDef:
return {
"Key": ...,
}
# ErrorDocumentTypeDef definition
class ErrorDocumentTypeDef(TypedDict):
Key: str,ExistingObjectReplicationTypeDef#
# ExistingObjectReplicationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ExistingObjectReplicationTypeDef
def get_value() -> ExistingObjectReplicationTypeDef:
return {
"Status": ...,
}
# ExistingObjectReplicationTypeDef definition
class ExistingObjectReplicationTypeDef(TypedDict):
Status: ExistingObjectReplicationStatusType, # (1)FilterRuleTypeDef#
# FilterRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import FilterRuleTypeDef
def get_value() -> FilterRuleTypeDef:
return {
"Name": ...,
}
# FilterRuleTypeDef definition
class FilterRuleTypeDef(TypedDict):
Name: NotRequired[FilterRuleNameType], # (1)
Value: NotRequired[str],GetBucketAccelerateConfigurationRequestTypeDef#
# GetBucketAccelerateConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketAccelerateConfigurationRequestTypeDef
def get_value() -> GetBucketAccelerateConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketAccelerateConfigurationRequestTypeDef definition
class GetBucketAccelerateConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)- See RequestPayerType
GetBucketAclRequestTypeDef#
# GetBucketAclRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketAclRequestTypeDef
def get_value() -> GetBucketAclRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketAclRequestTypeDef definition
class GetBucketAclRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketAnalyticsConfigurationRequestTypeDef#
# GetBucketAnalyticsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketAnalyticsConfigurationRequestTypeDef
def get_value() -> GetBucketAnalyticsConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketAnalyticsConfigurationRequestTypeDef definition
class GetBucketAnalyticsConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
ExpectedBucketOwner: NotRequired[str],GetBucketCorsRequestTypeDef#
# GetBucketCorsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketCorsRequestTypeDef
def get_value() -> GetBucketCorsRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketCorsRequestTypeDef definition
class GetBucketCorsRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketEncryptionRequestTypeDef#
# GetBucketEncryptionRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketEncryptionRequestTypeDef
def get_value() -> GetBucketEncryptionRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketEncryptionRequestTypeDef definition
class GetBucketEncryptionRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketIntelligentTieringConfigurationRequestTypeDef#
# GetBucketIntelligentTieringConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketIntelligentTieringConfigurationRequestTypeDef
def get_value() -> GetBucketIntelligentTieringConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketIntelligentTieringConfigurationRequestTypeDef definition
class GetBucketIntelligentTieringConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,GetBucketInventoryConfigurationRequestTypeDef#
# GetBucketInventoryConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketInventoryConfigurationRequestTypeDef
def get_value() -> GetBucketInventoryConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketInventoryConfigurationRequestTypeDef definition
class GetBucketInventoryConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
ExpectedBucketOwner: NotRequired[str],GetBucketLifecycleConfigurationRequestTypeDef#
# GetBucketLifecycleConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLifecycleConfigurationRequestTypeDef
def get_value() -> GetBucketLifecycleConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketLifecycleConfigurationRequestTypeDef definition
class GetBucketLifecycleConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketLifecycleRequestTypeDef#
# GetBucketLifecycleRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLifecycleRequestTypeDef
def get_value() -> GetBucketLifecycleRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketLifecycleRequestTypeDef definition
class GetBucketLifecycleRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketLocationRequestTypeDef#
# GetBucketLocationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLocationRequestTypeDef
def get_value() -> GetBucketLocationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketLocationRequestTypeDef definition
class GetBucketLocationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketLoggingRequestTypeDef#
# GetBucketLoggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLoggingRequestTypeDef
def get_value() -> GetBucketLoggingRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketLoggingRequestTypeDef definition
class GetBucketLoggingRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketMetadataTableConfigurationRequestTypeDef#
# GetBucketMetadataTableConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketMetadataTableConfigurationRequestTypeDef
def get_value() -> GetBucketMetadataTableConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketMetadataTableConfigurationRequestTypeDef definition
class GetBucketMetadataTableConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketMetricsConfigurationRequestTypeDef#
# GetBucketMetricsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketMetricsConfigurationRequestTypeDef
def get_value() -> GetBucketMetricsConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketMetricsConfigurationRequestTypeDef definition
class GetBucketMetricsConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
ExpectedBucketOwner: NotRequired[str],GetBucketNotificationConfigurationRequestRequestTypeDef#
# GetBucketNotificationConfigurationRequestRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketNotificationConfigurationRequestRequestTypeDef
def get_value() -> GetBucketNotificationConfigurationRequestRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketNotificationConfigurationRequestRequestTypeDef definition
class GetBucketNotificationConfigurationRequestRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketNotificationConfigurationRequestTypeDef#
# GetBucketNotificationConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketNotificationConfigurationRequestTypeDef
def get_value() -> GetBucketNotificationConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketNotificationConfigurationRequestTypeDef definition
class GetBucketNotificationConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketOwnershipControlsRequestTypeDef#
# GetBucketOwnershipControlsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketOwnershipControlsRequestTypeDef
def get_value() -> GetBucketOwnershipControlsRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketOwnershipControlsRequestTypeDef definition
class GetBucketOwnershipControlsRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketPolicyRequestTypeDef#
# GetBucketPolicyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketPolicyRequestTypeDef
def get_value() -> GetBucketPolicyRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketPolicyRequestTypeDef definition
class GetBucketPolicyRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],PolicyStatusTypeDef#
# PolicyStatusTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PolicyStatusTypeDef
def get_value() -> PolicyStatusTypeDef:
return {
"IsPublic": ...,
}
# PolicyStatusTypeDef definition
class PolicyStatusTypeDef(TypedDict):
IsPublic: NotRequired[bool],GetBucketPolicyStatusRequestTypeDef#
# GetBucketPolicyStatusRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketPolicyStatusRequestTypeDef
def get_value() -> GetBucketPolicyStatusRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketPolicyStatusRequestTypeDef definition
class GetBucketPolicyStatusRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketReplicationRequestTypeDef#
# GetBucketReplicationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketReplicationRequestTypeDef
def get_value() -> GetBucketReplicationRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketReplicationRequestTypeDef definition
class GetBucketReplicationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketRequestPaymentRequestTypeDef#
# GetBucketRequestPaymentRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketRequestPaymentRequestTypeDef
def get_value() -> GetBucketRequestPaymentRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketRequestPaymentRequestTypeDef definition
class GetBucketRequestPaymentRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketTaggingRequestTypeDef#
# GetBucketTaggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketTaggingRequestTypeDef
def get_value() -> GetBucketTaggingRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketTaggingRequestTypeDef definition
class GetBucketTaggingRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetBucketVersioningRequestTypeDef#
# GetBucketVersioningRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketVersioningRequestTypeDef
def get_value() -> GetBucketVersioningRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketVersioningRequestTypeDef definition
class GetBucketVersioningRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],IndexDocumentTypeDef#
# IndexDocumentTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IndexDocumentTypeDef
def get_value() -> IndexDocumentTypeDef:
return {
"Suffix": ...,
}
# IndexDocumentTypeDef definition
class IndexDocumentTypeDef(TypedDict):
Suffix: str,RedirectAllRequestsToTypeDef#
# RedirectAllRequestsToTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RedirectAllRequestsToTypeDef
def get_value() -> RedirectAllRequestsToTypeDef:
return {
"HostName": ...,
}
# RedirectAllRequestsToTypeDef definition
class RedirectAllRequestsToTypeDef(TypedDict):
HostName: str,
Protocol: NotRequired[ProtocolType], # (1)- See ProtocolType
GetBucketWebsiteRequestTypeDef#
# GetBucketWebsiteRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketWebsiteRequestTypeDef
def get_value() -> GetBucketWebsiteRequestTypeDef:
return {
"Bucket": ...,
}
# GetBucketWebsiteRequestTypeDef definition
class GetBucketWebsiteRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GetObjectAclRequestTypeDef#
# GetObjectAclRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectAclRequestTypeDef
def get_value() -> GetObjectAclRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectAclRequestTypeDef definition
class GetObjectAclRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],- See RequestPayerType
ObjectPartTypeDef#
# ObjectPartTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectPartTypeDef
def get_value() -> ObjectPartTypeDef:
return {
"PartNumber": ...,
}
# ObjectPartTypeDef definition
class ObjectPartTypeDef(TypedDict):
PartNumber: NotRequired[int],
Size: NotRequired[int],
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],GetObjectAttributesRequestTypeDef#
# GetObjectAttributesRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectAttributesRequestTypeDef
def get_value() -> GetObjectAttributesRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectAttributesRequestTypeDef definition
class GetObjectAttributesRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
ObjectAttributes: Sequence[ObjectAttributesType], # (1)
VersionId: NotRequired[str],
MaxParts: NotRequired[int],
PartNumberMarker: NotRequired[int],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (2)
ExpectedBucketOwner: NotRequired[str],- See ObjectAttributesType
- See RequestPayerType
ObjectLockLegalHoldTypeDef#
# ObjectLockLegalHoldTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectLockLegalHoldTypeDef
def get_value() -> ObjectLockLegalHoldTypeDef:
return {
"Status": ...,
}
# ObjectLockLegalHoldTypeDef definition
class ObjectLockLegalHoldTypeDef(TypedDict):
Status: NotRequired[ObjectLockLegalHoldStatusType], # (1)GetObjectLegalHoldRequestTypeDef#
# GetObjectLegalHoldRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectLegalHoldRequestTypeDef
def get_value() -> GetObjectLegalHoldRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectLegalHoldRequestTypeDef definition
class GetObjectLegalHoldRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],- See RequestPayerType
GetObjectLockConfigurationRequestTypeDef#
# GetObjectLockConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectLockConfigurationRequestTypeDef
def get_value() -> GetObjectLockConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectLockConfigurationRequestTypeDef definition
class GetObjectLockConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],ObjectLockRetentionOutputTypeDef#
# ObjectLockRetentionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectLockRetentionOutputTypeDef
def get_value() -> ObjectLockRetentionOutputTypeDef:
return {
"Mode": ...,
}
# ObjectLockRetentionOutputTypeDef definition
class ObjectLockRetentionOutputTypeDef(TypedDict):
Mode: NotRequired[ObjectLockRetentionModeType], # (1)
RetainUntilDate: NotRequired[datetime],GetObjectRetentionRequestTypeDef#
# GetObjectRetentionRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectRetentionRequestTypeDef
def get_value() -> GetObjectRetentionRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectRetentionRequestTypeDef definition
class GetObjectRetentionRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],- See RequestPayerType
GetObjectTaggingRequestTypeDef#
# GetObjectTaggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectTaggingRequestTypeDef
def get_value() -> GetObjectTaggingRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectTaggingRequestTypeDef definition
class GetObjectTaggingRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)- See RequestPayerType
GetObjectTorrentRequestTypeDef#
# GetObjectTorrentRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectTorrentRequestTypeDef
def get_value() -> GetObjectTorrentRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectTorrentRequestTypeDef definition
class GetObjectTorrentRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],- See RequestPayerType
PublicAccessBlockConfigurationTypeDef#
# PublicAccessBlockConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PublicAccessBlockConfigurationTypeDef
def get_value() -> PublicAccessBlockConfigurationTypeDef:
return {
"BlockPublicAcls": ...,
}
# PublicAccessBlockConfigurationTypeDef definition
class PublicAccessBlockConfigurationTypeDef(TypedDict):
BlockPublicAcls: NotRequired[bool],
IgnorePublicAcls: NotRequired[bool],
BlockPublicPolicy: NotRequired[bool],
RestrictPublicBuckets: NotRequired[bool],GetPublicAccessBlockRequestTypeDef#
# GetPublicAccessBlockRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetPublicAccessBlockRequestTypeDef
def get_value() -> GetPublicAccessBlockRequestTypeDef:
return {
"Bucket": ...,
}
# GetPublicAccessBlockRequestTypeDef definition
class GetPublicAccessBlockRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],GlacierJobParametersTypeDef#
# GlacierJobParametersTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GlacierJobParametersTypeDef
def get_value() -> GlacierJobParametersTypeDef:
return {
"Tier": ...,
}
# GlacierJobParametersTypeDef definition
class GlacierJobParametersTypeDef(TypedDict):
Tier: TierType, # (1)- See TierType
GranteeTypeDef#
# GranteeTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GranteeTypeDef
def get_value() -> GranteeTypeDef:
return {
"DisplayName": ...,
}
# GranteeTypeDef definition
class GranteeTypeDef(TypedDict):
Type: TypeType, # (1)
DisplayName: NotRequired[str],
EmailAddress: NotRequired[str],
ID: NotRequired[str],
URI: NotRequired[str],- See TypeType
HeadBucketRequestTypeDef#
# HeadBucketRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadBucketRequestTypeDef
def get_value() -> HeadBucketRequestTypeDef:
return {
"Bucket": ...,
}
# HeadBucketRequestTypeDef definition
class HeadBucketRequestTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],WaiterConfigTypeDef#
# WaiterConfigTypeDef TypedDict usage example
from types_boto3_s3.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],InitiatorTypeDef#
# InitiatorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InitiatorTypeDef
def get_value() -> InitiatorTypeDef:
return {
"ID": ...,
}
# InitiatorTypeDef definition
class InitiatorTypeDef(TypedDict):
ID: NotRequired[str],
DisplayName: NotRequired[str],JSONInputTypeDef#
# JSONInputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import JSONInputTypeDef
def get_value() -> JSONInputTypeDef:
return {
"Type": ...,
}
# JSONInputTypeDef definition
class JSONInputTypeDef(TypedDict):
Type: NotRequired[JSONTypeType], # (1)- See JSONTypeType
TieringTypeDef#
# TieringTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TieringTypeDef
def get_value() -> TieringTypeDef:
return {
"Days": ...,
}
# TieringTypeDef definition
class TieringTypeDef(TypedDict):
Days: int,
AccessTier: IntelligentTieringAccessTierType, # (1)InventoryFilterTypeDef#
# InventoryFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryFilterTypeDef
def get_value() -> InventoryFilterTypeDef:
return {
"Prefix": ...,
}
# InventoryFilterTypeDef definition
class InventoryFilterTypeDef(TypedDict):
Prefix: str,InventoryScheduleTypeDef#
# InventoryScheduleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryScheduleTypeDef
def get_value() -> InventoryScheduleTypeDef:
return {
"Frequency": ...,
}
# InventoryScheduleTypeDef definition
class InventoryScheduleTypeDef(TypedDict):
Frequency: InventoryFrequencyType, # (1)SSEKMSTypeDef#
# SSEKMSTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SSEKMSTypeDef
def get_value() -> SSEKMSTypeDef:
return {
"KeyId": ...,
}
# SSEKMSTypeDef definition
class SSEKMSTypeDef(TypedDict):
KeyId: str,JSONOutputTypeDef#
# JSONOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import JSONOutputTypeDef
def get_value() -> JSONOutputTypeDef:
return {
"RecordDelimiter": ...,
}
# JSONOutputTypeDef definition
class JSONOutputTypeDef(TypedDict):
RecordDelimiter: NotRequired[str],LifecycleExpirationOutputTypeDef#
# LifecycleExpirationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleExpirationOutputTypeDef
def get_value() -> LifecycleExpirationOutputTypeDef:
return {
"Date": ...,
}
# LifecycleExpirationOutputTypeDef definition
class LifecycleExpirationOutputTypeDef(TypedDict):
Date: NotRequired[datetime],
Days: NotRequired[int],
ExpiredObjectDeleteMarker: NotRequired[bool],NoncurrentVersionExpirationTypeDef#
# NoncurrentVersionExpirationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NoncurrentVersionExpirationTypeDef
def get_value() -> NoncurrentVersionExpirationTypeDef:
return {
"NoncurrentDays": ...,
}
# NoncurrentVersionExpirationTypeDef definition
class NoncurrentVersionExpirationTypeDef(TypedDict):
NoncurrentDays: NotRequired[int],
NewerNoncurrentVersions: NotRequired[int],NoncurrentVersionTransitionTypeDef#
# NoncurrentVersionTransitionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NoncurrentVersionTransitionTypeDef
def get_value() -> NoncurrentVersionTransitionTypeDef:
return {
"NoncurrentDays": ...,
}
# NoncurrentVersionTransitionTypeDef definition
class NoncurrentVersionTransitionTypeDef(TypedDict):
NoncurrentDays: NotRequired[int],
StorageClass: NotRequired[TransitionStorageClassType], # (1)
NewerNoncurrentVersions: NotRequired[int],TransitionOutputTypeDef#
# TransitionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TransitionOutputTypeDef
def get_value() -> TransitionOutputTypeDef:
return {
"Date": ...,
}
# TransitionOutputTypeDef definition
class TransitionOutputTypeDef(TypedDict):
Date: NotRequired[datetime],
Days: NotRequired[int],
StorageClass: NotRequired[TransitionStorageClassType], # (1)ListBucketAnalyticsConfigurationsRequestTypeDef#
# ListBucketAnalyticsConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketAnalyticsConfigurationsRequestTypeDef
def get_value() -> ListBucketAnalyticsConfigurationsRequestTypeDef:
return {
"Bucket": ...,
}
# ListBucketAnalyticsConfigurationsRequestTypeDef definition
class ListBucketAnalyticsConfigurationsRequestTypeDef(TypedDict):
Bucket: str,
ContinuationToken: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],ListBucketIntelligentTieringConfigurationsRequestTypeDef#
# ListBucketIntelligentTieringConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketIntelligentTieringConfigurationsRequestTypeDef
def get_value() -> ListBucketIntelligentTieringConfigurationsRequestTypeDef:
return {
"Bucket": ...,
}
# ListBucketIntelligentTieringConfigurationsRequestTypeDef definition
class ListBucketIntelligentTieringConfigurationsRequestTypeDef(TypedDict):
Bucket: str,
ContinuationToken: NotRequired[str],ListBucketInventoryConfigurationsRequestTypeDef#
# ListBucketInventoryConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketInventoryConfigurationsRequestTypeDef
def get_value() -> ListBucketInventoryConfigurationsRequestTypeDef:
return {
"Bucket": ...,
}
# ListBucketInventoryConfigurationsRequestTypeDef definition
class ListBucketInventoryConfigurationsRequestTypeDef(TypedDict):
Bucket: str,
ContinuationToken: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],ListBucketMetricsConfigurationsRequestTypeDef#
# ListBucketMetricsConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketMetricsConfigurationsRequestTypeDef
def get_value() -> ListBucketMetricsConfigurationsRequestTypeDef:
return {
"Bucket": ...,
}
# ListBucketMetricsConfigurationsRequestTypeDef definition
class ListBucketMetricsConfigurationsRequestTypeDef(TypedDict):
Bucket: str,
ContinuationToken: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],ListBucketsRequestTypeDef#
# ListBucketsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketsRequestTypeDef
def get_value() -> ListBucketsRequestTypeDef:
return {
"MaxBuckets": ...,
}
# ListBucketsRequestTypeDef definition
class ListBucketsRequestTypeDef(TypedDict):
MaxBuckets: NotRequired[int],
ContinuationToken: NotRequired[str],
Prefix: NotRequired[str],
BucketRegion: NotRequired[str],ListDirectoryBucketsRequestTypeDef#
# ListDirectoryBucketsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListDirectoryBucketsRequestTypeDef
def get_value() -> ListDirectoryBucketsRequestTypeDef:
return {
"ContinuationToken": ...,
}
# ListDirectoryBucketsRequestTypeDef definition
class ListDirectoryBucketsRequestTypeDef(TypedDict):
ContinuationToken: NotRequired[str],
MaxDirectoryBuckets: NotRequired[int],ListMultipartUploadsRequestTypeDef#
# ListMultipartUploadsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListMultipartUploadsRequestTypeDef
def get_value() -> ListMultipartUploadsRequestTypeDef:
return {
"Bucket": ...,
}
# ListMultipartUploadsRequestTypeDef definition
class ListMultipartUploadsRequestTypeDef(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],
RequestPayer: NotRequired[RequestPayerType], # (2)- See EncodingTypeType
- See RequestPayerType
ListObjectVersionsRequestTypeDef#
# ListObjectVersionsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectVersionsRequestTypeDef
def get_value() -> ListObjectVersionsRequestTypeDef:
return {
"Bucket": ...,
}
# ListObjectVersionsRequestTypeDef definition
class ListObjectVersionsRequestTypeDef(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],
RequestPayer: NotRequired[RequestPayerType], # (2)
OptionalObjectAttributes: NotRequired[Sequence[OptionalObjectAttributesType]], # (3)ListObjectsRequestTypeDef#
# ListObjectsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectsRequestTypeDef
def get_value() -> ListObjectsRequestTypeDef:
return {
"Bucket": ...,
}
# ListObjectsRequestTypeDef definition
class ListObjectsRequestTypeDef(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],
OptionalObjectAttributes: NotRequired[Sequence[OptionalObjectAttributesType]], # (3)ListObjectsV2RequestTypeDef#
# ListObjectsV2RequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectsV2RequestTypeDef
def get_value() -> ListObjectsV2RequestTypeDef:
return {
"Bucket": ...,
}
# ListObjectsV2RequestTypeDef definition
class ListObjectsV2RequestTypeDef(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],
OptionalObjectAttributes: NotRequired[Sequence[OptionalObjectAttributesType]], # (3)PartTypeDef#
# PartTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PartTypeDef
def get_value() -> PartTypeDef:
return {
"PartNumber": ...,
}
# PartTypeDef definition
class PartTypeDef(TypedDict):
PartNumber: NotRequired[int],
LastModified: NotRequired[datetime],
ETag: NotRequired[str],
Size: NotRequired[int],
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],ListPartsRequestTypeDef#
# ListPartsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListPartsRequestTypeDef
def get_value() -> ListPartsRequestTypeDef:
return {
"Bucket": ...,
}
# ListPartsRequestTypeDef definition
class ListPartsRequestTypeDef(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[Union[str, bytes]],- See RequestPayerType
MetadataEntryTypeDef#
# MetadataEntryTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetadataEntryTypeDef
def get_value() -> MetadataEntryTypeDef:
return {
"Name": ...,
}
# MetadataEntryTypeDef definition
class MetadataEntryTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[str],S3TablesDestinationResultTypeDef#
# S3TablesDestinationResultTypeDef TypedDict usage example
from types_boto3_s3.type_defs import S3TablesDestinationResultTypeDef
def get_value() -> S3TablesDestinationResultTypeDef:
return {
"TableBucketArn": ...,
}
# S3TablesDestinationResultTypeDef definition
class S3TablesDestinationResultTypeDef(TypedDict):
TableBucketArn: str,
TableName: str,
TableArn: str,
TableNamespace: str,S3TablesDestinationTypeDef#
# S3TablesDestinationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import S3TablesDestinationTypeDef
def get_value() -> S3TablesDestinationTypeDef:
return {
"TableBucketArn": ...,
}
# S3TablesDestinationTypeDef definition
class S3TablesDestinationTypeDef(TypedDict):
TableBucketArn: str,
TableName: str,ReplicationTimeValueTypeDef#
# ReplicationTimeValueTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationTimeValueTypeDef
def get_value() -> ReplicationTimeValueTypeDef:
return {
"Minutes": ...,
}
# ReplicationTimeValueTypeDef definition
class ReplicationTimeValueTypeDef(TypedDict):
Minutes: NotRequired[int],QueueConfigurationDeprecatedOutputTypeDef#
# QueueConfigurationDeprecatedOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import QueueConfigurationDeprecatedOutputTypeDef
def get_value() -> QueueConfigurationDeprecatedOutputTypeDef:
return {
"Id": ...,
}
# QueueConfigurationDeprecatedOutputTypeDef definition
class QueueConfigurationDeprecatedOutputTypeDef(TypedDict):
Id: NotRequired[str],
Event: NotRequired[EventType], # (1)
Events: NotRequired[List[EventType]], # (2)
Queue: NotRequired[str],TopicConfigurationDeprecatedOutputTypeDef#
# TopicConfigurationDeprecatedOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TopicConfigurationDeprecatedOutputTypeDef
def get_value() -> TopicConfigurationDeprecatedOutputTypeDef:
return {
"Id": ...,
}
# TopicConfigurationDeprecatedOutputTypeDef definition
class TopicConfigurationDeprecatedOutputTypeDef(TypedDict):
Id: NotRequired[str],
Events: NotRequired[List[EventType]], # (1)
Event: NotRequired[EventType], # (2)
Topic: NotRequired[str],ObjectDownloadFileRequestTypeDef#
# ObjectDownloadFileRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectDownloadFileRequestTypeDef
def get_value() -> ObjectDownloadFileRequestTypeDef:
return {
"Filename": ...,
}
# ObjectDownloadFileRequestTypeDef definition
class ObjectDownloadFileRequestTypeDef(TypedDict):
Filename: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],RestoreStatusTypeDef#
# RestoreStatusTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RestoreStatusTypeDef
def get_value() -> RestoreStatusTypeDef:
return {
"IsRestoreInProgress": ...,
}
# RestoreStatusTypeDef definition
class RestoreStatusTypeDef(TypedDict):
IsRestoreInProgress: NotRequired[bool],
RestoreExpiryDate: NotRequired[datetime],ObjectUploadFileRequestTypeDef#
# ObjectUploadFileRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectUploadFileRequestTypeDef
def get_value() -> ObjectUploadFileRequestTypeDef:
return {
"Filename": ...,
}
# ObjectUploadFileRequestTypeDef definition
class ObjectUploadFileRequestTypeDef(TypedDict):
Filename: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],OwnershipControlsRuleTypeDef#
# OwnershipControlsRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import OwnershipControlsRuleTypeDef
def get_value() -> OwnershipControlsRuleTypeDef:
return {
"ObjectOwnership": ...,
}
# OwnershipControlsRuleTypeDef definition
class OwnershipControlsRuleTypeDef(TypedDict):
ObjectOwnership: ObjectOwnershipType, # (1)PartitionedPrefixTypeDef#
# PartitionedPrefixTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PartitionedPrefixTypeDef
def get_value() -> PartitionedPrefixTypeDef:
return {
"PartitionDateSource": ...,
}
# PartitionedPrefixTypeDef definition
class PartitionedPrefixTypeDef(TypedDict):
PartitionDateSource: NotRequired[PartitionDateSourceType], # (1)ProgressTypeDef#
# ProgressTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ProgressTypeDef
def get_value() -> ProgressTypeDef:
return {
"BytesScanned": ...,
}
# ProgressTypeDef definition
class ProgressTypeDef(TypedDict):
BytesScanned: NotRequired[int],
BytesProcessed: NotRequired[int],
BytesReturned: NotRequired[int],PutBucketPolicyRequestBucketPolicyPutTypeDef#
# PutBucketPolicyRequestBucketPolicyPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketPolicyRequestBucketPolicyPutTypeDef
def get_value() -> PutBucketPolicyRequestBucketPolicyPutTypeDef:
return {
"Policy": ...,
}
# PutBucketPolicyRequestBucketPolicyPutTypeDef definition
class PutBucketPolicyRequestBucketPolicyPutTypeDef(TypedDict):
Policy: str,
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
ConfirmRemoveSelfBucketAccess: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],PutBucketPolicyRequestTypeDef#
# PutBucketPolicyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketPolicyRequestTypeDef
def get_value() -> PutBucketPolicyRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketPolicyRequestTypeDef definition
class PutBucketPolicyRequestTypeDef(TypedDict):
Bucket: str,
Policy: str,
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
ConfirmRemoveSelfBucketAccess: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],RequestPaymentConfigurationTypeDef#
# RequestPaymentConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RequestPaymentConfigurationTypeDef
def get_value() -> RequestPaymentConfigurationTypeDef:
return {
"Payer": ...,
}
# RequestPaymentConfigurationTypeDef definition
class RequestPaymentConfigurationTypeDef(TypedDict):
Payer: PayerType, # (1)- See PayerType
PutBucketVersioningRequestBucketVersioningEnableTypeDef#
# PutBucketVersioningRequestBucketVersioningEnableTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningEnableTypeDef
def get_value() -> PutBucketVersioningRequestBucketVersioningEnableTypeDef:
return {
"ChecksumAlgorithm": ...,
}
# PutBucketVersioningRequestBucketVersioningEnableTypeDef definition
class PutBucketVersioningRequestBucketVersioningEnableTypeDef(TypedDict):
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
MFA: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],VersioningConfigurationTypeDef#
# VersioningConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import VersioningConfigurationTypeDef
def get_value() -> VersioningConfigurationTypeDef:
return {
"MFADelete": ...,
}
# VersioningConfigurationTypeDef definition
class VersioningConfigurationTypeDef(TypedDict):
MFADelete: NotRequired[MFADeleteType], # (1)
Status: NotRequired[BucketVersioningStatusType], # (2)PutBucketVersioningRequestBucketVersioningSuspendTypeDef#
# PutBucketVersioningRequestBucketVersioningSuspendTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningSuspendTypeDef
def get_value() -> PutBucketVersioningRequestBucketVersioningSuspendTypeDef:
return {
"ChecksumAlgorithm": ...,
}
# PutBucketVersioningRequestBucketVersioningSuspendTypeDef definition
class PutBucketVersioningRequestBucketVersioningSuspendTypeDef(TypedDict):
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
MFA: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],QueueConfigurationDeprecatedTypeDef#
# QueueConfigurationDeprecatedTypeDef TypedDict usage example
from types_boto3_s3.type_defs import QueueConfigurationDeprecatedTypeDef
def get_value() -> QueueConfigurationDeprecatedTypeDef:
return {
"Id": ...,
}
# QueueConfigurationDeprecatedTypeDef definition
class QueueConfigurationDeprecatedTypeDef(TypedDict):
Id: NotRequired[str],
Event: NotRequired[EventType], # (1)
Events: NotRequired[Sequence[EventType]], # (2)
Queue: NotRequired[str],RecordsEventTypeDef#
# RecordsEventTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RecordsEventTypeDef
def get_value() -> RecordsEventTypeDef:
return {
"Payload": ...,
}
# RecordsEventTypeDef definition
class RecordsEventTypeDef(TypedDict):
Payload: NotRequired[bytes],RedirectTypeDef#
# RedirectTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RedirectTypeDef
def get_value() -> RedirectTypeDef:
return {
"HostName": ...,
}
# RedirectTypeDef definition
class RedirectTypeDef(TypedDict):
HostName: NotRequired[str],
HttpRedirectCode: NotRequired[str],
Protocol: NotRequired[ProtocolType], # (1)
ReplaceKeyPrefixWith: NotRequired[str],
ReplaceKeyWith: NotRequired[str],- See ProtocolType
ReplicaModificationsTypeDef#
# ReplicaModificationsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicaModificationsTypeDef
def get_value() -> ReplicaModificationsTypeDef:
return {
"Status": ...,
}
# ReplicaModificationsTypeDef definition
class ReplicaModificationsTypeDef(TypedDict):
Status: ReplicaModificationsStatusType, # (1)RequestProgressTypeDef#
# RequestProgressTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RequestProgressTypeDef
def get_value() -> RequestProgressTypeDef:
return {
"Enabled": ...,
}
# RequestProgressTypeDef definition
class RequestProgressTypeDef(TypedDict):
Enabled: NotRequired[bool],ScanRangeTypeDef#
# ScanRangeTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ScanRangeTypeDef
def get_value() -> ScanRangeTypeDef:
return {
"Start": ...,
}
# ScanRangeTypeDef definition
class ScanRangeTypeDef(TypedDict):
Start: NotRequired[int],
End: NotRequired[int],ServerSideEncryptionByDefaultTypeDef#
# ServerSideEncryptionByDefaultTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ServerSideEncryptionByDefaultTypeDef
def get_value() -> ServerSideEncryptionByDefaultTypeDef:
return {
"SSEAlgorithm": ...,
}
# ServerSideEncryptionByDefaultTypeDef definition
class ServerSideEncryptionByDefaultTypeDef(TypedDict):
SSEAlgorithm: ServerSideEncryptionType, # (1)
KMSMasterKeyID: NotRequired[str],SseKmsEncryptedObjectsTypeDef#
# SseKmsEncryptedObjectsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SseKmsEncryptedObjectsTypeDef
def get_value() -> SseKmsEncryptedObjectsTypeDef:
return {
"Status": ...,
}
# SseKmsEncryptedObjectsTypeDef definition
class SseKmsEncryptedObjectsTypeDef(TypedDict):
Status: SseKmsEncryptedObjectsStatusType, # (1)StatsTypeDef#
# StatsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import StatsTypeDef
def get_value() -> StatsTypeDef:
return {
"BytesScanned": ...,
}
# StatsTypeDef definition
class StatsTypeDef(TypedDict):
BytesScanned: NotRequired[int],
BytesProcessed: NotRequired[int],
BytesReturned: NotRequired[int],TopicConfigurationDeprecatedTypeDef#
# TopicConfigurationDeprecatedTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TopicConfigurationDeprecatedTypeDef
def get_value() -> TopicConfigurationDeprecatedTypeDef:
return {
"Id": ...,
}
# TopicConfigurationDeprecatedTypeDef definition
class TopicConfigurationDeprecatedTypeDef(TypedDict):
Id: NotRequired[str],
Events: NotRequired[Sequence[EventType]], # (1)
Event: NotRequired[EventType], # (2)
Topic: NotRequired[str],AbortMultipartUploadOutputTypeDef#
# AbortMultipartUploadOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AbortMultipartUploadOutputTypeDef
def get_value() -> AbortMultipartUploadOutputTypeDef:
return {
"RequestCharged": ...,
}
# AbortMultipartUploadOutputTypeDef definition
class AbortMultipartUploadOutputTypeDef(TypedDict):
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CompleteMultipartUploadOutputTypeDef#
# CompleteMultipartUploadOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CompleteMultipartUploadOutputTypeDef
def get_value() -> CompleteMultipartUploadOutputTypeDef:
return {
"Location": ...,
}
# CompleteMultipartUploadOutputTypeDef definition
class CompleteMultipartUploadOutputTypeDef(TypedDict):
Location: str,
Bucket: str,
Key: str,
Expiration: str,
ETag: str,
ChecksumCRC32: str,
ChecksumCRC32C: str,
ChecksumCRC64NVME: str,
ChecksumSHA1: str,
ChecksumSHA256: str,
ChecksumType: ChecksumTypeType, # (1)
ServerSideEncryption: ServerSideEncryptionType, # (2)
VersionId: str,
SSEKMSKeyId: str,
BucketKeyEnabled: bool,
RequestCharged: RequestChargedType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See ChecksumTypeType
- See ServerSideEncryptionType
- See RequestChargedType
- See ResponseMetadataTypeDef
CreateBucketOutputTypeDef#
# CreateBucketOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateBucketOutputTypeDef
def get_value() -> CreateBucketOutputTypeDef:
return {
"Location": ...,
}
# CreateBucketOutputTypeDef definition
class CreateBucketOutputTypeDef(TypedDict):
Location: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateMultipartUploadOutputTypeDef#
# CreateMultipartUploadOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateMultipartUploadOutputTypeDef
def get_value() -> CreateMultipartUploadOutputTypeDef:
return {
"AbortDate": ...,
}
# CreateMultipartUploadOutputTypeDef definition
class CreateMultipartUploadOutputTypeDef(TypedDict):
AbortDate: datetime,
AbortRuleId: str,
Bucket: str,
Key: str,
UploadId: str,
ServerSideEncryption: ServerSideEncryptionType, # (1)
SSECustomerAlgorithm: str,
SSECustomerKeyMD5: str,
SSEKMSKeyId: str,
SSEKMSEncryptionContext: str,
BucketKeyEnabled: bool,
RequestCharged: RequestChargedType, # (2)
ChecksumAlgorithm: ChecksumAlgorithmType, # (3)
ChecksumType: ChecksumTypeType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See ServerSideEncryptionType
- See RequestChargedType
- See ChecksumAlgorithmType
- See ChecksumTypeType
- See ResponseMetadataTypeDef
DeleteObjectOutputTypeDef#
# DeleteObjectOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectOutputTypeDef
def get_value() -> DeleteObjectOutputTypeDef:
return {
"DeleteMarker": ...,
}
# DeleteObjectOutputTypeDef definition
class DeleteObjectOutputTypeDef(TypedDict):
DeleteMarker: bool,
VersionId: str,
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DeleteObjectTaggingOutputTypeDef#
# DeleteObjectTaggingOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectTaggingOutputTypeDef
def get_value() -> DeleteObjectTaggingOutputTypeDef:
return {
"VersionId": ...,
}
# DeleteObjectTaggingOutputTypeDef definition
class DeleteObjectTaggingOutputTypeDef(TypedDict):
VersionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_s3.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetBucketAccelerateConfigurationOutputTypeDef#
# GetBucketAccelerateConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketAccelerateConfigurationOutputTypeDef
def get_value() -> GetBucketAccelerateConfigurationOutputTypeDef:
return {
"Status": ...,
}
# GetBucketAccelerateConfigurationOutputTypeDef definition
class GetBucketAccelerateConfigurationOutputTypeDef(TypedDict):
Status: BucketAccelerateStatusType, # (1)
RequestCharged: RequestChargedType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetBucketLocationOutputTypeDef#
# GetBucketLocationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLocationOutputTypeDef
def get_value() -> GetBucketLocationOutputTypeDef:
return {
"LocationConstraint": ...,
}
# GetBucketLocationOutputTypeDef definition
class GetBucketLocationOutputTypeDef(TypedDict):
LocationConstraint: BucketLocationConstraintType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetBucketPolicyOutputTypeDef#
# GetBucketPolicyOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketPolicyOutputTypeDef
def get_value() -> GetBucketPolicyOutputTypeDef:
return {
"Policy": ...,
}
# GetBucketPolicyOutputTypeDef definition
class GetBucketPolicyOutputTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetBucketRequestPaymentOutputTypeDef#
# GetBucketRequestPaymentOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketRequestPaymentOutputTypeDef
def get_value() -> GetBucketRequestPaymentOutputTypeDef:
return {
"Payer": ...,
}
# GetBucketRequestPaymentOutputTypeDef definition
class GetBucketRequestPaymentOutputTypeDef(TypedDict):
Payer: PayerType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PayerType
- See ResponseMetadataTypeDef
GetBucketVersioningOutputTypeDef#
# GetBucketVersioningOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketVersioningOutputTypeDef
def get_value() -> GetBucketVersioningOutputTypeDef:
return {
"Status": ...,
}
# GetBucketVersioningOutputTypeDef definition
class GetBucketVersioningOutputTypeDef(TypedDict):
Status: BucketVersioningStatusType, # (1)
MFADelete: MFADeleteStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetObjectOutputTypeDef#
# GetObjectOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectOutputTypeDef
def get_value() -> GetObjectOutputTypeDef:
return {
"Body": ...,
}
# GetObjectOutputTypeDef definition
class GetObjectOutputTypeDef(TypedDict):
Body: StreamingBody,
DeleteMarker: bool,
AcceptRanges: str,
Expiration: str,
Restore: str,
LastModified: datetime,
ContentLength: int,
ETag: str,
ChecksumCRC32: str,
ChecksumCRC32C: str,
ChecksumCRC64NVME: str,
ChecksumSHA1: str,
ChecksumSHA256: str,
ChecksumType: ChecksumTypeType, # (1)
MissingMeta: int,
VersionId: str,
CacheControl: str,
ContentDisposition: str,
ContentEncoding: str,
ContentLanguage: str,
ContentRange: 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,
TagCount: int,
ObjectLockMode: ObjectLockModeType, # (6)
ObjectLockRetainUntilDate: datetime,
ObjectLockLegalHoldStatus: ObjectLockLegalHoldStatusType, # (7)
ResponseMetadata: ResponseMetadataTypeDef, # (8)- See ChecksumTypeType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestChargedType
- See ReplicationStatusType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
- See ResponseMetadataTypeDef
GetObjectTorrentOutputTypeDef#
# GetObjectTorrentOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectTorrentOutputTypeDef
def get_value() -> GetObjectTorrentOutputTypeDef:
return {
"Body": ...,
}
# GetObjectTorrentOutputTypeDef definition
class GetObjectTorrentOutputTypeDef(TypedDict):
Body: StreamingBody,
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)HeadBucketOutputTypeDef#
# HeadBucketOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadBucketOutputTypeDef
def get_value() -> HeadBucketOutputTypeDef:
return {
"BucketLocationType": ...,
}
# HeadBucketOutputTypeDef definition
class HeadBucketOutputTypeDef(TypedDict):
BucketLocationType: LocationTypeType, # (1)
BucketLocationName: str,
BucketRegion: str,
AccessPointAlias: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)HeadObjectOutputTypeDef#
# HeadObjectOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadObjectOutputTypeDef
def get_value() -> HeadObjectOutputTypeDef:
return {
"DeleteMarker": ...,
}
# HeadObjectOutputTypeDef definition
class HeadObjectOutputTypeDef(TypedDict):
DeleteMarker: bool,
AcceptRanges: str,
Expiration: str,
Restore: str,
ArchiveStatus: ArchiveStatusType, # (1)
LastModified: datetime,
ContentLength: int,
ChecksumCRC32: str,
ChecksumCRC32C: str,
ChecksumCRC64NVME: str,
ChecksumSHA1: str,
ChecksumSHA256: str,
ChecksumType: ChecksumTypeType, # (2)
ETag: str,
MissingMeta: int,
VersionId: str,
CacheControl: str,
ContentDisposition: str,
ContentEncoding: str,
ContentLanguage: str,
ContentType: str,
ContentRange: str,
Expires: datetime,
WebsiteRedirectLocation: str,
ServerSideEncryption: ServerSideEncryptionType, # (3)
Metadata: Dict[str, str],
SSECustomerAlgorithm: str,
SSECustomerKeyMD5: str,
SSEKMSKeyId: str,
BucketKeyEnabled: bool,
StorageClass: StorageClassType, # (4)
RequestCharged: RequestChargedType, # (5)
ReplicationStatus: ReplicationStatusType, # (6)
PartsCount: int,
ObjectLockMode: ObjectLockModeType, # (7)
ObjectLockRetainUntilDate: datetime,
ObjectLockLegalHoldStatus: ObjectLockLegalHoldStatusType, # (8)
ResponseMetadata: ResponseMetadataTypeDef, # (9)- See ArchiveStatusType
- See ChecksumTypeType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestChargedType
- See ReplicationStatusType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
- See ResponseMetadataTypeDef
PutBucketLifecycleConfigurationOutputTypeDef#
# PutBucketLifecycleConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLifecycleConfigurationOutputTypeDef
def get_value() -> PutBucketLifecycleConfigurationOutputTypeDef:
return {
"TransitionDefaultMinimumObjectSize": ...,
}
# PutBucketLifecycleConfigurationOutputTypeDef definition
class PutBucketLifecycleConfigurationOutputTypeDef(TypedDict):
TransitionDefaultMinimumObjectSize: TransitionDefaultMinimumObjectSizeType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectAclOutputTypeDef#
# PutObjectAclOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectAclOutputTypeDef
def get_value() -> PutObjectAclOutputTypeDef:
return {
"RequestCharged": ...,
}
# PutObjectAclOutputTypeDef definition
class PutObjectAclOutputTypeDef(TypedDict):
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectLegalHoldOutputTypeDef#
# PutObjectLegalHoldOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectLegalHoldOutputTypeDef
def get_value() -> PutObjectLegalHoldOutputTypeDef:
return {
"RequestCharged": ...,
}
# PutObjectLegalHoldOutputTypeDef definition
class PutObjectLegalHoldOutputTypeDef(TypedDict):
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectLockConfigurationOutputTypeDef#
# PutObjectLockConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectLockConfigurationOutputTypeDef
def get_value() -> PutObjectLockConfigurationOutputTypeDef:
return {
"RequestCharged": ...,
}
# PutObjectLockConfigurationOutputTypeDef definition
class PutObjectLockConfigurationOutputTypeDef(TypedDict):
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectOutputTypeDef#
# PutObjectOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectOutputTypeDef
def get_value() -> PutObjectOutputTypeDef:
return {
"Expiration": ...,
}
# PutObjectOutputTypeDef definition
class PutObjectOutputTypeDef(TypedDict):
Expiration: str,
ETag: str,
ChecksumCRC32: str,
ChecksumCRC32C: str,
ChecksumCRC64NVME: str,
ChecksumSHA1: str,
ChecksumSHA256: str,
ChecksumType: ChecksumTypeType, # (1)
ServerSideEncryption: ServerSideEncryptionType, # (2)
VersionId: str,
SSECustomerAlgorithm: str,
SSECustomerKeyMD5: str,
SSEKMSKeyId: str,
SSEKMSEncryptionContext: str,
BucketKeyEnabled: bool,
Size: int,
RequestCharged: RequestChargedType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See ChecksumTypeType
- See ServerSideEncryptionType
- See RequestChargedType
- See ResponseMetadataTypeDef
PutObjectRetentionOutputTypeDef#
# PutObjectRetentionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectRetentionOutputTypeDef
def get_value() -> PutObjectRetentionOutputTypeDef:
return {
"RequestCharged": ...,
}
# PutObjectRetentionOutputTypeDef definition
class PutObjectRetentionOutputTypeDef(TypedDict):
RequestCharged: RequestChargedType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectTaggingOutputTypeDef#
# PutObjectTaggingOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectTaggingOutputTypeDef
def get_value() -> PutObjectTaggingOutputTypeDef:
return {
"VersionId": ...,
}
# PutObjectTaggingOutputTypeDef definition
class PutObjectTaggingOutputTypeDef(TypedDict):
VersionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)RestoreObjectOutputTypeDef#
# RestoreObjectOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RestoreObjectOutputTypeDef
def get_value() -> RestoreObjectOutputTypeDef:
return {
"RequestCharged": ...,
}
# RestoreObjectOutputTypeDef definition
class RestoreObjectOutputTypeDef(TypedDict):
RequestCharged: RequestChargedType, # (1)
RestoreOutputPath: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UploadPartOutputTypeDef#
# UploadPartOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import UploadPartOutputTypeDef
def get_value() -> UploadPartOutputTypeDef:
return {
"ServerSideEncryption": ...,
}
# UploadPartOutputTypeDef definition
class UploadPartOutputTypeDef(TypedDict):
ServerSideEncryption: ServerSideEncryptionType, # (1)
ETag: str,
ChecksumCRC32: str,
ChecksumCRC32C: str,
ChecksumCRC64NVME: str,
ChecksumSHA1: str,
ChecksumSHA256: str,
SSECustomerAlgorithm: str,
SSECustomerKeyMD5: str,
SSEKMSKeyId: str,
BucketKeyEnabled: bool,
RequestCharged: RequestChargedType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)AbortMultipartUploadRequestMultipartUploadAbortTypeDef#
# AbortMultipartUploadRequestMultipartUploadAbortTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AbortMultipartUploadRequestMultipartUploadAbortTypeDef
def get_value() -> AbortMultipartUploadRequestMultipartUploadAbortTypeDef:
return {
"RequestPayer": ...,
}
# AbortMultipartUploadRequestMultipartUploadAbortTypeDef definition
class AbortMultipartUploadRequestMultipartUploadAbortTypeDef(TypedDict):
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],
IfMatchInitiatedTime: NotRequired[TimestampTypeDef],- See RequestPayerType
AbortMultipartUploadRequestTypeDef#
# AbortMultipartUploadRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AbortMultipartUploadRequestTypeDef
def get_value() -> AbortMultipartUploadRequestTypeDef:
return {
"Bucket": ...,
}
# AbortMultipartUploadRequestTypeDef definition
class AbortMultipartUploadRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
UploadId: str,
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],
IfMatchInitiatedTime: NotRequired[TimestampTypeDef],- See RequestPayerType
CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef#
# CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef
def get_value() -> CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef:
return {
"ACL": ...,
}
# CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef definition
class CreateMultipartUploadRequestObjectInitiateMultipartUploadTypeDef(TypedDict):
ACL: NotRequired[ObjectCannedACLType], # (1)
CacheControl: NotRequired[str],
ContentDisposition: NotRequired[str],
ContentEncoding: NotRequired[str],
ContentLanguage: NotRequired[str],
ContentType: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
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[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (4)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (5)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (6)
ExpectedBucketOwner: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (7)
ChecksumType: NotRequired[ChecksumTypeType], # (8)- See ObjectCannedACLType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
- See ChecksumAlgorithmType
- See ChecksumTypeType
CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef#
# CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef
def get_value() -> CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef:
return {
"ACL": ...,
}
# CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef definition
class CreateMultipartUploadRequestObjectSummaryInitiateMultipartUploadTypeDef(TypedDict):
ACL: NotRequired[ObjectCannedACLType], # (1)
CacheControl: NotRequired[str],
ContentDisposition: NotRequired[str],
ContentEncoding: NotRequired[str],
ContentLanguage: NotRequired[str],
ContentType: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
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[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (4)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (5)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (6)
ExpectedBucketOwner: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (7)
ChecksumType: NotRequired[ChecksumTypeType], # (8)- See ObjectCannedACLType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
- See ChecksumAlgorithmType
- See ChecksumTypeType
CreateMultipartUploadRequestTypeDef#
# CreateMultipartUploadRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateMultipartUploadRequestTypeDef
def get_value() -> CreateMultipartUploadRequestTypeDef:
return {
"Bucket": ...,
}
# CreateMultipartUploadRequestTypeDef definition
class CreateMultipartUploadRequestTypeDef(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[TimestampTypeDef],
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[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (4)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (5)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (6)
ExpectedBucketOwner: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (7)
ChecksumType: NotRequired[ChecksumTypeType], # (8)- See ObjectCannedACLType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
- See ChecksumAlgorithmType
- See ChecksumTypeType
DeleteObjectRequestObjectDeleteTypeDef#
# DeleteObjectRequestObjectDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectRequestObjectDeleteTypeDef
def get_value() -> DeleteObjectRequestObjectDeleteTypeDef:
return {
"MFA": ...,
}
# DeleteObjectRequestObjectDeleteTypeDef definition
class DeleteObjectRequestObjectDeleteTypeDef(TypedDict):
MFA: NotRequired[str],
VersionId: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
BypassGovernanceRetention: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],
IfMatch: NotRequired[str],
IfMatchLastModifiedTime: NotRequired[TimestampTypeDef],
IfMatchSize: NotRequired[int],- See RequestPayerType
DeleteObjectRequestObjectSummaryDeleteTypeDef#
# DeleteObjectRequestObjectSummaryDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectRequestObjectSummaryDeleteTypeDef
def get_value() -> DeleteObjectRequestObjectSummaryDeleteTypeDef:
return {
"MFA": ...,
}
# DeleteObjectRequestObjectSummaryDeleteTypeDef definition
class DeleteObjectRequestObjectSummaryDeleteTypeDef(TypedDict):
MFA: NotRequired[str],
VersionId: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
BypassGovernanceRetention: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],
IfMatch: NotRequired[str],
IfMatchLastModifiedTime: NotRequired[TimestampTypeDef],
IfMatchSize: NotRequired[int],- See RequestPayerType
DeleteObjectRequestObjectVersionDeleteTypeDef#
# DeleteObjectRequestObjectVersionDeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectRequestObjectVersionDeleteTypeDef
def get_value() -> DeleteObjectRequestObjectVersionDeleteTypeDef:
return {
"MFA": ...,
}
# DeleteObjectRequestObjectVersionDeleteTypeDef definition
class DeleteObjectRequestObjectVersionDeleteTypeDef(TypedDict):
MFA: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
BypassGovernanceRetention: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],
IfMatch: NotRequired[str],
IfMatchLastModifiedTime: NotRequired[TimestampTypeDef],
IfMatchSize: NotRequired[int],- See RequestPayerType
DeleteObjectRequestTypeDef#
# DeleteObjectRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectRequestTypeDef
def get_value() -> DeleteObjectRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteObjectRequestTypeDef definition
class DeleteObjectRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
MFA: NotRequired[str],
VersionId: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (1)
BypassGovernanceRetention: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],
IfMatch: NotRequired[str],
IfMatchLastModifiedTime: NotRequired[TimestampTypeDef],
IfMatchSize: NotRequired[int],- See RequestPayerType
GetObjectRequestObjectGetTypeDef#
# GetObjectRequestObjectGetTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectRequestObjectGetTypeDef
def get_value() -> GetObjectRequestObjectGetTypeDef:
return {
"IfMatch": ...,
}
# GetObjectRequestObjectGetTypeDef definition
class GetObjectRequestObjectGetTypeDef(TypedDict):
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
VersionId: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)- See RequestPayerType
- See ChecksumModeType
GetObjectRequestObjectSummaryGetTypeDef#
# GetObjectRequestObjectSummaryGetTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectRequestObjectSummaryGetTypeDef
def get_value() -> GetObjectRequestObjectSummaryGetTypeDef:
return {
"IfMatch": ...,
}
# GetObjectRequestObjectSummaryGetTypeDef definition
class GetObjectRequestObjectSummaryGetTypeDef(TypedDict):
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
VersionId: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)- See RequestPayerType
- See ChecksumModeType
GetObjectRequestObjectVersionGetTypeDef#
# GetObjectRequestObjectVersionGetTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectRequestObjectVersionGetTypeDef
def get_value() -> GetObjectRequestObjectVersionGetTypeDef:
return {
"IfMatch": ...,
}
# GetObjectRequestObjectVersionGetTypeDef definition
class GetObjectRequestObjectVersionGetTypeDef(TypedDict):
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)- See RequestPayerType
- See ChecksumModeType
GetObjectRequestTypeDef#
# GetObjectRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectRequestTypeDef
def get_value() -> GetObjectRequestTypeDef:
return {
"Bucket": ...,
}
# GetObjectRequestTypeDef definition
class GetObjectRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
VersionId: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)- See RequestPayerType
- See ChecksumModeType
HeadObjectRequestObjectVersionHeadTypeDef#
# HeadObjectRequestObjectVersionHeadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadObjectRequestObjectVersionHeadTypeDef
def get_value() -> HeadObjectRequestObjectVersionHeadTypeDef:
return {
"IfMatch": ...,
}
# HeadObjectRequestObjectVersionHeadTypeDef definition
class HeadObjectRequestObjectVersionHeadTypeDef(TypedDict):
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)- See RequestPayerType
- See ChecksumModeType
HeadObjectRequestTypeDef#
# HeadObjectRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadObjectRequestTypeDef
def get_value() -> HeadObjectRequestTypeDef:
return {
"Bucket": ...,
}
# HeadObjectRequestTypeDef definition
class HeadObjectRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
VersionId: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)- See RequestPayerType
- See ChecksumModeType
LifecycleExpirationTypeDef#
# LifecycleExpirationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleExpirationTypeDef
def get_value() -> LifecycleExpirationTypeDef:
return {
"Date": ...,
}
# LifecycleExpirationTypeDef definition
class LifecycleExpirationTypeDef(TypedDict):
Date: NotRequired[TimestampTypeDef],
Days: NotRequired[int],
ExpiredObjectDeleteMarker: NotRequired[bool],ObjectIdentifierTypeDef#
# ObjectIdentifierTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectIdentifierTypeDef
def get_value() -> ObjectIdentifierTypeDef:
return {
"Key": ...,
}
# ObjectIdentifierTypeDef definition
class ObjectIdentifierTypeDef(TypedDict):
Key: str,
VersionId: NotRequired[str],
ETag: NotRequired[str],
LastModifiedTime: NotRequired[TimestampTypeDef],
Size: NotRequired[int],ObjectLockRetentionTypeDef#
# ObjectLockRetentionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectLockRetentionTypeDef
def get_value() -> ObjectLockRetentionTypeDef:
return {
"Mode": ...,
}
# ObjectLockRetentionTypeDef definition
class ObjectLockRetentionTypeDef(TypedDict):
Mode: NotRequired[ObjectLockRetentionModeType], # (1)
RetainUntilDate: NotRequired[TimestampTypeDef],TransitionTypeDef#
# TransitionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TransitionTypeDef
def get_value() -> TransitionTypeDef:
return {
"Date": ...,
}
# TransitionTypeDef definition
class TransitionTypeDef(TypedDict):
Date: NotRequired[TimestampTypeDef],
Days: NotRequired[int],
StorageClass: NotRequired[TransitionStorageClassType], # (1)PutBucketAccelerateConfigurationRequestTypeDef#
# PutBucketAccelerateConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketAccelerateConfigurationRequestTypeDef
def get_value() -> PutBucketAccelerateConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketAccelerateConfigurationRequestTypeDef definition
class PutBucketAccelerateConfigurationRequestTypeDef(TypedDict):
Bucket: str,
AccelerateConfiguration: AccelerateConfigurationTypeDef, # (1)
ExpectedBucketOwner: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)DeleteMarkerEntryTypeDef#
# DeleteMarkerEntryTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteMarkerEntryTypeDef
def get_value() -> DeleteMarkerEntryTypeDef:
return {
"Owner": ...,
}
# DeleteMarkerEntryTypeDef definition
class DeleteMarkerEntryTypeDef(TypedDict):
Owner: NotRequired[OwnerTypeDef], # (1)
Key: NotRequired[str],
VersionId: NotRequired[str],
IsLatest: NotRequired[bool],
LastModified: NotRequired[datetime],- See OwnerTypeDef
AnalyticsAndOperatorOutputTypeDef#
# AnalyticsAndOperatorOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsAndOperatorOutputTypeDef
def get_value() -> AnalyticsAndOperatorOutputTypeDef:
return {
"Prefix": ...,
}
# AnalyticsAndOperatorOutputTypeDef definition
class AnalyticsAndOperatorOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)- See TagTypeDef
AnalyticsAndOperatorTypeDef#
# AnalyticsAndOperatorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsAndOperatorTypeDef
def get_value() -> AnalyticsAndOperatorTypeDef:
return {
"Prefix": ...,
}
# AnalyticsAndOperatorTypeDef definition
class AnalyticsAndOperatorTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)- See TagTypeDef
GetBucketTaggingOutputTypeDef#
# GetBucketTaggingOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketTaggingOutputTypeDef
def get_value() -> GetBucketTaggingOutputTypeDef:
return {
"TagSet": ...,
}
# GetBucketTaggingOutputTypeDef definition
class GetBucketTaggingOutputTypeDef(TypedDict):
TagSet: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See TagTypeDef
- See ResponseMetadataTypeDef
GetObjectTaggingOutputTypeDef#
# GetObjectTaggingOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectTaggingOutputTypeDef
def get_value() -> GetObjectTaggingOutputTypeDef:
return {
"VersionId": ...,
}
# GetObjectTaggingOutputTypeDef definition
class GetObjectTaggingOutputTypeDef(TypedDict):
VersionId: str,
TagSet: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See TagTypeDef
- See ResponseMetadataTypeDef
IntelligentTieringAndOperatorOutputTypeDef#
# IntelligentTieringAndOperatorOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IntelligentTieringAndOperatorOutputTypeDef
def get_value() -> IntelligentTieringAndOperatorOutputTypeDef:
return {
"Prefix": ...,
}
# IntelligentTieringAndOperatorOutputTypeDef definition
class IntelligentTieringAndOperatorOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)- See TagTypeDef
IntelligentTieringAndOperatorTypeDef#
# IntelligentTieringAndOperatorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IntelligentTieringAndOperatorTypeDef
def get_value() -> IntelligentTieringAndOperatorTypeDef:
return {
"Prefix": ...,
}
# IntelligentTieringAndOperatorTypeDef definition
class IntelligentTieringAndOperatorTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)- See TagTypeDef
LifecycleRuleAndOperatorOutputTypeDef#
# LifecycleRuleAndOperatorOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleRuleAndOperatorOutputTypeDef
def get_value() -> LifecycleRuleAndOperatorOutputTypeDef:
return {
"Prefix": ...,
}
# LifecycleRuleAndOperatorOutputTypeDef definition
class LifecycleRuleAndOperatorOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)
ObjectSizeGreaterThan: NotRequired[int],
ObjectSizeLessThan: NotRequired[int],- See TagTypeDef
LifecycleRuleAndOperatorTypeDef#
# LifecycleRuleAndOperatorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleRuleAndOperatorTypeDef
def get_value() -> LifecycleRuleAndOperatorTypeDef:
return {
"Prefix": ...,
}
# LifecycleRuleAndOperatorTypeDef definition
class LifecycleRuleAndOperatorTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
ObjectSizeGreaterThan: NotRequired[int],
ObjectSizeLessThan: NotRequired[int],- See TagTypeDef
MetricsAndOperatorOutputTypeDef#
# MetricsAndOperatorOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsAndOperatorOutputTypeDef
def get_value() -> MetricsAndOperatorOutputTypeDef:
return {
"Prefix": ...,
}
# MetricsAndOperatorOutputTypeDef definition
class MetricsAndOperatorOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)
AccessPointArn: NotRequired[str],- See TagTypeDef
MetricsAndOperatorTypeDef#
# MetricsAndOperatorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsAndOperatorTypeDef
def get_value() -> MetricsAndOperatorTypeDef:
return {
"Prefix": ...,
}
# MetricsAndOperatorTypeDef definition
class MetricsAndOperatorTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
AccessPointArn: NotRequired[str],- See TagTypeDef
ReplicationRuleAndOperatorOutputTypeDef#
# ReplicationRuleAndOperatorOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationRuleAndOperatorOutputTypeDef
def get_value() -> ReplicationRuleAndOperatorOutputTypeDef:
return {
"Prefix": ...,
}
# ReplicationRuleAndOperatorOutputTypeDef definition
class ReplicationRuleAndOperatorOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[List[TagTypeDef]], # (1)- See TagTypeDef
ReplicationRuleAndOperatorTypeDef#
# ReplicationRuleAndOperatorTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationRuleAndOperatorTypeDef
def get_value() -> ReplicationRuleAndOperatorTypeDef:
return {
"Prefix": ...,
}
# ReplicationRuleAndOperatorTypeDef definition
class ReplicationRuleAndOperatorTypeDef(TypedDict):
Prefix: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)- See TagTypeDef
TaggingTypeDef#
# TaggingTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TaggingTypeDef
def get_value() -> TaggingTypeDef:
return {
"TagSet": ...,
}
# TaggingTypeDef definition
class TaggingTypeDef(TypedDict):
TagSet: Sequence[TagTypeDef], # (1)- See TagTypeDef
AnalyticsExportDestinationTypeDef#
# AnalyticsExportDestinationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsExportDestinationTypeDef
def get_value() -> AnalyticsExportDestinationTypeDef:
return {
"S3BucketDestination": ...,
}
# AnalyticsExportDestinationTypeDef definition
class AnalyticsExportDestinationTypeDef(TypedDict):
S3BucketDestination: AnalyticsS3BucketDestinationTypeDef, # (1)PutObjectRequestBucketPutObjectTypeDef#
# PutObjectRequestBucketPutObjectTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectRequestBucketPutObjectTypeDef
def get_value() -> PutObjectRequestBucketPutObjectTypeDef:
return {
"Key": ...,
}
# PutObjectRequestBucketPutObjectTypeDef definition
class PutObjectRequestBucketPutObjectTypeDef(TypedDict):
Key: str,
ACL: NotRequired[ObjectCannedACLType], # (1)
Body: NotRequired[BlobTypeDef],
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],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
IfMatch: NotRequired[str],
IfNoneMatch: NotRequired[str],
GrantFullControl: NotRequired[str],
GrantRead: NotRequired[str],
GrantReadACP: NotRequired[str],
GrantWriteACP: NotRequired[str],
WriteOffsetBytes: NotRequired[int],
Metadata: NotRequired[Mapping[str, str]],
ServerSideEncryption: NotRequired[ServerSideEncryptionType], # (3)
StorageClass: NotRequired[StorageClassType], # (4)
WebsiteRedirectLocation: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (5)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (6)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (7)
ExpectedBucketOwner: NotRequired[str],- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
PutObjectRequestObjectPutTypeDef#
# PutObjectRequestObjectPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectRequestObjectPutTypeDef
def get_value() -> PutObjectRequestObjectPutTypeDef:
return {
"ACL": ...,
}
# PutObjectRequestObjectPutTypeDef definition
class PutObjectRequestObjectPutTypeDef(TypedDict):
ACL: NotRequired[ObjectCannedACLType], # (1)
Body: NotRequired[BlobTypeDef],
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],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
IfMatch: NotRequired[str],
IfNoneMatch: NotRequired[str],
GrantFullControl: NotRequired[str],
GrantRead: NotRequired[str],
GrantReadACP: NotRequired[str],
GrantWriteACP: NotRequired[str],
WriteOffsetBytes: NotRequired[int],
Metadata: NotRequired[Mapping[str, str]],
ServerSideEncryption: NotRequired[ServerSideEncryptionType], # (3)
StorageClass: NotRequired[StorageClassType], # (4)
WebsiteRedirectLocation: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (5)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (6)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (7)
ExpectedBucketOwner: NotRequired[str],- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
PutObjectRequestObjectSummaryPutTypeDef#
# PutObjectRequestObjectSummaryPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectRequestObjectSummaryPutTypeDef
def get_value() -> PutObjectRequestObjectSummaryPutTypeDef:
return {
"ACL": ...,
}
# PutObjectRequestObjectSummaryPutTypeDef definition
class PutObjectRequestObjectSummaryPutTypeDef(TypedDict):
ACL: NotRequired[ObjectCannedACLType], # (1)
Body: NotRequired[BlobTypeDef],
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],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
IfMatch: NotRequired[str],
IfNoneMatch: NotRequired[str],
GrantFullControl: NotRequired[str],
GrantRead: NotRequired[str],
GrantReadACP: NotRequired[str],
GrantWriteACP: NotRequired[str],
WriteOffsetBytes: NotRequired[int],
Metadata: NotRequired[Mapping[str, str]],
ServerSideEncryption: NotRequired[ServerSideEncryptionType], # (3)
StorageClass: NotRequired[StorageClassType], # (4)
WebsiteRedirectLocation: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (5)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (6)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (7)
ExpectedBucketOwner: NotRequired[str],- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
PutObjectRequestTypeDef#
# PutObjectRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectRequestTypeDef
def get_value() -> PutObjectRequestTypeDef:
return {
"Bucket": ...,
}
# PutObjectRequestTypeDef definition
class PutObjectRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
ACL: NotRequired[ObjectCannedACLType], # (1)
Body: NotRequired[BlobTypeDef],
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],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
IfMatch: NotRequired[str],
IfNoneMatch: NotRequired[str],
GrantFullControl: NotRequired[str],
GrantRead: NotRequired[str],
GrantReadACP: NotRequired[str],
GrantWriteACP: NotRequired[str],
WriteOffsetBytes: NotRequired[int],
Metadata: NotRequired[Mapping[str, str]],
ServerSideEncryption: NotRequired[ServerSideEncryptionType], # (3)
StorageClass: NotRequired[StorageClassType], # (4)
WebsiteRedirectLocation: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
RequestPayer: NotRequired[RequestPayerType], # (5)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (6)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (7)
ExpectedBucketOwner: NotRequired[str],- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
UploadPartRequestMultipartUploadPartUploadTypeDef#
# UploadPartRequestMultipartUploadPartUploadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import UploadPartRequestMultipartUploadPartUploadTypeDef
def get_value() -> UploadPartRequestMultipartUploadPartUploadTypeDef:
return {
"Body": ...,
}
# UploadPartRequestMultipartUploadPartUploadTypeDef definition
class UploadPartRequestMultipartUploadPartUploadTypeDef(TypedDict):
Body: NotRequired[BlobTypeDef],
ContentLength: NotRequired[int],
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (2)
ExpectedBucketOwner: NotRequired[str],UploadPartRequestTypeDef#
# UploadPartRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import UploadPartRequestTypeDef
def get_value() -> UploadPartRequestTypeDef:
return {
"Bucket": ...,
}
# UploadPartRequestTypeDef definition
class UploadPartRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
PartNumber: int,
UploadId: str,
Body: NotRequired[BlobTypeDef],
ContentLength: NotRequired[int],
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (2)
ExpectedBucketOwner: NotRequired[str],WriteGetObjectResponseRequestTypeDef#
# WriteGetObjectResponseRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import WriteGetObjectResponseRequestTypeDef
def get_value() -> WriteGetObjectResponseRequestTypeDef:
return {
"RequestRoute": ...,
}
# WriteGetObjectResponseRequestTypeDef definition
class WriteGetObjectResponseRequestTypeDef(TypedDict):
RequestRoute: str,
RequestToken: str,
Body: NotRequired[BlobTypeDef],
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],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
DeleteMarker: NotRequired[bool],
ETag: NotRequired[str],
Expires: NotRequired[TimestampTypeDef],
Expiration: NotRequired[str],
LastModified: NotRequired[TimestampTypeDef],
MissingMeta: NotRequired[int],
Metadata: NotRequired[Mapping[str, str]],
ObjectLockMode: NotRequired[ObjectLockModeType], # (1)
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (2)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
PartsCount: NotRequired[int],
ReplicationStatus: NotRequired[ReplicationStatusType], # (3)
RequestCharged: NotRequired[RequestChargedType], # (4)
Restore: NotRequired[str],
ServerSideEncryption: NotRequired[ServerSideEncryptionType], # (5)
SSECustomerAlgorithm: NotRequired[str],
SSEKMSKeyId: NotRequired[str],
StorageClass: NotRequired[StorageClassType], # (6)
TagCount: NotRequired[int],
VersionId: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
- See ReplicationStatusType
- See RequestChargedType
- See ServerSideEncryptionType
- See StorageClassType
BucketCopyRequestTypeDef#
# BucketCopyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketCopyRequestTypeDef
def get_value() -> BucketCopyRequestTypeDef:
return {
"CopySource": ...,
}
# BucketCopyRequestTypeDef definition
class BucketCopyRequestTypeDef(TypedDict):
CopySource: CopySourceTypeDef, # (1)
Key: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
SourceClient: NotRequired[Union[BaseClient, None]],
Config: NotRequired[Union[TransferConfig, None]],ClientCopyRequestTypeDef#
# ClientCopyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ClientCopyRequestTypeDef
def get_value() -> ClientCopyRequestTypeDef:
return {
"CopySource": ...,
}
# ClientCopyRequestTypeDef definition
class ClientCopyRequestTypeDef(TypedDict):
CopySource: CopySourceTypeDef, # (1)
Bucket: str,
Key: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
SourceClient: NotRequired[Union[BaseClient, None]],
Config: NotRequired[Union[TransferConfig, None]],ObjectCopyRequestTypeDef#
# ObjectCopyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectCopyRequestTypeDef
def get_value() -> ObjectCopyRequestTypeDef:
return {
"CopySource": ...,
}
# ObjectCopyRequestTypeDef definition
class ObjectCopyRequestTypeDef(TypedDict):
CopySource: CopySourceTypeDef, # (1)
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
SourceClient: NotRequired[Union[BaseClient, None]],
Config: NotRequired[Union[TransferConfig, None]],BucketDownloadFileobjRequestTypeDef#
# BucketDownloadFileobjRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketDownloadFileobjRequestTypeDef
def get_value() -> BucketDownloadFileobjRequestTypeDef:
return {
"Key": ...,
}
# BucketDownloadFileobjRequestTypeDef definition
class BucketDownloadFileobjRequestTypeDef(TypedDict):
Key: str,
Fileobj: FileobjTypeDef,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],BucketUploadFileobjRequestTypeDef#
# BucketUploadFileobjRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketUploadFileobjRequestTypeDef
def get_value() -> BucketUploadFileobjRequestTypeDef:
return {
"Fileobj": ...,
}
# BucketUploadFileobjRequestTypeDef definition
class BucketUploadFileobjRequestTypeDef(TypedDict):
Fileobj: FileobjTypeDef,
Key: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],ClientDownloadFileobjRequestTypeDef#
# ClientDownloadFileobjRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ClientDownloadFileobjRequestTypeDef
def get_value() -> ClientDownloadFileobjRequestTypeDef:
return {
"Bucket": ...,
}
# ClientDownloadFileobjRequestTypeDef definition
class ClientDownloadFileobjRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
Fileobj: FileobjTypeDef,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],ClientUploadFileobjRequestTypeDef#
# ClientUploadFileobjRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ClientUploadFileobjRequestTypeDef
def get_value() -> ClientUploadFileobjRequestTypeDef:
return {
"Fileobj": ...,
}
# ClientUploadFileobjRequestTypeDef definition
class ClientUploadFileobjRequestTypeDef(TypedDict):
Fileobj: FileobjTypeDef,
Bucket: str,
Key: str,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],ObjectDownloadFileobjRequestTypeDef#
# ObjectDownloadFileobjRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectDownloadFileobjRequestTypeDef
def get_value() -> ObjectDownloadFileobjRequestTypeDef:
return {
"Fileobj": ...,
}
# ObjectDownloadFileobjRequestTypeDef definition
class ObjectDownloadFileobjRequestTypeDef(TypedDict):
Fileobj: FileobjTypeDef,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],ObjectUploadFileobjRequestTypeDef#
# ObjectUploadFileobjRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectUploadFileobjRequestTypeDef
def get_value() -> ObjectUploadFileobjRequestTypeDef:
return {
"Fileobj": ...,
}
# ObjectUploadFileobjRequestTypeDef definition
class ObjectUploadFileobjRequestTypeDef(TypedDict):
Fileobj: FileobjTypeDef,
ExtraArgs: NotRequired[Union[Dict[str, Any], None]],
Callback: NotRequired[Union[Callable[..., Any], None]],
Config: NotRequired[Union[TransferConfig, None]],ListBucketsOutputTypeDef#
# ListBucketsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketsOutputTypeDef
def get_value() -> ListBucketsOutputTypeDef:
return {
"Buckets": ...,
}
# ListBucketsOutputTypeDef definition
class ListBucketsOutputTypeDef(TypedDict):
Buckets: List[BucketTypeDef], # (1)
Owner: OwnerTypeDef, # (2)
ContinuationToken: str,
Prefix: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See BucketTypeDef
- See OwnerTypeDef
- See ResponseMetadataTypeDef
ListDirectoryBucketsOutputTypeDef#
# ListDirectoryBucketsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListDirectoryBucketsOutputTypeDef
def get_value() -> ListDirectoryBucketsOutputTypeDef:
return {
"Buckets": ...,
}
# ListDirectoryBucketsOutputTypeDef definition
class ListDirectoryBucketsOutputTypeDef(TypedDict):
Buckets: List[BucketTypeDef], # (1)
ContinuationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See BucketTypeDef
- See ResponseMetadataTypeDef
GetBucketCorsOutputTypeDef#
# GetBucketCorsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketCorsOutputTypeDef
def get_value() -> GetBucketCorsOutputTypeDef:
return {
"CORSRules": ...,
}
# GetBucketCorsOutputTypeDef definition
class GetBucketCorsOutputTypeDef(TypedDict):
CORSRules: List[CORSRuleOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CompletedMultipartUploadTypeDef#
# CompletedMultipartUploadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CompletedMultipartUploadTypeDef
def get_value() -> CompletedMultipartUploadTypeDef:
return {
"Parts": ...,
}
# CompletedMultipartUploadTypeDef definition
class CompletedMultipartUploadTypeDef(TypedDict):
Parts: NotRequired[Sequence[CompletedPartTypeDef]], # (1)CopyObjectOutputTypeDef#
# CopyObjectOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopyObjectOutputTypeDef
def get_value() -> CopyObjectOutputTypeDef:
return {
"CopyObjectResult": ...,
}
# CopyObjectOutputTypeDef 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)- See CopyObjectResultTypeDef
- See ServerSideEncryptionType
- See RequestChargedType
- See ResponseMetadataTypeDef
UploadPartCopyOutputTypeDef#
# UploadPartCopyOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import UploadPartCopyOutputTypeDef
def get_value() -> UploadPartCopyOutputTypeDef:
return {
"CopySourceVersionId": ...,
}
# UploadPartCopyOutputTypeDef 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)- See CopyPartResultTypeDef
- See ServerSideEncryptionType
- See RequestChargedType
- See ResponseMetadataTypeDef
CreateBucketConfigurationTypeDef#
# CreateBucketConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateBucketConfigurationTypeDef
def get_value() -> CreateBucketConfigurationTypeDef:
return {
"LocationConstraint": ...,
}
# CreateBucketConfigurationTypeDef definition
class CreateBucketConfigurationTypeDef(TypedDict):
LocationConstraint: NotRequired[BucketLocationConstraintType], # (1)
Location: NotRequired[LocationInfoTypeDef], # (2)
Bucket: NotRequired[BucketInfoTypeDef], # (3)CreateSessionOutputTypeDef#
# CreateSessionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateSessionOutputTypeDef
def get_value() -> CreateSessionOutputTypeDef:
return {
"ServerSideEncryption": ...,
}
# CreateSessionOutputTypeDef definition
class CreateSessionOutputTypeDef(TypedDict):
ServerSideEncryption: ServerSideEncryptionType, # (1)
SSEKMSKeyId: str,
SSEKMSEncryptionContext: str,
BucketKeyEnabled: bool,
Credentials: SessionCredentialsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)ObjectLockRuleTypeDef#
# ObjectLockRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectLockRuleTypeDef
def get_value() -> ObjectLockRuleTypeDef:
return {
"DefaultRetention": ...,
}
# ObjectLockRuleTypeDef definition
class ObjectLockRuleTypeDef(TypedDict):
DefaultRetention: NotRequired[DefaultRetentionTypeDef], # (1)DeleteObjectsOutputTypeDef#
# DeleteObjectsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectsOutputTypeDef
def get_value() -> DeleteObjectsOutputTypeDef:
return {
"Deleted": ...,
}
# DeleteObjectsOutputTypeDef definition
class DeleteObjectsOutputTypeDef(TypedDict):
Deleted: List[DeletedObjectTypeDef], # (1)
RequestCharged: RequestChargedType, # (2)
Errors: List[ErrorTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See DeletedObjectTypeDef
- See RequestChargedType
- See ErrorTypeDef
- See ResponseMetadataTypeDef
S3KeyFilterOutputTypeDef#
# S3KeyFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import S3KeyFilterOutputTypeDef
def get_value() -> S3KeyFilterOutputTypeDef:
return {
"FilterRules": ...,
}
# S3KeyFilterOutputTypeDef definition
class S3KeyFilterOutputTypeDef(TypedDict):
FilterRules: NotRequired[List[FilterRuleTypeDef]], # (1)S3KeyFilterTypeDef#
# S3KeyFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import S3KeyFilterTypeDef
def get_value() -> S3KeyFilterTypeDef:
return {
"FilterRules": ...,
}
# S3KeyFilterTypeDef definition
class S3KeyFilterTypeDef(TypedDict):
FilterRules: NotRequired[Sequence[FilterRuleTypeDef]], # (1)GetBucketPolicyStatusOutputTypeDef#
# GetBucketPolicyStatusOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketPolicyStatusOutputTypeDef
def get_value() -> GetBucketPolicyStatusOutputTypeDef:
return {
"PolicyStatus": ...,
}
# GetBucketPolicyStatusOutputTypeDef definition
class GetBucketPolicyStatusOutputTypeDef(TypedDict):
PolicyStatus: PolicyStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetObjectAttributesPartsTypeDef#
# GetObjectAttributesPartsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectAttributesPartsTypeDef
def get_value() -> GetObjectAttributesPartsTypeDef:
return {
"TotalPartsCount": ...,
}
# GetObjectAttributesPartsTypeDef definition
class GetObjectAttributesPartsTypeDef(TypedDict):
TotalPartsCount: NotRequired[int],
PartNumberMarker: NotRequired[int],
NextPartNumberMarker: NotRequired[int],
MaxParts: NotRequired[int],
IsTruncated: NotRequired[bool],
Parts: NotRequired[List[ObjectPartTypeDef]], # (1)GetObjectLegalHoldOutputTypeDef#
# GetObjectLegalHoldOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectLegalHoldOutputTypeDef
def get_value() -> GetObjectLegalHoldOutputTypeDef:
return {
"LegalHold": ...,
}
# GetObjectLegalHoldOutputTypeDef definition
class GetObjectLegalHoldOutputTypeDef(TypedDict):
LegalHold: ObjectLockLegalHoldTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectLegalHoldRequestTypeDef#
# PutObjectLegalHoldRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectLegalHoldRequestTypeDef
def get_value() -> PutObjectLegalHoldRequestTypeDef:
return {
"Bucket": ...,
}
# PutObjectLegalHoldRequestTypeDef definition
class PutObjectLegalHoldRequestTypeDef(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],GetObjectRetentionOutputTypeDef#
# GetObjectRetentionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectRetentionOutputTypeDef
def get_value() -> GetObjectRetentionOutputTypeDef:
return {
"Retention": ...,
}
# GetObjectRetentionOutputTypeDef definition
class GetObjectRetentionOutputTypeDef(TypedDict):
Retention: ObjectLockRetentionOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetPublicAccessBlockOutputTypeDef#
# GetPublicAccessBlockOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetPublicAccessBlockOutputTypeDef
def get_value() -> GetPublicAccessBlockOutputTypeDef:
return {
"PublicAccessBlockConfiguration": ...,
}
# GetPublicAccessBlockOutputTypeDef definition
class GetPublicAccessBlockOutputTypeDef(TypedDict):
PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutPublicAccessBlockRequestTypeDef#
# PutPublicAccessBlockRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutPublicAccessBlockRequestTypeDef
def get_value() -> PutPublicAccessBlockRequestTypeDef:
return {
"Bucket": ...,
}
# PutPublicAccessBlockRequestTypeDef definition
class PutPublicAccessBlockRequestTypeDef(TypedDict):
Bucket: str,
PublicAccessBlockConfiguration: PublicAccessBlockConfigurationTypeDef, # (1)
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],GrantTypeDef#
# GrantTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GrantTypeDef
def get_value() -> GrantTypeDef:
return {
"Grantee": ...,
}
# GrantTypeDef definition
class GrantTypeDef(TypedDict):
Grantee: NotRequired[GranteeTypeDef], # (1)
Permission: NotRequired[PermissionType], # (2)- See GranteeTypeDef
- See PermissionType
TargetGrantTypeDef#
# TargetGrantTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TargetGrantTypeDef
def get_value() -> TargetGrantTypeDef:
return {
"Grantee": ...,
}
# TargetGrantTypeDef definition
class TargetGrantTypeDef(TypedDict):
Grantee: NotRequired[GranteeTypeDef], # (1)
Permission: NotRequired[BucketLogsPermissionType], # (2)HeadBucketRequestWaitExtraTypeDef#
# HeadBucketRequestWaitExtraTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadBucketRequestWaitExtraTypeDef
def get_value() -> HeadBucketRequestWaitExtraTypeDef:
return {
"Bucket": ...,
}
# HeadBucketRequestWaitExtraTypeDef definition
class HeadBucketRequestWaitExtraTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)HeadBucketRequestWaitTypeDef#
# HeadBucketRequestWaitTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadBucketRequestWaitTypeDef
def get_value() -> HeadBucketRequestWaitTypeDef:
return {
"Bucket": ...,
}
# HeadBucketRequestWaitTypeDef definition
class HeadBucketRequestWaitTypeDef(TypedDict):
Bucket: str,
ExpectedBucketOwner: NotRequired[str],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)HeadObjectRequestWaitExtraTypeDef#
# HeadObjectRequestWaitExtraTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadObjectRequestWaitExtraTypeDef
def get_value() -> HeadObjectRequestWaitExtraTypeDef:
return {
"Bucket": ...,
}
# HeadObjectRequestWaitExtraTypeDef definition
class HeadObjectRequestWaitExtraTypeDef(TypedDict):
Bucket: str,
Key: str,
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
VersionId: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (3)- See RequestPayerType
- See ChecksumModeType
- See WaiterConfigTypeDef
HeadObjectRequestWaitTypeDef#
# HeadObjectRequestWaitTypeDef TypedDict usage example
from types_boto3_s3.type_defs import HeadObjectRequestWaitTypeDef
def get_value() -> HeadObjectRequestWaitTypeDef:
return {
"Bucket": ...,
}
# HeadObjectRequestWaitTypeDef definition
class HeadObjectRequestWaitTypeDef(TypedDict):
Bucket: str,
Key: str,
IfMatch: NotRequired[str],
IfModifiedSince: NotRequired[TimestampTypeDef],
IfNoneMatch: NotRequired[str],
IfUnmodifiedSince: NotRequired[TimestampTypeDef],
Range: NotRequired[str],
ResponseCacheControl: NotRequired[str],
ResponseContentDisposition: NotRequired[str],
ResponseContentEncoding: NotRequired[str],
ResponseContentLanguage: NotRequired[str],
ResponseContentType: NotRequired[str],
ResponseExpires: NotRequired[TimestampTypeDef],
VersionId: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (1)
PartNumber: NotRequired[int],
ExpectedBucketOwner: NotRequired[str],
ChecksumMode: NotRequired[ChecksumModeType], # (2)
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (3)- See RequestPayerType
- See ChecksumModeType
- See WaiterConfigTypeDef
MultipartUploadTypeDef#
# MultipartUploadTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MultipartUploadTypeDef
def get_value() -> MultipartUploadTypeDef:
return {
"UploadId": ...,
}
# MultipartUploadTypeDef 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)
ChecksumType: NotRequired[ChecksumTypeType], # (5)- See StorageClassType
- See OwnerTypeDef
- See InitiatorTypeDef
- See ChecksumAlgorithmType
- See ChecksumTypeType
InputSerializationTypeDef#
# InputSerializationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InputSerializationTypeDef
def get_value() -> InputSerializationTypeDef:
return {
"CSV": ...,
}
# InputSerializationTypeDef definition
class InputSerializationTypeDef(TypedDict):
CSV: NotRequired[CSVInputTypeDef], # (1)
CompressionType: NotRequired[CompressionTypeType], # (2)
JSON: NotRequired[JSONInputTypeDef], # (3)
Parquet: NotRequired[Mapping[str, Any]],- See CSVInputTypeDef
- See CompressionTypeType
- See JSONInputTypeDef
InventoryEncryptionOutputTypeDef#
# InventoryEncryptionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryEncryptionOutputTypeDef
def get_value() -> InventoryEncryptionOutputTypeDef:
return {
"SSES3": ...,
}
# InventoryEncryptionOutputTypeDef definition
class InventoryEncryptionOutputTypeDef(TypedDict):
SSES3: NotRequired[Dict[str, Any]],
SSEKMS: NotRequired[SSEKMSTypeDef], # (1)- See SSEKMSTypeDef
InventoryEncryptionTypeDef#
# InventoryEncryptionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryEncryptionTypeDef
def get_value() -> InventoryEncryptionTypeDef:
return {
"SSES3": ...,
}
# InventoryEncryptionTypeDef definition
class InventoryEncryptionTypeDef(TypedDict):
SSES3: NotRequired[Mapping[str, Any]],
SSEKMS: NotRequired[SSEKMSTypeDef], # (1)- See SSEKMSTypeDef
OutputSerializationTypeDef#
# OutputSerializationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import OutputSerializationTypeDef
def get_value() -> OutputSerializationTypeDef:
return {
"CSV": ...,
}
# OutputSerializationTypeDef definition
class OutputSerializationTypeDef(TypedDict):
CSV: NotRequired[CSVOutputTypeDef], # (1)
JSON: NotRequired[JSONOutputTypeDef], # (2)- See CSVOutputTypeDef
- See JSONOutputTypeDef
RuleOutputTypeDef#
# RuleOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RuleOutputTypeDef
def get_value() -> RuleOutputTypeDef:
return {
"Expiration": ...,
}
# RuleOutputTypeDef definition
class RuleOutputTypeDef(TypedDict):
Prefix: str,
Status: ExpirationStatusType, # (2)
Expiration: NotRequired[LifecycleExpirationOutputTypeDef], # (1)
ID: NotRequired[str],
Transition: NotRequired[TransitionOutputTypeDef], # (3)
NoncurrentVersionTransition: NotRequired[NoncurrentVersionTransitionTypeDef], # (4)
NoncurrentVersionExpiration: NotRequired[NoncurrentVersionExpirationTypeDef], # (5)
AbortIncompleteMultipartUpload: NotRequired[AbortIncompleteMultipartUploadTypeDef], # (6)- See LifecycleExpirationOutputTypeDef
- See ExpirationStatusType
- See TransitionOutputTypeDef
- See NoncurrentVersionTransitionTypeDef
- See NoncurrentVersionExpirationTypeDef
- See AbortIncompleteMultipartUploadTypeDef
ListBucketsRequestPaginateTypeDef#
# ListBucketsRequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketsRequestPaginateTypeDef
def get_value() -> ListBucketsRequestPaginateTypeDef:
return {
"Prefix": ...,
}
# ListBucketsRequestPaginateTypeDef definition
class ListBucketsRequestPaginateTypeDef(TypedDict):
Prefix: NotRequired[str],
BucketRegion: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDirectoryBucketsRequestPaginateTypeDef#
# ListDirectoryBucketsRequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListDirectoryBucketsRequestPaginateTypeDef
def get_value() -> ListDirectoryBucketsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListDirectoryBucketsRequestPaginateTypeDef definition
class ListDirectoryBucketsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListMultipartUploadsRequestPaginateTypeDef#
# ListMultipartUploadsRequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListMultipartUploadsRequestPaginateTypeDef
def get_value() -> ListMultipartUploadsRequestPaginateTypeDef:
return {
"Bucket": ...,
}
# ListMultipartUploadsRequestPaginateTypeDef definition
class ListMultipartUploadsRequestPaginateTypeDef(TypedDict):
Bucket: str,
Delimiter: NotRequired[str],
EncodingType: NotRequired[EncodingTypeType], # (1)
Prefix: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See EncodingTypeType
- See RequestPayerType
- See PaginatorConfigTypeDef
ListObjectVersionsRequestPaginateTypeDef#
# ListObjectVersionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectVersionsRequestPaginateTypeDef
def get_value() -> ListObjectVersionsRequestPaginateTypeDef:
return {
"Bucket": ...,
}
# ListObjectVersionsRequestPaginateTypeDef definition
class ListObjectVersionsRequestPaginateTypeDef(TypedDict):
Bucket: str,
Delimiter: NotRequired[str],
EncodingType: NotRequired[EncodingTypeType], # (1)
Prefix: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (2)
OptionalObjectAttributes: NotRequired[Sequence[OptionalObjectAttributesType]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See EncodingTypeType
- See RequestPayerType
- See OptionalObjectAttributesType
- See PaginatorConfigTypeDef
ListObjectsRequestPaginateTypeDef#
# ListObjectsRequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectsRequestPaginateTypeDef
def get_value() -> ListObjectsRequestPaginateTypeDef:
return {
"Bucket": ...,
}
# ListObjectsRequestPaginateTypeDef definition
class ListObjectsRequestPaginateTypeDef(TypedDict):
Bucket: str,
Delimiter: NotRequired[str],
EncodingType: NotRequired[EncodingTypeType], # (1)
Prefix: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (2)
ExpectedBucketOwner: NotRequired[str],
OptionalObjectAttributes: NotRequired[Sequence[OptionalObjectAttributesType]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See EncodingTypeType
- See RequestPayerType
- See OptionalObjectAttributesType
- See PaginatorConfigTypeDef
ListObjectsV2RequestPaginateTypeDef#
# ListObjectsV2RequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectsV2RequestPaginateTypeDef
def get_value() -> ListObjectsV2RequestPaginateTypeDef:
return {
"Bucket": ...,
}
# ListObjectsV2RequestPaginateTypeDef definition
class ListObjectsV2RequestPaginateTypeDef(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],
OptionalObjectAttributes: NotRequired[Sequence[OptionalObjectAttributesType]], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)- See EncodingTypeType
- See RequestPayerType
- See OptionalObjectAttributesType
- See PaginatorConfigTypeDef
ListPartsRequestPaginateTypeDef#
# ListPartsRequestPaginateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListPartsRequestPaginateTypeDef
def get_value() -> ListPartsRequestPaginateTypeDef:
return {
"Bucket": ...,
}
# ListPartsRequestPaginateTypeDef definition
class ListPartsRequestPaginateTypeDef(TypedDict):
Bucket: str,
Key: str,
UploadId: str,
RequestPayer: NotRequired[RequestPayerType], # (1)
ExpectedBucketOwner: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListPartsOutputTypeDef#
# ListPartsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListPartsOutputTypeDef
def get_value() -> ListPartsOutputTypeDef:
return {
"AbortDate": ...,
}
# ListPartsOutputTypeDef 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)
ChecksumType: ChecksumTypeType, # (7)
ResponseMetadata: ResponseMetadataTypeDef, # (8)- See PartTypeDef
- See InitiatorTypeDef
- See OwnerTypeDef
- See StorageClassType
- See RequestChargedType
- See ChecksumAlgorithmType
- See ChecksumTypeType
- See ResponseMetadataTypeDef
MetadataTableConfigurationResultTypeDef#
# MetadataTableConfigurationResultTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetadataTableConfigurationResultTypeDef
def get_value() -> MetadataTableConfigurationResultTypeDef:
return {
"S3TablesDestinationResult": ...,
}
# MetadataTableConfigurationResultTypeDef definition
class MetadataTableConfigurationResultTypeDef(TypedDict):
S3TablesDestinationResult: S3TablesDestinationResultTypeDef, # (1)MetadataTableConfigurationTypeDef#
# MetadataTableConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetadataTableConfigurationTypeDef
def get_value() -> MetadataTableConfigurationTypeDef:
return {
"S3TablesDestination": ...,
}
# MetadataTableConfigurationTypeDef definition
class MetadataTableConfigurationTypeDef(TypedDict):
S3TablesDestination: S3TablesDestinationTypeDef, # (1)MetricsTypeDef#
# MetricsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsTypeDef
def get_value() -> MetricsTypeDef:
return {
"Status": ...,
}
# MetricsTypeDef definition
class MetricsTypeDef(TypedDict):
Status: MetricsStatusType, # (1)
EventThreshold: NotRequired[ReplicationTimeValueTypeDef], # (2)ReplicationTimeTypeDef#
# ReplicationTimeTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationTimeTypeDef
def get_value() -> ReplicationTimeTypeDef:
return {
"Status": ...,
}
# ReplicationTimeTypeDef definition
class ReplicationTimeTypeDef(TypedDict):
Status: ReplicationTimeStatusType, # (1)
Time: ReplicationTimeValueTypeDef, # (2)NotificationConfigurationDeprecatedResponseTypeDef#
# NotificationConfigurationDeprecatedResponseTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NotificationConfigurationDeprecatedResponseTypeDef
def get_value() -> NotificationConfigurationDeprecatedResponseTypeDef:
return {
"TopicConfiguration": ...,
}
# NotificationConfigurationDeprecatedResponseTypeDef definition
class NotificationConfigurationDeprecatedResponseTypeDef(TypedDict):
TopicConfiguration: TopicConfigurationDeprecatedOutputTypeDef, # (1)
QueueConfiguration: QueueConfigurationDeprecatedOutputTypeDef, # (2)
CloudFunctionConfiguration: CloudFunctionConfigurationOutputTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See TopicConfigurationDeprecatedOutputTypeDef
- See QueueConfigurationDeprecatedOutputTypeDef
- See CloudFunctionConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
ObjectTypeDef#
# ObjectTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectTypeDef
def get_value() -> ObjectTypeDef:
return {
"Key": ...,
}
# ObjectTypeDef definition
class ObjectTypeDef(TypedDict):
Key: NotRequired[str],
LastModified: NotRequired[datetime],
ETag: NotRequired[str],
ChecksumAlgorithm: NotRequired[List[ChecksumAlgorithmType]], # (1)
ChecksumType: NotRequired[ChecksumTypeType], # (2)
Size: NotRequired[int],
StorageClass: NotRequired[ObjectStorageClassType], # (3)
Owner: NotRequired[OwnerTypeDef], # (4)
RestoreStatus: NotRequired[RestoreStatusTypeDef], # (5)- See ChecksumAlgorithmType
- See ChecksumTypeType
- See ObjectStorageClassType
- See OwnerTypeDef
- See RestoreStatusTypeDef
ObjectVersionTypeDef#
# ObjectVersionTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectVersionTypeDef
def get_value() -> ObjectVersionTypeDef:
return {
"ETag": ...,
}
# ObjectVersionTypeDef definition
class ObjectVersionTypeDef(TypedDict):
ETag: NotRequired[str],
ChecksumAlgorithm: NotRequired[List[ChecksumAlgorithmType]], # (1)
ChecksumType: NotRequired[ChecksumTypeType], # (2)
Size: NotRequired[int],
StorageClass: NotRequired[ObjectVersionStorageClassType], # (3)
Key: NotRequired[str],
VersionId: NotRequired[str],
IsLatest: NotRequired[bool],
LastModified: NotRequired[datetime],
Owner: NotRequired[OwnerTypeDef], # (4)
RestoreStatus: NotRequired[RestoreStatusTypeDef], # (5)- See ChecksumAlgorithmType
- See ChecksumTypeType
- See ObjectVersionStorageClassType
- See OwnerTypeDef
- See RestoreStatusTypeDef
OwnershipControlsOutputTypeDef#
# OwnershipControlsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import OwnershipControlsOutputTypeDef
def get_value() -> OwnershipControlsOutputTypeDef:
return {
"Rules": ...,
}
# OwnershipControlsOutputTypeDef definition
class OwnershipControlsOutputTypeDef(TypedDict):
Rules: List[OwnershipControlsRuleTypeDef], # (1)OwnershipControlsTypeDef#
# OwnershipControlsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import OwnershipControlsTypeDef
def get_value() -> OwnershipControlsTypeDef:
return {
"Rules": ...,
}
# OwnershipControlsTypeDef definition
class OwnershipControlsTypeDef(TypedDict):
Rules: Sequence[OwnershipControlsRuleTypeDef], # (1)TargetObjectKeyFormatOutputTypeDef#
# TargetObjectKeyFormatOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TargetObjectKeyFormatOutputTypeDef
def get_value() -> TargetObjectKeyFormatOutputTypeDef:
return {
"SimplePrefix": ...,
}
# TargetObjectKeyFormatOutputTypeDef definition
class TargetObjectKeyFormatOutputTypeDef(TypedDict):
SimplePrefix: NotRequired[Dict[str, Any]],
PartitionedPrefix: NotRequired[PartitionedPrefixTypeDef], # (1)TargetObjectKeyFormatTypeDef#
# TargetObjectKeyFormatTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TargetObjectKeyFormatTypeDef
def get_value() -> TargetObjectKeyFormatTypeDef:
return {
"SimplePrefix": ...,
}
# TargetObjectKeyFormatTypeDef definition
class TargetObjectKeyFormatTypeDef(TypedDict):
SimplePrefix: NotRequired[Mapping[str, Any]],
PartitionedPrefix: NotRequired[PartitionedPrefixTypeDef], # (1)ProgressEventTypeDef#
# ProgressEventTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ProgressEventTypeDef
def get_value() -> ProgressEventTypeDef:
return {
"Details": ...,
}
# ProgressEventTypeDef definition
class ProgressEventTypeDef(TypedDict):
Details: NotRequired[ProgressTypeDef], # (1)- See ProgressTypeDef
PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef#
# PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef
def get_value() -> PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef:
return {
"RequestPaymentConfiguration": ...,
}
# PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef definition
class PutBucketRequestPaymentRequestBucketRequestPaymentPutTypeDef(TypedDict):
RequestPaymentConfiguration: RequestPaymentConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketRequestPaymentRequestTypeDef#
# PutBucketRequestPaymentRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketRequestPaymentRequestTypeDef
def get_value() -> PutBucketRequestPaymentRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketRequestPaymentRequestTypeDef definition
class PutBucketRequestPaymentRequestTypeDef(TypedDict):
Bucket: str,
RequestPaymentConfiguration: RequestPaymentConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketVersioningRequestBucketVersioningPutTypeDef#
# PutBucketVersioningRequestBucketVersioningPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketVersioningRequestBucketVersioningPutTypeDef
def get_value() -> PutBucketVersioningRequestBucketVersioningPutTypeDef:
return {
"VersioningConfiguration": ...,
}
# PutBucketVersioningRequestBucketVersioningPutTypeDef definition
class PutBucketVersioningRequestBucketVersioningPutTypeDef(TypedDict):
VersioningConfiguration: VersioningConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
MFA: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],PutBucketVersioningRequestTypeDef#
# PutBucketVersioningRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketVersioningRequestTypeDef
def get_value() -> PutBucketVersioningRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketVersioningRequestTypeDef definition
class PutBucketVersioningRequestTypeDef(TypedDict):
Bucket: str,
VersioningConfiguration: VersioningConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
MFA: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],RoutingRuleTypeDef#
# RoutingRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RoutingRuleTypeDef
def get_value() -> RoutingRuleTypeDef:
return {
"Condition": ...,
}
# RoutingRuleTypeDef definition
class RoutingRuleTypeDef(TypedDict):
Redirect: RedirectTypeDef, # (2)
Condition: NotRequired[ConditionTypeDef], # (1)- See ConditionTypeDef
- See RedirectTypeDef
ServerSideEncryptionRuleTypeDef#
# ServerSideEncryptionRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ServerSideEncryptionRuleTypeDef
def get_value() -> ServerSideEncryptionRuleTypeDef:
return {
"ApplyServerSideEncryptionByDefault": ...,
}
# ServerSideEncryptionRuleTypeDef definition
class ServerSideEncryptionRuleTypeDef(TypedDict):
ApplyServerSideEncryptionByDefault: NotRequired[ServerSideEncryptionByDefaultTypeDef], # (1)
BucketKeyEnabled: NotRequired[bool],SourceSelectionCriteriaTypeDef#
# SourceSelectionCriteriaTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SourceSelectionCriteriaTypeDef
def get_value() -> SourceSelectionCriteriaTypeDef:
return {
"SseKmsEncryptedObjects": ...,
}
# SourceSelectionCriteriaTypeDef definition
class SourceSelectionCriteriaTypeDef(TypedDict):
SseKmsEncryptedObjects: NotRequired[SseKmsEncryptedObjectsTypeDef], # (1)
ReplicaModifications: NotRequired[ReplicaModificationsTypeDef], # (2)StatsEventTypeDef#
# StatsEventTypeDef TypedDict usage example
from types_boto3_s3.type_defs import StatsEventTypeDef
def get_value() -> StatsEventTypeDef:
return {
"Details": ...,
}
# StatsEventTypeDef definition
class StatsEventTypeDef(TypedDict):
Details: NotRequired[StatsTypeDef], # (1)- See StatsTypeDef
DeleteTypeDef#
# DeleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteTypeDef
def get_value() -> DeleteTypeDef:
return {
"Objects": ...,
}
# DeleteTypeDef definition
class DeleteTypeDef(TypedDict):
Objects: Sequence[ObjectIdentifierTypeDef], # (1)
Quiet: NotRequired[bool],AnalyticsFilterOutputTypeDef#
# AnalyticsFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsFilterOutputTypeDef
def get_value() -> AnalyticsFilterOutputTypeDef:
return {
"Prefix": ...,
}
# AnalyticsFilterOutputTypeDef definition
class AnalyticsFilterOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
And: NotRequired[AnalyticsAndOperatorOutputTypeDef], # (2)AnalyticsFilterTypeDef#
# AnalyticsFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsFilterTypeDef
def get_value() -> AnalyticsFilterTypeDef:
return {
"Prefix": ...,
}
# AnalyticsFilterTypeDef definition
class AnalyticsFilterTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
And: NotRequired[AnalyticsAndOperatorTypeDef], # (2)IntelligentTieringFilterOutputTypeDef#
# IntelligentTieringFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IntelligentTieringFilterOutputTypeDef
def get_value() -> IntelligentTieringFilterOutputTypeDef:
return {
"Prefix": ...,
}
# IntelligentTieringFilterOutputTypeDef definition
class IntelligentTieringFilterOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
And: NotRequired[IntelligentTieringAndOperatorOutputTypeDef], # (2)IntelligentTieringFilterTypeDef#
# IntelligentTieringFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IntelligentTieringFilterTypeDef
def get_value() -> IntelligentTieringFilterTypeDef:
return {
"Prefix": ...,
}
# IntelligentTieringFilterTypeDef definition
class IntelligentTieringFilterTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
And: NotRequired[IntelligentTieringAndOperatorTypeDef], # (2)LifecycleRuleFilterOutputTypeDef#
# LifecycleRuleFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleRuleFilterOutputTypeDef
def get_value() -> LifecycleRuleFilterOutputTypeDef:
return {
"Prefix": ...,
}
# LifecycleRuleFilterOutputTypeDef definition
class LifecycleRuleFilterOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
ObjectSizeGreaterThan: NotRequired[int],
ObjectSizeLessThan: NotRequired[int],
And: NotRequired[LifecycleRuleAndOperatorOutputTypeDef], # (2)MetricsFilterOutputTypeDef#
# MetricsFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsFilterOutputTypeDef
def get_value() -> MetricsFilterOutputTypeDef:
return {
"Prefix": ...,
}
# MetricsFilterOutputTypeDef definition
class MetricsFilterOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
AccessPointArn: NotRequired[str],
And: NotRequired[MetricsAndOperatorOutputTypeDef], # (2)MetricsFilterTypeDef#
# MetricsFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsFilterTypeDef
def get_value() -> MetricsFilterTypeDef:
return {
"Prefix": ...,
}
# MetricsFilterTypeDef definition
class MetricsFilterTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
AccessPointArn: NotRequired[str],
And: NotRequired[MetricsAndOperatorTypeDef], # (2)- See TagTypeDef
- See MetricsAndOperatorTypeDef
ReplicationRuleFilterOutputTypeDef#
# ReplicationRuleFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationRuleFilterOutputTypeDef
def get_value() -> ReplicationRuleFilterOutputTypeDef:
return {
"Prefix": ...,
}
# ReplicationRuleFilterOutputTypeDef definition
class ReplicationRuleFilterOutputTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
And: NotRequired[ReplicationRuleAndOperatorOutputTypeDef], # (2)ReplicationRuleFilterTypeDef#
# ReplicationRuleFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationRuleFilterTypeDef
def get_value() -> ReplicationRuleFilterTypeDef:
return {
"Prefix": ...,
}
# ReplicationRuleFilterTypeDef definition
class ReplicationRuleFilterTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
And: NotRequired[ReplicationRuleAndOperatorTypeDef], # (2)PutBucketTaggingRequestBucketTaggingPutTypeDef#
# PutBucketTaggingRequestBucketTaggingPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketTaggingRequestBucketTaggingPutTypeDef
def get_value() -> PutBucketTaggingRequestBucketTaggingPutTypeDef:
return {
"Tagging": ...,
}
# PutBucketTaggingRequestBucketTaggingPutTypeDef definition
class PutBucketTaggingRequestBucketTaggingPutTypeDef(TypedDict):
Tagging: TaggingTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],- See TaggingTypeDef
- See ChecksumAlgorithmType
PutBucketTaggingRequestTypeDef#
# PutBucketTaggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketTaggingRequestTypeDef
def get_value() -> PutBucketTaggingRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketTaggingRequestTypeDef definition
class PutBucketTaggingRequestTypeDef(TypedDict):
Bucket: str,
Tagging: TaggingTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],- See TaggingTypeDef
- See ChecksumAlgorithmType
PutObjectTaggingRequestTypeDef#
# PutObjectTaggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectTaggingRequestTypeDef
def get_value() -> PutObjectTaggingRequestTypeDef:
return {
"Bucket": ...,
}
# PutObjectTaggingRequestTypeDef definition
class PutObjectTaggingRequestTypeDef(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)- See TaggingTypeDef
- See ChecksumAlgorithmType
- See RequestPayerType
StorageClassAnalysisDataExportTypeDef#
# StorageClassAnalysisDataExportTypeDef TypedDict usage example
from types_boto3_s3.type_defs import StorageClassAnalysisDataExportTypeDef
def get_value() -> StorageClassAnalysisDataExportTypeDef:
return {
"OutputSchemaVersion": ...,
}
# StorageClassAnalysisDataExportTypeDef definition
class StorageClassAnalysisDataExportTypeDef(TypedDict):
OutputSchemaVersion: StorageClassAnalysisSchemaVersionType, # (1)
Destination: AnalyticsExportDestinationTypeDef, # (2)CopyObjectRequestObjectCopyFromTypeDef#
# CopyObjectRequestObjectCopyFromTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopyObjectRequestObjectCopyFromTypeDef
def get_value() -> CopyObjectRequestObjectCopyFromTypeDef:
return {
"CopySource": ...,
}
# CopyObjectRequestObjectCopyFromTypeDef definition
class CopyObjectRequestObjectCopyFromTypeDef(TypedDict):
CopySource: CopySourceOrStrTypeDef, # (1)
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[TimestampTypeDef],
CopySourceIfNoneMatch: NotRequired[str],
CopySourceIfUnmodifiedSince: NotRequired[TimestampTypeDef],
Expires: NotRequired[TimestampTypeDef],
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[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
CopySourceSSECustomerAlgorithm: NotRequired[str],
CopySourceSSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (8)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (9)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (10)
ExpectedBucketOwner: NotRequired[str],
ExpectedSourceBucketOwner: NotRequired[str],- See CopySourceTypeDef
- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See MetadataDirectiveType
- See TaggingDirectiveType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
CopyObjectRequestObjectSummaryCopyFromTypeDef#
# CopyObjectRequestObjectSummaryCopyFromTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopyObjectRequestObjectSummaryCopyFromTypeDef
def get_value() -> CopyObjectRequestObjectSummaryCopyFromTypeDef:
return {
"CopySource": ...,
}
# CopyObjectRequestObjectSummaryCopyFromTypeDef definition
class CopyObjectRequestObjectSummaryCopyFromTypeDef(TypedDict):
CopySource: CopySourceOrStrTypeDef, # (1)
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[TimestampTypeDef],
CopySourceIfNoneMatch: NotRequired[str],
CopySourceIfUnmodifiedSince: NotRequired[TimestampTypeDef],
Expires: NotRequired[TimestampTypeDef],
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[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
CopySourceSSECustomerAlgorithm: NotRequired[str],
CopySourceSSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (8)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (9)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (10)
ExpectedBucketOwner: NotRequired[str],
ExpectedSourceBucketOwner: NotRequired[str],- See CopySourceTypeDef
- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See MetadataDirectiveType
- See TaggingDirectiveType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
CopyObjectRequestTypeDef#
# CopyObjectRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CopyObjectRequestTypeDef
def get_value() -> CopyObjectRequestTypeDef:
return {
"Bucket": ...,
}
# CopyObjectRequestTypeDef definition
class CopyObjectRequestTypeDef(TypedDict):
Bucket: str,
CopySource: CopySourceOrStrTypeDef, # (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[TimestampTypeDef],
CopySourceIfNoneMatch: NotRequired[str],
CopySourceIfUnmodifiedSince: NotRequired[TimestampTypeDef],
Expires: NotRequired[TimestampTypeDef],
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[Union[str, bytes]],
SSEKMSKeyId: NotRequired[str],
SSEKMSEncryptionContext: NotRequired[str],
BucketKeyEnabled: NotRequired[bool],
CopySourceSSECustomerAlgorithm: NotRequired[str],
CopySourceSSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (8)
Tagging: NotRequired[str],
ObjectLockMode: NotRequired[ObjectLockModeType], # (9)
ObjectLockRetainUntilDate: NotRequired[TimestampTypeDef],
ObjectLockLegalHoldStatus: NotRequired[ObjectLockLegalHoldStatusType], # (10)
ExpectedBucketOwner: NotRequired[str],
ExpectedSourceBucketOwner: NotRequired[str],- See CopySourceTypeDef
- See ObjectCannedACLType
- See ChecksumAlgorithmType
- See MetadataDirectiveType
- See TaggingDirectiveType
- See ServerSideEncryptionType
- See StorageClassType
- See RequestPayerType
- See ObjectLockModeType
- See ObjectLockLegalHoldStatusType
UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef#
# UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef TypedDict usage example
from types_boto3_s3.type_defs import UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef
def get_value() -> UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef:
return {
"CopySource": ...,
}
# UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef definition
class UploadPartCopyRequestMultipartUploadPartCopyFromTypeDef(TypedDict):
CopySource: CopySourceOrStrTypeDef, # (1)
CopySourceIfMatch: NotRequired[str],
CopySourceIfModifiedSince: NotRequired[TimestampTypeDef],
CopySourceIfNoneMatch: NotRequired[str],
CopySourceIfUnmodifiedSince: NotRequired[TimestampTypeDef],
CopySourceRange: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
CopySourceSSECustomerAlgorithm: NotRequired[str],
CopySourceSSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (2)
ExpectedBucketOwner: NotRequired[str],
ExpectedSourceBucketOwner: NotRequired[str],- See CopySourceTypeDef
- See RequestPayerType
UploadPartCopyRequestTypeDef#
# UploadPartCopyRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import UploadPartCopyRequestTypeDef
def get_value() -> UploadPartCopyRequestTypeDef:
return {
"Bucket": ...,
}
# UploadPartCopyRequestTypeDef definition
class UploadPartCopyRequestTypeDef(TypedDict):
Bucket: str,
CopySource: CopySourceOrStrTypeDef, # (1)
Key: str,
PartNumber: int,
UploadId: str,
CopySourceIfMatch: NotRequired[str],
CopySourceIfModifiedSince: NotRequired[TimestampTypeDef],
CopySourceIfNoneMatch: NotRequired[str],
CopySourceIfUnmodifiedSince: NotRequired[TimestampTypeDef],
CopySourceRange: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
CopySourceSSECustomerAlgorithm: NotRequired[str],
CopySourceSSECustomerKey: NotRequired[Union[str, bytes]],
RequestPayer: NotRequired[RequestPayerType], # (2)
ExpectedBucketOwner: NotRequired[str],
ExpectedSourceBucketOwner: NotRequired[str],- See CopySourceTypeDef
- See RequestPayerType
CORSConfigurationTypeDef#
# CORSConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CORSConfigurationTypeDef
def get_value() -> CORSConfigurationTypeDef:
return {
"CORSRules": ...,
}
# CORSConfigurationTypeDef definition
class CORSConfigurationTypeDef(TypedDict):
CORSRules: Sequence[CORSRuleUnionTypeDef], # (1)CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef#
# CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef
def get_value() -> CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef:
return {
"MultipartUpload": ...,
}
# CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef definition
class CompleteMultipartUploadRequestMultipartUploadCompleteTypeDef(TypedDict):
MultipartUpload: NotRequired[CompletedMultipartUploadTypeDef], # (1)
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
ChecksumType: NotRequired[ChecksumTypeType], # (2)
MpuObjectSize: NotRequired[int],
RequestPayer: NotRequired[RequestPayerType], # (3)
ExpectedBucketOwner: NotRequired[str],
IfMatch: NotRequired[str],
IfNoneMatch: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],CompleteMultipartUploadRequestTypeDef#
# CompleteMultipartUploadRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CompleteMultipartUploadRequestTypeDef
def get_value() -> CompleteMultipartUploadRequestTypeDef:
return {
"Bucket": ...,
}
# CompleteMultipartUploadRequestTypeDef definition
class CompleteMultipartUploadRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
UploadId: str,
MultipartUpload: NotRequired[CompletedMultipartUploadTypeDef], # (1)
ChecksumCRC32: NotRequired[str],
ChecksumCRC32C: NotRequired[str],
ChecksumCRC64NVME: NotRequired[str],
ChecksumSHA1: NotRequired[str],
ChecksumSHA256: NotRequired[str],
ChecksumType: NotRequired[ChecksumTypeType], # (2)
MpuObjectSize: NotRequired[int],
RequestPayer: NotRequired[RequestPayerType], # (3)
ExpectedBucketOwner: NotRequired[str],
IfMatch: NotRequired[str],
IfNoneMatch: NotRequired[str],
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],CreateBucketRequestBucketCreateTypeDef#
# CreateBucketRequestBucketCreateTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateBucketRequestBucketCreateTypeDef
def get_value() -> CreateBucketRequestBucketCreateTypeDef:
return {
"ACL": ...,
}
# CreateBucketRequestBucketCreateTypeDef 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)CreateBucketRequestServiceResourceCreateBucketTypeDef#
# CreateBucketRequestServiceResourceCreateBucketTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateBucketRequestServiceResourceCreateBucketTypeDef
def get_value() -> CreateBucketRequestServiceResourceCreateBucketTypeDef:
return {
"Bucket": ...,
}
# CreateBucketRequestServiceResourceCreateBucketTypeDef 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)CreateBucketRequestTypeDef#
# CreateBucketRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateBucketRequestTypeDef
def get_value() -> CreateBucketRequestTypeDef:
return {
"Bucket": ...,
}
# CreateBucketRequestTypeDef definition
class CreateBucketRequestTypeDef(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)ObjectLockConfigurationTypeDef#
# ObjectLockConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ObjectLockConfigurationTypeDef
def get_value() -> ObjectLockConfigurationTypeDef:
return {
"ObjectLockEnabled": ...,
}
# ObjectLockConfigurationTypeDef definition
class ObjectLockConfigurationTypeDef(TypedDict):
ObjectLockEnabled: NotRequired[ObjectLockEnabledType], # (1)
Rule: NotRequired[ObjectLockRuleTypeDef], # (2)NotificationConfigurationFilterOutputTypeDef#
# NotificationConfigurationFilterOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NotificationConfigurationFilterOutputTypeDef
def get_value() -> NotificationConfigurationFilterOutputTypeDef:
return {
"Key": ...,
}
# NotificationConfigurationFilterOutputTypeDef definition
class NotificationConfigurationFilterOutputTypeDef(TypedDict):
Key: NotRequired[S3KeyFilterOutputTypeDef], # (1)GetObjectAttributesOutputTypeDef#
# GetObjectAttributesOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectAttributesOutputTypeDef
def get_value() -> GetObjectAttributesOutputTypeDef:
return {
"DeleteMarker": ...,
}
# GetObjectAttributesOutputTypeDef 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)- See RequestChargedType
- See ChecksumTypeDef
- See GetObjectAttributesPartsTypeDef
- See StorageClassType
- See ResponseMetadataTypeDef
AccessControlPolicyTypeDef#
# AccessControlPolicyTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AccessControlPolicyTypeDef
def get_value() -> AccessControlPolicyTypeDef:
return {
"Grants": ...,
}
# AccessControlPolicyTypeDef definition
class AccessControlPolicyTypeDef(TypedDict):
Grants: NotRequired[Sequence[GrantTypeDef]], # (1)
Owner: NotRequired[OwnerTypeDef], # (2)- See GrantTypeDef
- See OwnerTypeDef
GetBucketAclOutputTypeDef#
# GetBucketAclOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketAclOutputTypeDef
def get_value() -> GetBucketAclOutputTypeDef:
return {
"Owner": ...,
}
# GetBucketAclOutputTypeDef definition
class GetBucketAclOutputTypeDef(TypedDict):
Owner: OwnerTypeDef, # (1)
Grants: List[GrantTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See OwnerTypeDef
- See GrantTypeDef
- See ResponseMetadataTypeDef
GetObjectAclOutputTypeDef#
# GetObjectAclOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectAclOutputTypeDef
def get_value() -> GetObjectAclOutputTypeDef:
return {
"Owner": ...,
}
# GetObjectAclOutputTypeDef definition
class GetObjectAclOutputTypeDef(TypedDict):
Owner: OwnerTypeDef, # (1)
Grants: List[GrantTypeDef], # (2)
RequestCharged: RequestChargedType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See OwnerTypeDef
- See GrantTypeDef
- See RequestChargedType
- See ResponseMetadataTypeDef
S3LocationTypeDef#
# S3LocationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"BucketName": ...,
}
# S3LocationTypeDef 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)- See EncryptionTypeDef
- See ObjectCannedACLType
- See GrantTypeDef
- See TaggingTypeDef
- See MetadataEntryTypeDef
- See StorageClassType
ListMultipartUploadsOutputTypeDef#
# ListMultipartUploadsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListMultipartUploadsOutputTypeDef
def get_value() -> ListMultipartUploadsOutputTypeDef:
return {
"Bucket": ...,
}
# ListMultipartUploadsOutputTypeDef 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)
EncodingType: EncodingTypeType, # (3)
RequestCharged: RequestChargedType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
CommonPrefixes: NotRequired[List[CommonPrefixTypeDef]], # (2)- See MultipartUploadTypeDef
- See CommonPrefixTypeDef
- See EncodingTypeType
- See RequestChargedType
- See ResponseMetadataTypeDef
InventoryS3BucketDestinationOutputTypeDef#
# InventoryS3BucketDestinationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryS3BucketDestinationOutputTypeDef
def get_value() -> InventoryS3BucketDestinationOutputTypeDef:
return {
"AccountId": ...,
}
# InventoryS3BucketDestinationOutputTypeDef definition
class InventoryS3BucketDestinationOutputTypeDef(TypedDict):
Bucket: str,
Format: InventoryFormatType, # (1)
AccountId: NotRequired[str],
Prefix: NotRequired[str],
Encryption: NotRequired[InventoryEncryptionOutputTypeDef], # (2)InventoryS3BucketDestinationTypeDef#
# InventoryS3BucketDestinationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryS3BucketDestinationTypeDef
def get_value() -> InventoryS3BucketDestinationTypeDef:
return {
"AccountId": ...,
}
# InventoryS3BucketDestinationTypeDef definition
class InventoryS3BucketDestinationTypeDef(TypedDict):
Bucket: str,
Format: InventoryFormatType, # (1)
AccountId: NotRequired[str],
Prefix: NotRequired[str],
Encryption: NotRequired[InventoryEncryptionTypeDef], # (2)SelectObjectContentRequestTypeDef#
# SelectObjectContentRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SelectObjectContentRequestTypeDef
def get_value() -> SelectObjectContentRequestTypeDef:
return {
"Bucket": ...,
}
# SelectObjectContentRequestTypeDef definition
class SelectObjectContentRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
Expression: str,
ExpressionType: ExpressionTypeType, # (1)
InputSerialization: InputSerializationTypeDef, # (2)
OutputSerialization: OutputSerializationTypeDef, # (3)
SSECustomerAlgorithm: NotRequired[str],
SSECustomerKey: NotRequired[Union[str, bytes]],
RequestProgress: NotRequired[RequestProgressTypeDef], # (4)
ScanRange: NotRequired[ScanRangeTypeDef], # (5)
ExpectedBucketOwner: NotRequired[str],- See ExpressionTypeType
- See InputSerializationTypeDef
- See OutputSerializationTypeDef
- See RequestProgressTypeDef
- See ScanRangeTypeDef
SelectParametersTypeDef#
# SelectParametersTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SelectParametersTypeDef
def get_value() -> SelectParametersTypeDef:
return {
"InputSerialization": ...,
}
# SelectParametersTypeDef definition
class SelectParametersTypeDef(TypedDict):
InputSerialization: InputSerializationTypeDef, # (1)
ExpressionType: ExpressionTypeType, # (2)
Expression: str,
OutputSerialization: OutputSerializationTypeDef, # (3)GetBucketLifecycleOutputTypeDef#
# GetBucketLifecycleOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLifecycleOutputTypeDef
def get_value() -> GetBucketLifecycleOutputTypeDef:
return {
"Rules": ...,
}
# GetBucketLifecycleOutputTypeDef definition
class GetBucketLifecycleOutputTypeDef(TypedDict):
Rules: List[RuleOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetBucketMetadataTableConfigurationResultTypeDef#
# GetBucketMetadataTableConfigurationResultTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketMetadataTableConfigurationResultTypeDef
def get_value() -> GetBucketMetadataTableConfigurationResultTypeDef:
return {
"MetadataTableConfigurationResult": ...,
}
# GetBucketMetadataTableConfigurationResultTypeDef definition
class GetBucketMetadataTableConfigurationResultTypeDef(TypedDict):
MetadataTableConfigurationResult: MetadataTableConfigurationResultTypeDef, # (1)
Status: str,
Error: NotRequired[ErrorDetailsTypeDef], # (2)CreateBucketMetadataTableConfigurationRequestTypeDef#
# CreateBucketMetadataTableConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import CreateBucketMetadataTableConfigurationRequestTypeDef
def get_value() -> CreateBucketMetadataTableConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# CreateBucketMetadataTableConfigurationRequestTypeDef definition
class CreateBucketMetadataTableConfigurationRequestTypeDef(TypedDict):
Bucket: str,
MetadataTableConfiguration: MetadataTableConfigurationTypeDef, # (1)
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],DestinationTypeDef#
# DestinationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DestinationTypeDef
def get_value() -> DestinationTypeDef:
return {
"Bucket": ...,
}
# DestinationTypeDef 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)- See StorageClassType
- See AccessControlTranslationTypeDef
- See EncryptionConfigurationTypeDef
- See ReplicationTimeTypeDef
- See MetricsTypeDef
ListObjectsOutputTypeDef#
# ListObjectsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectsOutputTypeDef
def get_value() -> ListObjectsOutputTypeDef:
return {
"IsTruncated": ...,
}
# ListObjectsOutputTypeDef definition
class ListObjectsOutputTypeDef(TypedDict):
IsTruncated: bool,
Marker: str,
NextMarker: str,
Name: str,
Prefix: str,
Delimiter: str,
MaxKeys: int,
EncodingType: EncodingTypeType, # (3)
RequestCharged: RequestChargedType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
Contents: NotRequired[List[ObjectTypeDef]], # (1)
CommonPrefixes: NotRequired[List[CommonPrefixTypeDef]], # (2)- See ObjectTypeDef
- See CommonPrefixTypeDef
- See EncodingTypeType
- See RequestChargedType
- See ResponseMetadataTypeDef
ListObjectsV2OutputTypeDef#
# ListObjectsV2OutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectsV2OutputTypeDef
def get_value() -> ListObjectsV2OutputTypeDef:
return {
"IsTruncated": ...,
}
# ListObjectsV2OutputTypeDef definition
class ListObjectsV2OutputTypeDef(TypedDict):
IsTruncated: bool,
Name: str,
Prefix: str,
Delimiter: str,
MaxKeys: int,
EncodingType: EncodingTypeType, # (3)
KeyCount: int,
ContinuationToken: str,
NextContinuationToken: str,
StartAfter: str,
RequestCharged: RequestChargedType, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
Contents: NotRequired[List[ObjectTypeDef]], # (1)
CommonPrefixes: NotRequired[List[CommonPrefixTypeDef]], # (2)- See ObjectTypeDef
- See CommonPrefixTypeDef
- See EncodingTypeType
- See RequestChargedType
- See ResponseMetadataTypeDef
ListObjectVersionsOutputTypeDef#
# ListObjectVersionsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListObjectVersionsOutputTypeDef
def get_value() -> ListObjectVersionsOutputTypeDef:
return {
"IsTruncated": ...,
}
# ListObjectVersionsOutputTypeDef 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,
EncodingType: EncodingTypeType, # (4)
RequestCharged: RequestChargedType, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
CommonPrefixes: NotRequired[List[CommonPrefixTypeDef]], # (3)- See ObjectVersionTypeDef
- See DeleteMarkerEntryTypeDef
- See CommonPrefixTypeDef
- See EncodingTypeType
- See RequestChargedType
- See ResponseMetadataTypeDef
GetBucketOwnershipControlsOutputTypeDef#
# GetBucketOwnershipControlsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketOwnershipControlsOutputTypeDef
def get_value() -> GetBucketOwnershipControlsOutputTypeDef:
return {
"OwnershipControls": ...,
}
# GetBucketOwnershipControlsOutputTypeDef definition
class GetBucketOwnershipControlsOutputTypeDef(TypedDict):
OwnershipControls: OwnershipControlsOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)LoggingEnabledOutputTypeDef#
# LoggingEnabledOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LoggingEnabledOutputTypeDef
def get_value() -> LoggingEnabledOutputTypeDef:
return {
"TargetBucket": ...,
}
# LoggingEnabledOutputTypeDef definition
class LoggingEnabledOutputTypeDef(TypedDict):
TargetBucket: str,
TargetPrefix: str,
TargetGrants: NotRequired[List[TargetGrantTypeDef]], # (1)
TargetObjectKeyFormat: NotRequired[TargetObjectKeyFormatOutputTypeDef], # (2)GetBucketWebsiteOutputTypeDef#
# GetBucketWebsiteOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketWebsiteOutputTypeDef
def get_value() -> GetBucketWebsiteOutputTypeDef:
return {
"RedirectAllRequestsTo": ...,
}
# GetBucketWebsiteOutputTypeDef definition
class GetBucketWebsiteOutputTypeDef(TypedDict):
RedirectAllRequestsTo: RedirectAllRequestsToTypeDef, # (1)
IndexDocument: IndexDocumentTypeDef, # (2)
ErrorDocument: ErrorDocumentTypeDef, # (3)
RoutingRules: List[RoutingRuleTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See RedirectAllRequestsToTypeDef
- See IndexDocumentTypeDef
- See ErrorDocumentTypeDef
- See RoutingRuleTypeDef
- See ResponseMetadataTypeDef
WebsiteConfigurationTypeDef#
# WebsiteConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import WebsiteConfigurationTypeDef
def get_value() -> WebsiteConfigurationTypeDef:
return {
"ErrorDocument": ...,
}
# WebsiteConfigurationTypeDef definition
class WebsiteConfigurationTypeDef(TypedDict):
ErrorDocument: NotRequired[ErrorDocumentTypeDef], # (1)
IndexDocument: NotRequired[IndexDocumentTypeDef], # (2)
RedirectAllRequestsTo: NotRequired[RedirectAllRequestsToTypeDef], # (3)
RoutingRules: NotRequired[Sequence[RoutingRuleTypeDef]], # (4)- See ErrorDocumentTypeDef
- See IndexDocumentTypeDef
- See RedirectAllRequestsToTypeDef
- See RoutingRuleTypeDef
ServerSideEncryptionConfigurationOutputTypeDef#
# ServerSideEncryptionConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ServerSideEncryptionConfigurationOutputTypeDef
def get_value() -> ServerSideEncryptionConfigurationOutputTypeDef:
return {
"Rules": ...,
}
# ServerSideEncryptionConfigurationOutputTypeDef definition
class ServerSideEncryptionConfigurationOutputTypeDef(TypedDict):
Rules: List[ServerSideEncryptionRuleTypeDef], # (1)ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ServerSideEncryptionConfigurationTypeDef
def get_value() -> ServerSideEncryptionConfigurationTypeDef:
return {
"Rules": ...,
}
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
Rules: Sequence[ServerSideEncryptionRuleTypeDef], # (1)SelectObjectContentEventStreamTypeDef#
# SelectObjectContentEventStreamTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SelectObjectContentEventStreamTypeDef
def get_value() -> SelectObjectContentEventStreamTypeDef:
return {
"Records": ...,
}
# SelectObjectContentEventStreamTypeDef 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]],- See RecordsEventTypeDef
- See StatsEventTypeDef
- See ProgressEventTypeDef
NotificationConfigurationDeprecatedTypeDef#
# NotificationConfigurationDeprecatedTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NotificationConfigurationDeprecatedTypeDef
def get_value() -> NotificationConfigurationDeprecatedTypeDef:
return {
"TopicConfiguration": ...,
}
# NotificationConfigurationDeprecatedTypeDef definition
class NotificationConfigurationDeprecatedTypeDef(TypedDict):
TopicConfiguration: NotRequired[TopicConfigurationDeprecatedUnionTypeDef], # (1)
QueueConfiguration: NotRequired[QueueConfigurationDeprecatedUnionTypeDef], # (2)
CloudFunctionConfiguration: NotRequired[CloudFunctionConfigurationUnionTypeDef], # (3)- See TopicConfigurationDeprecatedTypeDef TopicConfigurationDeprecatedOutputTypeDef
- See QueueConfigurationDeprecatedTypeDef QueueConfigurationDeprecatedOutputTypeDef
- See CloudFunctionConfigurationTypeDef CloudFunctionConfigurationOutputTypeDef
DeleteObjectsRequestBucketDeleteObjectsTypeDef#
# DeleteObjectsRequestBucketDeleteObjectsTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectsRequestBucketDeleteObjectsTypeDef
def get_value() -> DeleteObjectsRequestBucketDeleteObjectsTypeDef:
return {
"Delete": ...,
}
# DeleteObjectsRequestBucketDeleteObjectsTypeDef definition
class DeleteObjectsRequestBucketDeleteObjectsTypeDef(TypedDict):
Delete: DeleteTypeDef, # (1)
MFA: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (2)
BypassGovernanceRetention: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)- See DeleteTypeDef
- See RequestPayerType
- See ChecksumAlgorithmType
DeleteObjectsRequestTypeDef#
# DeleteObjectsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import DeleteObjectsRequestTypeDef
def get_value() -> DeleteObjectsRequestTypeDef:
return {
"Bucket": ...,
}
# DeleteObjectsRequestTypeDef definition
class DeleteObjectsRequestTypeDef(TypedDict):
Bucket: str,
Delete: DeleteTypeDef, # (1)
MFA: NotRequired[str],
RequestPayer: NotRequired[RequestPayerType], # (2)
BypassGovernanceRetention: NotRequired[bool],
ExpectedBucketOwner: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)- See DeleteTypeDef
- See RequestPayerType
- See ChecksumAlgorithmType
PutObjectRetentionRequestTypeDef#
# PutObjectRetentionRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectRetentionRequestTypeDef
def get_value() -> PutObjectRetentionRequestTypeDef:
return {
"Bucket": ...,
}
# PutObjectRetentionRequestTypeDef definition
class PutObjectRetentionRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
Retention: NotRequired[ObjectLockRetentionUnionTypeDef], # (1)
RequestPayer: NotRequired[RequestPayerType], # (2)
VersionId: NotRequired[str],
BypassGovernanceRetention: NotRequired[bool],
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)
ExpectedBucketOwner: NotRequired[str],- See ObjectLockRetentionTypeDef ObjectLockRetentionOutputTypeDef
- See RequestPayerType
- See ChecksumAlgorithmType
RuleTypeDef#
# RuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RuleTypeDef
def get_value() -> RuleTypeDef:
return {
"Expiration": ...,
}
# RuleTypeDef definition
class RuleTypeDef(TypedDict):
Prefix: str,
Status: ExpirationStatusType, # (2)
Expiration: NotRequired[LifecycleExpirationUnionTypeDef], # (1)
ID: NotRequired[str],
Transition: NotRequired[TransitionUnionTypeDef], # (3)
NoncurrentVersionTransition: NotRequired[NoncurrentVersionTransitionTypeDef], # (4)
NoncurrentVersionExpiration: NotRequired[NoncurrentVersionExpirationTypeDef], # (5)
AbortIncompleteMultipartUpload: NotRequired[AbortIncompleteMultipartUploadTypeDef], # (6)- See LifecycleExpirationTypeDef LifecycleExpirationOutputTypeDef
- See ExpirationStatusType
- See TransitionTypeDef TransitionOutputTypeDef
- See NoncurrentVersionTransitionTypeDef
- See NoncurrentVersionExpirationTypeDef
- See AbortIncompleteMultipartUploadTypeDef
IntelligentTieringConfigurationOutputTypeDef#
# IntelligentTieringConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IntelligentTieringConfigurationOutputTypeDef
def get_value() -> IntelligentTieringConfigurationOutputTypeDef:
return {
"Id": ...,
}
# IntelligentTieringConfigurationOutputTypeDef definition
class IntelligentTieringConfigurationOutputTypeDef(TypedDict):
Id: str,
Status: IntelligentTieringStatusType, # (2)
Tierings: List[TieringTypeDef], # (3)
Filter: NotRequired[IntelligentTieringFilterOutputTypeDef], # (1)IntelligentTieringConfigurationTypeDef#
# IntelligentTieringConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import IntelligentTieringConfigurationTypeDef
def get_value() -> IntelligentTieringConfigurationTypeDef:
return {
"Id": ...,
}
# IntelligentTieringConfigurationTypeDef definition
class IntelligentTieringConfigurationTypeDef(TypedDict):
Id: str,
Status: IntelligentTieringStatusType, # (2)
Tierings: Sequence[TieringTypeDef], # (3)
Filter: NotRequired[IntelligentTieringFilterTypeDef], # (1)LifecycleRuleOutputTypeDef#
# LifecycleRuleOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleRuleOutputTypeDef
def get_value() -> LifecycleRuleOutputTypeDef:
return {
"Expiration": ...,
}
# LifecycleRuleOutputTypeDef definition
class LifecycleRuleOutputTypeDef(TypedDict):
Status: ExpirationStatusType, # (3)
Expiration: NotRequired[LifecycleExpirationOutputTypeDef], # (1)
ID: NotRequired[str],
Prefix: NotRequired[str],
Filter: NotRequired[LifecycleRuleFilterOutputTypeDef], # (2)
Transitions: NotRequired[List[TransitionOutputTypeDef]], # (4)
NoncurrentVersionTransitions: NotRequired[List[NoncurrentVersionTransitionTypeDef]], # (5)
NoncurrentVersionExpiration: NotRequired[NoncurrentVersionExpirationTypeDef], # (6)
AbortIncompleteMultipartUpload: NotRequired[AbortIncompleteMultipartUploadTypeDef], # (7)- See LifecycleExpirationOutputTypeDef
- See LifecycleRuleFilterOutputTypeDef
- See ExpirationStatusType
- See TransitionOutputTypeDef
- See NoncurrentVersionTransitionTypeDef
- See NoncurrentVersionExpirationTypeDef
- See AbortIncompleteMultipartUploadTypeDef
LifecycleRuleFilterTypeDef#
# LifecycleRuleFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleRuleFilterTypeDef
def get_value() -> LifecycleRuleFilterTypeDef:
return {
"Prefix": ...,
}
# LifecycleRuleFilterTypeDef definition
class LifecycleRuleFilterTypeDef(TypedDict):
Prefix: NotRequired[str],
Tag: NotRequired[TagTypeDef], # (1)
ObjectSizeGreaterThan: NotRequired[int],
ObjectSizeLessThan: NotRequired[int],
And: NotRequired[LifecycleRuleAndOperatorUnionTypeDef], # (2)MetricsConfigurationOutputTypeDef#
# MetricsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsConfigurationOutputTypeDef
def get_value() -> MetricsConfigurationOutputTypeDef:
return {
"Id": ...,
}
# MetricsConfigurationOutputTypeDef definition
class MetricsConfigurationOutputTypeDef(TypedDict):
Id: str,
Filter: NotRequired[MetricsFilterOutputTypeDef], # (1)MetricsConfigurationTypeDef#
# MetricsConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import MetricsConfigurationTypeDef
def get_value() -> MetricsConfigurationTypeDef:
return {
"Id": ...,
}
# MetricsConfigurationTypeDef definition
class MetricsConfigurationTypeDef(TypedDict):
Id: str,
Filter: NotRequired[MetricsFilterTypeDef], # (1)StorageClassAnalysisTypeDef#
# StorageClassAnalysisTypeDef TypedDict usage example
from types_boto3_s3.type_defs import StorageClassAnalysisTypeDef
def get_value() -> StorageClassAnalysisTypeDef:
return {
"DataExport": ...,
}
# StorageClassAnalysisTypeDef definition
class StorageClassAnalysisTypeDef(TypedDict):
DataExport: NotRequired[StorageClassAnalysisDataExportTypeDef], # (1)PutBucketCorsRequestBucketCorsPutTypeDef#
# PutBucketCorsRequestBucketCorsPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketCorsRequestBucketCorsPutTypeDef
def get_value() -> PutBucketCorsRequestBucketCorsPutTypeDef:
return {
"CORSConfiguration": ...,
}
# PutBucketCorsRequestBucketCorsPutTypeDef definition
class PutBucketCorsRequestBucketCorsPutTypeDef(TypedDict):
CORSConfiguration: CORSConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketCorsRequestTypeDef#
# PutBucketCorsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketCorsRequestTypeDef
def get_value() -> PutBucketCorsRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketCorsRequestTypeDef definition
class PutBucketCorsRequestTypeDef(TypedDict):
Bucket: str,
CORSConfiguration: CORSConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],GetObjectLockConfigurationOutputTypeDef#
# GetObjectLockConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetObjectLockConfigurationOutputTypeDef
def get_value() -> GetObjectLockConfigurationOutputTypeDef:
return {
"ObjectLockConfiguration": ...,
}
# GetObjectLockConfigurationOutputTypeDef definition
class GetObjectLockConfigurationOutputTypeDef(TypedDict):
ObjectLockConfiguration: ObjectLockConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutObjectLockConfigurationRequestTypeDef#
# PutObjectLockConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectLockConfigurationRequestTypeDef
def get_value() -> PutObjectLockConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutObjectLockConfigurationRequestTypeDef definition
class PutObjectLockConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ObjectLockConfiguration: NotRequired[ObjectLockConfigurationTypeDef], # (1)
RequestPayer: NotRequired[RequestPayerType], # (2)
Token: NotRequired[str],
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)
ExpectedBucketOwner: NotRequired[str],LambdaFunctionConfigurationOutputTypeDef#
# LambdaFunctionConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LambdaFunctionConfigurationOutputTypeDef
def get_value() -> LambdaFunctionConfigurationOutputTypeDef:
return {
"Id": ...,
}
# LambdaFunctionConfigurationOutputTypeDef definition
class LambdaFunctionConfigurationOutputTypeDef(TypedDict):
LambdaFunctionArn: str,
Events: List[EventType], # (1)
Id: NotRequired[str],
Filter: NotRequired[NotificationConfigurationFilterOutputTypeDef], # (2)QueueConfigurationOutputTypeDef#
# QueueConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import QueueConfigurationOutputTypeDef
def get_value() -> QueueConfigurationOutputTypeDef:
return {
"Id": ...,
}
# QueueConfigurationOutputTypeDef definition
class QueueConfigurationOutputTypeDef(TypedDict):
QueueArn: str,
Events: List[EventType], # (1)
Id: NotRequired[str],
Filter: NotRequired[NotificationConfigurationFilterOutputTypeDef], # (2)TopicConfigurationOutputTypeDef#
# TopicConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TopicConfigurationOutputTypeDef
def get_value() -> TopicConfigurationOutputTypeDef:
return {
"Id": ...,
}
# TopicConfigurationOutputTypeDef definition
class TopicConfigurationOutputTypeDef(TypedDict):
TopicArn: str,
Events: List[EventType], # (1)
Id: NotRequired[str],
Filter: NotRequired[NotificationConfigurationFilterOutputTypeDef], # (2)NotificationConfigurationFilterTypeDef#
# NotificationConfigurationFilterTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NotificationConfigurationFilterTypeDef
def get_value() -> NotificationConfigurationFilterTypeDef:
return {
"Key": ...,
}
# NotificationConfigurationFilterTypeDef definition
class NotificationConfigurationFilterTypeDef(TypedDict):
Key: NotRequired[S3KeyFilterUnionTypeDef], # (1)PutBucketAclRequestBucketAclPutTypeDef#
# PutBucketAclRequestBucketAclPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketAclRequestBucketAclPutTypeDef
def get_value() -> PutBucketAclRequestBucketAclPutTypeDef:
return {
"ACL": ...,
}
# PutBucketAclRequestBucketAclPutTypeDef 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],PutBucketAclRequestTypeDef#
# PutBucketAclRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketAclRequestTypeDef
def get_value() -> PutBucketAclRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketAclRequestTypeDef definition
class PutBucketAclRequestTypeDef(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],PutObjectAclRequestObjectAclPutTypeDef#
# PutObjectAclRequestObjectAclPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectAclRequestObjectAclPutTypeDef
def get_value() -> PutObjectAclRequestObjectAclPutTypeDef:
return {
"ACL": ...,
}
# PutObjectAclRequestObjectAclPutTypeDef definition
class PutObjectAclRequestObjectAclPutTypeDef(TypedDict):
ACL: NotRequired[ObjectCannedACLType], # (1)
AccessControlPolicy: NotRequired[AccessControlPolicyTypeDef], # (2)
ContentMD5: NotRequired[str],
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],- See ObjectCannedACLType
- See AccessControlPolicyTypeDef
- See ChecksumAlgorithmType
- See RequestPayerType
PutObjectAclRequestTypeDef#
# PutObjectAclRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutObjectAclRequestTypeDef
def get_value() -> PutObjectAclRequestTypeDef:
return {
"Bucket": ...,
}
# PutObjectAclRequestTypeDef definition
class PutObjectAclRequestTypeDef(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],- See ObjectCannedACLType
- See AccessControlPolicyTypeDef
- See ChecksumAlgorithmType
- See RequestPayerType
OutputLocationTypeDef#
# OutputLocationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import OutputLocationTypeDef
def get_value() -> OutputLocationTypeDef:
return {
"S3": ...,
}
# OutputLocationTypeDef definition
class OutputLocationTypeDef(TypedDict):
S3: NotRequired[S3LocationTypeDef], # (1)InventoryDestinationOutputTypeDef#
# InventoryDestinationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryDestinationOutputTypeDef
def get_value() -> InventoryDestinationOutputTypeDef:
return {
"S3BucketDestination": ...,
}
# InventoryDestinationOutputTypeDef definition
class InventoryDestinationOutputTypeDef(TypedDict):
S3BucketDestination: InventoryS3BucketDestinationOutputTypeDef, # (1)InventoryDestinationTypeDef#
# InventoryDestinationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryDestinationTypeDef
def get_value() -> InventoryDestinationTypeDef:
return {
"S3BucketDestination": ...,
}
# InventoryDestinationTypeDef definition
class InventoryDestinationTypeDef(TypedDict):
S3BucketDestination: InventoryS3BucketDestinationTypeDef, # (1)GetBucketMetadataTableConfigurationOutputTypeDef#
# GetBucketMetadataTableConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketMetadataTableConfigurationOutputTypeDef
def get_value() -> GetBucketMetadataTableConfigurationOutputTypeDef:
return {
"GetBucketMetadataTableConfigurationResult": ...,
}
# GetBucketMetadataTableConfigurationOutputTypeDef definition
class GetBucketMetadataTableConfigurationOutputTypeDef(TypedDict):
GetBucketMetadataTableConfigurationResult: GetBucketMetadataTableConfigurationResultTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ReplicationRuleOutputTypeDef#
# ReplicationRuleOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationRuleOutputTypeDef
def get_value() -> ReplicationRuleOutputTypeDef:
return {
"ID": ...,
}
# ReplicationRuleOutputTypeDef definition
class ReplicationRuleOutputTypeDef(TypedDict):
Status: ReplicationRuleStatusType, # (2)
Destination: DestinationTypeDef, # (5)
ID: NotRequired[str],
Priority: NotRequired[int],
Prefix: NotRequired[str],
Filter: NotRequired[ReplicationRuleFilterOutputTypeDef], # (1)
SourceSelectionCriteria: NotRequired[SourceSelectionCriteriaTypeDef], # (3)
ExistingObjectReplication: NotRequired[ExistingObjectReplicationTypeDef], # (4)
DeleteMarkerReplication: NotRequired[DeleteMarkerReplicationTypeDef], # (6)- See ReplicationRuleFilterOutputTypeDef
- See ReplicationRuleStatusType
- See SourceSelectionCriteriaTypeDef
- See ExistingObjectReplicationTypeDef
- See DestinationTypeDef
- See DeleteMarkerReplicationTypeDef
ReplicationRuleTypeDef#
# ReplicationRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationRuleTypeDef
def get_value() -> ReplicationRuleTypeDef:
return {
"ID": ...,
}
# ReplicationRuleTypeDef 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)- See ReplicationRuleFilterTypeDef
- See ReplicationRuleStatusType
- See SourceSelectionCriteriaTypeDef
- See ExistingObjectReplicationTypeDef
- See DestinationTypeDef
- See DeleteMarkerReplicationTypeDef
PutBucketOwnershipControlsRequestTypeDef#
# PutBucketOwnershipControlsRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketOwnershipControlsRequestTypeDef
def get_value() -> PutBucketOwnershipControlsRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketOwnershipControlsRequestTypeDef definition
class PutBucketOwnershipControlsRequestTypeDef(TypedDict):
Bucket: str,
OwnershipControls: OwnershipControlsUnionTypeDef, # (1)
ContentMD5: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],GetBucketLoggingOutputTypeDef#
# GetBucketLoggingOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLoggingOutputTypeDef
def get_value() -> GetBucketLoggingOutputTypeDef:
return {
"LoggingEnabled": ...,
}
# GetBucketLoggingOutputTypeDef definition
class GetBucketLoggingOutputTypeDef(TypedDict):
LoggingEnabled: LoggingEnabledOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)LoggingEnabledTypeDef#
# LoggingEnabledTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LoggingEnabledTypeDef
def get_value() -> LoggingEnabledTypeDef:
return {
"TargetBucket": ...,
}
# LoggingEnabledTypeDef definition
class LoggingEnabledTypeDef(TypedDict):
TargetBucket: str,
TargetPrefix: str,
TargetGrants: NotRequired[Sequence[TargetGrantTypeDef]], # (1)
TargetObjectKeyFormat: NotRequired[TargetObjectKeyFormatUnionTypeDef], # (2)PutBucketWebsiteRequestBucketWebsitePutTypeDef#
# PutBucketWebsiteRequestBucketWebsitePutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketWebsiteRequestBucketWebsitePutTypeDef
def get_value() -> PutBucketWebsiteRequestBucketWebsitePutTypeDef:
return {
"WebsiteConfiguration": ...,
}
# PutBucketWebsiteRequestBucketWebsitePutTypeDef definition
class PutBucketWebsiteRequestBucketWebsitePutTypeDef(TypedDict):
WebsiteConfiguration: WebsiteConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketWebsiteRequestTypeDef#
# PutBucketWebsiteRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketWebsiteRequestTypeDef
def get_value() -> PutBucketWebsiteRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketWebsiteRequestTypeDef definition
class PutBucketWebsiteRequestTypeDef(TypedDict):
Bucket: str,
WebsiteConfiguration: WebsiteConfigurationTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],GetBucketEncryptionOutputTypeDef#
# GetBucketEncryptionOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketEncryptionOutputTypeDef
def get_value() -> GetBucketEncryptionOutputTypeDef:
return {
"ServerSideEncryptionConfiguration": ...,
}
# GetBucketEncryptionOutputTypeDef definition
class GetBucketEncryptionOutputTypeDef(TypedDict):
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SelectObjectContentOutputTypeDef#
# SelectObjectContentOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import SelectObjectContentOutputTypeDef
def get_value() -> SelectObjectContentOutputTypeDef:
return {
"Payload": ...,
}
# SelectObjectContentOutputTypeDef definition
class SelectObjectContentOutputTypeDef(TypedDict):
Payload: EventStream[SelectObjectContentEventStreamTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)PutBucketNotificationRequestTypeDef#
# PutBucketNotificationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketNotificationRequestTypeDef
def get_value() -> PutBucketNotificationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketNotificationRequestTypeDef definition
class PutBucketNotificationRequestTypeDef(TypedDict):
Bucket: str,
NotificationConfiguration: NotificationConfigurationDeprecatedTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],GetBucketIntelligentTieringConfigurationOutputTypeDef#
# GetBucketIntelligentTieringConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketIntelligentTieringConfigurationOutputTypeDef
def get_value() -> GetBucketIntelligentTieringConfigurationOutputTypeDef:
return {
"IntelligentTieringConfiguration": ...,
}
# GetBucketIntelligentTieringConfigurationOutputTypeDef definition
class GetBucketIntelligentTieringConfigurationOutputTypeDef(TypedDict):
IntelligentTieringConfiguration: IntelligentTieringConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListBucketIntelligentTieringConfigurationsOutputTypeDef#
# ListBucketIntelligentTieringConfigurationsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketIntelligentTieringConfigurationsOutputTypeDef
def get_value() -> ListBucketIntelligentTieringConfigurationsOutputTypeDef:
return {
"IsTruncated": ...,
}
# ListBucketIntelligentTieringConfigurationsOutputTypeDef definition
class ListBucketIntelligentTieringConfigurationsOutputTypeDef(TypedDict):
IsTruncated: bool,
ContinuationToken: str,
NextContinuationToken: str,
IntelligentTieringConfigurationList: List[IntelligentTieringConfigurationOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetBucketLifecycleConfigurationOutputTypeDef#
# GetBucketLifecycleConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketLifecycleConfigurationOutputTypeDef
def get_value() -> GetBucketLifecycleConfigurationOutputTypeDef:
return {
"Rules": ...,
}
# GetBucketLifecycleConfigurationOutputTypeDef definition
class GetBucketLifecycleConfigurationOutputTypeDef(TypedDict):
Rules: List[LifecycleRuleOutputTypeDef], # (1)
TransitionDefaultMinimumObjectSize: TransitionDefaultMinimumObjectSizeType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See LifecycleRuleOutputTypeDef
- See TransitionDefaultMinimumObjectSizeType
- See ResponseMetadataTypeDef
GetBucketMetricsConfigurationOutputTypeDef#
# GetBucketMetricsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketMetricsConfigurationOutputTypeDef
def get_value() -> GetBucketMetricsConfigurationOutputTypeDef:
return {
"MetricsConfiguration": ...,
}
# GetBucketMetricsConfigurationOutputTypeDef definition
class GetBucketMetricsConfigurationOutputTypeDef(TypedDict):
MetricsConfiguration: MetricsConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListBucketMetricsConfigurationsOutputTypeDef#
# ListBucketMetricsConfigurationsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketMetricsConfigurationsOutputTypeDef
def get_value() -> ListBucketMetricsConfigurationsOutputTypeDef:
return {
"IsTruncated": ...,
}
# ListBucketMetricsConfigurationsOutputTypeDef definition
class ListBucketMetricsConfigurationsOutputTypeDef(TypedDict):
IsTruncated: bool,
ContinuationToken: str,
NextContinuationToken: str,
MetricsConfigurationList: List[MetricsConfigurationOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)AnalyticsConfigurationOutputTypeDef#
# AnalyticsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsConfigurationOutputTypeDef
def get_value() -> AnalyticsConfigurationOutputTypeDef:
return {
"Id": ...,
}
# AnalyticsConfigurationOutputTypeDef definition
class AnalyticsConfigurationOutputTypeDef(TypedDict):
Id: str,
StorageClassAnalysis: StorageClassAnalysisTypeDef, # (2)
Filter: NotRequired[AnalyticsFilterOutputTypeDef], # (1)AnalyticsConfigurationTypeDef#
# AnalyticsConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import AnalyticsConfigurationTypeDef
def get_value() -> AnalyticsConfigurationTypeDef:
return {
"Id": ...,
}
# AnalyticsConfigurationTypeDef definition
class AnalyticsConfigurationTypeDef(TypedDict):
Id: str,
StorageClassAnalysis: StorageClassAnalysisTypeDef, # (2)
Filter: NotRequired[AnalyticsFilterTypeDef], # (1)NotificationConfigurationResponseTypeDef#
# NotificationConfigurationResponseTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NotificationConfigurationResponseTypeDef
def get_value() -> NotificationConfigurationResponseTypeDef:
return {
"TopicConfigurations": ...,
}
# NotificationConfigurationResponseTypeDef definition
class NotificationConfigurationResponseTypeDef(TypedDict):
TopicConfigurations: List[TopicConfigurationOutputTypeDef], # (1)
QueueConfigurations: List[QueueConfigurationOutputTypeDef], # (2)
LambdaFunctionConfigurations: List[LambdaFunctionConfigurationOutputTypeDef], # (3)
EventBridgeConfiguration: Dict[str, Any],
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See TopicConfigurationOutputTypeDef
- See QueueConfigurationOutputTypeDef
- See LambdaFunctionConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
RestoreRequestTypeDef#
# RestoreRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RestoreRequestTypeDef
def get_value() -> RestoreRequestTypeDef:
return {
"Days": ...,
}
# RestoreRequestTypeDef 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)- See GlacierJobParametersTypeDef
- See RestoreRequestTypeType
- See TierType
- See SelectParametersTypeDef
- See OutputLocationTypeDef
InventoryConfigurationOutputTypeDef#
# InventoryConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryConfigurationOutputTypeDef
def get_value() -> InventoryConfigurationOutputTypeDef:
return {
"Destination": ...,
}
# InventoryConfigurationOutputTypeDef definition
class InventoryConfigurationOutputTypeDef(TypedDict):
Destination: InventoryDestinationOutputTypeDef, # (1)
IsEnabled: bool,
Id: str,
IncludedObjectVersions: InventoryIncludedObjectVersionsType, # (3)
Schedule: InventoryScheduleTypeDef, # (5)
Filter: NotRequired[InventoryFilterTypeDef], # (2)
OptionalFields: NotRequired[List[InventoryOptionalFieldType]], # (4)- See InventoryDestinationOutputTypeDef
- See InventoryFilterTypeDef
- See InventoryIncludedObjectVersionsType
- See InventoryOptionalFieldType
- See InventoryScheduleTypeDef
InventoryConfigurationTypeDef#
# InventoryConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import InventoryConfigurationTypeDef
def get_value() -> InventoryConfigurationTypeDef:
return {
"Destination": ...,
}
# InventoryConfigurationTypeDef definition
class InventoryConfigurationTypeDef(TypedDict):
Destination: InventoryDestinationTypeDef, # (1)
IsEnabled: bool,
Id: str,
IncludedObjectVersions: InventoryIncludedObjectVersionsType, # (3)
Schedule: InventoryScheduleTypeDef, # (5)
Filter: NotRequired[InventoryFilterTypeDef], # (2)
OptionalFields: NotRequired[Sequence[InventoryOptionalFieldType]], # (4)- See InventoryDestinationTypeDef
- See InventoryFilterTypeDef
- See InventoryIncludedObjectVersionsType
- See InventoryOptionalFieldType
- See InventoryScheduleTypeDef
ReplicationConfigurationOutputTypeDef#
# ReplicationConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationConfigurationOutputTypeDef
def get_value() -> ReplicationConfigurationOutputTypeDef:
return {
"Role": ...,
}
# ReplicationConfigurationOutputTypeDef definition
class ReplicationConfigurationOutputTypeDef(TypedDict):
Role: str,
Rules: List[ReplicationRuleOutputTypeDef], # (1)ReplicationConfigurationTypeDef#
# ReplicationConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ReplicationConfigurationTypeDef
def get_value() -> ReplicationConfigurationTypeDef:
return {
"Role": ...,
}
# ReplicationConfigurationTypeDef definition
class ReplicationConfigurationTypeDef(TypedDict):
Role: str,
Rules: Sequence[ReplicationRuleTypeDef], # (1)PutBucketEncryptionRequestTypeDef#
# PutBucketEncryptionRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketEncryptionRequestTypeDef
def get_value() -> PutBucketEncryptionRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketEncryptionRequestTypeDef definition
class PutBucketEncryptionRequestTypeDef(TypedDict):
Bucket: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationUnionTypeDef, # (1)
ContentMD5: NotRequired[str],
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],- See ServerSideEncryptionConfigurationTypeDef ServerSideEncryptionConfigurationOutputTypeDef
- See ChecksumAlgorithmType
LifecycleConfigurationTypeDef#
# LifecycleConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleConfigurationTypeDef
def get_value() -> LifecycleConfigurationTypeDef:
return {
"Rules": ...,
}
# LifecycleConfigurationTypeDef definition
class LifecycleConfigurationTypeDef(TypedDict):
Rules: Sequence[RuleUnionTypeDef], # (1)PutBucketIntelligentTieringConfigurationRequestTypeDef#
# PutBucketIntelligentTieringConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketIntelligentTieringConfigurationRequestTypeDef
def get_value() -> PutBucketIntelligentTieringConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketIntelligentTieringConfigurationRequestTypeDef definition
class PutBucketIntelligentTieringConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
IntelligentTieringConfiguration: IntelligentTieringConfigurationUnionTypeDef, # (1)LifecycleRuleTypeDef#
# LifecycleRuleTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LifecycleRuleTypeDef
def get_value() -> LifecycleRuleTypeDef:
return {
"Expiration": ...,
}
# LifecycleRuleTypeDef definition
class LifecycleRuleTypeDef(TypedDict):
Status: ExpirationStatusType, # (3)
Expiration: NotRequired[LifecycleExpirationUnionTypeDef], # (1)
ID: NotRequired[str],
Prefix: NotRequired[str],
Filter: NotRequired[LifecycleRuleFilterUnionTypeDef], # (2)
Transitions: NotRequired[Sequence[TransitionUnionTypeDef]], # (4)
NoncurrentVersionTransitions: NotRequired[Sequence[NoncurrentVersionTransitionTypeDef]], # (5)
NoncurrentVersionExpiration: NotRequired[NoncurrentVersionExpirationTypeDef], # (6)
AbortIncompleteMultipartUpload: NotRequired[AbortIncompleteMultipartUploadTypeDef], # (7)- See LifecycleExpirationTypeDef LifecycleExpirationOutputTypeDef
- See LifecycleRuleFilterTypeDef LifecycleRuleFilterOutputTypeDef
- See ExpirationStatusType
- See TransitionTypeDef TransitionOutputTypeDef
- See NoncurrentVersionTransitionTypeDef
- See NoncurrentVersionExpirationTypeDef
- See AbortIncompleteMultipartUploadTypeDef
PutBucketMetricsConfigurationRequestTypeDef#
# PutBucketMetricsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketMetricsConfigurationRequestTypeDef
def get_value() -> PutBucketMetricsConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketMetricsConfigurationRequestTypeDef definition
class PutBucketMetricsConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
MetricsConfiguration: MetricsConfigurationUnionTypeDef, # (1)
ExpectedBucketOwner: NotRequired[str],GetBucketAnalyticsConfigurationOutputTypeDef#
# GetBucketAnalyticsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketAnalyticsConfigurationOutputTypeDef
def get_value() -> GetBucketAnalyticsConfigurationOutputTypeDef:
return {
"AnalyticsConfiguration": ...,
}
# GetBucketAnalyticsConfigurationOutputTypeDef definition
class GetBucketAnalyticsConfigurationOutputTypeDef(TypedDict):
AnalyticsConfiguration: AnalyticsConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListBucketAnalyticsConfigurationsOutputTypeDef#
# ListBucketAnalyticsConfigurationsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketAnalyticsConfigurationsOutputTypeDef
def get_value() -> ListBucketAnalyticsConfigurationsOutputTypeDef:
return {
"IsTruncated": ...,
}
# ListBucketAnalyticsConfigurationsOutputTypeDef definition
class ListBucketAnalyticsConfigurationsOutputTypeDef(TypedDict):
IsTruncated: bool,
ContinuationToken: str,
NextContinuationToken: str,
AnalyticsConfigurationList: List[AnalyticsConfigurationOutputTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)LambdaFunctionConfigurationTypeDef#
# LambdaFunctionConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import LambdaFunctionConfigurationTypeDef
def get_value() -> LambdaFunctionConfigurationTypeDef:
return {
"Id": ...,
}
# LambdaFunctionConfigurationTypeDef definition
class LambdaFunctionConfigurationTypeDef(TypedDict):
LambdaFunctionArn: str,
Events: Sequence[EventType], # (1)
Id: NotRequired[str],
Filter: NotRequired[NotificationConfigurationFilterUnionTypeDef], # (2)- See EventType
- See NotificationConfigurationFilterTypeDef NotificationConfigurationFilterOutputTypeDef
QueueConfigurationTypeDef#
# QueueConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import QueueConfigurationTypeDef
def get_value() -> QueueConfigurationTypeDef:
return {
"Id": ...,
}
# QueueConfigurationTypeDef definition
class QueueConfigurationTypeDef(TypedDict):
QueueArn: str,
Events: Sequence[EventType], # (1)
Id: NotRequired[str],
Filter: NotRequired[NotificationConfigurationFilterUnionTypeDef], # (2)- See EventType
- See NotificationConfigurationFilterTypeDef NotificationConfigurationFilterOutputTypeDef
TopicConfigurationTypeDef#
# TopicConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import TopicConfigurationTypeDef
def get_value() -> TopicConfigurationTypeDef:
return {
"Id": ...,
}
# TopicConfigurationTypeDef definition
class TopicConfigurationTypeDef(TypedDict):
TopicArn: str,
Events: Sequence[EventType], # (1)
Id: NotRequired[str],
Filter: NotRequired[NotificationConfigurationFilterUnionTypeDef], # (2)- See EventType
- See NotificationConfigurationFilterTypeDef NotificationConfigurationFilterOutputTypeDef
RestoreObjectRequestObjectRestoreObjectTypeDef#
# RestoreObjectRequestObjectRestoreObjectTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RestoreObjectRequestObjectRestoreObjectTypeDef
def get_value() -> RestoreObjectRequestObjectRestoreObjectTypeDef:
return {
"VersionId": ...,
}
# RestoreObjectRequestObjectRestoreObjectTypeDef definition
class RestoreObjectRequestObjectRestoreObjectTypeDef(TypedDict):
VersionId: NotRequired[str],
RestoreRequest: NotRequired[RestoreRequestTypeDef], # (1)
RequestPayer: NotRequired[RequestPayerType], # (2)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)
ExpectedBucketOwner: NotRequired[str],RestoreObjectRequestObjectSummaryRestoreObjectTypeDef#
# RestoreObjectRequestObjectSummaryRestoreObjectTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RestoreObjectRequestObjectSummaryRestoreObjectTypeDef
def get_value() -> RestoreObjectRequestObjectSummaryRestoreObjectTypeDef:
return {
"VersionId": ...,
}
# RestoreObjectRequestObjectSummaryRestoreObjectTypeDef definition
class RestoreObjectRequestObjectSummaryRestoreObjectTypeDef(TypedDict):
VersionId: NotRequired[str],
RestoreRequest: NotRequired[RestoreRequestTypeDef], # (1)
RequestPayer: NotRequired[RequestPayerType], # (2)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)
ExpectedBucketOwner: NotRequired[str],RestoreObjectRequestTypeDef#
# RestoreObjectRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import RestoreObjectRequestTypeDef
def get_value() -> RestoreObjectRequestTypeDef:
return {
"Bucket": ...,
}
# RestoreObjectRequestTypeDef definition
class RestoreObjectRequestTypeDef(TypedDict):
Bucket: str,
Key: str,
VersionId: NotRequired[str],
RestoreRequest: NotRequired[RestoreRequestTypeDef], # (1)
RequestPayer: NotRequired[RequestPayerType], # (2)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (3)
ExpectedBucketOwner: NotRequired[str],GetBucketInventoryConfigurationOutputTypeDef#
# GetBucketInventoryConfigurationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketInventoryConfigurationOutputTypeDef
def get_value() -> GetBucketInventoryConfigurationOutputTypeDef:
return {
"InventoryConfiguration": ...,
}
# GetBucketInventoryConfigurationOutputTypeDef definition
class GetBucketInventoryConfigurationOutputTypeDef(TypedDict):
InventoryConfiguration: InventoryConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListBucketInventoryConfigurationsOutputTypeDef#
# ListBucketInventoryConfigurationsOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import ListBucketInventoryConfigurationsOutputTypeDef
def get_value() -> ListBucketInventoryConfigurationsOutputTypeDef:
return {
"ContinuationToken": ...,
}
# ListBucketInventoryConfigurationsOutputTypeDef definition
class ListBucketInventoryConfigurationsOutputTypeDef(TypedDict):
ContinuationToken: str,
InventoryConfigurationList: List[InventoryConfigurationOutputTypeDef], # (1)
IsTruncated: bool,
NextContinuationToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetBucketReplicationOutputTypeDef#
# GetBucketReplicationOutputTypeDef TypedDict usage example
from types_boto3_s3.type_defs import GetBucketReplicationOutputTypeDef
def get_value() -> GetBucketReplicationOutputTypeDef:
return {
"ReplicationConfiguration": ...,
}
# GetBucketReplicationOutputTypeDef definition
class GetBucketReplicationOutputTypeDef(TypedDict):
ReplicationConfiguration: ReplicationConfigurationOutputTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)BucketLoggingStatusTypeDef#
# BucketLoggingStatusTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketLoggingStatusTypeDef
def get_value() -> BucketLoggingStatusTypeDef:
return {
"LoggingEnabled": ...,
}
# BucketLoggingStatusTypeDef definition
class BucketLoggingStatusTypeDef(TypedDict):
LoggingEnabled: NotRequired[LoggingEnabledUnionTypeDef], # (1)PutBucketLifecycleRequestBucketLifecyclePutTypeDef#
# PutBucketLifecycleRequestBucketLifecyclePutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLifecycleRequestBucketLifecyclePutTypeDef
def get_value() -> PutBucketLifecycleRequestBucketLifecyclePutTypeDef:
return {
"ChecksumAlgorithm": ...,
}
# PutBucketLifecycleRequestBucketLifecyclePutTypeDef definition
class PutBucketLifecycleRequestBucketLifecyclePutTypeDef(TypedDict):
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
LifecycleConfiguration: NotRequired[LifecycleConfigurationTypeDef], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketLifecycleRequestTypeDef#
# PutBucketLifecycleRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLifecycleRequestTypeDef
def get_value() -> PutBucketLifecycleRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketLifecycleRequestTypeDef definition
class PutBucketLifecycleRequestTypeDef(TypedDict):
Bucket: str,
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
LifecycleConfiguration: NotRequired[LifecycleConfigurationTypeDef], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketAnalyticsConfigurationRequestTypeDef#
# PutBucketAnalyticsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketAnalyticsConfigurationRequestTypeDef
def get_value() -> PutBucketAnalyticsConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketAnalyticsConfigurationRequestTypeDef definition
class PutBucketAnalyticsConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
AnalyticsConfiguration: AnalyticsConfigurationUnionTypeDef, # (1)
ExpectedBucketOwner: NotRequired[str],PutBucketInventoryConfigurationRequestTypeDef#
# PutBucketInventoryConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketInventoryConfigurationRequestTypeDef
def get_value() -> PutBucketInventoryConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketInventoryConfigurationRequestTypeDef definition
class PutBucketInventoryConfigurationRequestTypeDef(TypedDict):
Bucket: str,
Id: str,
InventoryConfiguration: InventoryConfigurationUnionTypeDef, # (1)
ExpectedBucketOwner: NotRequired[str],PutBucketReplicationRequestTypeDef#
# PutBucketReplicationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketReplicationRequestTypeDef
def get_value() -> PutBucketReplicationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketReplicationRequestTypeDef definition
class PutBucketReplicationRequestTypeDef(TypedDict):
Bucket: str,
ReplicationConfiguration: ReplicationConfigurationUnionTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
Token: NotRequired[str],
ExpectedBucketOwner: NotRequired[str],PutBucketLoggingRequestBucketLoggingPutTypeDef#
# PutBucketLoggingRequestBucketLoggingPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLoggingRequestBucketLoggingPutTypeDef
def get_value() -> PutBucketLoggingRequestBucketLoggingPutTypeDef:
return {
"BucketLoggingStatus": ...,
}
# PutBucketLoggingRequestBucketLoggingPutTypeDef definition
class PutBucketLoggingRequestBucketLoggingPutTypeDef(TypedDict):
BucketLoggingStatus: BucketLoggingStatusTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],PutBucketLoggingRequestTypeDef#
# PutBucketLoggingRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLoggingRequestTypeDef
def get_value() -> PutBucketLoggingRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketLoggingRequestTypeDef definition
class PutBucketLoggingRequestTypeDef(TypedDict):
Bucket: str,
BucketLoggingStatus: BucketLoggingStatusTypeDef, # (1)
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (2)
ExpectedBucketOwner: NotRequired[str],BucketLifecycleConfigurationTypeDef#
# BucketLifecycleConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import BucketLifecycleConfigurationTypeDef
def get_value() -> BucketLifecycleConfigurationTypeDef:
return {
"Rules": ...,
}
# BucketLifecycleConfigurationTypeDef definition
class BucketLifecycleConfigurationTypeDef(TypedDict):
Rules: Sequence[LifecycleRuleUnionTypeDef], # (1)NotificationConfigurationTypeDef#
# NotificationConfigurationTypeDef TypedDict usage example
from types_boto3_s3.type_defs import NotificationConfigurationTypeDef
def get_value() -> NotificationConfigurationTypeDef:
return {
"TopicConfigurations": ...,
}
# NotificationConfigurationTypeDef definition
class NotificationConfigurationTypeDef(TypedDict):
TopicConfigurations: NotRequired[Sequence[TopicConfigurationUnionTypeDef]], # (1)
QueueConfigurations: NotRequired[Sequence[QueueConfigurationUnionTypeDef]], # (2)
LambdaFunctionConfigurations: NotRequired[Sequence[LambdaFunctionConfigurationUnionTypeDef]], # (3)
EventBridgeConfiguration: NotRequired[Mapping[str, Any]],- See TopicConfigurationTypeDef TopicConfigurationOutputTypeDef
- See QueueConfigurationTypeDef QueueConfigurationOutputTypeDef
- See LambdaFunctionConfigurationTypeDef LambdaFunctionConfigurationOutputTypeDef
PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef#
# PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef
def get_value() -> PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef:
return {
"ChecksumAlgorithm": ...,
}
# PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef definition
class PutBucketLifecycleConfigurationRequestBucketLifecycleConfigurationPutTypeDef(TypedDict):
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
LifecycleConfiguration: NotRequired[BucketLifecycleConfigurationTypeDef], # (2)
ExpectedBucketOwner: NotRequired[str],
TransitionDefaultMinimumObjectSize: NotRequired[TransitionDefaultMinimumObjectSizeType], # (3)- See ChecksumAlgorithmType
- See BucketLifecycleConfigurationTypeDef
- See TransitionDefaultMinimumObjectSizeType
PutBucketLifecycleConfigurationRequestTypeDef#
# PutBucketLifecycleConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketLifecycleConfigurationRequestTypeDef
def get_value() -> PutBucketLifecycleConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketLifecycleConfigurationRequestTypeDef definition
class PutBucketLifecycleConfigurationRequestTypeDef(TypedDict):
Bucket: str,
ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType], # (1)
LifecycleConfiguration: NotRequired[BucketLifecycleConfigurationTypeDef], # (2)
ExpectedBucketOwner: NotRequired[str],
TransitionDefaultMinimumObjectSize: NotRequired[TransitionDefaultMinimumObjectSizeType], # (3)- See ChecksumAlgorithmType
- See BucketLifecycleConfigurationTypeDef
- See TransitionDefaultMinimumObjectSizeType
PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef#
# PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef
def get_value() -> PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef:
return {
"NotificationConfiguration": ...,
}
# PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef definition
class PutBucketNotificationConfigurationRequestBucketNotificationPutTypeDef(TypedDict):
NotificationConfiguration: NotificationConfigurationTypeDef, # (1)
ExpectedBucketOwner: NotRequired[str],
SkipDestinationValidation: NotRequired[bool],PutBucketNotificationConfigurationRequestTypeDef#
# PutBucketNotificationConfigurationRequestTypeDef TypedDict usage example
from types_boto3_s3.type_defs import PutBucketNotificationConfigurationRequestTypeDef
def get_value() -> PutBucketNotificationConfigurationRequestTypeDef:
return {
"Bucket": ...,
}
# PutBucketNotificationConfigurationRequestTypeDef definition
class PutBucketNotificationConfigurationRequestTypeDef(TypedDict):
Bucket: str,
NotificationConfiguration: NotificationConfigurationTypeDef, # (1)
ExpectedBucketOwner: NotRequired[str],
SkipDestinationValidation: NotRequired[bool],