Skip to content

Literals#

Index > Pinpoint > Literals

Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.

ActionType#

# ActionType usage example

from mypy_boto3_pinpoint.literals import ActionType

def get_value() -> ActionType:
    return "DEEP_LINK"
# ActionType definition

ActionType = Literal[
    "DEEP_LINK",
    "OPEN_APP",
    "URL",
]

AlignmentType#

# AlignmentType usage example

from mypy_boto3_pinpoint.literals import AlignmentType

def get_value() -> AlignmentType:
    return "CENTER"
# AlignmentType definition

AlignmentType = Literal[
    "CENTER",
    "LEFT",
    "RIGHT",
]

AttributeTypeType#

# AttributeTypeType usage example

from mypy_boto3_pinpoint.literals import AttributeTypeType

def get_value() -> AttributeTypeType:
    return "AFTER"
# AttributeTypeType definition

AttributeTypeType = Literal[
    "AFTER",
    "BEFORE",
    "BETWEEN",
    "CONTAINS",
    "EXCLUSIVE",
    "INCLUSIVE",
    "ON",
]

ButtonActionType#

# ButtonActionType usage example

from mypy_boto3_pinpoint.literals import ButtonActionType

def get_value() -> ButtonActionType:
    return "CLOSE"
# ButtonActionType definition

ButtonActionType = Literal[
    "CLOSE",
    "DEEP_LINK",
    "LINK",
]

CampaignStatusType#

# CampaignStatusType usage example

from mypy_boto3_pinpoint.literals import CampaignStatusType

def get_value() -> CampaignStatusType:
    return "COMPLETED"
# CampaignStatusType definition

CampaignStatusType = Literal[
    "COMPLETED",
    "DELETED",
    "EXECUTING",
    "INVALID",
    "PAUSED",
    "PENDING_NEXT_RUN",
    "SCHEDULED",
]

ChannelTypeType#

# ChannelTypeType usage example

from mypy_boto3_pinpoint.literals import ChannelTypeType

def get_value() -> ChannelTypeType:
    return "ADM"
# ChannelTypeType definition

ChannelTypeType = Literal[
    "ADM",
    "APNS",
    "APNS_SANDBOX",
    "APNS_VOIP",
    "APNS_VOIP_SANDBOX",
    "BAIDU",
    "CUSTOM",
    "EMAIL",
    "GCM",
    "IN_APP",
    "PUSH",
    "SMS",
    "VOICE",
]

DayOfWeekType#

# DayOfWeekType usage example

from mypy_boto3_pinpoint.literals import DayOfWeekType

def get_value() -> DayOfWeekType:
    return "FRIDAY"
# DayOfWeekType definition

DayOfWeekType = Literal[
    "FRIDAY",
    "MONDAY",
    "SATURDAY",
    "SUNDAY",
    "THURSDAY",
    "TUESDAY",
    "WEDNESDAY",
]

DeliveryStatusType#

# DeliveryStatusType usage example

from mypy_boto3_pinpoint.literals import DeliveryStatusType

def get_value() -> DeliveryStatusType:
    return "DUPLICATE"
# DeliveryStatusType definition

DeliveryStatusType = Literal[
    "DUPLICATE",
    "OPT_OUT",
    "PERMANENT_FAILURE",
    "SUCCESSFUL",
    "TEMPORARY_FAILURE",
    "THROTTLED",
    "UNKNOWN_FAILURE",
]

DimensionTypeType#

# DimensionTypeType usage example

from mypy_boto3_pinpoint.literals import DimensionTypeType

def get_value() -> DimensionTypeType:
    return "EXCLUSIVE"
# DimensionTypeType definition

DimensionTypeType = Literal[
    "EXCLUSIVE",
    "INCLUSIVE",
]

DurationType#

# DurationType usage example

from mypy_boto3_pinpoint.literals import DurationType

def get_value() -> DurationType:
    return "DAY_14"
# DurationType definition

DurationType = Literal[
    "DAY_14",
    "DAY_30",
    "DAY_7",
    "HR_24",
]

EndpointTypesElementType#

# EndpointTypesElementType usage example

from mypy_boto3_pinpoint.literals import EndpointTypesElementType

def get_value() -> EndpointTypesElementType:
    return "ADM"
# EndpointTypesElementType definition

EndpointTypesElementType = Literal[
    "ADM",
    "APNS",
    "APNS_SANDBOX",
    "APNS_VOIP",
    "APNS_VOIP_SANDBOX",
    "BAIDU",
    "CUSTOM",
    "EMAIL",
    "GCM",
    "IN_APP",
    "PUSH",
    "SMS",
    "VOICE",
]

FilterTypeType#

# FilterTypeType usage example

from mypy_boto3_pinpoint.literals import FilterTypeType

def get_value() -> FilterTypeType:
    return "ENDPOINT"
# FilterTypeType definition

FilterTypeType = Literal[
    "ENDPOINT",
    "SYSTEM",
]

FormatType#

# FormatType usage example

from mypy_boto3_pinpoint.literals import FormatType

