Literals
Auto-generated documentation for S3 type annotations stubs module mypy-boto3-s3.
AnalyticsS3ExportFileFormatType
Usage Example
from mypy_boto3_s3.literals import AnalyticsS3ExportFileFormatType
def get_value() -> AnalyticsS3ExportFileFormatType:
return "CSV"
ArchiveStatusType
Usage Example
from mypy_boto3_s3.literals import ArchiveStatusType
def get_value() -> ArchiveStatusType:
return "ARCHIVE_ACCESS"
BucketAccelerateStatusType
Usage Example
from mypy_boto3_s3.literals import BucketAccelerateStatusType
def get_value() -> BucketAccelerateStatusType:
return "Enabled"
BucketCannedACLType
Usage Example
from mypy_boto3_s3.literals import BucketCannedACLType
def get_value() -> BucketCannedACLType:
return "authenticated-read"
Definition
BucketCannedACLType = Literal[
"authenticated-read",
"private",
"public-read",
"public-read-write",
]
BucketExistsWaiterName
Usage Example
from mypy_boto3_s3.literals import BucketExistsWaiterName
def get_value() -> BucketExistsWaiterName:
return "bucket_exists"
BucketLocationConstraintType
Usage Example
from mypy_boto3_s3.literals import BucketLocationConstraintType
def get_value() -> BucketLocationConstraintType:
return "EU"
Definition
BucketLocationConstraintType = Literal[
"af-south-1",
"ap-east-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ca-central-1",
"cn-north-1",
"cn-northwest-1",
"EU",
"eu-central-1",
"eu-north-1",
"eu-south-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"me-south-1",
"sa-east-1",
"us-east-2",
"us-gov-east-1",
"us-gov-west-1",
"us-west-1",
"us-west-2",
]
BucketLogsPermissionType
Usage Example
from mypy_boto3_s3.literals import BucketLogsPermissionType
def get_value() -> BucketLogsPermissionType:
return "FULL_CONTROL"
BucketNotExistsWaiterName
Usage Example
from mypy_boto3_s3.literals import BucketNotExistsWaiterName
def get_value() -> BucketNotExistsWaiterName:
return "bucket_not_exists"
BucketVersioningStatusType
Usage Example
from mypy_boto3_s3.literals import BucketVersioningStatusType
def get_value() -> BucketVersioningStatusType:
return "Enabled"
ChecksumAlgorithmType
Usage Example
from mypy_boto3_s3.literals import ChecksumAlgorithmType
def get_value() -> ChecksumAlgorithmType:
return "CRC32"
ChecksumModeType
Usage Example
from mypy_boto3_s3.literals import ChecksumModeType
def get_value() -> ChecksumModeType:
return "ENABLED"
CompressionTypeType
Usage Example
from mypy_boto3_s3.literals import CompressionTypeType
def get_value() -> CompressionTypeType:
return "BZIP2"
DeleteMarkerReplicationStatusType
Usage Example
from mypy_boto3_s3.literals import DeleteMarkerReplicationStatusType
def get_value() -> DeleteMarkerReplicationStatusType:
return "Disabled"
EncodingTypeType
Usage Example
from mypy_boto3_s3.literals import EncodingTypeType
def get_value() -> EncodingTypeType:
return "url"
EventType
Usage Example
from mypy_boto3_s3.literals import EventType
def get_value() -> EventType:
return "s3:IntelligentTiering"
Definition
EventType = Literal[
"s3:IntelligentTiering",
"s3:LifecycleExpiration:*",
"s3:LifecycleExpiration:Delete",
"s3:LifecycleExpiration:DeleteMarkerCreated",
"s3:LifecycleTransition",
"s3:ObjectAcl:Put",
"s3:ObjectCreated:*",
"s3:ObjectCreated:CompleteMultipartUpload",
"s3:ObjectCreated:Copy",
"s3:ObjectCreated:Post",
"s3:ObjectCreated:Put",
"s3:ObjectRemoved:*",
"s3:ObjectRemoved:Delete",
"s3:ObjectRemoved:DeleteMarkerCreated",
"s3:ObjectRestore:*",
"s3:ObjectRestore:Completed",
"s3:ObjectRestore:Delete",
"s3:ObjectRestore:Post",
"s3:ObjectTagging:*",
"s3:ObjectTagging:Delete",
"s3:ObjectTagging:Put",
"s3:ReducedRedundancyLostObject",
"s3:Replication:*",
"s3:Replication:OperationFailedReplication",
"s3:Replication:OperationMissedThreshold",
"s3:Replication:OperationNotTracked",
"s3:Replication:OperationReplicatedAfterThreshold",
]
ExistingObjectReplicationStatusType
Usage Example
from mypy_boto3_s3.literals import ExistingObjectReplicationStatusType
def get_value() -> ExistingObjectReplicationStatusType:
return "Disabled"
ExpirationStatusType
Usage Example
from mypy_boto3_s3.literals import ExpirationStatusType
def get_value() -> ExpirationStatusType:
return "Disabled"
ExpressionTypeType
Usage Example
from mypy_boto3_s3.literals import ExpressionTypeType
def get_value() -> ExpressionTypeType:
return "SQL"
FileHeaderInfoType
Usage Example
from mypy_boto3_s3.literals import FileHeaderInfoType
def get_value() -> FileHeaderInfoType:
return "IGNORE"
FilterRuleNameType
Usage Example
from mypy_boto3_s3.literals import FilterRuleNameType
def get_value() -> FilterRuleNameType:
return "prefix"
IntelligentTieringAccessTierType
Usage Example
from mypy_boto3_s3.literals import IntelligentTieringAccessTierType
def get_value() -> IntelligentTieringAccessTierType:
return "ARCHIVE_ACCESS"
IntelligentTieringStatusType
Usage Example
from mypy_boto3_s3.literals import IntelligentTieringStatusType
def get_value() -> IntelligentTieringStatusType:
return "Disabled"
InventoryFormatType
Usage Example
from mypy_boto3_s3.literals import InventoryFormatType
def get_value() -> InventoryFormatType:
return "CSV"
InventoryFrequencyType
Usage Example
from mypy_boto3_s3.literals import InventoryFrequencyType
def get_value() -> InventoryFrequencyType:
return "Daily"
InventoryIncludedObjectVersionsType
Usage Example
from mypy_boto3_s3.literals import InventoryIncludedObjectVersionsType
def get_value() -> InventoryIncludedObjectVersionsType:
return "All"
InventoryOptionalFieldType
Usage Example
from mypy_boto3_s3.literals import InventoryOptionalFieldType
def get_value() -> InventoryOptionalFieldType:
return "BucketKeyStatus"
Definition
InventoryOptionalFieldType = Literal[
"BucketKeyStatus",
"ChecksumAlgorithm",
"EncryptionStatus",
"ETag",
"IntelligentTieringAccessTier",
"IsMultipartUploaded",
"LastModifiedDate",
"ObjectLockLegalHoldStatus",
"ObjectLockMode",
"ObjectLockRetainUntilDate",
"ReplicationStatus",
"Size",
"StorageClass",
]
JSONTypeType
Usage Example
from mypy_boto3_s3.literals import JSONTypeType
def get_value() -> JSONTypeType:
return "DOCUMENT"
ListMultipartUploadsPaginatorName
Usage Example
from mypy_boto3_s3.literals import ListMultipartUploadsPaginatorName
def get_value() -> ListMultipartUploadsPaginatorName:
return "list_multipart_uploads"
ListObjectVersionsPaginatorName
Usage Example
from mypy_boto3_s3.literals import ListObjectVersionsPaginatorName
def get_value() -> ListObjectVersionsPaginatorName:
return "list_object_versions"
ListObjectsPaginatorName
Usage Example
from mypy_boto3_s3.literals import ListObjectsPaginatorName
def get_value() -> ListObjectsPaginatorName:
return "list_objects"
ListObjectsV2PaginatorName
Usage Example
from mypy_boto3_s3.literals import ListObjectsV2PaginatorName
def get_value() -> ListObjectsV2PaginatorName:
return "list_objects_v2"
ListPartsPaginatorName
Usage Example
from mypy_boto3_s3.literals import ListPartsPaginatorName
def get_value() -> ListPartsPaginatorName:
return "list_parts"
MFADeleteStatusType
Usage Example
from mypy_boto3_s3.literals import MFADeleteStatusType
def get_value() -> MFADeleteStatusType:
return "Disabled"
MFADeleteType
Usage Example
from mypy_boto3_s3.literals import MFADeleteType
def get_value() -> MFADeleteType:
return "Disabled"
MetadataDirectiveType
Usage Example
from mypy_boto3_s3.literals import MetadataDirectiveType
def get_value() -> MetadataDirectiveType:
return "COPY"
MetricsStatusType
Usage Example
from mypy_boto3_s3.literals import MetricsStatusType
def get_value() -> MetricsStatusType:
return "Disabled"
ObjectAttributesType
Usage Example
from mypy_boto3_s3.literals import ObjectAttributesType
def get_value() -> ObjectAttributesType:
return "Checksum"
Definition
ObjectAttributesType = Literal[
"Checksum",
"ETag",
"ObjectParts",
"ObjectSize",
"StorageClass",
]
ObjectCannedACLType
Usage Example
from mypy_boto3_s3.literals import ObjectCannedACLType
def get_value() -> ObjectCannedACLType:
return "authenticated-read"
Definition
ObjectCannedACLType = Literal[
"authenticated-read",
"aws-exec-read",
"bucket-owner-full-control",
"bucket-owner-read",
"private",
"public-read",
"public-read-write",
]
ObjectExistsWaiterName
Usage Example
from mypy_boto3_s3.literals import ObjectExistsWaiterName
def get_value() -> ObjectExistsWaiterName:
return "object_exists"
ObjectLockEnabledType
Usage Example
from mypy_boto3_s3.literals import ObjectLockEnabledType
def get_value() -> ObjectLockEnabledType:
return "Enabled"
ObjectLockLegalHoldStatusType
Usage Example
from mypy_boto3_s3.literals import ObjectLockLegalHoldStatusType
def get_value() -> ObjectLockLegalHoldStatusType:
return "OFF"
ObjectLockModeType
Usage Example
from mypy_boto3_s3.literals import ObjectLockModeType
def get_value() -> ObjectLockModeType:
return "COMPLIANCE"
ObjectLockRetentionModeType
Usage Example
from mypy_boto3_s3.literals import ObjectLockRetentionModeType
def get_value() -> ObjectLockRetentionModeType:
return "COMPLIANCE"
ObjectNotExistsWaiterName
Usage Example
from mypy_boto3_s3.literals import ObjectNotExistsWaiterName
def get_value() -> ObjectNotExistsWaiterName:
return "object_not_exists"
ObjectOwnershipType
Usage Example
from mypy_boto3_s3.literals import ObjectOwnershipType
def get_value() -> ObjectOwnershipType:
return "BucketOwnerEnforced"
Definition
ObjectOwnershipType = Literal[
"BucketOwnerEnforced",
"BucketOwnerPreferred",
"ObjectWriter",
]
ObjectStorageClassType
Usage Example
from mypy_boto3_s3.literals import ObjectStorageClassType
def get_value() -> ObjectStorageClassType:
return "DEEP_ARCHIVE"
Definition
ObjectStorageClassType = Literal[
"DEEP_ARCHIVE",
"GLACIER",
"GLACIER_IR",
"INTELLIGENT_TIERING",
"ONEZONE_IA",
"OUTPOSTS",
"REDUCED_REDUNDANCY",
"STANDARD",
"STANDARD_IA",
]
ObjectVersionStorageClassType
Usage Example
from mypy_boto3_s3.literals import ObjectVersionStorageClassType
def get_value() -> ObjectVersionStorageClassType:
return "STANDARD"
OwnerOverrideType
Usage Example
from mypy_boto3_s3.literals import OwnerOverrideType
def get_value() -> OwnerOverrideType:
return "Destination"
PayerType
Usage Example
from mypy_boto3_s3.literals import PayerType
def get_value() -> PayerType:
return "BucketOwner"
PermissionType
Usage Example
from mypy_boto3_s3.literals import PermissionType
def get_value() -> PermissionType:
return "FULL_CONTROL"
ProtocolType
Usage Example
from mypy_boto3_s3.literals import ProtocolType
def get_value() -> ProtocolType:
return "http"
QuoteFieldsType
Usage Example
from mypy_boto3_s3.literals import QuoteFieldsType
def get_value() -> QuoteFieldsType:
return "ALWAYS"
ReplicaModificationsStatusType
Usage Example
from mypy_boto3_s3.literals import ReplicaModificationsStatusType
def get_value() -> ReplicaModificationsStatusType:
return "Disabled"
ReplicationRuleStatusType
Usage Example
from mypy_boto3_s3.literals import ReplicationRuleStatusType
def get_value() -> ReplicationRuleStatusType:
return "Disabled"
ReplicationStatusType
Usage Example
from mypy_boto3_s3.literals import ReplicationStatusType
def get_value() -> ReplicationStatusType:
return "COMPLETE"
ReplicationTimeStatusType
Usage Example
from mypy_boto3_s3.literals import ReplicationTimeStatusType
def get_value() -> ReplicationTimeStatusType:
return "Disabled"
RequestChargedType
Usage Example
from mypy_boto3_s3.literals import RequestChargedType
def get_value() -> RequestChargedType:
return "requester"
RequestPayerType
Usage Example
from mypy_boto3_s3.literals import RequestPayerType
def get_value() -> RequestPayerType:
return "requester"
RestoreRequestTypeType
Usage Example
from mypy_boto3_s3.literals import RestoreRequestTypeType
def get_value() -> RestoreRequestTypeType:
return "SELECT"
ServerSideEncryptionType
Usage Example
from mypy_boto3_s3.literals import ServerSideEncryptionType
def get_value() -> ServerSideEncryptionType:
return "AES256"
SseKmsEncryptedObjectsStatusType
Usage Example
from mypy_boto3_s3.literals import SseKmsEncryptedObjectsStatusType
def get_value() -> SseKmsEncryptedObjectsStatusType:
return "Disabled"
StorageClassAnalysisSchemaVersionType
Usage Example
from mypy_boto3_s3.literals import StorageClassAnalysisSchemaVersionType
def get_value() -> StorageClassAnalysisSchemaVersionType:
return "V_1"
StorageClassType
Usage Example
from mypy_boto3_s3.literals import StorageClassType
def get_value() -> StorageClassType:
return "DEEP_ARCHIVE"
Definition
StorageClassType = Literal[
"DEEP_ARCHIVE",
"GLACIER",
"GLACIER_IR",
"INTELLIGENT_TIERING",
"ONEZONE_IA",
"OUTPOSTS",
"REDUCED_REDUNDANCY",
"STANDARD",
"STANDARD_IA",
]
TaggingDirectiveType
Usage Example
from mypy_boto3_s3.literals import TaggingDirectiveType
def get_value() -> TaggingDirectiveType:
return "COPY"
TierType
TransitionStorageClassType
Usage Example
from mypy_boto3_s3.literals import TransitionStorageClassType
def get_value() -> TransitionStorageClassType:
return "DEEP_ARCHIVE"
Definition
TransitionStorageClassType = Literal[
"DEEP_ARCHIVE",
"GLACIER",
"GLACIER_IR",
"INTELLIGENT_TIERING",
"ONEZONE_IA",
"STANDARD_IA",
]
TypeType
Usage Example
from mypy_boto3_s3.literals import TypeType
def get_value() -> TypeType:
return "AmazonCustomerByEmail"
S3ServiceName
Usage Example
from mypy_boto3_s3.literals import S3ServiceName
def get_value() -> S3ServiceName:
return "s3"
ServiceName
Usage Example
from mypy_boto3_s3.literals import ServiceName
def get_value() -> ServiceName:
return "accessanalyzer"
Definition
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"alexaforbusiness",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"arc-zonal-shift",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"backup",
"backup-gateway",
"backupstorage",
"batch",
"billingconductor",
"braket",
"budgets",
"ce",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codedeploy",
"codeguru-reviewer",
"codeguruprofiler",
"codepipeline",
"codestar",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcases",
"connectparticipant",
"controltower",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"dax",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
"ecr-public",
"ecs",
"efs",
"eks",
"elastic-inference",
"elasticache",
"elasticbeanstalk",
"elastictranscoder",
"elb",
"elbv2",
"emr",
"emr-containers",
"emr-serverless",
"es",
"events",
"evidently",
"finspace",
"finspace-data",
"firehose",
"fis",
"fms",
"forecast",
"forecastquery",
"frauddetector",
"fsx",
"gamelift",
"gamesparks",
"glacier",
"globalaccelerator",
"glue",
"grafana",
"greengrass",
"greengrassv2",
"groundstation",
"guardduty",
"health",
"healthlake",
"honeycode",
"iam",
"identitystore",
"imagebuilder",
"importexport",
"inspector",
"inspector2",
"internetmonitor",
"iot",
"iot-data",
"iot-jobs-data",
"iot-roborunner",
"iot1click-devices",
"iot1click-projects",
"iotanalytics",
"iotdeviceadvisor",
"iotevents",
"iotevents-data",
"iotfleethub",
"iotfleetwise",
"iotsecuretunneling",
"iotsitewise",
"iotthingsgraph",
"iottwinmaker",
"iotwireless",
"ivs",
"ivschat",
"kafka",
"kafkaconnect",
"kendra",
"kendra-ranking",
"keyspaces",
"kinesis",
"kinesis-video-archived-media",
"kinesis-video-media",
"kinesis-video-signaling",
"kinesis-video-webrtc-storage",
"kinesisanalytics",
"kinesisanalyticsv2",
"kinesisvideo",
"kms",
"lakeformation",
"lambda",
"lex-models",
"lex-runtime",
"lexv2-models",
"lexv2-runtime",
"license-manager",
"license-manager-linux-subscriptions",
"license-manager-user-subscriptions",
"lightsail",
"location",
"logs",
"lookoutequipment",
"lookoutmetrics",
"lookoutvision",
"m2",
"machinelearning",
"macie",
"macie2",
"managedblockchain",
"marketplace-catalog",
"marketplace-entitlement",
"marketplacecommerceanalytics",
"mediaconnect",
"mediaconvert",
"medialive",
"mediapackage",
"mediapackage-vod",
"mediastore",
"mediastore-data",
"mediatailor",
"memorydb",
"meteringmarketplace",
"mgh",
"mgn",
"migration-hub-refactor-spaces",
"migrationhub-config",
"migrationhuborchestrator",
"migrationhubstrategy",
"mobile",
"mq",
"mturk",
"mwaa",
"neptune",
"network-firewall",
"networkmanager",
"nimble",
"oam",
"omics",
"opensearch",
"opensearchserverless",
"opsworks",
"opsworkscm",
"organizations",
"outposts",
"panorama",
"personalize",
"personalize-events",
"personalize-runtime",
"pi",
"pinpoint",
"pinpoint-email",
"pinpoint-sms-voice",
"pinpoint-sms-voice-v2",
"pipes",
"polly",
"pricing",
"privatenetworks",
"proton",
"qldb",
"qldb-session",
"quicksight",
"ram",
"rbin",
"rds",
"rds-data",
"redshift",
"redshift-data",
"redshift-serverless",
"rekognition",
"resiliencehub",
"resource-explorer-2",
"resource-groups",
"resourcegroupstaggingapi",
"robomaker",
"rolesanywhere",
"route53",
"route53-recovery-cluster",
"route53-recovery-control-config",
"route53-recovery-readiness",
"route53domains",
"route53resolver",
"rum",
"s3",
"s3control",
"s3outposts",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"securityhub",
"securitylake",
"serverlessrepo",
"service-quotas",
"servicecatalog",
"servicecatalog-appregistry",
"servicediscovery",
"ses",
"sesv2",
"shield",
"signer",
"simspaceweaver",
"sms",
"sms-voice",
"snow-device-management",
"snowball",
"sns",
"sqs",
"ssm",
"ssm-contacts",
"ssm-incidents",
"ssm-sap",
"sso",
"sso-admin",
"sso-oidc",
"stepfunctions",
"storagegateway",
"sts",
"support",
"support-app",
"swf",
"synthetics",
"textract",
"timestream-query",
"timestream-write",
"tnb",
"transcribe",
"transfer",
"translate",
"voice-id",
"waf",
"waf-regional",
"wafv2",
"wellarchitected",
"wisdom",
"workdocs",
"worklink",
"workmail",
"workmailmessageflow",
"workspaces",
"workspaces-web",
"xray",
]
ResourceServiceName
Usage Example
from mypy_boto3_s3.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"
Definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]
PaginatorName
Usage Example
from mypy_boto3_s3.literals import PaginatorName
def get_value() -> PaginatorName:
return "list_multipart_uploads"
Definition
PaginatorName = Literal[
"list_multipart_uploads",
"list_object_versions",
"list_objects",
"list_objects_v2",
"list_parts",
]
WaiterName
Usage Example
from mypy_boto3_s3.literals import WaiterName
def get_value() -> WaiterName:
return "bucket_exists"
Definition
WaiterName = Literal[
"bucket_exists",
"bucket_not_exists",
"object_exists",
"object_not_exists",
]
RegionName
Usage Example
from mypy_boto3_s3.literals import RegionName
def get_value() -> RegionName:
return "af-south-1"
Definition
RegionName = Literal[
"af-south-1",
"ap-east-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-south-1",
"ap-south-2",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ap-southeast-4",
"ca-central-1",
"eu-central-1",
"eu-central-2",
"eu-north-1",
"eu-south-1",
"eu-south-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"me-central-1",
"me-south-1",
"sa-east-1",
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
]