Literals#
Auto-generated documentation for KMS type annotations stubs module mypy-boto3-kms.
AlgorithmSpecType#
# AlgorithmSpecType usage example
from mypy_boto3_kms.literals import AlgorithmSpecType
def get_value() -> AlgorithmSpecType:
return "RSAES_OAEP_SHA_1"# AlgorithmSpecType definition
AlgorithmSpecType = Literal[
"RSA_AES_KEY_WRAP_SHA_1",
"RSA_AES_KEY_WRAP_SHA_256",
"RSAES_OAEP_SHA_1",
"RSAES_OAEP_SHA_256",
"RSAES_PKCS1_V1_5",
"SM2PKE",
]ConnectionErrorCodeTypeType#
# ConnectionErrorCodeTypeType usage example
from mypy_boto3_kms.literals import ConnectionErrorCodeTypeType
def get_value() -> ConnectionErrorCodeTypeType:
return "CLUSTER_NOT_FOUND"# ConnectionErrorCodeTypeType definition
ConnectionErrorCodeTypeType = Literal[
"CLUSTER_NOT_FOUND",
"INSUFFICIENT_CLOUDHSM_HSMS",
"INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET",
"INTERNAL_ERROR",
"INVALID_CREDENTIALS",
"NETWORK_ERRORS",
"SUBNET_NOT_FOUND",
"USER_LOCKED_OUT",
"USER_LOGGED_IN",
"USER_NOT_FOUND",
"XKS_PROXY_ACCESS_DENIED",
"XKS_PROXY_INVALID_CONFIGURATION",
"XKS_PROXY_INVALID_RESPONSE",
"XKS_PROXY_INVALID_TLS_CONFIGURATION",
"XKS_PROXY_NOT_REACHABLE",
"XKS_PROXY_TIMED_OUT",
"XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION",
"XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND",
]ConnectionStateTypeType#
# ConnectionStateTypeType usage example
from mypy_boto3_kms.literals import ConnectionStateTypeType
def get_value() -> ConnectionStateTypeType:
return "CONNECTED"# ConnectionStateTypeType definition
ConnectionStateTypeType = Literal[
"CONNECTED",
"CONNECTING",
"DISCONNECTED",
"DISCONNECTING",
"FAILED",
]CustomKeyStoreTypeType#
# CustomKeyStoreTypeType usage example
from mypy_boto3_kms.literals import CustomKeyStoreTypeType
def get_value() -> CustomKeyStoreTypeType:
return "AWS_CLOUDHSM"# CustomKeyStoreTypeType definition
CustomKeyStoreTypeType = Literal[
"AWS_CLOUDHSM",
"EXTERNAL_KEY_STORE",
]CustomerMasterKeySpecType#
# CustomerMasterKeySpecType usage example
from mypy_boto3_kms.literals import CustomerMasterKeySpecType
def get_value() -> CustomerMasterKeySpecType:
return "ECC_NIST_P256"# CustomerMasterKeySpecType definition
CustomerMasterKeySpecType = Literal[
"ECC_NIST_P256",
"ECC_NIST_P384",
"ECC_NIST_P521",
"ECC_SECG_P256K1",
"HMAC_224",
"HMAC_256",
"HMAC_384",
"HMAC_512",
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
"SYMMETRIC_DEFAULT",
]DataKeyPairSpecType#
# DataKeyPairSpecType usage example
from mypy_boto3_kms.literals import DataKeyPairSpecType
def get_value() -> DataKeyPairSpecType:
return "ECC_NIST_P256"# DataKeyPairSpecType definition
DataKeyPairSpecType = Literal[
"ECC_NIST_P256",
"ECC_NIST_P384",
"ECC_NIST_P521",
"ECC_SECG_P256K1",
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
]DataKeySpecType#
# DataKeySpecType usage example
from mypy_boto3_kms.literals import DataKeySpecType
def get_value() -> DataKeySpecType:
return "AES_128"# DataKeySpecType definition
DataKeySpecType = Literal[
"AES_128",
"AES_256",
]DescribeCustomKeyStoresPaginatorName#
# DescribeCustomKeyStoresPaginatorName usage example
from mypy_boto3_kms.literals import DescribeCustomKeyStoresPaginatorName
def get_value() -> DescribeCustomKeyStoresPaginatorName:
return "describe_custom_key_stores"# DescribeCustomKeyStoresPaginatorName definition
DescribeCustomKeyStoresPaginatorName = Literal[
"describe_custom_key_stores",
]EncryptionAlgorithmSpecType#
# EncryptionAlgorithmSpecType usage example
from mypy_boto3_kms.literals import EncryptionAlgorithmSpecType
def get_value() -> EncryptionAlgorithmSpecType:
return "RSAES_OAEP_SHA_1"# EncryptionAlgorithmSpecType definition
EncryptionAlgorithmSpecType = Literal[
"RSAES_OAEP_SHA_1",
"RSAES_OAEP_SHA_256",
"SM2PKE",
"SYMMETRIC_DEFAULT",
]ExpirationModelTypeType#
# ExpirationModelTypeType usage example
from mypy_boto3_kms.literals import ExpirationModelTypeType
def get_value() -> ExpirationModelTypeType:
return "KEY_MATERIAL_DOES_NOT_EXPIRE"# ExpirationModelTypeType definition
ExpirationModelTypeType = Literal[
"KEY_MATERIAL_DOES_NOT_EXPIRE",
"KEY_MATERIAL_EXPIRES",
]GrantOperationType#
# GrantOperationType usage example
from mypy_boto3_kms.literals import GrantOperationType
def get_value() -> GrantOperationType:
return "CreateGrant"# GrantOperationType definition
GrantOperationType = Literal[
"CreateGrant",
"Decrypt",
"DeriveSharedSecret",
"DescribeKey",
"Encrypt",
"GenerateDataKey",
"GenerateDataKeyPair",
"GenerateDataKeyPairWithoutPlaintext",
"GenerateDataKeyWithoutPlaintext",
"GenerateMac",
"GetPublicKey",
"ReEncryptFrom",
"ReEncryptTo",
"RetireGrant",
"Sign",
"Verify",
"VerifyMac",
]KeyAgreementAlgorithmSpecType#
# KeyAgreementAlgorithmSpecType usage example
from mypy_boto3_kms.literals import KeyAgreementAlgorithmSpecType
def get_value() -> KeyAgreementAlgorithmSpecType:
return "ECDH"# KeyAgreementAlgorithmSpecType definition
KeyAgreementAlgorithmSpecType = Literal[
"ECDH",
]KeyEncryptionMechanismType#
# KeyEncryptionMechanismType usage example
from mypy_boto3_kms.literals import KeyEncryptionMechanismType
def get_value() -> KeyEncryptionMechanismType:
return "RSAES_OAEP_SHA_256"# KeyEncryptionMechanismType definition
KeyEncryptionMechanismType = Literal[
"RSAES_OAEP_SHA_256",
]KeyManagerTypeType#
# KeyManagerTypeType usage example
from mypy_boto3_kms.literals import KeyManagerTypeType
def get_value() -> KeyManagerTypeType:
return "AWS"# KeyManagerTypeType definition
KeyManagerTypeType = Literal[
"AWS",
"CUSTOMER",
]KeySpecType#
# KeySpecType usage example
from mypy_boto3_kms.literals import KeySpecType
def get_value() -> KeySpecType:
return "ECC_NIST_P256"# KeySpecType definition
KeySpecType = Literal[
"ECC_NIST_P256",
"ECC_NIST_P384",
"ECC_NIST_P521",
"ECC_SECG_P256K1",
"HMAC_224",
"HMAC_256",
"HMAC_384",
"HMAC_512",
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
"SYMMETRIC_DEFAULT",
]KeyStateType#
# KeyStateType usage example
from mypy_boto3_kms.literals import KeyStateType
def get_value() -> KeyStateType:
return "Creating"# KeyStateType definition
KeyStateType = Literal[
"Creating",
"Disabled",
"Enabled",
"PendingDeletion",
"PendingImport",
"PendingReplicaDeletion",
"Unavailable",
"Updating",
]KeyUsageTypeType#
# KeyUsageTypeType usage example
from mypy_boto3_kms.literals import KeyUsageTypeType
def get_value() -> KeyUsageTypeType:
return "ENCRYPT_DECRYPT"# KeyUsageTypeType definition
KeyUsageTypeType = Literal[
"ENCRYPT_DECRYPT",
"GENERATE_VERIFY_MAC",
"KEY_AGREEMENT",
"SIGN_VERIFY",
]ListAliasesPaginatorName#
# ListAliasesPaginatorName usage example
from mypy_boto3_kms.literals import ListAliasesPaginatorName
def get_value() -> ListAliasesPaginatorName:
return "list_aliases"# ListAliasesPaginatorName definition
ListAliasesPaginatorName = Literal[
"list_aliases",
]ListGrantsPaginatorName#
# ListGrantsPaginatorName usage example
from mypy_boto3_kms.literals import ListGrantsPaginatorName
def get_value() -> ListGrantsPaginatorName:
return "list_grants"# ListGrantsPaginatorName definition
ListGrantsPaginatorName = Literal[
"list_grants",
]ListKeyPoliciesPaginatorName#
# ListKeyPoliciesPaginatorName usage example
from mypy_boto3_kms.literals import ListKeyPoliciesPaginatorName
def get_value() -> ListKeyPoliciesPaginatorName:
return "list_key_policies"# ListKeyPoliciesPaginatorName definition
ListKeyPoliciesPaginatorName = Literal[
"list_key_policies",
]ListKeyRotationsPaginatorName#
# ListKeyRotationsPaginatorName usage example
from mypy_boto3_kms.literals import ListKeyRotationsPaginatorName
def get_value() -> ListKeyRotationsPaginatorName:
return "list_key_rotations"# ListKeyRotationsPaginatorName definition
ListKeyRotationsPaginatorName = Literal[
"list_key_rotations",
]ListKeysPaginatorName#
# ListKeysPaginatorName usage example
from mypy_boto3_kms.literals import ListKeysPaginatorName
def get_value() -> ListKeysPaginatorName:
return "list_keys"# ListKeysPaginatorName definition
ListKeysPaginatorName = Literal[
"list_keys",
]ListResourceTagsPaginatorName#
# ListResourceTagsPaginatorName usage example
from mypy_boto3_kms.literals import ListResourceTagsPaginatorName
def get_value() -> ListResourceTagsPaginatorName:
return "list_resource_tags"# ListResourceTagsPaginatorName definition
ListResourceTagsPaginatorName = Literal[
"list_resource_tags",
]ListRetirableGrantsPaginatorName#
# ListRetirableGrantsPaginatorName usage example
from mypy_boto3_kms.literals import ListRetirableGrantsPaginatorName
def get_value() -> ListRetirableGrantsPaginatorName:
return "list_retirable_grants"# ListRetirableGrantsPaginatorName definition
ListRetirableGrantsPaginatorName = Literal[
"list_retirable_grants",
]MacAlgorithmSpecType#
# MacAlgorithmSpecType usage example
from mypy_boto3_kms.literals import MacAlgorithmSpecType
def get_value() -> MacAlgorithmSpecType:
return "HMAC_SHA_224"# MacAlgorithmSpecType definition
MacAlgorithmSpecType = Literal[
"HMAC_SHA_224",
"HMAC_SHA_256",
"HMAC_SHA_384",
"HMAC_SHA_512",
]MessageTypeType#
# MessageTypeType usage example
from mypy_boto3_kms.literals import MessageTypeType
def get_value() -> MessageTypeType:
return "DIGEST"# MessageTypeType definition
MessageTypeType = Literal[
"DIGEST",
"RAW",
]MultiRegionKeyTypeType#
# MultiRegionKeyTypeType usage example
from mypy_boto3_kms.literals import MultiRegionKeyTypeType
def get_value() -> MultiRegionKeyTypeType:
return "PRIMARY"# MultiRegionKeyTypeType definition
MultiRegionKeyTypeType = Literal[
"PRIMARY",
"REPLICA",
]OriginTypeType#
# OriginTypeType usage example
from mypy_boto3_kms.literals import OriginTypeType
def get_value() -> OriginTypeType:
return "AWS_CLOUDHSM"# OriginTypeType definition
OriginTypeType = Literal[
"AWS_CLOUDHSM",
"AWS_KMS",
"EXTERNAL",
"EXTERNAL_KEY_STORE",
]RotationTypeType#
# RotationTypeType usage example
from mypy_boto3_kms.literals import RotationTypeType
def get_value() -> RotationTypeType:
return "AUTOMATIC"# RotationTypeType definition
RotationTypeType = Literal[
"AUTOMATIC",
"ON_DEMAND",
]SigningAlgorithmSpecType#
# SigningAlgorithmSpecType usage example
from mypy_boto3_kms.literals import SigningAlgorithmSpecType
def get_value() -> SigningAlgorithmSpecType:
return "ECDSA_SHA_256"# SigningAlgorithmSpecType definition
SigningAlgorithmSpecType = Literal[
"ECDSA_SHA_256",
"ECDSA_SHA_384",
"ECDSA_SHA_512",
"RSASSA_PKCS1_V1_5_SHA_256",
"RSASSA_PKCS1_V1_5_SHA_384",
"RSASSA_PKCS1_V1_5_SHA_512",
"RSASSA_PSS_SHA_256",
"RSASSA_PSS_SHA_384",
"RSASSA_PSS_SHA_512",
"SM2DSA",
]WrappingKeySpecType#
# WrappingKeySpecType usage example
from mypy_boto3_kms.literals import WrappingKeySpecType
def get_value() -> WrappingKeySpecType:
return "RSA_2048"# WrappingKeySpecType definition
WrappingKeySpecType = Literal[
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
]XksProxyConnectivityTypeType#
# XksProxyConnectivityTypeType usage example
from mypy_boto3_kms.literals import XksProxyConnectivityTypeType
def get_value() -> XksProxyConnectivityTypeType:
return "PUBLIC_ENDPOINT"# XksProxyConnectivityTypeType definition
XksProxyConnectivityTypeType = Literal[
"PUBLIC_ENDPOINT",
"VPC_ENDPOINT_SERVICE",
]KMSServiceName#
# KMSServiceName usage example
from mypy_boto3_kms.literals import KMSServiceName
def get_value() -> KMSServiceName:
return "kms"# KMSServiceName definition
KMSServiceName = Literal[
"kms",
]ServiceName#
# ServiceName usage example
from mypy_boto3_kms.literals import ServiceName
def get_value() -> ServiceName:
return "accessanalyzer"# ServiceName definition
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appfabric",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"application-signals",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"apptest",
"arc-zonal-shift",
"artifact",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"b2bi",
"backup",
"backup-gateway",
"backupsearch",
"batch",
"bcm-data-exports",
"bcm-pricing-calculator",
"bedrock",
"bedrock-agent",
"bedrock-agent-runtime",
"bedrock-data-automation",
"bedrock-data-automation-runtime",
"bedrock-runtime",
"billing",
"billingconductor",
"braket",
"budgets",
"ce",
"chatbot",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cleanroomsml",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",
"cloudfront-keyvaluestore",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codeconnections",
"codedeploy",
"codeguru-reviewer",
"codeguru-security",
"codeguruprofiler",
"codepipeline",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcampaignsv2",
"connectcases",
"connectparticipant",
"controlcatalog",
"controltower",
"cost-optimization-hub",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"datazone",
"dax",
"deadline",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"ds-data",
"dsql",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
"ecr-public",
"ecs",
"efs",
"eks",
"eks-auth",
"elastic-inference",
"elasticache",
"elasticbeanstalk",
"elastictranscoder",
"elb",
"elbv2",
"emr",
"emr-containers",
"emr-serverless",
"entityresolution",
"es",
"events",
"evidently",
"finspace",
"finspace-data",
"firehose",
"fis",
"fms",
"forecast",
"forecastquery",
"frauddetector",
"freetier",
"fsx",
"gamelift",
"geo-maps",
"geo-places",
"geo-routes",
"glacier",
"globalaccelerator",
"glue",
"grafana",
"greengrass",
"greengrassv2",
"groundstation",
"guardduty",
"health",
"healthlake",
"iam",
"identitystore",
"imagebuilder",
"importexport",
"inspector",
"inspector-scan",
"inspector2",
"internetmonitor",
"invoicing",
"iot",
"iot-data",
"iot-jobs-data",
"iot1click-devices",
"iot1click-projects",
"iotanalytics",
"iotdeviceadvisor",
"iotevents",
"iotevents-data",
"iotfleethub",
"iotfleetwise",
"iotsecuretunneling",
"iotsitewise",
"iotthingsgraph",
"iottwinmaker",
"iotwireless",
"ivs",
"ivs-realtime",
"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",
"launch-wizard",
"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",
"macie2",
"mailmanager",
"managedblockchain",
"managedblockchain-query",
"marketplace-agreement",
"marketplace-catalog",
"marketplace-deployment",
"marketplace-entitlement",
"marketplace-reporting",
"marketplacecommerceanalytics",
"mediaconnect",
"mediaconvert",
"medialive",
"mediapackage",
"mediapackage-vod",
"mediapackagev2",
"mediastore",
"mediastore-data",
"mediatailor",
"medical-imaging",
"memorydb",
"meteringmarketplace",
"mgh",
"mgn",
"migration-hub-refactor-spaces",
"migrationhub-config",
"migrationhuborchestrator",
"migrationhubstrategy",
"mq",
"mturk",
"mwaa",
"neptune",
"neptune-graph",
"neptunedata",
"network-firewall",
"networkflowmonitor",
"networkmanager",
"networkmonitor",
"notifications",
"notificationscontacts",
"oam",
"observabilityadmin",
"omics",
"opensearch",
"opensearchserverless",
"opsworks",
"opsworkscm",
"organizations",
"osis",
"outposts",
"panorama",
"partnercentral-selling",
"payment-cryptography",
"payment-cryptography-data",
"pca-connector-ad",
"pca-connector-scep",
"pcs",
"personalize",
"personalize-events",
"personalize-runtime",
"pi",
"pinpoint",
"pinpoint-email",
"pinpoint-sms-voice",
"pinpoint-sms-voice-v2",
"pipes",
"polly",
"pricing",
"privatenetworks",
"proton",
"qapps",
"qbusiness",
"qconnect",
"qldb",
"qldb-session",
"quicksight",
"ram",
"rbin",
"rds",
"rds-data",
"redshift",
"redshift-data",
"redshift-serverless",
"rekognition",
"repostspace",
"resiliencehub",
"resource-explorer-2",
"resource-groups",
"resourcegroupstaggingapi",
"robomaker",
"rolesanywhere",
"route53",
"route53-recovery-cluster",
"route53-recovery-control-config",
"route53-recovery-readiness",
"route53domains",
"route53profiles",
"route53resolver",
"rum",
"s3",
"s3control",
"s3outposts",
"s3tables",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"security-ir",
"securityhub",
"securitylake",
"serverlessrepo",
"service-quotas",
"servicecatalog",
"servicecatalog-appregistry",
"servicediscovery",
"ses",
"sesv2",
"shield",
"signer",
"simspaceweaver",
"sms",
"sms-voice",
"snow-device-management",
"snowball",
"sns",
"socialmessaging",
"sqs",
"ssm",
"ssm-contacts",
"ssm-incidents",
"ssm-quicksetup",
"ssm-sap",
"sso",
"sso-admin",
"sso-oidc",
"stepfunctions",
"storagegateway",
"sts",
"supplychain",
"support",
"support-app",
"swf",
"synthetics",
"taxsettings",
"textract",
"timestream-influxdb",
"timestream-query",
"timestream-write",
"tnb",
"transcribe",
"transfer",
"translate",
"trustedadvisor",
"verifiedpermissions",
"voice-id",
"vpc-lattice",
"waf",
"waf-regional",
"wafv2",
"wellarchitected",
"wisdom",
"workdocs",
"workmail",
"workmailmessageflow",
"workspaces",
"workspaces-thin-client",
"workspaces-web",
"xray",
]ResourceServiceName#
# ResourceServiceName usage example
from mypy_boto3_kms.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"# ResourceServiceName definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]PaginatorName#
# PaginatorName usage example
from mypy_boto3_kms.literals import PaginatorName
def get_value() -> PaginatorName:
return "describe_custom_key_stores"# PaginatorName definition
PaginatorName = Literal[
"describe_custom_key_stores",
"list_aliases",
"list_grants",
"list_key_policies",
"list_key_rotations",
"list_keys",
"list_resource_tags",
"list_retirable_grants",
]RegionName#
# RegionName usage example
from mypy_boto3_kms.literals import RegionName
def get_value() -> RegionName:
return "af-south-1"# RegionName 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",
"ap-southeast-5",
"ca-central-1",
"ca-west-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",
"il-central-1",
"me-central-1",
"me-south-1",
"sa-east-1",
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
]