def get_value() -> FormatType:
    return "CSV"
# FormatType definition

FormatType = Literal[
    "CSV",
    "JSON",
]

FrequencyType#

# FrequencyType usage example

from mypy_boto3_pinpoint.literals import FrequencyType

def get_value() -> FrequencyType:
    return "DAILY"
# FrequencyType definition

FrequencyType = Literal[
    "DAILY",
    "EVENT",
    "HOURLY",
    "IN_APP_EVENT",
    "MONTHLY",
    "ONCE",
    "WEEKLY",
]

IncludeType#

# IncludeType usage example

from mypy_boto3_pinpoint.literals import IncludeType

def get_value() -> IncludeType:
    return "ALL"
# IncludeType definition

IncludeType = Literal[
    "ALL",
    "ANY",
    "NONE",
]

JobStatusType#

# JobStatusType usage example

from mypy_boto3_pinpoint.literals import JobStatusType

def get_value() -> JobStatusType:
    return "COMPLETED"
# JobStatusType definition

JobStatusType = Literal[
    "COMPLETED",
    "COMPLETING",
    "CREATED",
    "FAILED",
    "FAILING",
    "INITIALIZING",
    "PENDING_JOB",
    "PREPARING_FOR_INITIALIZATION",
    "PROCESSING",
]

JourneyRunStatusType#

# JourneyRunStatusType usage example

from mypy_boto3_pinpoint.literals import JourneyRunStatusType

def get_value() -> JourneyRunStatusType:
    return "CANCELLED"
# JourneyRunStatusType definition

JourneyRunStatusType = Literal[
    "CANCELLED",
    "COMPLETED",
    "RUNNING",
    "SCHEDULED",
]

LayoutType#

# LayoutType usage example

from mypy_boto3_pinpoint.literals import LayoutType

def get_value() -> LayoutType:
    return "BOTTOM_BANNER"
# LayoutType definition

LayoutType = Literal[
    "BOTTOM_BANNER",
    "CAROUSEL",
    "MIDDLE_BANNER",
    "MOBILE_FEED",
    "OVERLAYS",
    "TOP_BANNER",
]

MessageTypeType#

# MessageTypeType usage example

from mypy_boto3_pinpoint.literals import MessageTypeType

def get_value() -> MessageTypeType:
    return "PROMOTIONAL"
# MessageTypeType definition

MessageTypeType = Literal[
    "PROMOTIONAL",
    "TRANSACTIONAL",
]

ModeType#

# ModeType usage example

from mypy_boto3_pinpoint.literals import ModeType

def get_value() -> ModeType:
    return "DELIVERY"
# ModeType definition

ModeType = Literal[
    "DELIVERY",
    "FILTER",
]

OperatorType#

# OperatorType usage example

from mypy_boto3_pinpoint.literals import OperatorType

def get_value() -> OperatorType:
    return "ALL"
# OperatorType definition

OperatorType = Literal[
    "ALL",
    "ANY",
]

RecencyTypeType#

# RecencyTypeType usage example

from mypy_boto3_pinpoint.literals import RecencyTypeType

def get_value() -> RecencyTypeType:
    return "ACTIVE"
# RecencyTypeType definition

RecencyTypeType = Literal[
    "ACTIVE",
    "INACTIVE",
]

SegmentTypeType#

# SegmentTypeType usage example

from mypy_boto3_pinpoint.literals import SegmentTypeType

def get_value() -> SegmentTypeType:
    return "DIMENSIONAL"
# SegmentTypeType definition

SegmentTypeType = Literal[
    "DIMENSIONAL",
    "IMPORT",
]

SourceTypeType#

# SourceTypeType usage example

from mypy_boto3_pinpoint.literals import SourceTypeType

def get_value() -> SourceTypeType:
    return "ALL"
# SourceTypeType definition

SourceTypeType = Literal[
    "ALL",
    "ANY",
    "NONE",
]

StateType#

# StateType usage example

from mypy_boto3_pinpoint.literals import StateType

def get_value() -> StateType:
    return "ACTIVE"
# StateType definition

StateType = Literal[
    "ACTIVE",
    "CANCELLED",
    "CLOSED",
    "COMPLETED",
    "DRAFT",
    "PAUSED",
]

TemplateTypeType#

# TemplateTypeType usage example

from mypy_boto3_pinpoint.literals import TemplateTypeType

def get_value() -> TemplateTypeType:
    return "EMAIL"
# TemplateTypeType definition

TemplateTypeType = Literal[
    "EMAIL",
    "INAPP",
    "PUSH",
    "SMS",
    "VOICE",
]

TimezoneEstimationMethodsElementType#

# TimezoneEstimationMethodsElementType usage example

from mypy_boto3_pinpoint.literals import TimezoneEstimationMethodsElementType

def get_value() -> TimezoneEstimationMethodsElementType:
    return "PHONE_NUMBER"
# TimezoneEstimationMethodsElementType definition

TimezoneEstimationMethodsElementType = Literal[
    "PHONE_NUMBER",
    "POSTAL_CODE",
]

TypeType#

# TypeType usage example

from mypy_boto3_pinpoint.literals import TypeType

def get_value() -> TypeType:
    return "ALL"
# TypeType definition

TypeType = Literal[
    "ALL",
    "ANY",
    "NONE",
]

PinpointServiceName#

# PinpointServiceName usage example

from mypy_boto3_pinpoint.literals import PinpointServiceName

def get_value() -> PinpointServiceName:
    return "pinpoint"
# PinpointServiceName definition

PinpointServiceName = Literal[
    "pinpoint",
]

ServiceName#

# ServiceName usage example

from mypy_boto3_pinpoint.literals import ServiceName

def get_value() -> ServiceName:
    return "accessanalyzer"
# ServiceName definition

ServiceName = Literal[
    "accessanalyzer",
    "account",
    "acm",
    "acm-pca",
    "alexaforbusiness",
    "amp",
    "amplify",
    "amplifybackend",
    "amplifyuibuilder",
    "apigateway",
    "apigatewaymanagementapi",
    "apigatewayv2",
    "appconfig",
    "appconfigdata",
    "appfabric",
    "appflow",
    "appintegrations",
    "application-autoscaling",
    "application-insights",
    "applicationcostprofiler",
    "appmesh",
    "apprunner",
    "appstream",
    "appsync",
    "arc-zonal-shift",
    "artifact",
    "athena",
    "auditmanager",
    "autoscaling",
    "autoscaling-plans",
    "b2bi",
    "backup",
    "backup-gateway",
    "backupstorage",
    "batch",
    "bcm-data-exports",
    "bedrock",
    "bedrock-agent",
    "bedrock-agent-runtime",
    "bedrock-runtime",
    "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",
    "codedeploy",
    "codeguru-reviewer",
    "codeguru-security",
    "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",
    "cost-optimization-hub",
    "cur",
    "customer-profiles",
    "databrew",
    "dataexchange",
    "datapipeline",
    "datasync",
    "datazone",
    "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",
    "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",
    "glacier",
    "globalaccelerator",
    "glue",
    "grafana",
    "greengrass",
    "greengrassv2",
    "groundstation",
    "guardduty",
    "health",
    "healthlake",
    "honeycode",
    "iam",
    "identitystore",
    "imagebuilder",
    "importexport",
    "inspector",
    "inspector-scan",
    "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",
    "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",
    "managedblockchain",
    "managedblockchain-query",
    "marketplace-agreement",
    "marketplace-catalog",
    "marketplace-deployment",
    "marketplace-entitlement",
    "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",
    "mobile",
    "mq",
    "mturk",
    "mwaa",
    "neptune",
    "neptune-graph",
    "neptunedata",
    "network-firewall",
    "networkmanager",
    "networkmonitor",
    "nimble",
    "oam",
    "omics",
    "opensearch",
    "opensearchserverless",
    "opsworks",
    "opsworkscm",
    "organizations",
    "osis",
    "outposts",
    "panorama",
    "payment-cryptography",
    "payment-cryptography-data",
    "pca-connector-ad",
    "personalize",
    "personalize-events",
    "personalize-runtime",
    "pi",
    "pinpoint",
    "pinpoint-email",
    "pinpoint-sms-voice",
    "pinpoint-sms-voice-v2",
    "pipes",
    "polly",
    "pricing",
    "privatenetworks",
    "proton",
    "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",
    "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",
    "supplychain",
    "support",
    "support-app",
    "swf",
    "synthetics",
    "textract",
    "timestream-query",
    "timestream-write",
    "tnb",
    "transcribe",
    "transfer",
    "translate",
    "trustedadvisor",
    "verifiedpermissions",
    "voice-id",
    "vpc-lattice",
    "waf",
    "waf-regional",
    "wafv2",
    "wellarchitected",
    "wisdom",
    "workdocs",
    "worklink",
    "workmail",
    "workmailmessageflow",
    "workspaces",
    "workspaces-thin-client",
    "workspaces-web",
    "xray",
]

ResourceServiceName#

# ResourceServiceName usage example

from mypy_boto3_pinpoint.literals import ResourceServiceName

def get_value() -> ResourceServiceName:
    return "cloudformation"
# ResourceServiceName definition

ResourceServiceName = Literal[
    "cloudformation",
    "cloudwatch",
    "dynamodb",
    "ec2",
    "glacier",
    "iam",
    "opsworks",
    "s3",
    "sns",
    "sqs",
]

RegionName#

# RegionName usage example

from mypy_boto3_pinpoint.literals import RegionName

def get_value() -> RegionName:
    return "ap-northeast-1"
# RegionName definition

RegionName = Literal[
    "ap-northeast-1",
    "ap-northeast-2",
    "ap-south-1",
    "ap-southeast-1",
    "ap-southeast-2",
    "ca-central-1",
    "eu-central-1",
    "eu-west-1",
    "eu-west-2",
    "us-east-1",
    "us-east-2",
    "us-west-2",
]